---
title: "Retrieves a Subscription resource."
method: GET
path: "/subscriptions/{id}"
tags: ["Subscription"]
---

# Retrieves a Subscription resource.

`GET /subscriptions/{id}`

Retrieves a Subscription resource.

## Path parameters

- `id` string, required

## Response `200`

Subscription resource

- Subscription
  - `id` string — Unique identifier for this subscription note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726"
  - `integration` string — The key of the integration source e.g. "quickbooks", or "xero"
  - `srcId` string — The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"
  - `status` boolean, nullable — Status of the subscription e.g. expired
  - `balance` integer, nullable — Amount in balance for the subscription in cents e.g. 500045
  - `totalRevenue` integer, nullable — Total revenue from this specific subscription in cents e.g. 387687
  - `productPrice` integer, nullable — Price of the subscribed product in cents e.g. 4999
  - `currencyCode` string, nullable — Currency code e.g. "EUR"
  - `currentPeriodStart` string, nullable — Current period start datetime e.g. "2014-11-18" e.g. "1655792028"
  - `currentPeriodEnd` string, nullable — Current period end datetime e.g. "2014-11-18" e.g. "1653977628"
  - `nextPeriodStart` string, nullable — Date next period starts e.g. "2014-11-18" e.g. "1653977628"
  - `cancelAtEndOfPeriod` boolean, nullable — Boolean on if plan is canelled at the end of the current period
  - `signupId` string, nullable — Signup id e.g. "user123"
  - `signupRevenue` string, nullable — Signup revenue e.g. "250"
  - `couponCode` string, nullable — Coupon code e.g. "PROMOCODE"
  - `customerId` string, nullable — Customer id e.g. "123"
  - `productId` string, nullable — Id for the subscribed product e.g. "321"
  - `creditCardId` string, nullable — Credit card id e.g. "4250"
  - `created` string, date-time, nullable — The date and time the subscription is first created e.g. "2013-11-18T02:17:40.080Z"
  - `modified` string, date-time, nullable — Date entry was last modified e.g. "2013-11-18T02:17:40.080Z"
  - `customerFirstName` string, nullable — Customer first name e.g. "Jane"
  - `customerLastName` string, nullable — Customer last name e.g. "Doe"
  - `startDate` string, date-time, nullable — Start datetime of the subscription e.g. "2013-11-18T02:17:40.080Z"
  - `endDate` string, date-time, nullable — End datetime of the subscription e.g. "2015-11-18T02:17:40.080Z"
  - `planName` string, nullable — Name of the plan of which this subscription is an instance e.g. "Basic Plan"
  - `activated` string, nullable — Indicates when the subscription was activated e.g. "Jan 23 2023"
  - `remainingIntervals` integer, nullable — Number of remaining subscription intervals e.g. 12
  - `monthlyRevenue` integer, nullable — Revenue per month in cents e.g. 500000
  - `netMonthlyRevenue` integer, nullable — Monthly revenue after taxes e.g. 300000
  - `contractStartDate` string, date-time, nullable — Date contract starts * e.g. "2013-11-18T02:17:40.080Z"
  - `expiredTimestamp` string, date-time, nullable — When the current subscription expires e.g. "2013-11-18T02:17:40.080Z"
  - `planInterval` string, nullable — Length of each subscription plan e.g. "Monthly"
  - `numOfIntervals` integer, nullable — Number of subscription intervals e.g. 12

## Other responses

- `404` — Resource not found

---

[API](https://skmtc.net/bossinsights/apis/boss-insights.md) · [All operations](https://skmtc.net/bossinsights/apis/boss-insights/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bossinsights/boss-insights/versions/d08a107895ad/schema)