v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

Subscriptions

Get subscription

Retrieves detailed information for a specific subscription.

The response includes:

Current tier
Active add-ons
Subscription status

get/subscriptions/{id}

Path parameters

idstring required

The unique identifier of the subscription

Response

When request is successful. Returns a 'Subscription' object.

hrefstring nullable

relationstring nullable

methodstring nullable

idstring nullable

Unique identifier of the subscription.

type0 | 1

productSuitestring nullable

The product suite of the subscription.

statusstring nullable

Current status of the subscription.

If missing, then the firm does not have a platform subscription.

Possible values: Trialing, Active, Canceled, PastDue, Unpaid, Incomplete, IncompleteExpired.

intervalstring nullable

Current billing interval of the subscription.

Derived from the tiers billing interval. Returns 'None' if a tier is not associated to this subscription.

Currently only Monthly and Yearly are supported.

Possible values: None, Daily, Weekly, Monthly, Yearly.

quantityinteger nullable

The number of user licenses for this subscription.

createdDatestring date-time nullable

The created date of the subscription.

trialStatusstring nullable

The trial status of the subscription.

None - The subscription is not trialing a tier or add-on.
Trialing - The subscription is in its trial phase (on signup) or a promotion is applied and a tier or add-on is being trialed.

trialPeriodStartDatestring date-time nullable

The trial period start date of the subscription.

Used in conjuction with the trial period end date to determine if the subscription is currently in trial mode.

Null if the subscription is not in trial mode.

trialPeriodEndDatestring date-time nullable

The trial period end date of the subscription.

Used in conjuction with the trial period start date to determine if the subscription is currently in trial mode.

Null if the subscription is not in trial mode.

currentPeriodStartDatestring date-time nullable

The start date of the subscription.

currentPeriodEndDatestring date-time nullable

The end date of the subscription.

cancellationStatusstring nullable

The cancellation status of the subscription.

None - The subscription is not canceled and no cancelation requests have been made.
Pending - The subscription has been canceled and will be canceled at a later date.
Canceled - The subscription has been canceled.

Possible values: None, Pending, Canceled.

cancellationTypestring nullable

Represents the most recent cancellation type for the subscription.

This can be used alongside the CanceledAt and CancelAt properties to determine the cancellation status and timing.

PeriodEnd - Subscription will be canceled at the end of the billing cycle.
Immediate - Subscription was canceled immediatly.
Date - If not already canceled, the subscription will be canceled at the 'CancelAt' date.

Possible values: PeriodEnd, Immediate, Date.

canceledAtstring date-time nullable

If the subscription has been canceled, the date of that cancellation.

Otherwise, the date of the cancel request.

cancelAtstring date-time nullable

A date in the future at which the subscription will automatically get canceled and the status will change to 'Canceled'.

Example response

{
  "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "tier": {
    "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
    "name": "Intake",
    "prices": [
      {
        "default": true,
        "active": true,
        "type": "Recurring",
        "name": "\"$109 per user/month\"",
        "amount": 5900,
        "interval": "Monthly"
      }
    ],
    "createdDate": "2022-04-23T14:00:00Z",
    "updatedDate": "2022-04-23T14:00:00Z"
  },
  "trialingTier": {
    "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
    "name": "Intake",
    "prices": [
      {
        "default": true,
        "active": true,
        "type": "Recurring",
        "name": "\"$109 per user/month\"",
        "amount": 5900,
        "interval": "Monthly"
      }
    ],
    "createdDate": "2022-04-23T14:00:00Z",
    "updatedDate": "2022-04-23T14:00:00Z"
  },
  "addOns": [
    {
      "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
      "name": "Intake",
      "prices": [
        {
          "default": true,
          "active": true,
          "type": "Recurring",
          "name": "\"$109 per user/month\"",
          "amount": 5900,
          "interval": "Monthly"
        }
      ],
      "createdDate": "2022-04-23T14:00:00Z",
      "updatedDate": "2022-04-23T14:00:00Z"
    }
  ],
  "usages": [
    {
      "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
      "prices": [
        {
          "default": true,
          "active": true,
          "type": "Recurring",
          "name": "\"$109 per user/month\"",
          "amount": 5900,
          "interval": "Monthly"
        }
      ]
    }
  ],
  "discounts": [
    {
      "promotion": {
        "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
        "tiers": [
          {
            "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
            "name": "Intake",
            "prices": [
              {
                "default": true,
                "active": true,
                "type": "Recurring",
                "name": "\"$109 per user/month\"",
                "amount": 5900,
                "interval": "Monthly"
              }
            ],
            "createdDate": "2022-04-23T14:00:00Z",
            "updatedDate": "2022-04-23T14:00:00Z"
          }
        ],
        "addOns": [
          {
            "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
            "name": "Intake",
            "prices": [
              {
                "default": true,
                "active": true,
                "type": "Recurring",
                "name": "\"$109 per user/month\"",
                "amount": 5900,
                "interval": "Monthly"
              }
            ],
            "createdDate": "2022-04-23T14:00:00Z",
            "updatedDate": "2022-04-23T14:00:00Z"
          }
        ],
        "name": "Summer Sale 2024",
        "description": "Summer Sale 2024",
        "durationDays": 7,
        "amountOff": 2000,
        "percentOff": 20.5,
        "numUsed": 42,
        "createdDate": "2024-01-15T10:00:00Z",
        "expirationDate": "2024-12-31T23:59:59Z",
        "codes": [
          {
            "id": "promo_code_1234",
            "name": "SUMMER2024",
            "description": "100% discount!",
            "code": "SUMMER2024",
            "minimumAmount": 5000,
            "limit": 100,
            "createdDate": "2024-01-15T10:00:00Z",
            "expiratonDate": "2024-12-31T23:59:59Z"
          }
        ]
      }
    }
  ],
  "quantity": 3,
  "createdDate": "2022-04-23T14:00:00Z",
  "trialPeriodStartDate": "2022-04-23T14:00:00Z",
  "trialPeriodEndDate": "2022-04-23T14:00:00Z",
  "currentPeriodStartDate": "2022-04-23T14:00:00Z",
  "currentPeriodEndDate": "2022-04-23T14:00:00Z",
  "cancellationType": "PeriodEnd",
  "canceledAt": "2024-12-01T09:00:00Z",
  "cancelAt": "2025-04-23T14:00:00Z"
}