Skip to main content
POST
/
orders
/
{id}
/
cancel
Cancelling an order
curl --request POST \
  --url https://api.peeker.ai/partner/v1/orders/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domains": [
    "acme-mail.com",
    "dom_01HZX0D02A2B3C4D5E6F7G8H"
  ]
}
'
{ "data": { "id": "ord_01HZX0OR1A2B3C4D5E6F7G8H", "status": "cancel_scheduled", "cancellation_scheduled_at": "2026-05-08T12:00:00Z", "cancels_at": "2026-06-07T12:00:00Z", "domains": [ { "id": "dom_01HZX0D01A2B3C4D5E6F7G8H", "domain": "domain-01.com" }, { "id": "dom_01HZX0D02A2B3C4D5E6F7G8H", "domain": "domain-02.com" } ] } }
curl --request POST \
  --url https://api.peeker.ai/partner/v1/orders/ord_01HZX0OR1A2B3C4D5E6F7G8H/cancel \
  --header 'Authorization: Bearer pk_test_<your-test-key>'
Cancels every domain on the order. No request body is needed.
Cancelling an order schedules the inboxes to be deleted at the end of the renewal period. Cancelling an individual Google domain cancels the 2-3 licenses on that domain and only reduces that part of the order amount.

Authorizations

​
Authorization
string
header
default:Bearer pk_test_<your-test-key>
required

Your partner API key. Use pk_live_… against the live system or pk_test_… against the sandbox.

Path Parameters

​
id
string
required

The order ID, e.g. ord_01HZX.

Example:

"ord_01HZX0OR1A2B3C4D5E6F7G8H"

Body

application/json
​
domains
string[]
required

Include only when cancelling specific domains. Each entry can be a dom_… ID or a raw domain name.

Minimum array length: 1
Example:
[
  "acme-mail.com",
  "dom_01HZX0D02A2B3C4D5E6F7G8H"
]

Response

200 - application/json

Cancellation schedule for the order or selected domains.

​
data
object
required
Last modified on June 16, 2026