Cancel an order
Only confirmed API-origin purchases support this action. Dashboard purchases,
including purchases paid with credits, return 409 invalid_request: manage
cancellation in the Peeker dashboard. Replacements keep the original
purchase origin, even when requested through the API. Ambiguous origin also
returns 409 before any action starts. Existing API-origin Stripe-funded
requests return 202 with saved cancellation requests to poll. No scheduled
webhook is emitted until required billing and Peeker updates succeed. Shared Stripe
subscriptions use domain/item cancellation so sibling orders remain active.
Registration-only domains in a whole-order cancellation stop renewing without
changing the shared subscription or their paid expiration date. Selected Stripe
domains and whole orders sharing a subscription are limited to 100 domains per request.
Every selector must match this order; an invalid selector rejects the full request.
Cancels the whole order, or only the domains you list. Omit the
body to cancel everything. Finalization is scheduled at the current
paid inbox billing period end (cancels_at). Selected inboxes must
share a billing period end; conflicting dates return 409 invalid_request.
Microsoft domains cancelled within 7 days of purchase or renewal end immediately
(order.domains_cancelled, or order.cancelled when nothing else remains) and that
month is refunded to credits; the rest of the request keeps cancels_at.
Google renewals remain payable once due. Set force to true for immediate
Google cancellation without a refund. Insufficient credits never block cancellation;
any already-due renewal is recorded as owed for separate collection. Supplier shutdown
is asynchronous and is not confirmed by this response.
See How orders work.
- Cancel whole order
- Cancel specific domains
Authorizations
Partner API key (pk_live_… or pk_test_…).
Path Parameters
Order ID (ord_…).
"ord_01HZX0OR1A2B3C4D5E6F7G8H"
Body
Response
Cancellation schedule for the order or selected domains.
- Option 1
- Option 2