On this page
No Headings
amountobjectvaluerequirednumberdecimal0The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
currency_coderequiredstring^[A-Z]{3}$Currency code in ISO 4217 format.
descriptionstringThe description on the plan
invoice_display_namestringSpecifies the name that will appear on the invoice
namestringThe name of the plan
chargesarrayitemsobjectidrequiredstringUnique identifier of the charge
tax_codesarrayList of unique codes used to identify taxes to be applied.
itemsstringpropertiesobjectPricing thresholds that determine the charges
min_amountobjectvaluerequirednumberdecimal0The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
minimum_commitmentobjectMinimum commitment for this plan.
amountrequiredobjectvaluerequirednumberdecimal0The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
invoice_display_namestringSpecifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.
tax_codesarrayList of unique codes used to identify taxes to be applied.
itemsstringchargeUsagearrayitemsobjectidstringRefers to the charge usage threshold unique identifier
recurringstringIndicates if recurring invoices will be created
threshold_display_namestringIndicates the name for the usage threshold
created_atstringdate-timeDate and time in ISO 8601 format.
updated_atstringdate-timeDate and time in ISO 8601 format.
amountobjectvaluerequirednumberdecimal0The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
tax_codesarrayList of unique codes used to identify taxes to be applied.
itemsstringtrial_periodintegerThe number of days the plan's base cost is provided at no charge