Credits
Create a credit
Create a credit
POST
/
api
/
credits
/
Creates a credit.
Authorizations
Authorization
string
headerrequiredToken-based authentication with required prefix "Token"
Body
customer_id
string | null
requiredThe id provided when creating the customer, we suggest matching with your internal customer id in your backend
amount
number
requiredcurrency_code
string
requireddescription
string | null
effective_at
string
expires_at
string | null
amount_paid
number
amount_paid_currency_code
string
Response
201 - application/json
credit_id
string
requiredcustomer
object
requiredamount
number
requiredamount_remaining
number
requiredcurrency
object
requireddescription
string | null
requiredeffective_at
string
requiredexpires_at
string | null
requiredstatus
enum<string>
requiredactive
- Activeinactive
- Inactive
Available options:
active
, inactive
amount_paid
number
requiredamount_paid_currency
object
requireddrawdowns
object[]
required