Skip to main content
GET
List credits
string
Unique identifier of the credit
string
Unique identifier of the account associated with the credit
enum
Status of the credit
string
Creation date of the credit
string
string
string
string

Allowed filter combinations

  • id
  • account_id
  • account_id, status
  • account_id, status, created_at
  • account_id, created_at
Fields that can be searched on using _search query param
string
Unique identifier of the credits
Fields with which the list response can be sorted using _sort query param
string
string
Default sort order:created_at DESC, id ASC

Authorizations

Authorization
string
header
required

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

Query Parameters

nextToken
string

Pagination token used as a marker to get records from next page.

Example:

"eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ=="

status
string

Filter option to filter by status.

account_id
string

Filter option to filter based on account id.

Example:

"1234"

id
string

Filter option to filter based on credit id.

Example:

"cred.1znpoFlsI3U.zmg85"

pageSize
integer

Maximum page size expected by client to return the record list.

NOTE: Max page size cannot be more than 50. Also 50 is the default page size if no value is provided.

Example:

10

Response

Response for Get invoice requests

List credits response

data
object[]
required
Maximum array length: 50
nextToken
string
Maximum string length: 500
Example:

"eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ=="