API documentation

Endpoints

GET/client/:customerId/invoice/:invoiceId

Retrieve invoice details

Request this resource after selecting an invoice from the list. In addition to totals and states, the response contains Stripe line items when available and authenticated paths for downloading the PDFs.

Request
Build the URL with the parameters below and send the code in the Authorization header.
GEThttps://stripe-ix.betacode.tech/api/v1/client/:customerId/invoice/:invoiceId

Inputs and parameters

customerIdpathstring

Stripe Customer ID. Starts with cus_.

Required

invoiceIdpathstring

Stripe Invoice ID. Starts with in_.

Required

Request example

curl "https://stripe-ix.betacode.tech/api/v1/client/cus_Q1w2E3r4/invoice/in_1Q2w3E4r" \
  -H "Authorization: Bearer ixp_test_YOUR_ACCESS_CODE" \
  -H "Accept: application/json"
Response
On success, this endpoint returns JSON with Content-Type application/json.

Output example

{
  "id": "in_1Q2w3E4r",
  "number": "A-2026-0042",
  "customer_id": "cus_Q1w2E3r4",
  "display_name": "Acme, Lda.",
  "issued_at": "2026-08-18T10:30:00.000Z",
  "subtotal_cents": 10000,
  "discount_cents": 1000,
  "tax_cents": 2300,
  "tax_percent": 23,
  "total_cents": 12300,
  "currency": "eur",
  "status": "paid",
  "ix_sync_state": "synced",
  "ix_id": 98765,
  "ix_status": "settled",
  "lines": [
    {
      "id": "il_1AbCdEf",
      "description": "Consultoria",
      "quantity": 2,
      "subtotal_cents": 11000,
      "discount_cents": 1000,
      "discount_percent": 10,
      "unit_amount_cents": 5500,
      "amount_cents": 10000,
      "currency": "eur"
    }
  ],
  "lines_source": "stripe",
  "downloads": {
    "ix": "/api/v1/client/cus_Q1w2E3r4/invoice/in_1Q2w3E4r/ix/download",
    "stripe": "/api/v1/client/cus_Q1w2E3r4/invoice/in_1Q2w3E4r/stripe/download"
  }
}

Behavior

  • The relationship between customerId and invoiceId is validated before any data is returned.
  • lines_source is stripe when lines came from Stripe and none when they are unavailable.
  • downloads.ix is null until an InvoiceXpress document has been associated.

Integration notes

  • Download paths are relative to the same API host and require the same Bearer token.
  • Temporary line-item unavailability does not prevent stored invoice data from being returned.