On this page
No Headings
A payment definition, which determines how often and for how long the customer is charged. Includes the interval at which the customer is charged, the charge amount, and optional shipping fees and taxes.
objectidstringThe ID of the payment definition.
namerequiredstringThe payment definition name.
typerequiredstring"TRIAL", "REGULAR"The payment definition type. Each plan must have at least one regular payment definition and, optionally, a trial payment definition. Each definition specifies how often and for how long the customer is charged.
frequency_intervalrequiredstringThe interval at which the customer is charged. Value cannot be greater than 12 months.
frequencyrequiredstring"WEEK", "DAY", "YEAR", "MONTH"The frequency of the payment in this definition.
cyclesrequiredstringThe number of payment cycles. For infinite plans with a regular payment definition, set cycles to 0.
charge_modelsarrayAn array of shipping fees and taxes.
itemsobjectThe shipping fee and tax information.
idstringThe ID of the charge model.
typerequiredstring"TAX", "SHIPPING"The charge model type, which is tax or shipping.
amountrequiredobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The currency and amount of the shipping fee or tax.
valuerequiredstringThe value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.amountrequiredobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The currency and amount of the charge to make at the end of each payment cycle for this definition.
valuerequiredstringThe value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.