On this page
No Headings
The 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.
objectidstringThe 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.