Skip to main content
GET
List credit grants

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

Query Parameters

billingScheduleId
string

Return only the grants belonging to this billing schedule.

customerId
string

Return only the grants held by this customer, across all of their billing schedules.

limit
integer

Maximum number of grants per page, from 1 to 100. Defaults to 20.

after
string

Cursor for the next page, from pagination.after. Omit for the first page. Use either after or before, not both.

before
string

Cursor for the previous page, from pagination.before. Omit for the first page. Use either after or before, not both.

sortOrder
string

Order by creation date: DESC for newest first, ASC for oldest first. Defaults to DESC.

Response

OK

items
object[]
required

The V2 credit grants on this page.

Example:
pagination
object
required

Results pagination.

Example: