Start free trial

Preview Addon Change

POST/api/v1/billing/addon/preview

Preview the billing impact of adding or removing an add-on.

Request Body:

  • addon_slug: Add-on module slug from AddOnModule enum
  • action: 'add' or 'remove'

Returns: Prorated amount (cents), addon price, and effective date for removals.

Operation ID: preview_addon_change_api_v1_billing_addon_preview_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: AddonPreviewRequest

addon_slugstringrequired

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

actionstringrequired

'add' or 'remove'.

One of: add, remove

Responses

201Successful Response

Schema: SuccessEnvelope_PreviewAddonChangeResponse_

successboolean
messagestring
codestring
dataPreviewAddonChangeResponse

422Validation Error

Schema: HTTPValidationError

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