billing

GET `/v1/trials/eligibility`

Can this organization start a trial on this plan, and on what terms?

Pengesahan

Hantar kunci API sebagai token pembawa. Titik akhir ini tidak menyatakan kebenaran tertentu dalam spesifikasi, jadi berikan kunci anda kebenaran minimum yang diperlukan dan semak respons tersebut daripada membuat andaian.

Tempat ID organisasi anda diletakkan

Titik akhir ini mengambil org_id sebagai parameter pertanyaan. Biarkan ia kosong dan panggilan tersebut meliputi keseluruhan subpohon penyewaan anda; hantarkannya untuk mengecilkan panggilan kepada satu organisasi.

ID organisasi anda terletak pada skrin kekunci API dalam papan pemuka anda, di sebelah kekunci itu sendiri. Ia adalah ID yang sama dalam setiap panggilan yang anda buat.

Cuba

Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.

curl -X GET https://api.zinndigital.com/v1/trials/eligibility?plan_code=<plan_code> \
  -H "Authorization: Bearer zdk_live_…"

Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API

Butiran

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.

Parameter

Nama	Jenis	Diperlukan	Apakah ia
`plan_code (query)`	`string`	Ya	—
`org_id (query)`	`string`	Tidak	—

Respons

Nama	Jenis	Diperlukan	Apakah ia
`plan_code`	`string`	Ya	—
`eligible`	`boolean`	Ya	—
`duration_days`	`integer`	Tidak	—
`max_sites`	`integer`	Tidak	—
`requires_card`	`boolean`	Tidak	—
`reason`	`string<, no_trial_on_plan, no_billing_org, already_used>`	Ya	Empty when eligible.
`upgrade`	`TrialUpgradeOffer`	Tidak	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…

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 403