PayPal Plans API is one of 37 APIs that PayPal publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Plans. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.
This API exposes
7 operations
across 5 paths,
and defines 44 schemas.
It is described by OpenAPI 3.0.3, at version 1.6.
Requests are made against 2 base URLs: https://api-m.sandbox.paypal.com, https://api-m.paypal.com.
7 operations5 paths44 schemas2 GET1 PATCH4 POST
Metadata
The identity and technical contract details declared by the specification.
PayPal Plans API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (Oauth2) using the clientCredentials flow, exposing 1 scope.
Oauth2 — Oauth 2.0 authentication
Paths & Operations 7
Across 5 paths, the API surfaces 7 operations — 2 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are plan (12 properties), plan_request_POST (8 properties), pricing_scheme (6 properties), error_415 (5 properties). Each schema is shown below with its type and property counts.
plan_request_POST
object
The create plan request details.
8 properties4 required
plans.create-400
object
1 property
error_404
object
The server has not found anything matching the request URI. This either means that the URI is incorrect or the resource is not available.
5 properties
billing_cycle
object
The billing cycle details.
5 properties3 required
error_409
object
The server has detected a conflict while processing this request.
5 properties
403
object
1 property
payment_preferences
object
The payment preferences for a subscription.
4 properties
link_description
object
The request-related [HATEOAS link](/docs/api/reference/api-responses/hateoas-links) information.
3 properties2 required
plans.patch-422
object
1 property
patch
object
The JSON patch object to apply partial updates to resources.
4 properties1 required
error_403
object
The client is not authorized to access this resource, although it may have valid credentials.
5 properties
error_422
object
The requested action cannot be performed and may require interaction with APIs or processes outside of the current request. This is distinct from a 500 respons…
5 properties
plans.update-pricing-schemes-400
object
1 property
update_pricing_scheme_request
object
The update pricing scheme request details.
2 properties2 required
error_details
object
The error details. Required for client-side 4XX errors.
5 properties1 required
error_link_description
object
The request-related [HATEOAS link](/api/rest/responses/hateoas-links) information.
3 properties2 required
plans.deactivate-422
object
1 property
plan
object
The plan details.
12 properties
error_default
The default error response.
400
object
1 property
error_location
string
The location of the field that caused the error. Value is body, path, or query.
plan_collection
object
The list of plans with details.
4 properties
patch_request
array
An array of JSON patch objects to apply partial updates to resources.
money
object
The currency and amount for a financial transaction, such as a balance or payment due.
2 properties2 required
pricing_tier
object
The pricing tier details.
3 properties2 required
401
object
1 property
422
object
1 property
plans.update-pricing-schemes-422
object
1 property
taxes
object
The tax details.
2 properties1 required
error_503
object
The server is temporarily unable to handle the request, for example, because of planned maintenance or downtime.
4 properties
error_400
object
Request is not well-formed, syntactically incorrect, or violates schema.
5 properties
pricing_scheme
object
The pricing scheme details.
6 properties
currency_code
string
The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
error_401
object
Authentication failed due to missing Authorization header, or invalid authentication credentials.
5 properties
404
object
1 property
error_415
object
The server does not support the request payload's media type.
5 properties
plans.patch-400
object
1 property
plans.activate-422
object
1 property
update_pricing_schemes_list_request
object
The update pricing scheme request details.
1 property1 required
error_500
object
This is either a system or application error, and generally indicates that although the client appeared to provide a correct request, something unexpected has…
4 properties
percentage
string
The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as 19.99.
date_time
string
The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339section-5.6). Seconds are required while fractional seconds are option…
frequency
object
The frequency of the billing cycle.
2 properties1 required
422_2
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of PayPal Plans API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
