Tenant

Read monthly plan and Enterprise trial status

Requires a human workspace session with tenant:read. Trial expiry pauses Enterprise features without erasing prepaid balances or changing the assigned usage rate. Complete paid Enterprise checkout to restore those features; a top-up does not extend the trial.

get/credits/plans

Request

  • Base URL
    https://api.paywithlocus.com/api
  • URL
    https://api.paywithlocus.com/api/credits/plans
  • Auth
    HTTP bearer

Query parameters

refreshboolean

Reconcile the current Stripe subscription before returning the plan.

Response

Current subscription, trial deadline and checkout availability

successunknown
enabledboolean
currentPlan'free' | 'plus' | 'enterprise' | 'enterprise_plus'
legacyboolean
checkoutConfiguredboolean
includedBalanceUsdstring
includedExpiresAtstring date-time nullable

Changes

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