Skip to main content
GET
/
orders
/
{id}
Typescript (SDK)
import { Crevio } from "@crevio/sdk";

const crevio = new Crevio({
  apiKey: process.env["CREVIO_API_KEY"] ?? "",
});

async function run() {
  const result = await crevio.orders.get({
    id: "<id>",
  });

  console.log(result);
}

run();
{
  "id": "<string>",
  "object": "<string>",
  "status": "succeeded",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "amount": 123,
  "currency": "<string>",
  "amount_refunded": 123,
  "customer": "<string>",
  "checkout": "<string>",
  "line_items": [
    {
      "id": "<string>",
      "object": "<string>",
      "quantity": 123,
      "price_variant": "<string>",
      "product": "<string>",
      "order": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Path Parameters

id
string
required

The resource ID (e.g., "prod_abc123") or slug (e.g., "my-product")

Query Parameters

expand
string

Comma-separated relations to expand: customer, line_items

Response

Order details

id
string
required
object
string
required
status
enum<string>
required
Available options:
succeeded,
pending,
failed,
refunded,
partially_refunded,
disputed
created_at
string<date-time>
required
updated_at
string<date-time>
required
amount
number
required
currency
string
required
amount_refunded
number
required
customer
required

ID by default, full object when expanded

checkout
string
required
line_items
object[]