Credits

List Credit Grants for a customer

Changed on

List all Credit Grants and their outstanding balances where the balance is non-zero

get/credits/{customerId}/grants

Request

  • Base URL
    https://sandbox.sequencehq.com/api
  • URL
    https://sandbox.sequencehq.com/api/credits/{customerId}/grants
  • Auth
    none declared. Required headers: Authorization

Path parameters

customerIdstring required

Customer ID

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Response

OK

Example response

{
  "items": [
    {
      "id": "22efb229-c474-407c-bbf7-f5e113ee8b20",
      "name": "API Calls",
      "grantAmount": 1000,
      "balance": 324,
      "issueDate": "2022-02-22",
      "expiryDate": "2030-03-03"
    }
  ]
}

Changes

  • 02acff42af53Revision changes
    • breaking

      the // response's property format changed from date to no format for status

    • breaking

      the // response's property format changed from date to no format for status

    • warning

      deleted the header request parameter Sequence-Version

    • info

      added the new optional header request parameter sequence-version