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

On this page

Resources

GitHub repo

Postman repo

PayPal.com

llms.txt

Where to find us

Developer blog

Community

Help Center

Sign up for updates

Where to hear from us

X

YouTube

LinkedIn

Discord

Legal

Privacy Policy

Terms of Service

Developer Agreement

© 2026 PayPal. All rights reserved.

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

PlanUpdateRequest

namestringOptional

codestringOptional

billing_cycleenum<BillingCycle>Optional

The billing cycle indicating how often the subscription is charged

Value in"WEEKLY" | "MONTHLY" | "QUARTERLY" | "YEARLY"

descriptionstringOptional

amountobject<Amount>Optional

Amount properties

2 properties

valuenumberRequired

The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).

Default0FormatdecimalRange0 <= value <= ∞

currency_codestring<Currency>Required

Currency code in ISO 4217 format.

Match^[A-Z]{3}$Length3 <= length <= 3

trial_periodintegerOptional

pay_in_advancebooleanOptional

tax_codesarray<string>Optional

List of unique codes used to identify taxes to be applied.

minimum_commitmentobject<MinimumCommitmentRequest>Optional

Minimum commitment for this plan.

MinimumCommitmentRequest properties

3 properties

amountobject<AmountNoCurrency>Required

AmountNoCurrency properties

1 property

valuenumberRequired

The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).

Default0FormatdecimalRange0 <= value <= ∞

invoice_display_namestringOptional

Specifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.

tax_codesarray<string>Optional

List of unique codes used to identify taxes to be applied.

cascading_updatesbooleanOptional

Determines if changes made to the parent plan should be cascaded to the overridden plans in subscription

usage_based_chargesobject<UsageBasedChargeUpdateRequest>[]Optional

UsageBasedChargeUpdateRequest properties

6 properties

idstringRequired

Unique identifier of the charge

metric_idstringRequired

Unique identifier of the metric

charge_modelenum<ChargeModel>Optional

Defines the pricing model to calculate the charge

Default"STANDARD"Value in"STANDARD" | "GRADUATED" | "PACKAGE" | "PERCENTAGE" | "VOLUME"

tax_codesarray<string>Optional

List of unique codes used to identify taxes to be applied.

propertiesobjectOptional

Pricing thresholds that determine the charges

min_amountobject<AmountNoCurrency>Optional

AmountNoCurrency properties

1 property

valuenumberRequired

The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).

Default0FormatdecimalRange0 <= value <= ∞

Back to top

On this page

No Headings