partner
POST /v1/partner/customers/{externalId}/trials/{trialId}/cancel
End a card-free trial you started, now.
Authentication
Send an API key as a bearer token. The key must carry the partner.domains permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/partner/customers/{externalId}/trials/{trialId}/cancel \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Ends a trial you started with createPartnerHostingOrder trial: true (the id is trial.trial_id on getPartnerHostingOrder). The trial goes canceled at once, its site stops serving and its deletion is scheduled, and nothing is billed before or after. The response is the trial ORDER: its trial.status reads canceled; the order's own status stays completed, because a settled $0 order is a historical fact. Repeating the call is safe and returns the same body. Refusals, details[0].code: not_owned (a 404 — not a trial you started for this customer), already_converted (it became a paid plan: cancel the subscription instead), already_ended (past its cut-off; its site is already stopped). Open this on hosting_orders.trial.cancel. Requires partner.domains.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
externalId (path) | string | Yes | 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… |
trialId (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
order_id | string | Yes | — |
human_ref | string | Yes | The reference the payment page returns to you as ?order=. |
pay_url | string | No | Only in the response that placed (or replayed) the order: the hosted page the customer pays on. It carries a secret that is stored nowhere — treat it as one. Absent on a trial… |
pay_expires_at | string | No | — |
org_id | string | Yes | — |
trial | PartnerHostingTrial | null | Yes | Present on an order placed with trial: true; null on every other order. Until fulfilment starts the trial, status is pending and the dates are null. |
replaces_subscription_id | object | No | The live plan subscription this order replaces, as named on the request (ADR 0036); null when the order ADDS a plan. Once fulfilled that subscription is canceled and… |
status | string | Yes | As on PartnerOrder. |
currency | string | Yes | — |
term_months | integer | Yes | — |
subtotal_minor | integer | Yes | — |
tax_minor | integer | Yes | — |
total_minor | integer | Yes | — |
lines | PartnerHostingOrderLine[] | Yes | — |
site | PartnerHostingOrderSite | null | Yes | — |
subscription_id | object | Yes | The subscription the paid plan line became; null until fulfilment. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429