Subscriptions

Get detailed information about subscription.

get/api/v1/subscriptions/{subscriptionId}

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/{subscriptionId}
  • Auth: HTTP bearer

Path parameters

subscriptionIdstring uuid required

Subscription Id.

Response

Returns a subscription.

idinteger required

Subscription Id.

namestring nullable

Subscription name.

displayNamestring nullable

Subscription name.

usedRendersinteger nullable

Used renders.

usedWatermarkedRendersinteger nullable

Used renders (watermarked).

averageRendersinteger nullable

Average renders over the last CHILI.GraFx.Platform.API.Modules.Subscription.Models.SubscriptionModel.AverageRendersPeriodDays days.

averageWatermarkedRendersinteger nullable

Average renders (watermarked) over the last CHILI.GraFx.Platform.API.Modules.Subscription.Models.SubscriptionModel.AverageRendersPeriodDays days.

averageRendersPeriodDaysinteger required

The number of days over which CHILI.GraFx.Platform.API.Modules.Subscription.Models.SubscriptionModel.AverageRenders and CHILI.GraFx.Platform.API.Modules.Subscription.Models.SubscriptionModel.AverageWatermarkedRenders are calculated.

maxRendersinteger nullable

Max renders available in subscription.

maxStorageinteger nullable

Max storage available in subscription in bytes.

storageUsedinteger required

Storage used in bytes.

startDatestring nullable

Subscription start date.

endDatestring nullable

Subscription end date.

subscriptionType'OnPremises' | 'Saas' required

Subscription type.

status'Inactive' | 'Active' required

Status of user subscription.

clientNamestring nullable

Client name which uses the subscription.

billingClientContactstring nullable

Client billing contact information.

templateDesignerSeatsTotalinteger nullable

Max count of template designer seats.

templateDesignerSeatsUsedinteger nullable

Using count of template designer seats.

isGraFxPricebookboolean required

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

pricebookVersionstring required

The pricebook version.

subscriptionTierstring required

The subscription tier.

maxTemplatesinteger required

The maximum amount of templates.

isWhitelabeledboolean required

Flag which indicates if the subscription is whitelabeled.

overdueInvoicesboolean required

Flag which indicates if the account has overdue invoices.

isPublisherEnabledboolean required

Flag which indicates if Publisher is enabled for the subscription.

isStudioEnabledboolean required

Flag which indicates if Studio is enabled for the subscription.

isExperienceEnabledboolean nullable

Flag which indicates if Experience is enabled for the subscription.

maxSpacesinteger nullable

The maximum amount of Experience spaces.

Example response

{
  "id": 1,
  "name": "CHILI (Online)",
  "displayName": "Temporary subscription",
  "usedRenders": 1000,
  "usedWatermarkedRenders": 1000,
  "averageRenders": 1000,
  "averageWatermarkedRenders": 1000,
  "averageRendersPeriodDays": 183,
  "maxRenders": 2500,
  "maxStorage": 250000000000,
  "storageUsed": 81959236,
  "environments": [
    {
      "id": 494,
      "guid": "432cf5d3-b432-4f32-b9dc-f8a14320aa0f",
      "name": "cp-eee-001",
      "region": "westeurope",
      "usedStorage": 1093314335,
      "backOfficeUri": "https://cp-000-000.chili-publish-sandbox.online/cp-000-000/interface.aspx"
    }
  ],
  "licenses": [
    {
      "id": "CPF-2022-0000001",
      "coresTotal": 16,
      "coresUsed": 2,
      "url": "https://chili-publish.com/Licenses/Details/00000000-0000-0000-0000-000000000000"
    }
  ],
  "startDate": "11/12/2022 12:15:32 AM",
  "endDate": "11/12/2023 12:15:32 PM",
  "clientName": "CHILI Group",
  "billingClientContact": "simple@example.com",
  "templateDesignerSeatsTotal": 6,
  "templateDesignerSeatsUsed": 4,
  "tenantInformation": {
    "sandboxEnvironmentsTotal": 4,
    "sandboxEnvironmentsUsed": 2,
    "productionEnvironmentsTotal": 4,
    "productionEnvironmentsUsed": 1
  },
  "isGraFxPricebook": true,
  "pricebookVersion": "2025",
  "subscriptionTier": "Basic",
  "maxTemplates": 10,
  "isPublisherEnabled": true,
  "isStudioEnabled": true,
  "isExperienceEnabled": true
}

Changes

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