Get subscription invoices

curl --request GET \
  --url https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/invoices \
  --header 'X-SALESBRICKS-KEY: <api-key>'

{
  "count": 123,
  "results": [
    {
      "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,
      "time_zone": "<string>",
      "payments": [
        {
          "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "invoice_number": "<string>",
          "paid_amount": 123,
          "paid_at": "2023-11-07T05:31:56Z",
          "currency": "<string>",
          "error": "<string>"
        }
      ]
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

GET

api

subscriptions

{subscription_id}

invoices

Get subscription invoices

curl --request GET \
  --url https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/invoices \
  --header 'X-SALESBRICKS-KEY: <api-key>'

{
  "count": 123,
  "results": [
    {
      "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,
      "time_zone": "<string>",
      "payments": [
        {
          "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "invoice_number": "<string>",
          "paid_amount": 123,
          "paid_at": "2023-11-07T05:31:56Z",
          "currency": "<string>",
          "error": "<string>"
        }
      ]
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Authorizations

X-SALESBRICKS-KEY

string

header

required

API key for authentication

Path Parameters

subscription_id

string

required

Query Parameters

limit

integer

Maximum number of invoices to return (default: 100, max: 1000)

offset

integer

Number of records to skip (default: 0)

ordering

enum<string>

Order results by field (prefix with '-' for descending order)

Available options:

-amount,

-created_at,

-due_at,

amount,

created_at,

due_at

scope

enum<string>

Filter invoices based on status (past, current, all)

Available options:

all,

current,

past

Response

200 - application/json

count

integer

required

Example:

123

results

object[]

required

Show child attributes

results.invoice_id

string<uuid>

required

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

results.subscription_id

string<uuid>

required

ID of the subscription this invoice belongs to

results.customer_id

string<uuid>

required

ID of the customer who will pay this invoice

results.invoice_number

string

required

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

results.due_at

string<date-time>

required

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

results.bill_at

string<date-time>

required

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

results.issued_at

string<date-time>

required

The date on which this invoice was issued.

results.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.

results.fully_paid_at

string<date-time>

required

The date on which this invoice was fully paid.

results.grand_total

integer

required

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

results.remaining_amount

integer

required

Remaining amount for this invoice.

results.currency

string

required

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

results.is_renewal_estimate

boolean

required

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

results.time_zone

string

Invoice timezone

results.payments

object[]

The latest 10 payments made against this invoice, ordered by paid_at descending.

Show child attributes

results.payments.payment_id

string<uuid>

required

Unique identifier for the payment

results.payments.invoice_number

string | null

required

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

results.payments.paid_amount

integer | null

required

The amount paid

results.payments.paid_at

string<date-time> | null

required

the date at which this payment was paid

results.payments.currency

string

required

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

results.payments.error

string | null

required

Any errors that occured during this payment processing

string<uri> | null

Example:

"http://api.example.org/accounts/?offset=400&limit=100"

string<uri> | null

Example:

"http://api.example.org/accounts/?offset=200&limit=100"

Get the current subscription state Get subscription signed order form pdf

⌘I

Customers

Invoices

Plans

Subscriptions

Payment Methods

Usage

Get subscription invoices

Authorizations

Path Parameters

Query Parameters

Response