Lotus home pagelight logo
Credits
Update credit
POST

/api/credits/{credit_id}/update/

X-API-KEY*
Authorization*
curl --request POST \
  --url https://api.uselotus.io/api/credits/{credit_id}/update/ \
  --header 'Authorization: <authorization>' \
  --header 'X-API-KEY: <x-api-key>'

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.

lotus.update_credit(
    credit_id='credit_0569173ee6654369',
    description='New description',
    expires_at='2027-01-01T00:00:00Z'
)

​
Authorizations

Authorization[header]required
string

Token-based authentication with required prefix "Token"

​
Path Parameters

credit_idrequired
string

The ID of the credit to retrieve or update.

​
Body

description
string
expires_at
string

​
Response

amountrequired
number
amount_paidrequired
number
amount_paid_currencyrequired
object
amount_remainingrequired
number
credit_idrequired
string
currencyrequired
object
customerrequired
object
descriptionrequired
string
drawdownsrequired
array
effective_atrequired
string
expires_atrequired
string
statusrequired
string
  • active - Active
  • inactive - Inactive
Available options:
active,
inactive