RevKeen Docs
Api reference

Create an order

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 unauthenticated — missing, malformed, or revoked API key.
  • 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.

POST
/orders

Authorization

x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

In: header

Request Body

application/json

Order creation details

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.revkeen.com/v2/orders" \  -H "x-api-key: $REVKEEN_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "customer_id": "00000000-0000-0000-0000-000000000000",    "currency": "usd",    "billing_type": "one_time",    "line_items": [      {        "product_id": "00000000-0000-0000-0000-000000000000",        "description": "string",        "quantity": 1,        "unit_price": 0,        "metadata": {}      }    ],    "metadata": {},    "notes": "string",    "expires_at": "2026-01-01T00:00:00Z",    "invoice_id": "00000000-0000-0000-0000-000000000000",    "subscription_id": "00000000-0000-0000-0000-000000000000"  }'
{
  "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"
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string"
  }
}
Edit on GitHub