billing
GET /v1/trials/eligibility
Can this organization start a trial on this plan, and on what terms?
Authentification
Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.
Où insérer l'ID de votre organisation
Cet point de terminaison prend org_id comme paramètre de requête. Omettez-le et l'appel couvrira l'ensemble de votre sous-arbre de location ; envoyez-le pour restreindre l'appel à une seule organisation.
L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/trials/eligibility?plan_code=<plan_code> \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
plan_code (query) | string | Oui | — |
org_id (query) | string | Non | — |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
plan_code | string | Oui | — |
eligible | boolean | Oui | — |
duration_days | integer | Non | — |
max_sites | integer | Non | — |
requires_card | boolean | Non | — |
reason | string<, no_trial_on_plan, no_billing_org, already_used> | Oui | Empty when eligible. |
upgrade | TrialUpgradeOffer | Non | 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… |
Erreurs que cet point de terminaison peut renvoyer
401 · 403