put/billing/overage

Request

  • Base URL: https://api.useanima.sh/v1
  • URL: https://api.useanima.sh/v1/billing/overage
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

enabledboolean

Opt in to (or out of) metered overage

limitCentsinteger

Overage to authorize above the included allowance, in cents

monthlySpendCentsinteger nullable

Absolute ceiling; null CLEARS it, omitting the field leaves it unchanged

Response

OK

enabledboolean required

Whether the customer has opted in to metered overage

limitCentsinteger required

Overage the customer authorized above their included allowance, in cents

monthlySpendCentsinteger nullable required

Customer's own absolute ceiling; lowers the cap but never raises it

effectiveCapCentsinteger required

What enforcement actually compares spend against; 0 when overage is off

usedCentsinteger required

Metered overage accrued so far this billing period, in cents

planCeilingCentsinteger nullable required

Most this plan permits authorizing; null on Enterprise (no ceiling)

periodstring required

Billing-period key the usage figure covers

Changes

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