Get billing payment history for settings page

GET/v1/settings/billing/payments

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Responses

200OK

itemsSettingsBillingPaymentItem[] | nullrequired

Show properties

Array of SettingsBillingPaymentItem

amountinteger<int64>required

created_atstringrequired

currencystringrequired

idstringrequired

invoice_idstringrequired

invoice_numberstring

methodstring

paid_atstring

providerstringrequired

provider_payment_session_idstring

provider_reference_idstring

statusstringrequired

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/payments"

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

import requests

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

Response

{
  "items": [
    {
      "amount": 0,
      "created_at": "string",
      "currency": "string",
      "id": "string",
      "invoice_id": "string",
      "invoice_number": "string",
      "method": "string",
      "paid_at": "string",
      "provider": "string",
      "provider_payment_session_id": "string",
      "provider_reference_id": "string",
      "status": "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"
  }
}

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