Get Subscriptions

GET /api/v1_1/subscriptions

get
Subscriptions

https://{domain}.customersuccessbox.com/api/v1_1/subscriptions
GET Subscriptions fetches a list of all subscriptions paginated with a limit of 20 records per page.
Request
Response
Request
Headers
Authorization
required
string
Bearer {secret_key}
Content-Type
required
string
application/json
Query Parameters
page
optional
string
Page number to start from
Response
200: OK
{
"data": [
{
"id": 100000,
"account_id": "100000",
"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": "1000",
"mrr_in_default_currency": "1000",
"cancelled_mrr": "0",
"cancelled_mrr_in_default_currency": "0",
"forecast": "up-sell",
"forecast_amount": "0",
"forecast_amount_in_default_currency": "0",
"billing_period": "1",
"billing_period_unit": "year",
"product_name": "Q8v8",
"product_code": null,
"plan_name": "Enterprise",
"plan_code": null,
"plan_quantity": "1",
"plan_unit_price": "500",
"currency": "USD",
"stage": "Active",
"stage_csb": null,
"external_subscription_id": "SUB-HbyF7XmA7s99",
"external_account_id": null,
"activated_on": "2017-07-17 00:00:00",
"cancelled_on": "2018-07-28 00:00:00",
"created_on": "2017-07-17 00:00:00",
"next_billing_on": "2019-01-14 00:00:00",
"subscription_ends_on": "2019-02-28 00:00:00",
"current_term_start_on": null,
"current_term_end_on": null,
"latest_amendment_on": null,
"subscription_start_on": "2018-11-19 00:00:00",
"trial_ends_on": null,
"trial_start_on": null,
"updated_on": "2018-07-17 00:00:00",
"created_at": "2018-07-17 08:09:22",
"updated_at": "2019-04-15 15:35:55",
"subscription_start_on_for_humans": "5 months ago",
"subscription_start_on_for_date_format": "2018-11-19",
"subscription_ends_on_for_humans": "2 months ago",
"subscription_ends_on_for_date_format": "2019-02-28",
"cancelled_on_for_humans": "9 months ago",
"cancelled_on_for_date_format": "2018-07-28",
"created_on_for_humans": "1 year ago",
"created_on_for_date_format": "2017-07-17",
"updated_on_for_humans": "9 months ago",
"updated_on_for_date_format": "2018-07-17",
"activated_on_for_humans": "1 year ago",
"activated_on_for_date_format": "2017-07-17",
"trial_start_on_for_humans": "",
"trial_start_on_for_date_format": "",
"trial_ends_on_for_humans": "",
"trial_ends_on_for_date_format": "",
"next_billing_on_for_humans": "3 months ago",
"next_billing_on_for_date_format": "2019-01-14"
},
{
"id": 100001,
"account_id": "100001",
"stage_id": "100002",
"status_id": "100002",
"status": "Future",
"status_csb": "Future",
"amount": "3000",
"amount_in_default_currency": "3000",
"arr": null,
"arr_in_default_currency": null,
"mrr": "800",
"mrr_in_default_currency": "800",
"cancelled_mrr": "0",
"cancelled_mrr_in_default_currency": "0",
"forecast": "up-sell",
"forecast_amount": "0",
"forecast_amount_in_default_currency": "0",
"billing_period": "1",
"billing_period_unit": "year",
"product_name": "jBzA",
"product_code": null,
"plan_name": "Enterprise",
"plan_code": null,
"plan_quantity": "1",
"plan_unit_price": "400",
"currency": "USD",
"stage": "Live",
"stage_csb": "Live",
"external_subscription_id": "SUB-MuENEaOnWL2b",
"external_account_id": null,
"activated_on": "2018-09-27 00:00:00",
"cancelled_on": null,
"created_on": "2018-05-17 00:00:00",
"next_billing_on": "2019-09-27 00:00:00",
"subscription_ends_on": "2019-09-27 00:00:00",
"current_term_start_on": null,
"current_term_end_on": null,
"latest_amendment_on": null,
"subscription_start_on": "2018-09-28 00:00:00",
"trial_ends_on": "2018-09-26 00:00:00",
"trial_start_on": "2018-08-27 00:00:00",
"updated_on": "2018-11-14 00:00:00",
"created_at": "2018-07-17 08:09:22",
"updated_at": "2019-04-15 15:35:55",
"subscription_start_on_for_humans": "7 months ago",
"subscription_start_on_for_date_format": "2018-09-28",
"subscription_ends_on_for_humans": "4 months from now",
"subscription_ends_on_for_date_format": "2019-09-27",
"cancelled_on_for_humans": "",
"cancelled_on_for_date_format": "",
"created_on_for_humans": "11 months ago",
"created_on_for_date_format": "2018-05-17",
"updated_on_for_humans": "5 months ago",
"updated_on_for_date_format": "2018-11-14",
"activated_on_for_humans": "7 months ago",
"activated_on_for_date_format": "2018-09-27",
"trial_start_on_for_humans": "8 months ago",
"trial_start_on_for_date_format": "2018-08-27",
"trial_ends_on_for_humans": "7 months ago",
"trial_ends_on_for_date_format": "2018-09-26",
"next_billing_on_for_humans": "4 months from now",
"next_billing_on_for_date_format": "2019-09-27"
},
{
"id": 100002,
"account_id": "100002",
"stage_id": null,
"status_id": "100000",
"status": "Active",
"status_csb": "Active",
"amount": "7000",
"amount_in_default_currency": "7000",
"arr": null,
"arr_in_default_currency": null,
"mrr": "583.33333333333",
"mrr_in_default_currency": "583.33333333333",
"cancelled_mrr": "0",
"cancelled_mrr_in_default_currency": "0",
"forecast": "up-sell",
"forecast_amount": "0",
"forecast_amount_in_default_currency": "0",
"billing_period": "1",
"billing_period_unit": "year",
"product_name": "ndIE",
"product_code": null,
"plan_name": "Enterprise",
"plan_code": null,
"plan_quantity": "5000",
"plan_unit_price": "350",
"currency": "USD",
"stage": "Cancelled",
"stage_csb": null,
"external_subscription_id": "SUB-8nfkypoDIdSR",
"external_account_id": null,
"activated_on": "2017-11-17 00:00:00",
"cancelled_on": null,
"created_on": "2017-11-17 00:00:00",
"next_billing_on": "2019-03-30 00:00:00",
"subscription_ends_on": "2019-09-05 00:00:00",
"current_term_start_on": null,
"current_term_end_on": null,
"latest_amendment_on": null,
"subscription_start_on": "2018-09-06 00:00:00",
"trial_ends_on": null,
"trial_start_on": null,
"updated_on": "2018-07-17 00:00:00",
"created_at": "2018-07-17 08:09:22",
"updated_at": "2019-04-15 15:35:55",
"subscription_start_on_for_humans": "7 months ago",
"subscription_start_on_for_date_format": "2018-09-06",
"subscription_ends_on_for_humans": "4 months from now",
"subscription_ends_on_for_date_format": "2019-09-05",
"cancelled_on_for_humans": "",
"cancelled_on_for_date_format": "",
"created_on_for_humans": "1 year ago",
"created_on_for_date_format": "2017-11-17",
"updated_on_for_humans": "9 months ago",
"updated_on_for_date_format": "2018-07-17",
"activated_on_for_humans": "1 year ago",
"activated_on_for_date_format": "2017-11-17",
"trial_start_on_for_humans": "",
"trial_start_on_for_date_format": "",
"trial_ends_on_for_humans": "",
"trial_ends_on_for_date_format": "",
"next_billing_on_for_humans": "1 month ago",
"next_billing_on_for_date_format": "2019-03-30"
},
{
"id": 100003,
"account_id": "100003",
"stage_id": null,
"status_id": "100000",
"status": "Active",
"status_csb": "Active",
"amount": "3000",
"amount_in_default_currency": "3000",
"arr": null,
"arr_in_default_currency": null,
"mrr": "250",
"mrr_in_default_currency": "250",
"cancelled_mrr": "0",
"cancelled_mrr_in_default_currency": "0",
"forecast": "convert",
"forecast_amount": "0",
"forecast_amount_in_default_currency": "0",
"billing_period": "1",
"billing_period_unit": "year",
"product_name": "Dh8b",
"product_code": null,
"plan_name": "Startup",
"plan_code": null,
"plan_quantity": "1",
"plan_unit_price": "0",
"currency": "USD",
"stage": "Cancelled",
"stage_csb": null,
"external_subscription_id": "SUB-uQWbQe9dR8OV",
"external_account_id": null,
"activated_on": "2018-02-22 00:00:00",
"cancelled_on": null,
"created_on": "2017-07-17 00:00:00",
"next_billing_on": "2018-11-29 00:00:00",
"subscription_ends_on": "2018-04-09 00:00:00",
"current_term_start_on": null,
"current_term_end_on": null,
"latest_amendment_on": null,
"subscription_start_on": "2018-08-31 00:00:00",
"trial_ends_on": null,
"trial_start_on": null,
"updated_on": "2018-07-17 00:00:00",
"created_at": "2018-07-17 08:09:22",
"updated_at": "2019-04-15 15:35:55",
"subscription_start_on_for_humans": "7 months ago",
"subscription_start_on_for_date_format": "2018-08-31",
"subscription_ends_on_for_humans": "1 year ago",
"subscription_ends_on_for_date_format": "2018-04-09",
"cancelled_on_for_humans": "",
"cancelled_on_for_date_format": "",
"created_on_for_humans": "1 year ago",
"created_on_for_date_format": "2017-07-17",
"updated_on_for_humans": "9 months ago",
"updated_on_for_date_format": "2018-07-17",
"activated_on_for_humans": "1 year ago",
"activated_on_for_date_format": "2018-02-22",
"trial_start_on_for_humans": "",
"trial_start_on_for_date_format": "",
"trial_ends_on_for_humans": "",
"trial_ends_on_for_date_format": "",
"next_billing_on_for_humans": "5 months ago",
"next_billing_on_for_date_format": "2018-11-29"
},
{
"id": 100004,
"account_id": "100004",
"stage_id": null,
"status_id": "100001",
"status": "Cancelled",
"status_csb": "Cancelled",
"amount": "3000",
"amount_in_default_currency": "3000",
"arr": null,
"arr_in_default_currency": null,
"mrr": "250",
"mrr_in_default_currency": "250",
"cancelled_mrr": "250",
"cancelled_mrr_in_default_currency": "0",
"forecast": "up-sell",
"forecast_amount": "0",
"forecast_amount_in_default_currency": "0",
"billing_period": "1",
"billing_period_unit": "year",
"product_name": "ztx6",
"product_code": null,
"plan_name": "Startup",
"plan_code": "ztx6",
"plan_quantity": "1",
"plan_unit_price": "0",
"currency": "USD",
"stage": "Cancelled",
"stage_csb": null,
"external_subscription_id": "SUB-oSUSqBcIqV6s",
"external_account_id": null,
"activated_on": "2017-08-17 00:00:00",
"cancelled_on": null,
"created_on": "2017-08-17 00:00:00",
"next_billing_on": "2018-05-02 00:00:00",
"subscription_ends_on": "2018-05-02 00:00:00",
"current_term_start_on": null,
"current_term_end_on": null,
"latest_amendment_on": null,
"subscription_start_on": "2018-08-31 00:00:00",
"trial_ends_on": null,
"trial_start_on": null,
"updated_on": "2018-07-17 00:00:00",
"created_at": "2018-07-17 08:09:22",
"updated_at": "2019-04-15 15:35:55",
"subscription_start_on_for_humans": "7 months ago",
"subscription_start_on_for_date_format": "2018-08-31",
"subscription_ends_on_for_humans": "11 months ago",
"subscription_ends_on_for_date_format": "2018-05-02",
"cancelled_on_for_humans": "",
"cancelled_on_for_date_format": "",
"created_on_for_humans": "1 year ago",
"created_on_for_date_format": "2017-08-17",
"updated_on_for_humans": "9 months ago",
"updated_on_for_date_format": "2018-07-17",
"activated_on_for_humans": "1 year ago",
"activated_on_for_date_format": "2017-08-17",
"trial_start_on_for_humans": "",
"trial_start_on_for_date_format": "",
"trial_ends_on_for_humans": "",
"trial_ends_on_for_date_format": "",
"next_billing_on_for_humans": "11 months ago",
"next_billing_on_for_date_format": "2018-05-02"
},
{
"id": 100005,
"account_id": "100005",
"stage_id": null,
"status_id": "100001",
"status": "Cancelled",
"status_csb": "Cancelled",
"amount": "2000",
"amount_in_default_currency": "2000",
"arr": null,
"arr_in_default_currency": null,
"mrr": "166.66666666667",
"mrr_in_default_currency": "166.66666666667",
"cancelled_mrr": "166.66666666667",
"cancelled_mrr_in_default_currency": "0",
"forecast": "up-sell",
"forecast_amount": "0",
"forecast_amount_in_default_currency": "0",
"billing_period": "1",
"billing_period_unit": "year",
"product_name": "jxWl",
"product_code": null,
"plan_name": "Enterprise",
"plan_code": null,
"plan_quantity": "1",
"plan_unit_price": "0",
"currency": "USD",
"stage": "Cancelled",
"stage_csb": null,
"external_subscription_id": "SUB-gtCvhg1fA5j9",
"external_account_id": null,
"activated_on": "2018-04-17 00:00:00",
"cancelled_on": null,
"created_on": "2018-04-17 00:00:00",
"next_billing_on": "2018-10-04 00:00:00",
"subscription_ends_on": "2018-10-04 00:00:00",
"current_term_start_on": null,
"current_term_end_on": null,
"latest_amendment_on": null,
"subscription_start_on": "2018-08-31 00:00:00",
"trial_ends_on": null,
"trial_start_on": null,
"updated_on": "2018-07-17 00:00:00",
"created_at": "2018-07-17 08:09:22",
"updated_at": "2019-04-15 15:35:55",
"subscription_start_on_for_humans": "7 months ago",
"subscription_start_on_for_date_format": "2018-08-31",
"subscription_ends_on_for_humans": "6 months ago",
"subscription_ends_on_for_date_format": "2018-10-04",
"cancelled_on_for_humans": "",
"cancelled_on_for_date_format": "",
"created_on_for_humans": "1 year ago",
"created_on_for_date_format": "2018-04-17",
"updated_on_for_humans": "9 months ago",
"updated_on_for_date_format": "2018-07-17",
"activated_on_for_humans": "1 year ago",
"activated_on_for_date_format": "2018-04-17",
"trial_start_on_for_humans": "",
"trial_start_on_for_date_format": "",
"trial_ends_on_for_humans": "",
"trial_ends_on_for_date_format": "",
"next_billing_on_for_humans": "6 months ago",
"next_billing_on_for_date_format": "2018-10-04"
}
],
"limit": 20,
"page": 1
}

CURL example

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