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