POST
/
api
/
credits
/

Creates a credit.

Authorizations

Authorization
string
headerrequired

Token-based authentication with required prefix "Token"

Body

customer_id
string | null
required

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

amount
number
required
currency_code
string
required
description
string | null
effective_at
string
expires_at
string | null
amount_paid
number
amount_paid_currency_code
string

Response

201 - 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
List creditsVoid credit