reseller

POST `/v1/reseller/dunning`

Publish the next version of your ladder.

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението 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, за да можете да видите действителния отговор. Отворете този крайpoint в 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.

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 422 · 429

POST /v1/reseller/dunning