billing

GET `/v1/trials/eligibility`

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

Autentikasi

Kirimkan kunci API sebagai token bearer. Titik akhir ini tidak menyatakan izin tertentu dalam spesifikasi, jadi berikan kunci Anda izin minimum yang diperlukan dan periksa responsnya alih-alih berasumsi.

Tempat ID organisasi Anda dimasukkan

Titik akhir ini menerima org_id sebagai parameter kueri. Kosongkan parameter tersebut dan panggilan ini akan mencakup seluruh subpohon penyewa Anda; kirimkan untuk mempersempit panggilan ke satu organisasi.

ID organisasi Anda berada di layar kunci API di dasbor Anda, di sebelah kunci itu sendiri. Itu adalah ID yang sama dalam setiap panggilan yang Anda buat.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

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

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

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	Wajib	Tentang apa ini
`plan_code (query)`	`string`	Ya	—
`org_id (query)`	`string`	Tidak	—

Tanggapan

Nama	Jenis	Wajib	Tentang apa ini
`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…

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403