plans

Show plan details

Shows details for a plan, by ID.

get/v1/billing/plans/{id}

Request

Base URL
https://api-m.sandbox.paypal.com
Auth
OAuth 2
Client credentials
Token URL/api/oauth-proxy
Scopeshttps://uri.paypal.com/services/subscriptions
TypeScript
https://skmtc.dev/paypal/apis/subscriptions/docs/v1/billing/plans/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

The ID of the subscription.

Headers

Content-Typestring required

The media type. Required for operations with a request body. The value is application/<format>, where the format is json.

Response

A successful request returns the HTTP 200 OK status code and a JSON response body that shows plan details.

idstring

The unique PayPal-generated ID for the plan.

product_idstring

The ID for the product.

namestring

The plan name.

descriptionstring

The detailed description of the plan.

quantity_supportedboolean

Indicates whether you can subscribe to this plan by providing a quantity for the goods or service.

create_timestring ppaas_date_time_v3

The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.<blockquote><strong>Note:</strong> The regular expression provides guidance but does not reject all invalid dates.</blockquote>

update_timestring ppaas_date_time_v3

Changes

No recorded changes to this operation across all 1 revision of this API.