reseller
POST /v1/reseller/dunning
Publish the next version of your ladder.
Uwierzytelnianie
Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie reseller.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.
Miejsce na identyfikator organizacji
Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.
Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
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> }'Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
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`.
Parametry
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
org_id (query) | Uuid | Nie | 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… |
Treść żądania
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
steps | DunningStep[] | Tak | — |
reason | string | Tak | 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. |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
using_platform_default | boolean | Tak | 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 | Tak | 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 | Tak | 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[] | Tak | Every version this reseller has published, newest first. |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 404 · 422 · 429