Turn row overage on or off

POST

/billing/overage

curl --request POST \
  --url https://api.sloose.com/billing/overage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": true }'

• Production
• Staging

With overage off, a run that would exceed the monthly allowance is refused outright. With it on, the rows are written and billed per thousand. Only offered on plans that price it.

Authorizations

• sessionAuth
• apiTokenAuth

Request Body^required

Media typeapplication/json

object

enabled

boolean | null

key

additional properties

Example^generated

{
  "enabled": true
}

Responses

200

The new state.

Media typeapplication/json

object

overageEnabled

required

boolean

overageAllowed

required

Plan offers it AND the org switched it on.

boolean

Example^generated

{
  "overageEnabled": true,
  "overageAllowed": true
}

400

enabled is not a boolean.

Media typeapplication/json

object

error

required

string

key

additional properties

Example^generated

{
  "error": "example"
}

401

No bearer, or one that is expired, revoked or no longer resolves to a member.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

403

The bearer’s role is too low, or it was issued for a different org.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

409

This org is a sandbox. Billing is managed on its production org.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: SANDBOX_ORG

key

additional properties

Example

{
  "code": "SANDBOX_ORG"
}