POST
/
api
/
credits
/
{credit_id}
/
update
/

This can be used to alter the description or expiration date of a credit. If the credit expiry is in the past, this will throw an error. If the targeted credit is no longer active, this will throw an error.

Authorizations

Authorization
string
headerrequired

Token-based authentication with required prefix "Token"

Path Parameters

credit_id
string
required

The ID of the credit to retrieve or update.

Body

description
string | null
expires_at
string | null

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
Void credit