Autentikasi
Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin reseller.manage; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.
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 POST https://api.zinndigital.com/v1/reseller/dunning \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "steps": <DunningStep[]>, "reason": <string> }'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
Publishing, never editing. A ladder changed while customers are halfway up it must not change what those customers were already told, so every save is a new immutable version and runs already climbing keep the one they started on. A 422 carries the validator's own sentence, naming which rung is wrong and why - a `warn` whose grace disagrees with the next rung would tell a customer a deadline that is not the deadline. Requires `reseller.manage`.
Parameter
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
org_id (query) | Uuid | Tidak | Which of your organizations this applies to. Required only when you belong to more than one here - otherwise it is inferred, and an id outside your direct memberships is a 404 r… |
Isi permintaan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
steps | DunningStep[] | Ya | — |
reason | string | Ya | Why it changed. Required: a ladder decides when a paying customer is suspended, and a version with no reason is one nobody can explain a year later. |
Tanggapan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
using_platform_default | boolean | Ya | True when the reseller has published no ladder of their own. `active_version` then carries the PLATFORM rungs their clients are chased on today, so the screen never has to rende… |
max_total_days | integer | Ya | The longest a whole ladder may run. A hard coupling, not a preference: the rebill workflow's execution timeout is derived from it, and a longer ladder would be terminated mid-cl… |
active_version | DunningPolicyVersion | Ya | The ladder in force. On the platform-default view this is synthesised rather than read from a row, so `id` is null and `version` is 0. |
versions | DunningPolicyVersion[] | Ya | Every version this reseller has published, newest first. |
Kesalahan yang dapat dikembalikan oleh titik akhir ini
401 · 403 · 404 · 422 · 429