Dashboard

Set what happens when the organization goes over its plan

put/dashboard/organizations/{organization_id}/billing/over-plan

Request

  • Base URL: https://api.whisperr.net
  • URL: https://api.whisperr.net/dashboard/organizations/{organization_id}/billing/over-plan
  • Auth: HTTP bearer

Path parameters

organization_idstring required

Whisperr organization ID.

Request body

mode'stop' | 'cover' required
spend_limit_centsinteger nullable

Response

The full billing status after the change.

access'reveal_only' | 'full' | 'read_only' required
can_start_trialboolean required
cancel_at_period_endboolean required
checkout_attempt_idstring uuid
checkout_expires_atstring date-time
current_period_endstring date-time
organization_idstring required
plan_code'free' | 'solo' | 'studio' | 'team' | 'scale' | 'enterprise' | 'starter' | 'growth' required
portal_availableboolean required
state'pretrial' | 'checkout_pending' | 'trialing' | 'active' | 'past_due' | 'unpaid' | 'paused' | 'incomplete' | 'incomplete_expired' | 'canceled' | 'manual_review' required
trial_claimedboolean required
trial_endstring date-time
trial_startstring date-time

Example response

{
  "usage": {
    "month": "2026-10"
  }
}

Changes

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