認証
ベアラー トークンとして API キーを送信します。キーには reseller.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
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コンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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