partner
POST /v1/partner/customers/{externalId}/boosts/{purchaseId}/cancel
Remove a customer's performance boost at the end of its paid month.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу partner.domains; кључ без ње се одбија уз 403, а не 404.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X POST https://api.zinndigital.com/v1/partner/customers/{externalId}/boosts/{purchaseId}/cancel \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
The partner twin of cancelBoostPurchase: the boost keeps working until ends_at (the end of its paid month), then the site drops back to its plan's limits; nothing is refunded. purchaseId is the boost's id — getPartnerSiteResources.held.id, or the purchase_id on the order line that bought it. It cannot touch a plan: only a performance-boost purchase is accepted (422 not_a_boost otherwise), and a subscription is not a purchase. Refusals (details[0].code): not_a_boost, not_owned (another of your customers), already_cancelled (removal already scheduled), already_ended; an id you cannot reach is a 404. Requires partner.domains.
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
externalId (path) | string | Да | YOUR id for that customer — whatever your own system calls them. It is what makes linking idempotent, and it is scoped to your partner programme: another partner's id is a 404… |
purchaseId (path) | string | Да | — |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
purchase_id | string | Да | — |
extra_code | string | Да | — |
ends_at | object | Да | The last day the boost works (the end of the paid month); after it the site drops back to its plan's limits at the next converge. |
Грешке које ова крајња тачка може вратити
401 · 403 · 404 · 422 · 429