Credits
List credit grants
List all credit grants for this account
get/credits
Query parameters
limitinteger
Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).
afterstring
Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.
beforestring
Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.next or pagination.previous to retrieve each page.
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": "746fc7f2-8098-4fe7-953c-7d51c580a126",
"sequenceAccountId": "dce9ae85-d8d0-42b4-bcad-f221a64363c6",
"customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
"name": "On-boarding Credits",
"creditUnitType": "CURRENCY",
"currency": "GBP",
"metricId": "f092246c-6b90-4106-bcca-304ccf06bf45",
"amount": 10,
"costOfCredit": 10,
"taxRateId": "179d1ab3-cc96-48e2-9310-067b0b42d47c",
"effectiveDate": "2023-01-01",
"expiryDate": "2023-01-31",
"createdAt": "2022-10-07T14:12:08.826121Z",
"creditNoteId": "73086198-8752-4ec9-a99b-16209a32dc6c",
"integrationIds": [
{
"service": "Xero",
"id": "74ed2615-4730-49ab-9445-74f31723a206",
"isPending": false
}
]
}
],
"pagination": {
"after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
"before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
"totalResultSize": 10
}
}