Skip to main content
POST
/
orders
/
{id}
/
cancel
curl --request POST \ --url https://api.peeker.ai/api/partner/v1/orders/{id}/cancel \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "scope": "order" } '
{
  "data": {
    "id": "ord_01HZX0OR1A2B3C4D5E6F7G8H",
    "user_id": "usr_01HZX0C6Z3K4M5N6P7Q8R9S0",
    "email": "client@example.com",
    "bundle_id": "bun_123",
    "status": "in_progress",
    "domain_count": 12,
    "costs": {
      "total_cents": 36800,
      "currency": "usd",
      "line_items": [
        {
          "type": "google_license",
          "quantity": 20,
          "amount_cents": 2000
        },
        {
          "type": "microsoft_license",
          "quantity": 2,
          "amount_cents": 1800
        },
        {
          "type": "domain_registration",
          "quantity": 10,
          "amount_cents": 33000
        }
      ]
    },
    "domains": {
      "registered": [
        "domain-01.com",
        "domain-02.com"
      ],
      "imported": [
        "team-acme.com"
      ]
    },
    "users": [
      {
        "first_name": "Sam",
        "last_name": "Lee",
        "profile_picture_url": null
      }
    ],
    "created_at": "2026-05-08T12:00:00Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.peeker.ai/llms.txt

Use this file to discover all available pages before exploring further.

{ "scope": "order" }
Cancels every domain on the order. Status moves to cancel_scheduled immediately.
You can’t cancel a single inbox or part of a Google license. It’s the whole order or whole domains. Cancellation finalizes after a short grace window.

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
​
scope
enum<string>
required

Cancel the whole order.

Available options:
order
Example:

"order"

Response

200 - application/json

Full order detail returned by GET /orders/{id} and order webhooks.

​
data
object
required
Last modified on May 14, 2026