Sign in

v1

latestOpenAPI 3.0.32026-07-1336286494.8 KB
api

get/api/credits/

Query parameters

currency_codestring

Filter to adjustments in a specific currency

customer_idstring nullable required

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

effective_afterstring date-time

Filter to adjustments that are effective after this date

effective_beforestring date-time

Filter to adjustments that are effective before this date

expires_afterstring date-time

Filter to adjustments that expire after this date

expires_beforestring date-time

Filter to adjustments that expire before this date

issued_afterstring date-time

Filter to adjustments that were issued after this date

issued_beforestring date-time

Filter to adjustments that were issued before this date

statusstring[]

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

Response

credit_idstring required
amountnumber double required
amount_remainingnumber double required
descriptionstring nullable required
effective_atstring date-time required
expires_atstring date-time nullable required
status'active' | 'inactive' required
  • active - Active
  • inactive - Inactive
amount_paidnumber double required
All 36 operations