Start free trial

Toggle Addon

POST/api/v1/billing/addon

Add or remove an add-on from the business's Stripe subscription.

Request Body:

  • addon_slug: Add-on module slug from AddOnModule enum
  • action: 'add' (charges prorated amount immediately) or 'remove' (effective at period end, no refund)

Effect:

  • Adding: Stripe subscription is updated, prorated amount is charged immediately
  • Removing: Item removed with no proration, takes effect at period end

Returns: Updated active_addons list and effective date.

Operation ID: toggle_addon_api_v1_billing_addon_post·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Request body

Schema: AddonToggleRequest

addon_slugstringrequired

Add-on module slug (e.g. 'ai_pro').

actionstringrequired

'add' or 'remove'.

One of: add, remove

Responses

201Successful Response

Schema: SuccessEnvelope_ToggleAddonResponse_

successboolean
messagestring
codestring
dataToggleAddonResponse

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject