API Reference
Log In
API Reference

Toggle a tenant's usage-based billing

Enable or disable usage-based billing for the tenant (PRODUCT-3245). When disabled, the UI hides every billing surface for the tenant — invoices, payment methods, plan and subscription screens. Defaults to enabled.

The flag is a presentation opt-in: nothing in ingestion, rating or invoicing is gated on it. The same value is exposed on the tenant stub returned by GET /v2/api/users/me, which is where the front end reads it before first paint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the tenant. Format: Revenium hashid (URL-safe encoded string).

Body Params

Request to toggle usage-based billing for a tenant

boolean | null
required

Whether usage-based billing should be enabled for the tenant. When false the UI hides every billing surface: invoices, payment methods, plan and subscription screens. Nothing in ingestion, rating or invoicing is gated on this flag. Required: omitting it or sending null is rejected with a 400.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*