Turn row overage on or off

POST

/orgs/{org}/billing/overage

curl --request POST \
  --url https://api.sloose.com/orgs/org_9f3c/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, and only on a monthly subscription: overage is billed monthly, so turning it on for an annual one is refused 409 OVERAGE_MONTHLY_ONLY — move to a larger plan instead (#1369).

Session only: billing is a person’s to manage, never an org’s API token’s (D5).

Authorizations

• sessionAuth

Parameters

Path Parameters

org

required

The org id the session was issued for. A token for one org can never read another.

string

Example

org_9f3c

The org id the session was issued for. A token for one org can never read another.

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, it was issued for a different org, it is an API token (SESSION_REQUIRED), or it is a staff member’s view of the org (IMPERSONATION_REFUSED; a read-only view is refused before this, IMPERSONATION_READ_ONLY): billing spends and changes the org’s money, and a view would do it in the member’s name.

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

Turned on for an annual subscription: overage is billed monthly. Nothing changed.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: OVERAGE_MONTHLY_ONLY

key

additional properties

Example

{
  "code": "OVERAGE_MONTHLY_ONLY"
}