reseller

POST `/v1/reseller/clients/{orgId}/plan`

Put a client on a plan — call this before provisioning their first service.

પ્રમાણીકરણ

એપીઆઈ કી (API key) ને બેરર ટોકન તરીકે મોકલો. કી પાસે reseller.provision પરવાનગી હોવી આવશ્યક છે; તેના વગરની કીને 404 ને બદલે 403 સાથે અસ્વીકાર કરવામાં આવશે.

જ્યાં તમારી સંસ્થા આઈડી જાય છે

આ એન્ડપૉઇન્ટ URL માં જ તમારી સંસ્થાની આઈડી orgId તરીકે લે છે. તેને પાથમાં બદલો — તેના બદલે બીજું કોઈ હેડર કે ક્વેરી પૅરામીટર કામ કરશે નહીં.

તમારી સંસ્થાની આઈડી તમારા ડેશબોર્ડ પર API કી સ્ક્રીન પર, કી ની બાજુમાં જ છે. તે તમે કરો છો તે દરેક કૉલમાં સમાન આઈડી છે.

આયમાવો

કોઈપણ કૌંસમાં રહેલી બાબતને તમારા પોતાના મૂલ્યોથી બદલો અને કી પ્લેસહોલ્ડરને તમારા ડેશબોર્ડની કીથી બદલો.

curl -X POST https://api.zinndigital.com/v1/reseller/clients/{orgId}/plan \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "plan_code": <string> }'

साइन ઇન કરેલ છે? તમારા ડેશબોર્ડમાં આવેલું API કન્સોલ તમારી વાસ્તવિક સંસ્થાની આઈડી અને તમારી પોતાની કી ભરે છે, અને લાઇવ API સામે વિનંતી ચલાવે છે જેથી તમે વાસ્તવિક પ્રતિસાદ જોઈ શકો. આ અંતિમબિંદુને API કન્સોલમાં ખોલો

વિગતો

Grants the client organization the plan your product sells, and returns the subscription_id to pass to createSite. Requires reseller.provision. ⛔⛔ A provisioning module MUST call this before createSite, and omitting it is a silent, total loss of the invoice. A newly created organization has no subscription, and createSite has no plan field — so a site provisioned without one lands with no plan at all. Your wholesale statement is built from your clients' live subscriptions, so there is no line for that service and Zinn® bills you nothing while the hosting runs; the client inherits no entitlements, so no quota is applied to their box; and changeResellerServicePackage has nothing to change, so an upgrade you sell cannot be performed. Nothing anywhere reports this — the site provisions and serves perfectly. Your client is never invoiced by Zinn®. The subscription is granted comped: it exists to carry entitlements and to put a line on your wholesale statement, and our renewal billing skips it. You bill your client; we bill you. A second service for the same client. On the same plan this is a no-op and returns 200 with created: false — the plan's own site allowance covers the extra site, so nothing further is granted and a retried provision cannot disturb the subscription it is re-establishing. On a different plan it is refused 422, because replacing the live plan would leave one of the two services unbilled. Either sell both on the same plan, or set the client up as a separate client record. To move a client to a different plan, use changeResellerServicePackage on the service. 422 for an unknown plan code and for a plan that is not for sale. 409 when the client's existing usage does not fit the plan being granted, with the real numbers.

પેરામીટર્સ

નામ	પ્રકાર	જરૂરી	તે શું છે
`orgId (path)`	`Uuid`	હા	One of your client organizations.
`org_id (query)`	`Uuid`	ના	Which of YOUR organizations is asking. Required only when you belong to more than one.

રિકવેસ્ટ બોડી

નામ	પ્રકાર	જરૂરી	તે શું છે
`plan_code`	`string`	હા	The plan to put this client on, by code — the value your product's module settings carry. The newest active version of it is always what is granted.
`interval`	`string`	ના	Billing interval for the wholesale line. Defaults to `monthly`.

જવાબ

નામ	પ્રકાર	જરૂરી	તે શું છે
`client_org_id`	`Uuid`	હા	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`subscription_id`	`string`	ના	Pass this as `subscription_id` on `createSite`. Null when the client is on no plan — provisioning a site in that state is what leaves it unbilled.
`plan_code`	`string`	ના	—
`plan_name`	`string`	ના	—
`interval`	`string`	ના	—
`created`	`boolean`	હા	True when this call granted the plan, false when the client was already on it. A retried provision needs the difference without inferring it from a timestamp.
`wholesale_amount_minor`	`integer`	ના	What Zinn® charges you per period. `null`, never `0`, when unpriced.
`wholesale_currency`	`string`	ના	—

આ એન્ડપોઇન્ટ જે ભૂલો પરત કરી શકે છે

401 · 403 · 404 · 409 · 422 · 429

POST /v1/reseller/clients/{orgId}/plan