List plans
GET {{base_url}}/v1/billing/plans?page_size=10&page=1&total_required=true
Lists billing plans.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
product_id | string | Filters the response by a Product ID. | |
plan_ids | string | Filters the response by list of plan IDs. Filter supports upto 10 plan IDs. | |
page_size | number | The number of items to return in the response. | |
page | number | A non-zero integer which is the start index of the entire list of items to return in the response. The combination of page=1 and page_size=20 returns the first 20 items. The combination of page=2 and page_size=20 returns the next 20 items. | |
total_required | boolean | Indicates whether to show the total count in the response. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | The Content-Type header field is used to specify the nature of the data in the body of an entity. PayPal REST APIs support application/json. | |
PayPal-Request-Id | string | The server stores keys for 72 hours. | |
PayPal-Client-Metadata-Id | string | Optional. Verifies that the payment originates from a valid, user-consented device and application. Reduces fraud and decreases declines. Transactions that do not include a client metadata ID are not eligible for PayPal Seller Protection. | |
PayPal-Partner-Attribution-Id | string | Optional. Identifies the caller as a PayPal partner. To receive revenue attribution, specify a unique build notation (BN) code. BN codes provide tracking on all transactions that originate or are associated with a particular partner. To find your BN code, see Code and Credential Reference. | |
PayPal-Auth-Assertion | string | An API client-provided JSON Web Token (JWT) assertion that identifies the merchant. To use this header, you must get consent to act on behalf of a merchant. | |
Prefer | string | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> | |
Prefer | string | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> |
RESPONSES
status: OK
{"plans":[{"id":"P-3AA40999TK546021CMQYGZFY","version":1,"product_id":"1680892199","name":"Fresh Clean Tees Plan","status":"ACTIVE","description":"Each shirt they send out to subscribers is designed with lots of attention to detail","usage_type":"LICENSED","billing_cycles":[{"pricing_scheme":{"version":1,"fixed_price":{"currency_code":"USD","value":"1.0"},"create_time":"2023-04-07T19:18:47Z","update_time":"2023-04-07T19:18:47Z"},"frequency":{"interval_unit":"MONTH","interval_count":1},"tenure_type":"TRIAL","sequence":1,"total_cycles":1},{"pricing_scheme":{"version":1,"fixed_price":{"currency_code":"USD","value":"44.0"},"create_time":"2023-04-07T19:18:47Z","update_time":"2023-04-07T19:18:47Z"},"frequency":{"interval_unit":"MONTH","interval_count":1},"tenure_type":"REGULAR","sequence":2,"total_cycles":12}],"payment_preferences":{"service_type":"PREPAID","auto_bill_outstanding":true,"setup_fee":{"currency_code":"USD","value":"10.0"},"setup_fee_failure_action":"CONTINUE","payment_failure_threshold":3},"taxes":{"percentage":"10.0","inclusive":false},"quantity_supported":false,"payee":{"merchant_id":"C7CYMKZDG8D6E","display_data":{"business_email":"john_merchant@example.com"}},"create_time":"2023-04-07T19:18:47Z","update_time":"2023-04-07T19:18:47Z","links":[{"href":"https://api.sandbox.paypal.com/v1/billing/plans/P-3AA40999TK546021CMQYGZFY","rel":"self","method":"GET","encType":"application/json"}]}],"total_items":1,"total_pages":1,"links":[{"href":"https://api.sandbox.paypal.com/v1/billing/plans?product_id=1680892199\u0026page_size=10\u0026page=1","rel":"self","method":"GET","encType":"application/json"}]}