usage

Retrieve credit balance

Returns the credit balance, the grants that make it up, and recent credits added or expired, newest first.

Each entry includes balance_after, the balance once it applied.

get/credit

Request

  • Base URL: http://localhost:3030
  • URL: http://localhost:3030/credit
  • Auth: HTTP bearer

Query parameters

limitinteger

Number of ledger entries to return, between 1 and 500. Defaults to 50.

Response

The credit balance.

object'credit_balance' required

The object's type. Always credit_balance.

organization_idstring required

The organization's id.

balanceinteger required

The current credit balance.

included_creditsinteger required

Credits included with the plan each billing period. 0 without a plan.

Example response

{
  "organization_id": "0192f3a4-5b6c-7d8e-9f01-23456789abcd",
  "grants": [
    {
      "id": "cgr_01j9z3k4m5n6p7q8r9s0t1v2w3"
    }
  ],
  "ledger": [
    {
      "grant": "cgr_01j9z3k4m5n6p7q8r9s0t1v2w3",
      "reason": "purchase",
      "reference": "evt_1Q2w3E4r5T6y7U8i"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.