On this page
No Headings
The billing cycle details.
objectpricing_schemeobjectThe active pricing scheme for this billing cycle. A free trial billing cycle does not require a pricing scheme.
versionintegerThe version of the pricing scheme.
fixed_priceobjectThe fixed amount to charge for the subscription. The changes to fixed amount are applicable to both existing and future subscriptions. For existing subscriptions, payments within 10 days of price change are not affected.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.pricing_modelstring"VOLUME", "TIERED"^[A-Z_]+$The pricing model for tiered plan. The tiers parameter is required.
tiersarrayAn array of pricing tiers which are used for billing volume/tiered plans. pricing_model field has to be specified.
itemsobjectThe pricing tier details.
starting_quantityrequiredstring^([0-9]+|([0-9]+)?[.][0-9]+)$The starting quantity for the tier.
ending_quantitystring^([0-9]+|([0-9]+)?[.][0-9]+)$The ending quantity for the tier. Optional for the last tier.
amountrequiredobjectThe pricing amount for the tier.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.create_timestringppaas_date_time_v3^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time when this pricing scheme was created, in Internet date and time format.
update_timestringppaas_date_time_v3^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time when this pricing scheme was last updated, in Internet date and time format.
frequencyrequiredobjectThe frequency details for this billing cycle.
interval_unitrequiredstring"DAY", "WEEK", "MONTH", "YEAR"^[A-Z_]+$The interval at which the subscription is charged or billed.
interval_countinteger1The number of intervals after which a subscriber is billed. For example, if the interval_unit is DAY with an interval_count of 2, the subscription is billed once every two days. The following table lists the maximum allowed values for the interval_count for each interval_unit:
Interval unit | Maximum interval count |
|---|---|
DAY | 365 |
WEEK | 52 |
MONTH | 12 |
YEAR | 1 |
tenure_typerequiredstring"REGULAR", "TRIAL"^[A-Z_]+$The tenure type of the billing cycle. In case of a plan having trial cycle, only 2 trial cycles are allowed per plan.
sequencerequiredintegerThe order in which this cycle is to run among other billing cycles. For example, a trial billing cycle has a sequence of 1 while a regular billing cycle has a sequence of 2, so that trial cycle runs before the regular cycle.
total_cyclesinteger1The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between 1 and 999 for total_cycles). Regular billing cycles can be executed infinite times (value of 0 for total_cycles) or a finite number of times (value between 1 and 999 for total_cycles).