billing
GET /v1/trials/eligibility
Can this organization start a trial on this plan, and on what terms?
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
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/eligibility?plan_code=<plan_code> \
-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
Lets a CTA be honest **before** it is clicked. Without it the only way to learn that a plan has no trial, or that this organization has already had one, is to press the button and read a 422 — which is how a "Start free trial" button that cannot start a free trial stays on a pricing page for months. `reason` distinguishes the cases deliberately: "this plan has no trial" and "you have already had yours" lead a customer to do completely different things, and a bare `eligible: false` would collapse them into one shrug.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
plan_code (query) | string | Yes | — |
org_id (query) | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
plan_code | string | Yes | — |
eligible | boolean | Yes | — |
duration_days | integer | No | — |
max_sites | integer | No | — |
requires_card | boolean | No | — |
reason | string<, no_trial_on_plan, no_billing_org, already_used> | Yes | Empty when eligible. |
upgrade | TrialUpgradeOffer | No | The plan the customer asked about, priced in their currency, so a refusal ends in a decision rather than a dead end. ⚖️ Owner instruction 2026-08-19: *"if they try to start a ne… |
Errors this endpoint can return
401 · 403