On this page
No Headings
idstringUnique identifier of the plan. This ID is used internally to track the plan and cannot be modified.
namestringcodestringbilling_cyclestring"WEEKLY", "MONTHLY", "QUARTERLY", "YEARLY"The billing cycle indicating how often the subscription is charged
descriptionstringamountobjecttrial_periodintegerpay_in_advancebooleantaxesarrayList of tax entities configured for the plan.
itemsobjectRepresents a customizable tax rate that can be applied to invoices and fees
namerequiredstringName of the tax
ratestring^(?!0+(?:\.0+)?$)(?:0?\.\d{1,2}|[1-9]\d?(?:\.\d{1,2})?|100(?:\.0{1,2})?)$The percentage rate of the tax applied to transactions. A decimal amount from 0.01 to 100.00 inclusive, always with exactly two decimal places, no leading zeros except 0.xx.
descriptionstringDetailed description of the tax for internal reference
codestring^[a-zA-Z0-9_-]*$Unique code used to identify the tax. Must contain only alphanumeric characters, underscores, and hyphens.
idstringuuidUnique identifier of the tax
created_atobjectdate-timeDate and time in ISO 8601 format.
The effective start date of the subscription; can be past, current, or future. Date must be provided in ISO 8601 format
usage_based_chargesarrayitemsobjectidrequiredstringUnique identifier of the charge
metric_idrequiredstringUnique identifier of the metric
charge_modelstring"STANDARD", "GRADUATED", "PACKAGE", "PERCENTAGE", "VOLUME""STANDARD"Defines the pricing model to calculate the charge
propertiesobjectPricing thresholds that determine the charges
taxesarrayList of tax entities configured for the usage based charge.
itemsobjectRepresents a customizable tax rate that can be applied to invoices and fees
namerequiredstringName of the tax
ratestring^(?!0+(?:\.0+)?$)(?:0?\.\d{1,2}|[1-9]\d?(?:\.\d{1,2})?|100(?:\.0{1,2})?)$The percentage rate of the tax applied to transactions. A decimal amount from 0.01 to 100.00 inclusive, always with exactly two decimal places, no leading zeros except 0.xx.
descriptionstringDetailed description of the tax for internal reference
codestring^[a-zA-Z0-9_-]*$Unique code used to identify the tax. Must contain only alphanumeric characters, underscores, and hyphens.
idstringuuidUnique identifier of the tax
created_atobjectdate-timeDate and time in ISO 8601 format.
The effective start date of the subscription; can be past, current, or future. Date must be provided in ISO 8601 format
min_amountobjectminimum_commitmentobjectcreated_atobjectdate-timeDate and time in ISO 8601 format.
cascading_updatesbooleanDetermines if changes made to the parent plan should be cascaded to the children plans
updated_atobjectdate-timeDate and time in ISO 8601 format.