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-PLVN6400VM7S","plan_id":"P-7YC896222K2322022MIBO7QQ","start_time":"2022-11-01T00:00:00Z","quantity":"1","shipping_amount":{"currency_code":"USD","value":"10.0"},"subscriber":{"email_address":"foobuyer@example.com","name":{"given_name":"FooBuyer","surname":"Jones"},"shipping_address":{"name":{"full_name":"John Doe"},"address":{"address_line_1":"2211 N First Street","address_line_2":"Building 17","admin_area_2":"San Jose","admin_area_1":"CA","postal_code":"95131","country_code":"US"}}},"create_time":"2022-02-08T22:41:46Z","plan_overridden":false,"plan":{"product_id":"1644357377","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":"1.0"}},"frequency":{"interval_unit":"MONTH","interval_count":1},"tenure_type":"TRIAL","sequence":1,"total_cycles":1},{"pricing_scheme":{"fixed_price":{"currency_code":"USD","value":"44.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":3},"taxes":{"percentage":"10.0","inclusive":false},"quantity_supported":false},"links":[{"href":"https://api.sandbox.paypal.com/v1/billing/subscriptions/I-PLVN6400VM7S","rel":"edit","method":"PATCH"},{"href":"https://api.sandbox.paypal.com/v1/billing/subscriptions/I-PLVN6400VM7S?fields=last_failed_payment,plan","rel":"self","method":"GET"},{"href":"https://www.sandbox.paypal.com/webapps/billing/subscriptions?ba_token=BA-6V2025733U538713K","rel":"approve","method":"GET"}]}