GET
/
v1
/
invoices
/
{id}

Path Parameters

id
string
required

The invoice id.

Response

200 - application/json

The request was successfully processed and the invoice is returned.

id
string
required

The unique identifier of the invoice.

displayId
string
required

The human-readable identifier of the invoice.

customer
object
required

The customer associated with this invoice.

paymentAccount
object
required

The payment account used for this invoice.

startDate
string
required

The start date of the billing period.

endDate
string
required

The end date of the billing period.

totalAmount
number
required

The total amount to be paid for this invoice.

Required range: x > 0
payments
object[] | null
required

List of payments associated with this invoice.

status
enum<string>
required

The current status of the invoice.

Available options:
open,
closed,
paid,
canceled
plans
object[]
required

List of plans associated with this invoice.

additionalItems
object[]
required

List of additional items charged in this invoice.

closedReason
enum<string>

The reason why the billing cycle was closed.

Available options:
end_of_cycle,
billing_end_day_updated