On this page
No Headings
The merchant preferences for a plan, which define 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.
objectcancel_urlrequiredstringuriThe URL where the customer can cancel the agreement.
return_urlrequiredstringuriThe URL where the customer can approve the agreement.
notify_urlstringuriThe URL where the customer is notified that the agreement was created. Read-only and reserved for future use.
max_fail_attemptsstring"0"The maximum number of allowed failed payment attempts. The default value, which is 0, defines infinite failed payment attempts.
auto_bill_amountstring"YES", "NO""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.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. If the initial payment clears, the pending agreement becomes active. If the initial payment fails, the pending agreement is canceled.Note: You can use thesetup_feevalue as the initial amount to trigger theinitial_fail_amount_action.
accepted_payment_typestringThe payment types that are accepted for this plan. Read-only and reserved for future use.
char_setstringThe character set for this plan. Read-only and reserved for future use.
setup_feeobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The currency and amount of the set-up fee for the agreement. This fee is the initial, non-recurring payment amount that is due immediately when the billing agreement is created. Can be used as the initial amount to trigger the initial_fail_amount_action. The default for the amount is 0.
valuerequiredstringThe value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.