Skip to main content
List all 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>"
        }
      ],
      "attachments": [
        "<unknown>"
      ]
    }
  ],
  "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
Pattern: ^([a-zA-Z\d\-]+)$

Query Parameters

​
limit
integer

Number of results to return per page.

​
offset
integer

The initial index from which to return the results.

​
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
​
next
string<uri> | null
Example:

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

​
previous
string<uri> | null
Example:

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