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 price integer the default price of the product in cents currency string appendix docid\ kfbmx4q3dxjtduqf75yx1 the default currency of the product price in stock boolean this attribute shows if the product has any stock available pricetype type string the value is always billing plan priceupdated 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 price discount allowed boolean this attribute shows if the product can have any discounts applied to it price shown boolean this attribute shows if the product is currently visible in external assets pricedescription description string the default description of the product price seo title string the default seo title of the product price seo description string the default seo description of the product price long description string this default long description of the product price stock integer the available stock for this product client id string the id of the client associated with this billing plan price tax calculation string this attribute shows how taxes are calculated for this product the possible values are exclusive and inclusive price 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 appendix docid\ kfbmx4q3dxjtduqf75yx1 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 } ] id string the object's unique identifier object string the value is always pricing model currency string appendix docid\ kfbmx4q3dxjtduqf75yx1 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 price 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 appendix docid\ kfbmx4q3dxjtduqf75yx1 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 } } 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 } secondary attributes max units integer the maximum amount of stock that can be purchased in a single order price 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 pricestock limit warning stock limit warning integer if the product stock falls below this value, an email notification will be sent to you price is moss product boolean legacy 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 digital files 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 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" } ] 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 } { "id" "df2ebe6e 16e9 4d72 b5bf f2670f5f4953", "object" "product", "classification" "agency billing plan", "created" "2024 02 18 00 51 47 +0000", "created unix" 1708217507, "currency" "eur", "gallery" \[], "type" "billing plan", "updated" "2024 02 18 12 17 25 +0000", "updated unix" 1708258645, "on sale" true, "discount allowed" true, "reviews allowed" null, "hide if no stock" false, "shown" false, "buyable" true, "has variations" false, "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 } ], "custom attributes" \[], "custom fields" null, "related products" \[], "has image" false, "whitelist" null, "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 }, "integer id" null, "is moss product" true, "in stock" true, "stock" null, "unlimited stock" true, "min units" null, "max units" null, "stock limit warning" null, "allow negative stock" false, "seo description" null, "seo title" null, "description" null, "name" "more expensive", "billing cycle" "month", "interval" 1, "trial period" 0, "descriptor" "", "retries" 3, "cancel action" "cancel", "cancel behaviour" "end of period", "charge shipping during trial" null, "is customer product" false, "price" 10000, "languages" { "en" { "title" "more expensive", "seo title" null, "description" null, "seo description" null, "slug" null } }, "reviews" { "average rating" null, "reviews" 0 }, "invoices" 0, "subscriptions" 1, "lifetime revenue" 0, "customers" 0, "permissions" { "account" { "view" true, "edit" true, "remove" true }, "billing" { "view" true, "edit" true }, "keys" { "view" true, "edit" true, "remove" true, "create" true }, "webhooks" { "view" true, "edit" true, "remove" true, "create" true }, "logs" { "view" true }, "audit trail" { "view" true }, "revenue analytics" { "view" true }, "source analytics" { "view" true }, "visitor analytics" { "view" true }, "domains" { "edit" true, "view" true, "create" true, "remove" true }, "taxes" { "edit" true, "view" true, "create" true, "remove" true }, "teammates" { "edit" true, "view" true, "create" true, "remove" true }, "reports" { "view" true, "edit" true }, "sites" { "edit" true, "view" true, "create" true, "remove" true, "publish" true }, "pages" { "edit" true, "view" true, "create" true, "remove" true }, "affiliate programs" { "edit" true, "view" true, "create" true, "remove" true }, "affiliates" { "edit" true, "view" true, "remove" true }, "payouts" { "edit" true, "view" true, "create" true, "remove" true }, "affiliate network" { "edit" true, "view" true }, "payments" { "edit" true, "view" true, "remove" true }, "integrations" { "edit" true, "create" true, "publish" true, "view" true, "remove" true }, "invoices" { "view" true, "edit" true, "remove" true, "create" true }, "subscriptions" { "view" true, "edit" true, "remove" true }, "instalment plans" { "view" true, "edit" true, "remove" true }, "customers" { "view" true, "edit" true, "create" true, "remove" true }, "subscribers" { "view" true, "edit" true, "create" true, "remove" true }, "mailing lists" { "view" true, "edit" true, "create" true, "remove" true }, "automations" { "view" true, "edit" true, "create" true, "remove" true }, "discounts" { "view" true, "edit" true, "create" true, "remove" true }, "email templates" { "view" true, "edit" true, "create" true, "remove" true }, "reviews" { "view" true, "edit" true, "remove" true }, "assets" { "view" true, "edit" true, "create" true, "remove" true }, "products" { "view" true, "edit" true, "create" true, "remove" true }, "shippings" { "view" true, "edit" true, "create" true, "remove" true }, "warehouses" { "view" true, "edit" true, "create" true, "remove" true }, "support" { "view" true, "edit" true, "remove" true, "create" true }, "clients" { "view" true, "edit" true, "remove" true, "create" true }, "agency billing plans" { "view" true, "edit" true, "remove" true, "create" true } }, "quotas" { "storage quota" 1073741824, "datatransfer quota" 0, "domains quota" 1, "transaction quota" 0, "products quota" 10, "languages quota" 1, "currencies quota" 1, "newsletters quota" 0, "teammates quota" 0, "automations quota" 0, "api quota" 0 } }