Products
curl --request GET \
--url https://api.sortx.co.uk/entitlements/products \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/entitlements/products', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/entitlements/products"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"products": [
{
"id": "<string>",
"name": "<string>",
"job": "<string>",
"automates": [
"<string>"
],
"manualPath": "<string>",
"availability": "sold",
"price": {
"model": "monthly",
"monthlyPence": 123
},
"state": "active",
"source": "operator",
"endsAt": "<string>",
"awaitingPayment": true,
"endedAt": "<string>"
}
],
"subscription": {
"status": "<string>",
"currentPeriodEnd": "<string>",
"suspended": true,
"inDunning": true,
"billingAccount": true,
"paymentFailedAt": "<string>",
"graceEndsAt": "<string>",
"graceLapsed": true,
"endedForNonPaymentAt": "<string>"
},
"history": [
{
"id": "<string>",
"productId": "<string>",
"action": "purchased",
"actorKind": "user",
"actorUserId": "<string>",
"endsAt": "<string>",
"occurredAt": "<string>"
}
],
"canManageBilling": true,
"fairUse": {
"users": 123,
"properties": 123,
"storageGb": 123
}
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}entitlements
Products
Every product with its price, availability and this workspace’s state
GET
/
entitlements
/
products
Products
curl --request GET \
--url https://api.sortx.co.uk/entitlements/products \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/entitlements/products', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/entitlements/products"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"products": [
{
"id": "<string>",
"name": "<string>",
"job": "<string>",
"automates": [
"<string>"
],
"manualPath": "<string>",
"availability": "sold",
"price": {
"model": "monthly",
"monthlyPence": 123
},
"state": "active",
"source": "operator",
"endsAt": "<string>",
"awaitingPayment": true,
"endedAt": "<string>"
}
],
"subscription": {
"status": "<string>",
"currentPeriodEnd": "<string>",
"suspended": true,
"inDunning": true,
"billingAccount": true,
"paymentFailedAt": "<string>",
"graceEndsAt": "<string>",
"graceLapsed": true,
"endedForNonPaymentAt": "<string>"
},
"history": [
{
"id": "<string>",
"productId": "<string>",
"action": "purchased",
"actorKind": "user",
"actorUserId": "<string>",
"endsAt": "<string>",
"occurredAt": "<string>"
}
],
"canManageBilling": true,
"fairUse": {
"users": 123,
"properties": 123,
"storageGb": 123
}
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}Authorizations
A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.