Get invoice details
curl --request GET \
  --url https://api.salesbricks.com/api/v2/invoices/{invoice_id} \
  --header 'X-SALESBRICKS-KEY: <api-key>'
{
  "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "invoice_number": "<string>",
  "due_at": "2023-11-07T05:31:56Z",
  "bill_at": "2023-11-07T05:31:56Z",
  "issued_at": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "fully_paid_at": "2023-11-07T05:31:56Z",
  "grand_total": 123,
  "remaining_amount": 123,
  "currency": "<string>",
  "is_renewal_estimate": true
}

Authorizations

​
X-SALESBRICKS-KEY
string
header
required

API key for authentication

Path Parameters

​
invoice_id
string
required

Response

​
invoice_id
string<uuid>
required

Unique identifier for the invoice. If the id is null, this is an estimate

​
subscription_id
string<uuid>
required

ID of the subscription this invoice belongs to

​
customer_id
string<uuid>
required

ID of the customer who will pay this invoice

​
invoice_number
string
required

Short form identifier for the invoice. If the invoice_number is null, this is an estimate

​
due_at
string<date-time>
required

The date on which this invoice is expected to be paid by.

​
bill_at
string<date-time>
required

The date on which this invoice will be issued and potentially charged.

​
issued_at
string<date-time>
required

The date on which this invoice was issued.

​
status
string
required

Current status of the invoice (e.g., PENDING, PAID, MUTED). Muted status prevents invoices from being sent out, these invoices come from migration cut-overs or via muting invoices in the product settings.

​
fully_paid_at
string<date-time>
required

The date on which this invoice was fully paid.

​
grand_total
integer
required

Total amount due for this invoice. For scheduled invoices, this will be the expected payment amount.

​
remaining_amount
integer
required

Remaining amount for this invoice.

​
currency
string
required

The currency in which the invoice is denominated (e.g., USD, EUR).

​
is_renewal_estimate
boolean
required

This is an estimate for a renewal that has not yet closed, but is expected to.