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

PlanOverridesResponse

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<UsageBasedCharge>[]Optional

UsageBasedCharge 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"

propertiesobjectOptional

Pricing thresholds that determine the charges

taxesobject<TaxResponse>[]Optional

List of tax entities configured for the usage based charge.

TaxResponse properties

6 properties

namestringRequired

Name of the tax

ratestringOptional

The percentage rate of the tax applied to transactions. A decimal amount from 0.01 to 100.00 inclusive, always with exactly two decimal places, no leading zeros except 0.xx.

Match^(?!0+(?:\.0+)?$)(?:0?\.\d{1,2}|[1-9]\d?(?:\.\d{1,2})?|100(?:\.0{1,2})?)$

descriptionstringOptional

Detailed description of the tax for internal reference

codestring<TaxCode>Optional

Unique code used to identify the tax. Must contain only alphanumeric characters, underscores, and hyphens.

Match^[a-zA-Z0-9_-]*$

idstringOptional

Unique identifier of the tax

Formatuuid

created_atstring<DateTimeWithZone>Optional

Date and time in ISO 8601 format.

Formatdate-time

min_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

minimum_commitmentobject<MinimumCommitment>Optional

Minimum commitment for this plan.

MinimumCommitment properties

7 properties

amountobject<Amount>Required

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

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.

taxesobject<TaxResponse>[]Optional

List of tax entities configured for the minimum commitment.

TaxResponse properties

6 properties

namestringRequired

Name of the tax

ratestringOptional

The percentage rate of the tax applied to transactions. A decimal amount from 0.01 to 100.00 inclusive, always with exactly two decimal places, no leading zeros except 0.xx.

Match^(?!0+(?:\.0+)?$)(?:0?\.\d{1,2}|[1-9]\d?(?:\.\d{1,2})?|100(?:\.0{1,2})?)$

descriptionstringOptional

Detailed description of the tax for internal reference

codestring<TaxCode>Optional

Unique code used to identify the tax. Must contain only alphanumeric characters, underscores, and hyphens.

Match^[a-zA-Z0-9_-]*$

idstringOptional

Unique identifier of the tax

Formatuuid

created_atstring<DateTimeWithZone>Optional

Date and time in ISO 8601 format.

Formatdate-time

idstringOptional

Unique identifier of the minimum commitment, created by Lago.

Formatuuid

plan_codestringOptional

The unique code representing the plan to be attached to the customer.

created_atstringOptional

The date and time when the minimum commitment was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the minimum commitment was initially created.

Formatdate-time

updated_atstringOptional

The date and time when the minimum commitment was updated. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the minimum commitment was initially created.

Formatdate-time

chargeUsageobject<ChargeUsageThresholdResponse>[]Optional

ChargeUsageThresholdResponse 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<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

taxesobject<TaxResponse>[]Optional

List of tax entities configured for the plan.

TaxResponse properties

6 properties

namestringRequired

Name of the tax

ratestringOptional

The percentage rate of the tax applied to transactions. A decimal amount from 0.01 to 100.00 inclusive, always with exactly two decimal places, no leading zeros except 0.xx.

Match^(?!0+(?:\.0+)?$)(?:0?\.\d{1,2}|[1-9]\d?(?:\.\d{1,2})?|100(?:\.0{1,2})?)$

descriptionstringOptional

Detailed description of the tax for internal reference

codestring<TaxCode>Optional

Unique code used to identify the tax. Must contain only alphanumeric characters, underscores, and hyphens.

Match^[a-zA-Z0-9_-]*$

idstringOptional

Unique identifier of the tax

Formatuuid

created_atstring<DateTimeWithZone>Optional

Date and time in ISO 8601 format.

Formatdate-time

trial_periodintegerOptional

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

Back to top

On this page

No Headings