On this page
No Headings
namestringcodestringbilling_cyclestring"WEEKLY", "MONTHLY", "QUARTERLY", "YEARLY"The billing cycle indicating how often the subscription is charged
descriptionstringamountobjecttrial_periodintegerpay_in_advancebooleantax_codesarrayList of unique codes used to identify taxes to be applied.
itemsstringminimum_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.
itemsstringusage_based_chargesarrayitemsobjectmetric_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
tax_codesarrayList of unique codes used to identify taxes to be applied.
itemsstringmin_amountobjectvaluerequirednumberdecimal0The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).