reseller

POST `/v1/reseller/dunning`

Publish the next version of your ladder.

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл reseller.manage; ключ без нього відхиляється з кодом 403, а не 404.

Де вказується ідентифікатор вашої організації

Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.

Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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> }'

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

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`.

Параметри

Назва	Тип	Обов'язкове	Що це таке
`org_id (query)`	`Uuid`	Ні	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…

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`steps`	`DunningStep[]`	Так	—
`reason`	`string`	Так	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.

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`using_platform_default`	`boolean`	Так	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`	Так	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`	Так	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[]`	Так	Every version this reseller has published, newest first.

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 422 · 429

POST /v1/reseller/dunning