Create a subscription fee

Attaches recurring-payment terms to a product (and optionally a specific variant).

POST/subscription_fees

Authorization

AuthorizationBearer token (JWT) · headerrequired

Request body

requiredapplication/json

product_idintegerrequired

variant_idinteger

payment_intervalstringrequired

Allowed:1_week1_month3_months6_months12_months

renewal_feeinteger

In cents

setup_feeinteger

In cents

number_of_paymentsinteger

payment_dayinteger

by_percentageboolean

allow_non_recurring_paymentboolean

min_days_for_cancellationinteger

allow_changing_dayboolean

extend_on_reenableboolean

on_first_renewalstring

Responses

201

Subscription fee created

_linksHalLinks

idinteger

seller_idinteger

product_idinteger

variant_idinteger

payment_intervalstring

Allowed:1_week1_month3_months6_months12_months

renewal_feeinteger

In cents

renewal_fee_priceinteger

In cents

setup_feeinteger

In cents

number_of_paymentsinteger

payment_dayinteger

by_percentageboolean

allow_non_recurring_paymentboolean

min_days_for_cancellationinteger

allow_changing_dayboolean

extend_on_reenableboolean

on_first_renewalstring

created_onstring<date-time>

updated_onstring<date-time>

422

Validation error

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Bodyapplication/json

product_idinteger*variant_idintegerpayment_intervalstring*renewal_feeintegerIn centssetup_feeintegerIn centsnumber_of_paymentsintegerpayment_dayintegerby_percentagebooleanallow_non_recurring_paymentbooleanmin_days_for_cancellationintegerallow_changing_daybooleanextend_on_reenablebooleanon_first_renewalstring

Request

curl -X POST 'https://api.onbolder.com/v2/subscription_fees' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "product_id": 101,
  "payment_interval": "1_month",
  "renewal_fee": 2999
}'

const response = await fetch("https://api.onbolder.com/v2/subscription_fees", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"product_id\": 101,\n  \"payment_interval\": \"1_month\",\n  \"renewal_fee\": 2999\n}"
});

import requests

response = requests.post(
    "https://api.onbolder.com/v2/subscription_fees",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"product_id\": 101,\n  \"payment_interval\": \"1_month\",\n  \"renewal_fee\": 2999\n}",
)

Response

{
  "_links": {
    "property1": {
      "href": "string",
      "templated": true,
      "method": "get",
      "title": "string",
      "type": "string"
    },
    "property2": {
      "href": "string",
      "templated": true,
      "method": "get",
      "title": "string",
      "type": "string"
    }
  },
  "id": 0,
  "seller_id": 0,
  "product_id": 0,
  "variant_id": 0,
  "payment_interval": "1_week",
  "renewal_fee": 0,
  "renewal_fee_price": 0,
  "setup_fee": 0,
  "number_of_payments": 0,
  "payment_day": 0,
  "by_percentage": true,
  "allow_non_recurring_payment": true,
  "min_days_for_cancellation": 0,
  "allow_changing_day": true,
  "extend_on_reenable": true,
  "on_first_renewal": "string",
  "created_on": "2019-08-24T14:15:22Z",
  "updated_on": "2019-08-24T14:15:22Z"
}