On this page
No Headings
The payment definition, which defines a regular or trial payment.
objectidstringThe PayPal-generated ID for the resource.
namerequiredstringThe payment definition name.
typerequiredstring"TRIAL", "REGULAR"The payment definition type.
frequency_intervalrequiredstringThe interval at which the customer is charged. Value cannot be greater than 12 months.
frequencyrequiredstringThe frequency of the payment in this definition.
Note: You can specify thefrequencyvalue in any case. For example, you can specify the frequency of the payment asWEEK,Week, orweek.
cyclesrequiredstringThe number of payment cycles in this definition. For infinite plans with a regular payment definition, set cycles to 0.
charge_modelsarrayAn array of shipping fee and tax information for this definition.
itemsobjectThe charge model for a payment definition. A charge model defines shipping fee and tax information.
idstringThe PayPal-generated ID for the resource.
typerequiredstring"TAX", "SHIPPING"The charge model type.
amountrequiredobjectThe currency and amount for a transaction.
The currency and amount for this charge model.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The currency value. Might be an integer for currencies like JPY that are not typically fractional or a three-place decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency codes - ISO 4217.
currencyrequiredobjectppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
amountrequiredobjectThe currency and amount for a transaction.
The currency and amount to charge at the end of each payment cycle for this definition.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The currency value. Might be an integer for currencies like JPY that are not typically fractional or a three-place decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency codes - ISO 4217.
currencyrequiredobjectppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.