Widget

Own balance (end-user)

Returns the calling end user's own balance in the workspace's credit denomination. Authenticates with an end-user token, optionally alongside a publishable key for the browser widget.

get/credits/me/balance

Request

  • Base URL
    https://api.paywithlocus.com/api
  • URL
    https://api.paywithlocus.com/api/credits/me/balance
  • Auth
    • HTTP bearer
    • or HTTP bearer and API key in header X-Locus-Publishable-Key

Headers

X-Locus-Session-Idstring

Required only when the end-user JWT carries sid. Send the original high-entropy session value; sid is its SHA-256 fingerprint. Ignored for secret-key authentication.

Response

Balance in the tenant's credit denomination

successunknown required

Changes

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