Subscriptions

Get all existing subscriptions.

get/api/v1/subscriptions

Request

Base URL: https://api.chiligrafx.com (the document declares no server; this is the origin it was published from)
URL: https://api.chiligrafx.com/api/v1/subscriptions
Auth: HTTP bearer

Response

Returns array of subscriptions.

idinteger required

Subscription Id.

guidstring uuid required

Subscription GUID.

namestring required

Subscription name.

displayNamestring required

Subscription display name.

isActiveboolean required

true if subscription is still active.

clientIdstring uuid required

Client GUID.

clientNamestring nullable

Client name.

isGraFxPricebookboolean required

Flag which indicates if the subscription belongs to a GraFx pricebook.

subscriptionType'OnPremises' | 'Saas' required

Subscription type.

pricebookVersionstring required

The pricebook version.

isWhitelabeledboolean required

Flag which indicates if the subscription is whitelabeled.

Example response

[
  {
    "id": 44,
    "guid": "d9aa2149-7f95-4ecc-ab2f-d6d12708f8da",
    "name": "CHILI - OnlineTrial",
    "displayName": "Temporary subscription",
    "isActive": true,
    "clientId": "950c78e8-99c0-4681-98b3-a8b2ff11683c",
    "clientName": "CHILI",
    "isGraFxPricebook": true,
    "pricebookVersion": "2025"
  }
]

Changes

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