RevKeenDocs
StatusSupport
API Reference

Cancel an order

Cancels an order. Only orders that haven't been paid or fulfilled can be canceled. --- **Related endpoints** - `GET /orders` — List orders - `POST /orders` — Create an order - `GET /orders/{id}` — Retrieve an order - `PATCH /orders/{id}` — Update an order - `POST /orders/{id}/pay` — Pay for an order - `POST /orders/{id}/fulfill` — Fulfill an order **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).

POST
/orders/{id}/cancel

Cancels an order. Only orders that haven't been paid or fulfilled can be canceled.

Related endpoints

  • GET /orders — List orders
  • POST /orders — Create an order
  • GET /orders/{id} — Retrieve an order
  • PATCH /orders/{id} — Update an order
  • POST /orders/{id}/pay — Pay for an order
  • POST /orders/{id}/fulfill — Fulfill an order

Common errors

  • 400 invalid_request — malformed payload or failed validation.
  • 401 authentication_error — missing, invalid, expired, or revoked credential. Codes: authentication_failed, invalid_api_key, expired_api_key, api_key_revoked, session_invalid, merchant_required. Carries a WWW-Authenticate: Bearer challenge.
  • 404 resource_missing — the referenced resource does not exist or is not visible to your key.

Idempotency

Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.

Authorization

x-api-key<token>

Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.

In: header

Path Parameters

id*string

Order ID

Formatuuid

Request Body

application/json

Cancellation details

TypeScript Definitions

Use the request body type in TypeScript.

Parameters for canceling an order before fulfillment.

Response Body

application/json

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl -X POST "https://api.revkeen.com/v2/orders/00000000-0000-0000-0000-000000000000/cancel" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "string"
  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "object": "order",  "public_id": "string",  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",  "status": "draft",  "billing_type": "one_time",  "fulfillment_status": "unfulfilled",  "currency": "string",  "subtotal": 0,  "discount": 0,  "tax": 0,  "total": 0,  "amount_paid": 0,  "amount_refunded": 0,  "amount_due": 0,  "line_items": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",      "description": "string",      "quantity": 1,      "unit_price": 0,      "subtotal": 0,      "discount": 0,      "tax": 0,      "total": 0,      "metadata": {},      "position": 0    }  ],  "metadata": {},  "notes": "string",  "invoice_id": "f4c4edb8-11e0-4b33-bcc1-482dc59ebb32",  "subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "paid_at": "2019-08-24T14:15:22Z",  "canceled_at": "2019-08-24T14:15:22Z",  "fulfilled_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z"}

Update a meter PATCH

Update a meter's configuration. Note: `event_name` and `aggregation` are immutable after creation. --- **Related endpoints** - `GET /meters` — List meters - `POST /meters` — Create a meter - `GET /meters/{id}` — Get a meter - `POST /meters/{meterId}/prices` — Create a meter price - `GET /meters/{meterId}/prices` — List meter prices - `PATCH /meters/{meterId}/prices/{priceId}` — Update a meter price - `POST /meters/{meterId}/prices/{priceId}/deactivate` — Deactivate a meter price **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).

Create an order POST

Creates a new order with line items. Orders start in draft status. --- **Related endpoints** - `GET /orders` — List orders - `GET /orders/{id}` — Retrieve an order - `PATCH /orders/{id}` — Update an order - `POST /orders/{id}/pay` — Pay for an order - `POST /orders/{id}/cancel` — Cancel an order - `POST /orders/{id}/fulfill` — Fulfill an order **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).