GET
/
api
/
credits
/

Retrieves an array of credits.

Authorizations

Authorization
string
headerrequired

Token-based authentication with required prefix "Token"

Query Parameters

currency_code
string

Filter to adjustments in a specific currency

customer_id
string | null
required

The id provided when creating the customer, we suggest matching with your internal customer id in your backend

effective_after
string

Filter to adjustments that are effective after this date

effective_before
string

Filter to adjustments that are effective before this date

expires_after
string

Filter to adjustments that expire after this date

expires_before
string

Filter to adjustments that expire before this date

issued_after
string

Filter to adjustments that were issued after this date

issued_before
string

Filter to adjustments that were issued before this date

status
enum<string>[]

Filter to a specific set of adjustment statuses. Defaults to both active and inactive.

Available options:
active,
inactive

Response

200 - application/json
credit_id
string
required
customer
object
required
amount
number
required
amount_remaining
number
required
currency
object
required
description
string | null
required
effective_at
string
required
expires_at
string | null
required
status
enum<string>
required
  • active - Active
  • inactive - Inactive
Available options:
active,
inactive
amount_paid
number
required
amount_paid_currency
object
required
drawdowns
object[]
required
Get Invoice PDFCreate a credit