Skip to main content
GET
Retrieve an invoice

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required
Example:

"inv_drjjua6ampd1op2fg98k89x8"

Response

Retrieve the invoice details

object
enum<string>
required
Available options:
invoice
id
string
required

Unique identifier of the invoice.

Example:

"inv_drjjua6ampd1op2fg98k89x8"

customer
string
required

ID of the customer the invoice belongs to.

Example:

"cus_a8n8ol7yd4h0wohx824f0bui"

subscription
string
required

ID of the subscription the invoice belongs to.

Example:

"sub_jd8mlscm062jb6ks50tck9gi"

invoice_number
string
required

Human-readable invoice number displayed on the invoice document

Example:

"H62SU12A-003"

month
number
required

Numeric month (1-12) for which the invoice is issued

Example:

4

year
number
required

Four-digit year for which the invoice is issued

Example:

2025

period_start
string
required

Timestamp marking the beginning of the billing period (inclusive)

Example:

"2025-03-31T22:00:00Z"

period_end
string
required

Timestamp marking the end of the billing period (exclusive)

Example:

"2025-04-30T22:00:00Z"

period_number
number
required

Sequential number of the billing period within the subscription (1-based)

Example:

3

status
enum<string>
required

Current status of the invoice:

Available options:
open,
paid,
voided
Example:

"open"

type
enum<string>
required

Discriminator for usage invoices, which bill metered electricity consumption for the period.

Available options:
usage
Example:

"usage"

usage
number
required

Total energy consumption in kilowatt-hours (kWh) during the billing period

Example:

100

total
number
required

Total amount due in euros (EUR) including all fees, taxes, and energy costs

Example:

110.04

issued_at

Timestamp when the invoice was issued

Example:

"2024-03-14T12:00:00Z"

paid_at

Timestamp when the invoice was paid

Example:

"2024-03-14T12:00:00Z"