On this page
No Headings
The plan that can be used to create an agreement.
objectidstringThe PayPal-generated ID for the resource.
namerequiredstringThe plan name.
descriptionrequiredstringThe plan description.
typerequiredstring"FIXED", "INFINITE"The plan type.
statestring"CREATED", "ACTIVE", "INACTIVE", "DELETED"The status of the plan.
create_timestringThe date and time when the plan was created, in Internet date and time format.
update_timestringThe date and time when this plan was updated, in Internet date and time format.
payment_definitionsarrayAn array of payment definitions for this plan.
itemsobjectThe payment definition, which defines a regular or trial payment.
The payment definition, which defines a regular or trial payment.
Note: You can specify thefrequencyvalue in any case. For example, you can specify the frequency of the payment asWEEK,Week, orweek.
idstringThe 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.
termsarrayAn array of terms for this plan.
itemsobjectThe plan terms.
idstringThe PayPal-generated ID for the resource.
typerequiredstringThe term type.
occurrencesrequiredstringThe number of times that money can be pulled during this term.
buyer_editablerequiredstringIndicates whether the customer can edit the amount in this term.
max_billing_amountrequiredobjectThe currency and amount for a transaction.
The currency and amount of the maximum billing amount associated with this term.
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.
amount_rangerequiredobjectThe currency and amount for a transaction.
The amount range for this term.
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.
merchant_preferencesobjectThe merchant preferences that override the default information in the plan. If you omit this parameter, the agreement uses the default merchant preferences from the plan. The merchant preferences include how much it costs to set up the agreement, the URLs where the customer can approve or cancel the agreement, the maximum number of allowed failed payment attempts, whether PayPal automatically bills the outstanding balance in the next billing cycle, and the action if the customer's initial payment fails.
idstringThe PayPal-generated ID for the resource.
cancel_urlrequiredstringuriThe URL to which the customer is redirected if they cancel the agreement.
return_urlrequiredstringuriThe URL to which the customer is redirected if they accept the agreement.
max_fail_attemptsstringThe maximum number of allowed failed payment attempts. Default is 0, which allows infinite failed payment attempts.
auto_bill_amountstring"YES", "NO"Indicates whether PayPal automatically bills the outstanding balance in the next billing cycle. The outstanding balance is the total amount of any previously failed scheduled payments. Value is:
NO. PayPal does not automatically bill the customer the outstanding balance. Default is NO.YES. PayPal automatically bills the customer the outstanding balance.initial_fail_amount_actionstring"CONTINUE", "CANCEL""CONTINUE"The action if the customer's initial payment fails. Value is:
CONTINUE. The agreement remains active and the failed payment amount is added to the outstanding balance. If auto-billing is enabled, PayPal automatically bills the outstanding balance in the next billing cycle.CANCEL. PayPal creates the agreement but sets its state to pending until the initial payment clears. When the initial payment clears, the pending agreement becomes active. If the initial payment fails, the pending agreement is cancelled.Note: Initial payment failures will not increment the max_fail_attempt counter as initial payments are not considered regularly recurring payments.accepted_payment_typestringThe payment types that are accepted for this agreement. Read-only and reserved for future use.
char_setstringThe character set for this agreement. Read-only and reserved for future use.
setup_feeobjectThe currency and amount for a transaction.
The currency and amount of the fee to set up the agreement. Default is 0.
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.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstringThe complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.
relrequiredstringThe link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"The HTTP method required to make the related call.
currency_codeobjectppaas_common_currency_code_v2The currency code for the plan.
The three-character ISO-4217 currency code that identifies the currency.