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

Update Pricing Scheme Request

The update pricing scheme request details.

pricing_schemesobject<update_pricing_scheme_request>[]Required

An array of pricing schemes.

Items1 <= length <= 99

update_pricing_scheme_request properties

2 properties

billing_cycle_sequenceintegerRequired

The billing cycle sequence.

Range1 <= value <= 99

pricing_schemeobject<pricing_scheme>Required

The pricing scheme details.

pricing_scheme properties

6 properties

versionintegerOptional

The version of the pricing scheme.

Range0 <= value <= 999

fixed_priceobject<money>Optional

The fixed amount to charge for the subscription. The changes to fixed amount are applicable to both existing and future subscriptions. For existing subscriptions, payments within 10 days of price change are not affected.

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

pricing_modelenumOptional

The pricing model for tiered plan. The `tiers` parameter is required.

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

Allowed values

"VOLUME"
"TIERED"

tiersobject<pricing_tier>[]Optional

An array of pricing tiers which are used for billing volume/tiered plans. pricing_model field has to be specified.

Items1 <= length <= 32

pricing_tier properties

3 properties

starting_quantitystringRequired

The starting quantity for the tier.

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

ending_quantitystringOptional

The ending quantity for the tier. Optional for the last tier.

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

amountobject<money>Required

The pricing amount for the tier.

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

create_timestring<date_time>Optional

The date and time when this pricing scheme was created, in [Internet date and time format](https://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

update_timestring<date_time>Optional

The date and time when this pricing scheme was last updated, in [Internet date and time format](https://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

Back to top

Update Pricing Scheme Request

The update pricing scheme request details.

pricing_schemesobject<update_pricing_scheme_request>[]Required

An array of pricing schemes.

Items1 <= length <= 99

update_pricing_scheme_request properties

2 properties

billing_cycle_sequenceintegerRequired

The billing cycle sequence.

Range1 <= value <= 99

pricing_schemeobject<pricing_scheme>Required

The pricing scheme details.

pricing_scheme properties

6 properties

versionintegerOptional

The version of the pricing scheme.

Range0 <= value <= 999

fixed_priceobject<money>Optional

The fixed amount to charge for the subscription. The changes to fixed amount are applicable to both existing and future subscriptions. For existing subscriptions, payments within 10 days of price change are not affected.

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

pricing_modelenumOptional

The pricing model for tiered plan. The `tiers` parameter is required.

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

Allowed values

"VOLUME"
"TIERED"

tiersobject<pricing_tier>[]Optional

An array of pricing tiers which are used for billing volume/tiered plans. pricing_model field has to be specified.

Items1 <= length <= 32

pricing_tier properties

3 properties

starting_quantitystringRequired

The starting quantity for the tier.

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

ending_quantitystringOptional

The ending quantity for the tier. Optional for the last tier.

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

amountobject<money>Required

The pricing amount for the tier.

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

create_timestring<date_time>Optional

The date and time when this pricing scheme was created, in [Internet date and time format](https://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

update_timestring<date_time>Optional

The date and time when this pricing scheme was last updated, in [Internet date and time format](https://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

Update Pricing Scheme Request

update_pricing_scheme_request properties

pricing_scheme properties

money properties

pricing_tier properties

money properties

Back to top

On this page

On this page

Update Pricing Scheme Request

update_pricing_scheme_request properties

pricing_scheme properties

money properties

pricing_tier properties

money properties

Back to top

On this page

Update Pricing Scheme Request

update_pricing_scheme_request properties

pricing_scheme properties

money properties

pricing_tier properties

money 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

Update Pricing Scheme Request

update_pricing_scheme_request properties

pricing_scheme properties

money properties

pricing_tier properties

money properties

Back to top

On this page