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

Terms

The terms for the plan.

idstringOptional

The ID of the terms.

Length0 <= length <= 128

typeenumRequired

The term type.

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

occurrencesstringRequired

The number of times that money can be pulled during this term.

buyer_editablestringRequired

Indicates whether the customer can edit the amount in this term.

max_billing_amountobject<currency>Required

The currency and amount for a financial transaction, such as a balance or payment due.

currency properties

2 properties

currencystringRequired

The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/).

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 - ISO 4217](https://www.iso.org/iso-4217-currency-codes.html).

amount_rangeobject<currency>Required

The currency and amount for a financial transaction, such as a balance or payment due.

currency properties

2 properties

currencystringRequired

The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/).

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 - ISO 4217](https://www.iso.org/iso-4217-currency-codes.html).

Back to top

On this page

No Headings