staqlydocs
REST APIAPI referenceAuth

Current plan and usage

Current plan and usage (the Community Edition reports the unlocked plan, named Community Edition)

Every request sends Authorization: Bearer ...: the access token in local mode, an API key stk_... in cloud mode. Use Send to try it against your cloud instance with your API key.

GET
/v1/workspace/usage

Authorization

headerAuthorizationBearer <token>

API key (stk_...), or in the Community Edition the access token (stk_local_...)

Response Body

OK

application/json
  1. response
plan*
period*string
usage*
plan_expires_at*|

End of the free trial or paid period; null = no end. A Stripe-billed plan adds a 3-day payment grace after its paid or trial period, so count a trial down to trial_ends_at instead.

Formatdate-time
trial_ends_at*|

When the 7-day free trial ends: Stripe's trial_end for a Stripe trial, the end of the server-side trial on a server without billing; null when the workspace is in no trial.

Formatdate-time
suspended*boolean

The trial or paid period ended unpaid. The workspace is read-only: reads and exports work, other changes answer 402 plan_expired until it is a plan is paid for (POST /v1/billing/checkout).

posts_by_status*

Posts created this period, counted by their current status (statuses with no posts are left out).

webhook_deliveries*

Webhook deliveries right now. failed gave up after every retry and can be redelivered.

curl -X GET 'https://staqly.example.com/v1/workspace/usage'
{  "plan": {    "id": "plus",    "name": "string",    "price_month": 29,    "price_year": 276,    "currency": "eur",    "highlight": true,    "limits": {      "posts_per_month": 0,      "channels": 0,      "alerts": 0,      "webhooks": 0,      "api_keys": 0,      "storage_bytes": 0,      "max_upload_bytes": 0,      "data_export": true,      "x_posts_per_period": 450    },    "features": [      "string"    ],    "entitlements": [      "string"    ],    "base_limits": {      "posts_per_month": 0,      "channels": 0,      "alerts": 0,      "webhooks": 0,      "api_keys": 0,      "storage_bytes": 0,      "max_upload_bytes": 0,      "data_export": true,      "x_posts_per_period": 450    },    "limit_bonuses": [      {        "limit": "channels",        "add": 10,        "unlimited": true,        "from": "Channels pack"      }    ]  },  "period": "2026-10",  "usage": {    "posts_per_month": 0,    "channels": 0,    "seats": 0,    "alerts": 0,    "webhooks": 0,    "api_keys": 0,    "storage_bytes": 0,    "x_posts_per_period": 0  },  "plan_expires_at": "2019-08-24T14:15:22Z",  "trial_ends_at": "2019-08-24T14:15:22Z",  "suspended": true,  "posts_by_status": {    "draft": 2,    "scheduled": 2,    "published": 1  },  "webhook_deliveries": {    "queued": 0,    "retrying": 0,    "failed": 0  }}