List transactions for subscription
GET {{base_url}}/v1/billing/subscriptions/:subscription_id/transactions?start_time=2022-01-01T00:00:00.000Z&end_time=2030-01-01T00:00:00.000Z
Lists transactions for a subscription.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
start_time | string | (Required) The start time of the range of transactions to list. | |
end_time | string | (Required) The end time of the range of transactions to list. |
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
{"transactions":[{"status":"COMPLETED","id":"84675445GA532204T","amount_with_breakdown":{"gross_amount":{"currency_code":"USD","value":"11.00"},"fee_amount":{"currency_code":"USD","value":"0.87"},"net_amount":{"currency_code":"USD","value":"10.13"}},"payer_name":{"given_name":"John","surname":"Doe"},"payer_email":"sb-va2vu25121657@personal.example.com","time":"2023-04-10T19:07:56.000Z"}],"links":[{"href":"https://api-m.sandbox.paypal.com/v1/billing/subscriptions/I-2GBPV1D6MTYW/transactions?start_time=2022-01-01T00%3A00%3A00.000Z\u0026end_time=2030-01-01T00%3A00%3A00.000Z","rel":"SELF","method":"GET"}]}