Payment Preferences Override

The payment preferences to override at subscription level.

auto_bill_outstandingbooleanOptional

Indicates whether to automatically bill the outstanding amount in the next billing cycle.

setup_feeobject<money>Optional

The initial set-up fee for the service.

money properties

2 properties

currency_codestring<currency_code>Required

The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A 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](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

setup_fee_failure_actionenumOptional

The action to take on the subscription if the initial payment for the setup fails.

Match^[A-Z_]+$Length1 <= length <= 24

Allowed values

"CONTINUE"
"CANCEL"

payment_failure_thresholdintegerOptional

The 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.

Range0 <= value <= 999

The payment preferences to override at subscription level.

auto_bill_outstandingbooleanOptional

Indicates whether to automatically bill the outstanding amount in the next billing cycle.

setup_feeobject<money>Optional

The initial set-up fee for the service.

money properties

2 properties

currency_codestring<currency_code>Required

The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A 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](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

setup_fee_failure_actionenumOptional

The action to take on the subscription if the initial payment for the setup fails.

Match^[A-Z_]+$Length1 <= length <= 24

Allowed values

"CONTINUE"
"CANCEL"

payment_failure_thresholdintegerOptional

Range0 <= value <= 999

Payment Preferences Override

money properties

Back to top

On this page

On this page

Payment Preferences Override

money properties

Back to top

On this page

Payment Preferences Override

money properties

Back to top

On this page

On this page

We currently use cookies to improve and customize your experience on our site. If you accept, we’ll also use marketing cookies to show you personalized ads. Manage your cookies and learn more.

Payment Preferences Override

money properties

Back to top

On this page