On this page
No Headings
The payment preferences for a subscription.
objectauto_bill_outstandingbooleantrueIndicates whether to automatically bill the outstanding amount in the next billing cycle.
setup_feeobjectThe initial set-up fee for the service.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.setup_fee_failure_actionstring"CONTINUE", "CANCEL"^[A-Z_]+$"CANCEL"The action to take on the subscription if the initial payment for the setup fails.
payment_failure_thresholdinteger0The maximum number of payment failures before a subscription is suspended. For example, if payment_failure_threshold is 2, the subscription automatically updates to the SUSPEND state if two consecutive payments fail.