GET

/api/credits/

X-API-KEY*
curl --request GET \
  --url https://api.uselotus.io/api/credits/ \
  --header 'Authorization: <authorization>' \
  --header 'X-API-KEY: <x-api-key>'
[
  {
    "amount": "number",
    "amount_paid": "number",
    "amount_paid_currency": {
      "code": "string",
      "name": "string",
      "symbol": "string"
    },
    "amount_remaining": "number",
    "credit_id": "string",
    "currency": {
      "code": "string",
      "name": "string",
      "symbol": "string"
    },
    "customer": {
      "customer_id": "string",
      "customer_name": "string",
      "email": "string"
    },
    "description": "string",
    "drawdowns": [
      {
        "amount": "number",
        "applied_at": "string",
        "credit_id": "string",
        "description": "string"
      }
    ],
    "effective_at": "string",
    "expires_at": "string",
    "status": "active"
  }
]

Retrieves an array of credits.

lotus.list_credits(customer_id='cust_0569173ee6654369')

Authorizations

Authorizationheaderrequired
string

Token-based authentication with required prefix "Token"

Query Parameters

currency_code
string

Filter to adjustments in a specific currency

customer_idrequired
string

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

effective_after
string

Filter to adjustments that are effective after this date

effective_before
string

Filter to adjustments that are effective before this date

expires_after
string

Filter to adjustments that expire after this date

expires_before
string

Filter to adjustments that expire before this date

issued_after
string

Filter to adjustments that were issued after this date

issued_before
string

Filter to adjustments that were issued before this date

status
Default: ["active","inactive"]
array

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

Response

array