Skip to main content
GET
/
account
/
subscriptions
List subscriptions
curl --request GET \
  --url https://wsapi.chat/account/subscriptions \
  --header 'X-Api-Key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "curPeriodStart": "2023-11-07T05:31:56Z",
      "curPeriodEnd": "2023-11-07T05:31:56Z",
      "quantity": 123,
      "plan": "<string>",
      "price": "<string>",
      "status": "<string>",
      "cancelAtPeriodEnd": true,
      "instanceIds": [
        "<string>"
      ]
    }
  ],
  "totalCount": 123,
  "pageNumber": 123,
  "pageSize": 123
}

Authorizations

X-Api-Key
string
header
required

Customer API key. Only the customer-level key is accepted for /account/* endpoints. No X-Instance-Id header is required.

Query Parameters

pageNumber
integer
default:1
pageSize
integer
default:20

Response

Paginated list of subscriptions

items
object[]
totalCount
integer
pageNumber
integer
pageSize
integer