Get the account's credit balance and plan

userID must be the authenticated account's own id (anything else is 403). Check the balance before taking on long work.

get/v1/users/{userID}/credits

Request

  • Base URL: https://api.plori.ai
  • URL: https://api.plori.ai/v1/users/{userID}/credits
  • Auth: HTTP bearer

Path parameters

userIDstring uuid required

Response

Balance, plan, and purchase options.

balanceinteger

Wallet balance in micro-USD (µ$), where 1,000,000 µ$ = $1. The wallet keeps the name 'credits' but every amount is US dollars.

low_credit_thresholdinteger

Low-balance threshold, in micro-USD (µ$).

peg_centsinteger

Deprecated. Amounts are micro-USD (µ$), where 1,000,000 µ$ = $1; use that conversion rather than a credits-per-dollar rate.

can_manage_billingboolean
audience'anon' | 'registered_free' | 'subscribed'

Changes

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