billing
GET /v1/trials
This organization's free trial, if it has one.
Authentication
Send an API key as a bearer token. The endpoint checks billing.view; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/trials \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Returns {"data": null} when there is no trial. ⛔ Not a 404: "you have no trial" is an ordinary answer to this question and the dashboard renders an offer from it — a 404 would make the ordinary case look like an error.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | Trial | Yes | — |
Errors this endpoint can return
401 · 403