Get Subscription

GET /api/v1_1/subscription/{subscription_id}

get
Subscription

https://{domain}.customersuccessbox.com/api/v1_1/subscription/{subscription_id}
GET Subscription fetches a single unique Subscription record along with its attributes
Request
Response
Request
Path Parameters
subscription_id
required
string
Unique identifier for subscription
Headers
Authorization
required
string
Bearer {secret_key}
Content-Type
required
string
application/json
Response
200: OK
{
"data": {
"id": 100006,
"account_id": "100006",
"stage_id": null,
"status_id": "100000",
"status": "Active",
"status_csb": "Active",
"amount": "12000",
"amount_in_default_currency": "12000",
"arr": null,
"arr_in_default_currency": null,
"mrr": "500",
"mrr_in_default_currency": "500",
"cancelled_mrr": "0",
"cancelled_mrr_in_default_currency": "0",
"forecast": "up-sell",
"forecast_amount": "1000",
"forecast_amount_in_default_currency": "1000",
"billing_period": "2",
"billing_period_unit": "year",
"product_name": "ndIE",
"product_code": null,
"plan_name": "Enterprise",
"plan_code": null,
"plan_quantity": "2",
"plan_unit_price": "1000",
"currency": "USD",
"stage": "Cancelled",
"stage_csb": null,
"external_subscription_id": "SUB-z6nQnbKzrohx",
"external_account_id": null,
"activated_on": "2019-05-30 00:00:00",
"cancelled_on": null,
"created_on": "2018-09-21 00:00:00",
"next_billing_on": "2018-12-12 00:00:00",
"subscription_ends_on": "2021-01-07 00:00:00",
"current_term_start_on": null,
"current_term_end_on": null,
"latest_amendment_on": null,
"subscription_start_on": "2019-01-08 00:00:00",
"trial_ends_on": "2018-11-16 00:00:00",
"trial_start_on": "2018-10-31 00:00:00",
"updated_on": "2018-12-28 00:00:00",
"created_at": "2018-07-17 08:09:22",
"updated_at": "2019-04-15 15:35:55",
"subscription_start_on_for_humans": "3 months ago",
"subscription_start_on_for_date_format": "2019-01-08",
"subscription_ends_on_for_humans": "1 year from now",
"subscription_ends_on_for_date_format": "2021-01-07",
"cancelled_on_for_humans": "",
"cancelled_on_for_date_format": "",
"created_on_for_humans": "7 months ago",
"created_on_for_date_format": "2018-09-21",
"updated_on_for_humans": "4 months ago",
"updated_on_for_date_format": "2018-12-28",
"activated_on_for_humans": "4 weeks from now",
"activated_on_for_date_format": "2019-05-30",
"trial_start_on_for_humans": "5 months ago",
"trial_start_on_for_date_format": "2018-10-31",
"trial_ends_on_for_humans": "5 months ago",
"trial_ends_on_for_date_format": "2018-11-16",
"next_billing_on_for_humans": "4 months ago",
"next_billing_on_for_date_format": "2018-12-12"
}
}

CURL example

curl --location --request GET "https://{domain}.customersuccessbox.com/api/v1_1/subscription/SUB-z6nQnbKzrohx" \
--header "Authorization: Bearer {secret_api_key}" \
--header "Content-Type: application/json" \