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

Canceled Recurring Billing

The recurring billing canceled details.

expected_refundobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

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.

Formatppaas_common_currency_code_v2Length3 <= 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

cancellation_detailsobject<cancellation_details>Optional

The cancellation details.

cancellation_details properties

4 properties

cancellation_datestring<date_time>Optional

The date and time of the cancellation, in [Internet date and time format](http://tools.ietf.org/html/rfc3339#section-5.6).

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Formatppaas_date_time_v3Length20 <= length <= 64

cancellation_numberstringOptional

The cancellation number.

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

cancelledbooleanOptional

Indicates whether the dispute was canceled.

cancellation_modeenumOptional

Indicates the mode used for order cancellation.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"CANCELLED_PAYPAL_BILLING_AGREEMENT"
"WEBSITE"
"PHONE"
"EMAIL"
"WRITTEN"
"IN_PERSON"

Back to top

Canceled Recurring Billing

The recurring billing canceled details.

expected_refundobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

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.

Formatppaas_common_currency_code_v2Length3 <= 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

cancellation_detailsobject<cancellation_details>Optional

The cancellation details.

cancellation_details properties

4 properties

cancellation_datestring<date_time>Optional

The date and time of the cancellation, in [Internet date and time format](http://tools.ietf.org/html/rfc3339#section-5.6).

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Formatppaas_date_time_v3Length20 <= length <= 64

cancellation_numberstringOptional

The cancellation number.

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

cancelledbooleanOptional

Indicates whether the dispute was canceled.

cancellation_modeenumOptional

Indicates the mode used for order cancellation.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"CANCELLED_PAYPAL_BILLING_AGREEMENT"
"WEBSITE"
"PHONE"
"EMAIL"
"WRITTEN"
"IN_PERSON"

Canceled Recurring Billing

money properties

cancellation_details properties

Back to top

On this page

On this page

Canceled Recurring Billing

money properties

cancellation_details properties

Back to top

On this page

Canceled Recurring Billing

money properties

cancellation_details properties

Back to top

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Canceled Recurring Billing

money properties

cancellation_details properties

Back to top

On this page