v1

latestOpenAPI 3.0.3Lucid2026-07-14155181312.3 KB

Subscriptions

Get Subscription

Retrieves details about a specific subscription on the account.

get/v1/subscriptions/{id}

Path parameters

idstring uuid required

Subscription ID

Response

OK. Returns the subscription.

idstring uuid required

Subscription ID

licenseTotalinteger

Total number of available licenses on the subscription and its addons. If there are unlimited licenses, this field will not be returned.

licensesUsedinteger required

Number of licenses currently assigned to users on the subscription

trialboolean required

Whether this is a trial subscription

startstring date-time required

Date and time when subscription started

endstring date-time required

Date and time when subscription ends

renewalstring date-time required

Date and time when subscription renewal happens

Example response

{
  "id": "8e8cf611-d74c-4a2f-8b61-754b22328fbb",
  "licenseTotal": 100,
  "licensesUsed": 50,
  "start": "2024-08-08T22:21:48.612Z",
  "end": "2024-08-08T22:21:48.612Z",
  "renewal": "2024-08-08T22:21:48.612Z"
}