Peeker Partner API

POST

orders

{id}

cancel

Cancel 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"
      }
    ]
  }
}

Cancel whole order
Cancel specific domains

curl --request POST \
  --url https://api.peeker.ai/partner/v1/orders/ord_01HZX0OR1A2B3C4D5E6F7G8H/cancel \
  --header 'Authorization: Bearer pk_test_<your-test-key>'

Cancels the whole order. No body needed.

{
  "domains": ["acme-mail.com", "dom_01HZX0D02A2B3C4D5E6F7G8H"]
}

Cancels only these domains (dom_… ID or name).

Cancel is accepted right away (cancel_scheduled) and finishes 30 days later (cancels_at). Cancelling the whole order ends in order.cancelled. Cancelling some domains can leave the order active (order.domains_cancelled). Those seats stop renewing after the 30 days. The order costs field is not rewritten when you schedule the cancel.

Authorizations

Authorization

string

header

default:Bearer pk_test_<your-test-key>

required

Partner API key (pk_live_… or pk_test_…).

Path Parameters

string

required

Order ID (ord_…).

Example:

"ord_01HZX0OR1A2B3C4D5E6F7G8H"

Body

application/json

domains

string[]

required

Domains to cancel (dom_… ID or name). Omit the body to cancel the whole order.

Minimum array length: 1

Example:

[
  "acme-mail.com",
  "dom_01HZX0D02A2B3C4D5E6F7G8H"
]

Response

Cancellation schedule for the order or selected domains.

data

object

required

Show child attributes

Last modified on August 25, 2026

Account

Provider workspaces

Bundles

Domains

Domain pool

Orders

Domain swaps

Cancel an order

Authorizations

Path Parameters

Body

Response