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

PlanOverridesRequest

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

descriptionstringOptional

The description on the plan

invoice_display_namestringOptional

Specifies the name that will appear on the invoice

namestringOptional

The name of the plan

chargesobject<SubscriptionUsageBasedCharge>[]Optional

SubscriptionUsageBasedCharge properties

4 properties

idstringRequired

Unique identifier of the charge

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

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.

chargeUsageobject<ChargeUsageThresholdRequest>[]Optional

ChargeUsageThresholdRequest properties

6 properties

idstringOptional

Refers to the charge usage threshold unique identifier

recurringstringOptional

Indicates if recurring invoices will be created

threshold_display_namestringOptional

Indicates the name for the usage threshold

created_atstring<DateTimeWithZone>Optional

Date and time in ISO 8601 format.

Formatdate-time

updated_atstring<DateTimeWithZone>Optional

Date and time in ISO 8601 format.

Formatdate-time

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

tax_codesarray<string>Optional

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

trial_periodintegerOptional

The number of days the plan's base cost is provided at no charge

Back to top

On this page

No Headings