Credit API

Get Credit Balance

GET /auxilia/credits/balance

Authorization Required

OAuth	APIKey
Yes	Yes

OAuth scope: credit.read or credit.full

Response

{
  "data": USER_CREDIT_OBJECT,
  "ts": 1723923923
}

Get Credit Ledger

GET /auxilia/credits/ledger?offset=:offset&limit=:limit

Authorization Required

OAuth	APIKey
Yes	Yes

OAuth scope: credit.read or credit.full

Parameters

Parameter	Type	Description
offset	number	Pagination offset.
limit	number	Pagination limit (default: 16).

Response

{
  "data": {
    "pagination": {
      "offset": 0,
      "next_offset": 16,
      "limit": 16
    },
    "items": [CREDIT_LEDGER_OBJECT, ...]
  },
  "ts": 1723923923
}

Topup Credit

POST /auxilia/credits/topup

Authorization Required

OAuth	APIKey
No	No

Request Body

{
  "amount": 10,
  "credit_amount": 1000,
  "currency": "USD",
  "channel": "stripe",
  "redirect_url": "https://example.com/credit/return"
}

Notes:

• redirect_url is required.
• At least one of amount or credit_amount must be positive.

Response

{
  "data": {
    "order_id": 1,
    "payment_url": "https://...",
    "credit_amount": 1000
  },
  "ts": 1723923923
}

Consume Credit

POST /auxilia/credits/consume

Authorization Required

OAuth	APIKey
Yes	Yes

OAuth scope: credit.full

Request Body

{
  "amount_credit": 10,
  "source_id": "post_ai",
  "meta": {
    "post_id": 1
  }
}

Notes:

• amount_credit must be positive.
• source_id is required.

Response

{
  "data": CREDIT_LEDGER_OBJECT,
  "ts": 1723923923
}