reseller

POST `/v1/reseller/dunning`

Publish the next version of your ladder.

Նույնականացում

Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա reseller.manage թույլտվությունը. առանց դրա բանալին մերժվում է 403, և ոչ թե 404 կարգավիճակով:

Որտեղ տեղադրվում է ձեր կազմակերպության ID-ն

Այs վերջնակետը ընդունում է 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

POST /v1/reseller/dunning