Create Billing Plan

This API endpoint (POST) creates a billing plan product. If the request succeeds it returns a Product Object﻿ otherwise it will return an error. 

Permissions: products.create
Webhook event: product-created﻿ 
Body Parameters
tax_category string *
The tax category﻿ of the product.
﻿
pricing_model array of objects *
An array of objects, each representing a pricing model associated with the product. 
JSON
"pricing_model": [
    {
      "billing_cycle": "month",
      "currency": "EUR",
      "price": 1200,
      "interval": 2
    }
]
"pricing_model": [
    {
      "billing_cycle": "month",
      "currency": "EUR",
      "price": 1200,
      "interval": 2
    }
]
﻿
currency string Currency Code﻿
The currency of the pricing model.
price integer
The price of the item for this pricing model
billing_cycle string
The billing cycle of this pricing model. Available for products with type billing_plan. 
interval integer
The billing interval of this pricing model. Available for products with type billing_plan.
﻿
languages object *
The titles, subtitles, seo descriptions, seo titles and long descriptions of the product in all supported languages. The minimum information required is a title in at least one language. The object's keys are a Language Codes﻿ while the values are also objects with the content of the product.
Note: A language has to be activated on your account before it can be used.
Exampe
"languages": {
    "en": {
        "title": "Blue T-Shirt",
        "description": "Exclusive Blue T-Shirt, just 100 pieces available",
        "seo_title": "Blue T-Shirt",
        "seo_description": "Exclusive Blue T-Shirt, just 100 pieces available",
        "slug": "blue-t-shirt"
    },
    "de": {
        // German content
    },
    "sv": {
        // Swedish content
    }
}
"languages": {
    "en": {
        "title": "Blue T-Shirt",
        "description": "Exclusive Blue T-Shirt, just 100 pieces available",
        "seo_title": "Blue T-Shirt",
        "seo_description": "Exclusive Blue T-Shirt, just 100 pieces available",
        "slug": "blue-t-shirt"
    },
    "de": {
        // German content
    },
    "sv": {
        // Swedish content
    }
}
﻿
﻿
unlimited_stock boolean
The default value is true. If set to false, then the stock parameter is required.
﻿
stock integer
The available stock for this product. You can ignore this parameter if unlimited_stock is set to true.
﻿
retries integer
The number of retries that are allowed when the customer fails to pay for their billing plan.
﻿
charge_shipping_during_trial boolean
Determines if the shipping cost will be charged during the trial period of a physical subscription. Available for billing plans with classification set to Physical Subscription.
﻿
cancel_action string
Determines what action is taken when all available retries for a recurring payment have failed. The possible values are pause and cancel. 
﻿
cancel_behaviour string
Determines how cancellations are handled. The possible values are immediate and end_of_period. 
﻿
descriptor string
The statement descriptor of the billing plan. The maximum number of characters is 20.
﻿
trial_period integer
The trial period of the billing plan in days. The default value is 0.
﻿
stock_limit_warning integer
If the product stock falls below this value, an email notification will be sent to you. Will be ignored if unlimited_stock is set to true.
﻿
max_units integer
The maximum amount of stock that can be purchased in a single order.
﻿
min_units integer
The minimum amount of stock that can be purchased in a single order.
﻿
buyable boolean
This attribute shows if the product is available for sale.
﻿
on_sale boolean
This attribute shows if there is a specific sale or promotion active currently active.
﻿
discount_allowed boolean
Determines if the product can have any discounts applied to it. The default value is true.
﻿
reviews_allowed boolean
This attribute shows if customers can leave reviews for this item. The default value is false.
﻿
shown boolean
Determines if the product is currently visible in external assets. The default value is true.
﻿
exclude_from_feed boolean
Determines if the product will be included in third-party feeds and product search engines.
﻿
new_from date-format﻿
The date the product was launched for sale as a brand new item.
﻿
new_to date-format﻿
After this date, the product will not be considered a brand-new item. 
﻿
expiry_date date-format﻿
After this date, the product will not be available for sale.
﻿
release_date date-format﻿
The date that the product will be released for sale.
﻿
gallery array of strings
Each string in the array must be an Asset Object﻿ id.
﻿
related_products array of strings
An array of product IDs, each representing a related product.
﻿
whitelist array of strings
An array of ISO country codes. Only customers from these countries can purchase this product. 
﻿
custom_attributes array of objects
An array of objects each corresponding to a custom attribute configured on the product. 
JSON
"custom_attributes": [
  {
    "language": "en",
    "name": "Attribute name",
    "value": "Attribute value"
  }
]
"custom_attributes": [
  {
    "language": "en",
    "name": "Attribute name",
    "value": "Attribute value"
  }
]
﻿
language string
The language of the custom attribute.
name string
This name of the custom attribute.
value string
The value of the custom attribute.
﻿
custom_fields array of objects
An array of objects each corresponding to a custom field configured on the product. 
JSON
"custom_fields": [
  {
    "language": "en",
    "name": "Field name",
    "type": "checkboxes",
    "values": [
        "value1",
        "value2"
    ]
  },
  {
    "language": "en",
    "name": "Name",
    "range_from": 1709762400,
    "range_to": 1711749600,
    "type": "date-picker"
  }
]
"custom_fields": [
  {
    "language": "en",
    "name": "Field name",
    "type": "checkboxes",
    "values": [
        "value1",
        "value2"
    ]
  },
  {
    "language": "en",
    "name": "Name",
    "range_from": 1709762400,
    "range_to": 1711749600,
    "type": "date-picker"
  }
]
﻿
language string
The language of the custom field.
name string
This name of the custom field.
type string
This type of the custom field. The possible values are size, checkboxes, textfield, textarea, date-picker.
values array of strings
An array of strings, each represtive a value for the custom field. Available for custom fields with type "checkboxes".
range_from timestamp
The starting range for the custom fields. Available for custom fields with type "range_from".
range_to string
The starting range for the custom fields. Available for custom fields with type "range_to".
/
/v2/products/create/billing-plan
View
﻿
﻿
Create Digital Product
Retrieve Product