BillKit/DocsConsole
Invoices

Get invoice

Retrieve one invoice, with its line items.

GET/v1/invoices/{invoice_id}
Operation get_invoice·Scope invoices:read·OpenAPI v1.1.0

Parameters

ParameterDescription
invoice_idstring · pathrequiredId of the invoice, which starts inv_.
expandstring | null · queryoptionalComma-separated related objects to include in the response. Expandable here: customer. An unknown name is a 400, and embedding another resource needs that resource's read scope. At most 256 characters.

Returns

Returns an InvoiceResponse object.

Errors

StatusCause
400The request was refused (type: invalid_request_error): a required parameter is missing (parameter_missing), one failed validation (parameter_invalid) or is not one the operation takes (parameter_unknown), and param names it.
401No credential, or one that does not authenticate.
402The account is suspended (tenant_suspended), or the payment provider refused a charge or refund the call made (type: payment_error, code: payment_refused).
403Authenticated, but not allowed: missing scope (insufficient_scope), a key of the wrong mode (mode_mismatch), or a refused origin. Needs the invoices:read scope.
404No such object in this account and mode.
429Rate limited. Retry-After says when to try again.
500Something failed on BillKit's side (type: api_error). Retry with the same Idempotency-Key.
503Temporarily unable to serve. reason says whether the request was attempted.
Request · curl
curl -X GET https://api.billkit.eu/v1/invoices/inv_9XKp2vQ1 \
  -H "Authorization: Bearer $BILLKIT_API_KEY"
Response · 200 OK
{
  "billing_address_at_invoice_time": {
    "key": "value"
  },
  "created": 1789392000,
  "currency": "EUR",
  "customer": {
    "country_code": "NL",
    "email": "ada@example.com",
    "id": "obj_9XKp2vQ1",
    "name": "Ada Lovelace",
    "object": "customer.summary"
  },
  "customer_business_name_at_invoice_time": "string",
  "customer_email_at_invoice_time": "ada@example.com",
  "customer_id": "cus_9XKp2vQ1",
  "customer_name_at_invoice_time": "string",
  "customer_vat_number_at_invoice_time": "string",
  "discount_cents": 1900,
  "due_at": 1789392000,
  "id": "inv_9XKp2vQ1",
  "lines": [
    {
      "amount_cents": 1900,
      "currency": "EUR",
      "description": "string",
      "id": "ili_9XKp2vQ1",
      "object": "invoice_line_item",
      "period_end": 0,
      "period_start": 0,
      "quantity": 0,
      "tax_rate_basis_points": 0
    }
  ],
  "livemode": false,
  "number": "string",
  "object": "invoice",
  "one_shot_payment_id": "osp_9XKp2vQ1",
  "paid_at": 1789392000,
  "payment_id": "pay_9XKp2vQ1",
  "pdf_url": "https://acme.example/welcome",
  "status": "open",
  "subscription_id": "sub_9XKp2vQ1",
  "subtotal_cents": 1900,
  "tax_cents": 1900,
  "tax_country_code": "NL",
  "tax_reverse_charged": false,
  "total_cents": 1900,
  "voided_at": 1789392000
}