Get billing invoices for settings page

GET/v1/settings/billing/invoices

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Responses

200OK

itemsSettingsBillingInvoiceItem[] | nullrequired

Show properties

Array of SettingsBillingInvoiceItem

billing_profileSettingsBillingProfileSnapshotItemrequired

Show properties

address_line_1stringrequired

address_line_2stringrequired

billing_emailstringrequired

billing_phonestringrequired

citystringrequired

country_codestringrequired

legal_namestringrequired

postal_codestringrequired

state_or_provincestringrequired

tax_idstringrequired

tax_namestringrequired

currencystringrequired

due_atstring

idstringrequired

invoice_numberstringrequired

issued_atstringrequired

latest_reference_idstring

latest_session_statusstring

linesSettingsBillingInvoiceLineItem[] | nullrequired

Show properties

Array of SettingsBillingInvoiceLineItem

descriptionstringrequired

line_totalinteger<int64>required

line_typestringrequired

positioninteger<int32>required

quantityinteger<int32>required

unit_amountinteger<int64>required

notesstring

paid_atstring

period_endstring

period_startstring

statusstringrequired

subtotal_amountinteger<int64>required

target_planstring

tax_amountinteger<int64>required

total_amountinteger<int64>required

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/settings/billing/invoices"

const response = await fetch("/v1/settings/billing/invoices", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/settings/billing/invoices",
)

Response

{
  "items": [
    {
      "billing_profile": {
        "address_line_1": "string",
        "address_line_2": "string",
        "billing_email": "string",
        "billing_phone": "string",
        "city": "string",
        "country_code": "string",
        "legal_name": "string",
        "postal_code": "string",
        "state_or_province": "string",
        "tax_id": "string",
        "tax_name": "string"
      },
      "currency": "string",
      "due_at": "string",
      "id": "string",
      "invoice_number": "string",
      "issued_at": "string",
      "latest_reference_id": "string",
      "latest_session_status": "string",
      "lines": [
        {
          "description": "string",
          "line_total": 0,
          "line_type": "string",
          "position": 0,
          "quantity": 0,
          "unit_amount": 0
        }
      ],
      "notes": "string",
      "paid_at": "string",
      "period_end": "string",
      "period_start": "string",
      "status": "string",
      "subtotal_amount": 0,
      "target_plan": "string",
      "tax_amount": 0,
      "total_amount": 0
    }
  ]
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}