Create Billing Plan

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

Permissions: agency_billing_plans.create
Webhook event: product-created﻿ 
Body Parameters
pricing_model array of objects *
The pricing configuration of the Billing Plan in all supported currencies.
Exampe
"pricing_model": [
    {
      "currency": "EUR",
      "price": 1000,
      "billing_cycle": "month",
      "interval": 3,
      "transaction_fees": 3.5,
      "transaction_fees_cents": 0
    }
]
"pricing_model": [
    {
      "currency": "EUR",
      "price": 1000,
      "billing_cycle": "month",
      "interval": 3,
      "transaction_fees": 3.5,
      "transaction_fees_cents": 0
    }
]
﻿
currency string (currency code)﻿﻿
price integer
interval integer
transaction_fees decimal
The percentage to charge as a fee on every client's transaction. The default value is 0.
transaction_fees_cents integer
The number of cents to charge as a fee on every client's transaction. The default value is 0.
billing_cycle - string
The billing cycle of this pricing model.  The available values are day, month, week and year.
﻿
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 keys of the object are a Language code﻿ 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": "My super awesome blue t-shirt",
        "seo_description": "Exclusive Blue T-Shirt, just 100 pieces available",
        "slug": "blue-shirt"
    },
    "de": {
        // German content
    },
    "sv": {
        // Swedish content
    }
}
"languages": {
    "en": {
        "title": "Blue T-Shirt",
        "description": "Exclusive Blue T-Shirt, just 100 pieces available",
        "seo_title": "My super awesome blue t-shirt",
        "seo_description": "Exclusive Blue T-Shirt, just 100 pieces available",
        "slug": "blue-shirt"
    },
    "de": {
        // German content
    },
    "sv": {
        // Swedish content
    }
}
﻿
﻿
permissions object Permissions Reference﻿
An object containing the permissions of the product. Any clients that join this billing plan will receive matching permission to your Whitelabel platform.
﻿
trial_period integer
The trial period of the billing plan in days. The default value is 0.
﻿
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.
﻿
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 cancelations 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.
﻿
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
Determines if the product is available for sale and can be purchased via external sites and Tamio checkout flows. The default value is true.
﻿
discount_allowed boolean
Determines if the product can have any discounts applied to it. The default value is true.
﻿
shown boolean
Determines if the product is currently visible in external assets. The default value is true.
﻿
client_id string
A client ID for assigning the billing plan. Once specified, only the designated client can purchase this billing plan. 
﻿
exclude_from_feed boolean
Determines if the product will be included in third-party feeds and product search engines.
﻿
new_from date-from﻿
The date the product was launched for sale as a brand new item.
﻿
new_to date-from﻿
After this date, the product will not be considered a brand-new item. 
﻿
expiry_date date-from﻿
After this date, the product will not be available for sale.
﻿
release_date date-from﻿
The date that the product will be released for sale.
﻿
gallery array of strings
Each string in the array must be an Asset id.
﻿
quotas object
An object containing any custom quotas associated with the billing plan. When users purchase this plan, their quotas will be updated according to these values. 
Example
"quotas": {
   "automations_quota" : 100,
   "transaction_quota" : 100,
   "datatransfer_quota" : 100,
   "storage_quota" : 3,
   "languages_quota" : 1,
   "products_quota" : 100,
   "domains_quota" : 100,
   "currencies_quota" : 2,
   "teammates_quota" : 100,
   "api_quota" : 100,
   "newsletters_quota" : 100
}
"quotas": {
   "automations_quota" : 100,
   "transaction_quota" : 100,
   "datatransfer_quota" : 100,
   "storage_quota" : 3,
   "languages_quota" : 1,
   "products_quota" : 100,
   "domains_quota" : 100,
   "currencies_quota" : 2,
   "teammates_quota" : 100,
   "api_quota" : 100,
   "newsletters_quota" : 100
}
﻿
﻿
custom_attributes array of objects
You can create custom attributes for a product and save them for later use. They can be incorporated into your custom flows when retrieving a product or via webhooks. You can also use them to trigger actions such as registering information in a CRM or an ERP system. 
The custom_attributes option is an array that contains objects each corresponding to a custom attribute. 
Example
"custom_attributes": [
    {
        "language": "en",
        "name": "Name",
        "value": "Some value"
    }
]
"custom_attributes": [
    {
        "language": "en",
        "name": "Name",
        "value": "Some value"
    }
]
﻿
language string
name string
value string
﻿
custom_fields array of objects
You can create custom fields for a product and save them for later use. They are used on Tamio sites for filtering results and on custom flows. The custom_fields option is an array that contains objects each corresponding to a custom attribute. The possible configurations can be seen below.
Example
"custom_fields": [
    {
        "language": "en",
        "name": "Name",
        "values": ["Some value"],
        "type": "checkboxes"
    },
    {
        "language": "en",
        "name": "Name",
        "values": ["Some value"],
        "type": "date-picker",
        "range_from": "2024-03-06",
        "range_to": "2024-03-31"
    },
    {
        "language": "en",
        "name": "Name",
        "type": "size"
    }
]
"custom_fields": [
    {
        "language": "en",
        "name": "Name",
        "values": ["Some value"],
        "type": "checkboxes"
    },
    {
        "language": "en",
        "name": "Name",
        "values": ["Some value"],
        "type": "date-picker",
        "range_from": "2024-03-06",
        "range_to": "2024-03-31"
    },
    {
        "language": "en",
        "name": "Name",
        "type": "size"
    }
]
﻿
language string
name string
values array of strings
Available for custom fields with type checkboxes.
range_from date-format﻿
Available for custom fields with type date-picker.
range_to date-format﻿
Available for custom fields with type date-picker.
type string
The possible values are size, checkboxes, textfield, textarea and date-picker. Controlls how the they will be displayed on Tamio sites.
﻿
﻿
/
/v2/whitelabel/plans/create
View
﻿
﻿
Billing Plan Object
Retrieve Billing Plan