GET
/
credits
/
{customerId}
/
balances
curl --request GET \
  --url https://eu.sequencehq.com/api/credits/{customerId}/balances \
  --header 'Authorization: <authorization>'
{
  "items": [
    {
      "id": "6587e308-ab0d-4a58-8cc1-1d168490de7b",
      "type": "CASH",
      "name": "Credits",
      "balance": "50",
      "grants": [
        {
          "id": "5a0faea3-7ad5-4a83-a420-09bb6576f7e6",
          "sequenceAccountId": "a507e782-d26b-4d34-92b9-aacd1667e1f0",
          "customerId": "eabb3196-9c73-4c0d-b508-d3c4fc7b2cbb",
          "type": "CASH",
          "currency": "GBP",
          "metricId": "b84f5290-fe95-4c6f-bedc-477700125265",
          "name": "GBP",
          "originalAmount": "10",
          "currentBalance": "1",
          "expiryDate": "2024-01-02",
          "costOfCredit": "10",
          "taxRateId": "b3c37ea3-96bb-44fb-baed-01eb38d3328e",
          "effectiveDate": "2024-01-01",
          "createdAt": "2024-01-01T12:00:00Z"
        }
      ],
      "transactions": [
        {
          "id": "c770d296-ef09-459b-b8dd-42c334e00dab",
          "grantId": "5a0faea3-7ad5-4a83-a420-09bb6576f7e6",
          "reason": "because",
          "invoiceId": "c6864c69-42a3-4966-8c22-1c56d7375a05",
          "billingRunId": "e95256be-08e7-4585-b3c7-fa9928aacd90",
          "type": "CREDIT",
          "amount": "10",
          "date": "2024-01-01"
        }
      ]
    }
  ]
}

Headers

​
Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

​
Sequence-Version
enum<string>

Use this header to select an API version

Available options:
2024-07-30

Path Parameters

​
customerId
string
required

Customer ID

Response

200
application/json

OK

The response is of type object.