List invoices

GET /api/invoices

Returns up to 24 recent Stripe invoices for the authenticated user.

Responses

invoices object[]

id string Stripe invoice ID Example: in_1abc2def3ghi

number string | null Human-readable invoice number Example: INV-0001

amount integer Amount paid in cents

currency string Example: usd

status string draftopenpaidvoiduncollectible

created integer Unix timestamp

pdfUrl string | null (uri)

hostedUrl string | null (uri)

description string | null

errorrequired object

coderequired string Machine-readable error code UNAUTHORIZEDFORBIDDENNOT_FOUNDVALIDATION_FAILEDRATE_LIMITEDSLUG_TAKENSLUG_RESERVEDDOMAIN_IN_USEAPP_LIMIT_REACHEDSUBSCRIPTION_REQUIREDSUBSCRIPTION_EXISTSNO_PAYMENT_METHODNO_ACTIVE_SUBSCRIPTIONNOT_CANCELINGALREADY_CANCELINGSUBSCRIPTION_CANCELINGSAME_PLANCARD_ERRORPAYMENT_ERRORNO_STRIPE_CUSTOMERCERT_CREATION_FAILEDDEPLOY_FAILEDAPI_KEY_LIMIT_REACHEDINVALID_IDEMPOTENCY_KEYIDEMPOTENCY_KEY_REUSEINTERNAL_ERROR

messagerequired string Human-readable error description

docUrl string (uri) Link to relevant API documentation for this error Example: https://orbitkit.io/api/errors/#unauthorized

details object[] Additional validation details (Zod errors)

errorrequired object

messagerequired string Human-readable error description

docUrl string (uri) Link to relevant API documentation for this error Example: https://orbitkit.io/api/errors/#unauthorized

details object[] Additional validation details (Zod errors)

Language

URL

GET https://api.orbitkit.io/api/invoices

curl -X GET "https://api.orbitkit.io/api/invoices" \
  -H "Authorization: Bearer $ORBITKIT_API_KEY"

const response = await fetch("https://api.orbitkit.io/api/invoices", {
  method: "GET",
  headers: {
    "Authorization": "Bearer " + apiKey,
  },
});

const data = await response.json();
console.log(data);

var request = URLRequest(url: URL(string: "https://api.orbitkit.io/api/invoices")!)
request.httpMethod = "GET"
request.setValue("Bearer \(apiKey)", forHTTPHeaderField: "Authorization")

let (data, _) = try await URLSession.shared.data(for: request)
let json = try JSONSerialization.jsonObject(with: data)
print(json)

200

{
  "invoices": [
    {
      "id": "in_1abc2def3ghi",
      "number": "INV-0001",
      "amount": 0,
      "currency": "usd",
      "status": "draft",
      "created": 0,
      "pdfUrl": "https://example.com",
      "hostedUrl": "https://example.com",
      "description": "string"
    }
  ]
}

401

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or expired token",
    "docUrl": "https://orbitkit.io/api/errors/#unauthorized"
  }
}

404

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "docUrl": "https://orbitkit.io/api/errors/#not-found"
  }
}