Account

Balance, limits, allowance and recent ledger

Balance is read from the append-only ledger. funding.cash_on_hand_credits is money that has cleared; a top-up is spendable immediately but an order is only SENT to a supplier once the money behind it settles. read_allowance shows the monthly row entitlement before a 429. refund shows what an unspent balance would return today.

get/v1/credits

Request

  • Base URL: https://api.placementapi.com
  • URL: https://api.placementapi.com/v1/credits
  • Auth: HTTP bearer

Response

OK

balance_creditsinteger

Credits. 1 credit = 1 US cent.

balance_usdstring

Credits are pegged 1:1 to US cents, so this is exact.

refund_grace_daysinteger nullable

The account grace period, in days, applied once. On timing alone an undelivered order is flagged refund_eligible from due_at plus one account grace period. A credit refund for an order already with a supplier is guarded separately by due_at plus the supplier's refund window plus that same one account grace period, and it also requires that we have recovered from the supplier, unless we choose to bridge it as a goodwill decision. Passing the timing threshold alone never returns credits.

volume_credits_earnedinteger

Changes

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