Update Pricing Scheme

The update pricing scheme request details.

Schema Information

Type:object

Properties

billing_cycle_sequencerequired

Type: integer

Minimum: 1

Maximum: 99

The billing cycle sequence.

pricing_schemerequired

Type: object

The pricing scheme details.

version

Type: integer

Minimum: 0

Maximum: 999

The version of the pricing scheme.

fixed_price

Type: object

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.

currency_coderequired

Type: string

Min length: 3

Max length: 3

The three-character ISO-4217 currency code that identifies the currency.

valuerequired

Type: string

Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

Max length: 32

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.

pricing_model

Type: string

Enum: "VOLUME", "TIERED"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 24

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

tiers

Type: array

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

Array Items

items

Type: object

The pricing tier details.

starting_quantityrequired

Type: string

Pattern: ^([0-9]+|([0-9]+)?[.][0-9]+)$

Min length: 1

Max length: 32

The starting quantity for the tier.

ending_quantity

Type: string

Pattern: ^([0-9]+|([0-9]+)?[.][0-9]+)$

Min length: 1

Max length: 32

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

amountrequired

Type: object

The pricing amount for the tier.

currency_coderequired

Type: string

Min length: 3

Max length: 3

The three-character ISO-4217 currency code that identifies the currency.

valuerequired

Type: string

Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

Max length: 32

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.

create_time

Type: string

Format: ppaas_date_time_v3

Pattern:

^[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})$

Min length: 20

Max length: 64

The date and time when this pricing scheme was created, in Internet date and time format.

update_time

Type: string

Format: ppaas_date_time_v3

Pattern:

^[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})$

Min length: 20

Max length: 64

The date and time when this pricing scheme was last updated, in Internet date and time format.

Properties

billing_cycle_sequencerequired

Type: integer

Minimum: 1

Maximum: 99

The billing cycle sequence.

pricing_schemerequired

Type: object

The pricing scheme details.

version

Type: integer

Minimum: 0

Maximum: 999

The version of the pricing scheme.

fixed_price

Type: object

currency_coderequired

Type: string

Min length: 3

Max length: 3

The three-character ISO-4217 currency code that identifies the currency.

valuerequired

Type: string

Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

Max length: 32

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.

pricing_model

Type: string

Enum: "VOLUME", "TIERED"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 24

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

tiers

Type: array

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

Array Items

items

Type: object

The pricing tier details.

starting_quantityrequired

Type: string

Pattern: ^([0-9]+|([0-9]+)?[.][0-9]+)$

Min length: 1

Max length: 32

The starting quantity for the tier.

ending_quantity

Type: string

Pattern: ^([0-9]+|([0-9]+)?[.][0-9]+)$

Min length: 1

Max length: 32

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

amountrequired

Type: object

The pricing amount for the tier.

currency_coderequired

Type: string

Min length: 3

Max length: 3

The three-character ISO-4217 currency code that identifies the currency.

valuerequired

Type: string

Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

Max length: 32

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.

create_time

Type: string

Format: ppaas_date_time_v3

Pattern:

^[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})$

Min length: 20

Max length: 64

The date and time when this pricing scheme was created, in Internet date and time format.

update_time

Type: string

Format: ppaas_date_time_v3

Pattern:

^[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})$

Min length: 20

Max length: 64

The date and time when this pricing scheme was last updated, in Internet date and time format.

Update Pricing Scheme

Schema Information

Properties

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

Schema Information

Properties