Subscriptions
RetrieveSubscription
Retrieves a specific subscription.
get/v2/subscriptions/{subscription_id}
Path parameters
subscription_idstring required
The ID of the subscription to retrieve.
Query parameters
includestring
A query parameter to specify related information to be included in the response.
The supported query parameter values are:
- actions: to include scheduled actions on the targeted subscription.
Response
Success
Example response
{
"subscription": {
"card_id": "ccof:IkWfpLj4tNHMyFii3GB",
"charged_through_date": "2023-11-20",
"created_at": "2022-07-27T21:53:10Z",
"customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
"id": "8151fc89-da15-4eb9-a685-1a70883cebfc",
"invoice_ids": [
"inv:0-ChCHu2mZEabLeeHahQnXDjZQECY",
"inv:0-ChrcX_i3sNmfsHTGKhI4Wg2mceA"
],
"location_id": "S8GWD5R9QB376",
"paid_until_date": "2024-08-01",
"plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H",
"price_override_money": {
"amount": 25000,
"currency": "USD"
},
"source": {
"name": "My Application"
},
"start_date": "2022-07-27",
"status": "ACTIVE",
"timezone": "America/Los_Angeles"
}
}