Skip to main content
GET
/
invoices
/
{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.invoices.get({
    id: "<id>",
  });

  console.log(result);
}

run();
{
  "id": "<string>",
  "object": "<string>",
  "number": "<string>",
  "description": "<string>",
  "customer_name": "<string>",
  "email_address": "<string>",
  "due_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "amount": 123,
  "currency": "<string>",
  "paid_at": "<string>",
  "price_variant": "<string>",
  "customer": "<string>",
  "order": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://crevio.co/docs/llms.txt

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

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, price_variant, order

Response

Invoice details

​
id
string
required
​
object
string
required
​
status
enum<string>
required
Available options:
open,
paid,
past_due,
void
​
number
string
required
​
description
string | null
required
​
customer_name
string | null
required
​
email_address
string | null
required
​
due_at
string<date-time>
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
amount
number | null
required
​
currency
string | null
required
​
paid_at
string
required
​
price_variant
required

ID by default, full object when expanded

​
customer

ID by default, full object when expanded

​
order

ID by default, full object when expanded