Usage

Read the month's message pool state

The month's message pool: allowance, messages used, top-up pack bonus, and what's left. A coach still on trial economics is measured against the trial cap since the trial started, not against the monthly pool.

API key scopes: usage:read.

get/api/usage/messages

Request

  • Base URL: https://api.setluca.com
  • URL: https://api.setluca.com/api/usage/messages
  • Auth: one of:
    • API key in cookie luca.session_token
    • API key in header x-api-key
    • HTTP bearer

Headers

Luca-API-Version'1'

The major version of the API this client was built against. Omit it and the request is served by the current major version. Any other value is refused with 400 unsupported_api_version.

Response

ok

planTierstring required
usedinteger required
allowedinteger required
remaininginteger required
usagePctinteger required
warnboolean required
exhaustedboolean required
isTrialCapboolean

Changes

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