Show subscription details
GET {{base_url}}/v1/billing/subscriptions/:subscription_id
Shows details for a subscription, by ID.
Request Params
| Key | Datatype | Required | Description |
| fields | string | | List of fields that are to be returned in the response. Possible value for fields are last_failed_payment and plan. |
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
{"status":"APPROVAL_PENDING","id":"I-3K9N0AULDABT","plan_id":"P-3U540844AX2546419MQYHLVQ","start_time":"2023-04-10T16:57:03Z","quantity":"1","create_time":"2023-04-10T16:57:03Z","plan_overridden":false,"plan":{"product_id":"1680892199","name":"Fresh Clean Tees Plan","description":"Each shirt they send out to subscribers is designed with lots of attention to detail","billing_cycles":[{"pricing_scheme":{"fixed_price":{"currency_code":"USD","value":"10.0"}},"frequency":{"interval_unit":"MONTH","interval_count":1},"tenure_type":"TRIAL","sequence":1,"total_cycles":1},{"pricing_scheme":{"fixed_price":{"currency_code":"USD","value":"50.0"}},"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":7},"taxes":{"percentage":"10.0","inclusive":false},"quantity_supported":false},"links":[{"href":"https://api.sandbox.paypal.com/v1/billing/subscriptions/I-3K9N0AULDABT","rel":"edit","method":"PATCH"},{"href":"https://api.sandbox.paypal.com/v1/billing/subscriptions/I-3K9N0AULDABT?fields=last_failed_payment,plan","rel":"self","method":"GET"},{"href":"https://www.sandbox.paypal.com/webapps/billing/subscriptions?ba_token=BA-6NS85567LW887234V","rel":"approve","method":"GET"}]}