reseller
GET /v1/reseller/dunning
Your own dunning ladder, and its history.
Autenticazione
Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione reseller.view; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.
L'ID della tua organizzazione va qui
Questo endpoint accetta org_id come parametro di query. Omettilo e la chiamata coprirà l'intero sottoalbero del tuo tenant; invialo per limitare la chiamata a una singola organizzazione.
L'identificativo della tua organizzazione si trova nella schermata delle chiavi API nella tua dashboard, accanto alla chiave stessa. È lo stesso identificativo in ogni chiamata che effettui.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
curl -X GET https://api.zinndigital.com/v1/reseller/dunning \
-H "Authorization: Bearer zdk_live_…"Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
The schedule your clients are chased on when a payment fails - your retry timings, your grace period, your suspension threshold and your own reminder copy. If you have not published one, this answers `using_platform_default: true` with the rungs your clients actually climb today, because the platform ladder is the fallback. It never returns an empty ladder: that would describe a system in which nobody is chased at all. Requires `reseller.view`.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
org_id (query) | Uuid | No | 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… |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
using_platform_default | boolean | Sì | 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 | Sì | 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 | Sì | 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[] | Sì | Every version this reseller has published, newest first. |
Errori che questo endpoint può restituire
401 · 403 · 404 · 429