Skip to main content
POST
List credits

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

List all credits for a customer

customer_id
string<uuid>
required
credit_id
string<uuid>
covering_date
string<date-time>

Return only credits that have access schedules that "cover" the provided date

starting_at
string<date-time>

Include only credits that have any access on or after the provided date

effective_before
string<date-time>

Include only credits that have any access before the provided date (exclusive)

include_contract_credits
boolean

Include credits on the contract level.

include_archived
boolean

Include archived credits and credits from archived contracts.

include_ledgers
boolean

Include credit ledgers in the response. Setting this flag may cause the query to be slower.

include_balance
boolean

Include the balance in the response. Setting this flag may cause the query to be slower.

next_page
string

The next page token from a previous response.

limit
integer
default:25

The maximum number of commits to return. Defaults to 25.

Required range: 1 <= x <= 25

Response

200 - application/json

Success

data
object[]
required
next_page
string | null
required