partner
GET /v1/partner/customers/{externalId}/hosting-orders/{orderId}
Read one of your customer's hosting orders, and the site it became.
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 GET https://api.zinndigital.com/v1/partner/customers/{externalId}/hosting-orders/{orderId} \
-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
The authoritative state of a hosting order you placed: its status, the subscription the paid plan became (subscription_id, null until fulfilment), and — when the order carried a site — the site's id and status once fulfilment has created it, or error with the reason it could not be. A trial order also carries trial: its status, its ends_at and cutoff_at, and the plan to subscribe to. A domain order, another customer's or another partner's order is a 404. There is no pay_url here. 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… |
orderId (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 · 429