INinkbox
Billing

Update Billing Settings

Changed on
put/api/v1/billing/settings

Request

  • Base URL
    https://api.inkbox.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.inkbox.ai/api/v1/billing/settings
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Request body

overage_cap_centsinteger nullable

Monthly SMS+voice overage spend limit in cents. Omit to leave unchanged; null clears the limit; 0 blocks all overage-incurring sends and calls.

remove_branding_footerboolean nullable

Set true to remove the 'Sent via Inkbox' footer from outbound emails (paid plans only; 403 on Free). Omit or null to leave unchanged.

Response

Successful Response

overage_cap_centsinteger nullable

Monthly SMS+voice overage spend limit in cents; None = no limit. Once cycle-to-date overage spend reaches it, overage-incurring sends and calls are refused (402) until the cycle resets or the limit is raised. Usage within included allowances is never blocked; inbound and in-flight usage can exceed the limit slightly.

remove_branding_footerboolean

When true and the organization is on a paid plan, outbound emails omit the 'Sent via Inkbox' footer. Automatically set to true when upgrading from Free to any paid plan. On the Free plan the footer always applies.

Changes

  • 77c7e3ee70cfRevision changes
    • info

      added to the response body allOf list for the response status

    • info

      removed subschema #1 from the response body allOf list for the response status

  • a0729c3c4a0bRevision changes
    • info

      added subschema #1 to the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status