Billing Plan Object

Core Attributes
id string
A unique identifier for the product.
﻿
object string
The value is always product.
﻿
name string
The default product name.
﻿
classification string
The value is always Agency Billing Plan
﻿
created string
The date the product was created, formatted as YYYY-MM-DD HH:mm:ss +0:00 UTC.
﻿
created_unix timestamp
The date the product was created as a Unix timestamp.
﻿
price integer
The default price of the product in cents.
﻿
currency string (Currency code)﻿
The default currency of the product.
﻿
in_stock boolean
This attribute shows if the product has any stock available.
﻿
type string
The value is always  billing_plan.
﻿
updated string
The date the product was last updated, formatted as YYYY-MM-DD HH:mm:ss +0:00 UTC.
﻿
updated_unix timestamp
The date the product was last updated as a Unix timestamp.
﻿
buyable boolean
This attribute shows if the product is available for sale.
﻿
discount_allowed boolean
This attribute shows if the product can have any discounts applied to it.
﻿
shown boolean
This attribute shows if the product is currently visible in external assets.
﻿
description string
The default description of the product.
﻿
seo_title string
The default SEO title of the product.
﻿
seo_description string
The default SEO description of the product.
﻿
long_description string
This default long description of the product.
﻿
stock integer
The available stock for this product.
﻿
client_id string
The id of the client associated with this billing plan.
﻿
tax_calculation string
This attribute shows how taxes are calculated for this product. The possible values are exclusive and inclusive. 
﻿
unlimited_stock boolean
This attribute shows if the product has unlimited stock. Applicable for products with type digital_service, digita_product or billing_plan. 
﻿
permissions object Permissions Reference﻿
An object containing the permissions of the product. Any clients joining this billing plan will receive matching permission to your Whitelabel platform.
﻿
pricing_model array of objects
An array of objects, each representing a pricing model associated with the product. 
Exampe
"pricing_model": [
    {
      "id": "7c91b131-b17b-4778-bf98-ec3d3d57da9f",
      "object": "pricing_model",
      "currency": "EUR",
      "price": 10000,
      "billing_cycle": "month",
      "interval": 1,
      "stripe_price_id": "price_1OkybgEje1Uz2UKgIARNhyMk",
      "transaction_fees_cents": 0,
      "transaction_fees": 2,
      "is_metered": true
    }
]
"pricing_model": [
    {
      "id": "7c91b131-b17b-4778-bf98-ec3d3d57da9f",
      "object": "pricing_model",
      "currency": "EUR",
      "price": 10000,
      "billing_cycle": "month",
      "interval": 1,
      "stripe_price_id": "price_1OkybgEje1Uz2UKgIARNhyMk",
      "transaction_fees_cents": 0,
      "transaction_fees": 2,
      "is_metered": true
    }
]
﻿
id string
The object's unique identifier.
object string
The value is always pricing_model
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.
stripe_price_id string
The id of the Stripe price object associated with the product. Available for products with type billing_plan.
transaction_fees decimal
The transaction fees as a percentage.
transaction_fees_cents integer
The transaction fees in cents.
﻿
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.
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
    }
}
﻿
﻿
quotas object
An object containing any custom quotas associated with the billing plan. 
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
}
﻿
﻿
Secondary Attributes
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.
﻿
in_stock boolean
This attribute shows whether the product has any stock available. 
﻿
has_image boolean
This attribute shows whether the product has any images.
﻿
is_client_product boolean
This attribute shows whether the product is associated with any clients. 
﻿
stock_limit_warning integer
If the product stock falls below this value, an email notification will be sent to you.
﻿
is_moss_product boolean legacy
This attribute shows if the product's category falls under MOSS VAT rules (EU Merchants).
﻿
retries integer
The number of retries allowed when the customer fails to pay for their billing plan.
﻿
cancel_action string
This attribute shows what action is taken when all available retries for a recurring payment have failed. The possible values are pause and cancel.
﻿
cancel_behaviour string
This attribute shows how manual cancellations are handled when initiated by the customer or the merchant. The possible values are immediate and end_of_period. 
﻿
descriptor string
The statement descriptor of the billing plan.
﻿
billing_cycle string
The billing cycle of the billing plan. The possible values are month, day, year and week.
﻿
interval integer
The billing interval of the billing plan.
﻿
trial_period integer
The trial period of the billing plan in days.
﻿
whitelist array of strings
An array of ISO country codes. Only customers from these countries can purchase this product. 
﻿
gallery array of strings
Each string in the array is a public image url of the product.
﻿
reviews object
An object containing details about the reviews for this billing plan such as the total number of reviews and the average rating. 
﻿
invoices integer
The total number of invoices associated with this billing plan.
﻿
subscriptions integer
The total number of subscriptions associated with this billing plan. 
﻿
lifetime_revenue integer
The lifetime revenue generated by this billing plan.
﻿
customers integer
The total number of customers associated with this billing plan.
﻿
custom_attributes array of objects
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"
    }
]
﻿
﻿
custom_fields array of objects
The custom_fields option is an array that contains objects each corresponding to a custom field. 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"
    }
]
﻿
﻿
additional_information object
An object containing other secondary product attributes such as expiry date and release date. 
Example
"additional_information": {
    "sample": false,
    "release_date_unix": null,
    "release_date": null,
    "expiry_date_unix": null,
    "expiry_date": null,
    "new_from_unix": null,
    "new_from": null,
    "new_to_unix": null,
    "new_to": null,
    "exclude_from_feed": false
}
"additional_information": {
    "sample": false,
    "release_date_unix": null,
    "release_date": null,
    "expiry_date_unix": null,
    "expiry_date": null,
    "new_from_unix": null,
    "new_from": null,
    "new_to_unix": null,
    "new_to": null,
    "exclude_from_feed": false
}
﻿
﻿
﻿
/
Billing Plan Object Example
View
﻿
﻿
Billing Plans
Create Billing Plan
Billing Plan Object

Core Attributes

﻿

Secondary Attributes
