Subscriptions

List Subscriptions

Lists all subscriptions on the authenticated user's Lucid account. This endpoint is paginated.

get/v1/subscriptions

Request

Base URL: https://api.lucid.co
URL: https://api.lucid.co/v1/subscriptions
Auth: one of:
- HTTP bearer
- OAuth 2 (authorization code, authorization URL https://lucid.app/oauth2/authorize, token URL https://api.lucid.co/oauth2/token, scopes: licenses:admin.readonly, licenses:admin)

Response

OK. Returns an array of subscriptions on the account.

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"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.