Business Platforms and marketplacesPlatforms Enterprise

Business Platforms and marketplaces Enterprise

Sections

Business Platforms and marketplaces Enterprise

Help

FAQs Account help Technical support API Status

APIs & SDKs

JavaScript SDK React SDK REST API Server SDKs Codes Webhook events iOS Android

Charge Amount from Subscriber

The charge amount from the subscriber.

notestringRequired

The reason or note for the subscription charge.

Match^.*$Length1 <= length <= 128

capture_typeenumRequired

The type of capture.

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

Allowed values

"OUTSTANDING_BALANCE"

amountobject<money>Required

The amount of the outstanding balance. This value cannot be greater than the current outstanding balance amount.

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

Back to top

Charge Amount from Subscriber

The charge amount from the subscriber.

notestringRequired

The reason or note for the subscription charge.

Match^.*$Length1 <= length <= 128

capture_typeenumRequired

The type of capture.

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

Allowed values

"OUTSTANDING_BALANCE"

amountobject<money>Required

The amount of the outstanding balance. This value cannot be greater than the current outstanding balance amount.

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

Charge Amount from Subscriber

money properties

Back to top

On this page

On this page

Charge Amount from Subscriber

money properties

Back to top

On this page

Charge Amount from Subscriber

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.

Charge Amount from Subscriber

money properties

Back to top

On this page