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'

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_slug string required

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

action string required

'add' or 'remove'.

One of: add, remove

Responses

201 Successful Response

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

POST /api/v1/billing/addon/preview

bash

curl -X POST 'https://api.ondayzero.com/api/v1/billing/addon/preview' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "addon_slug": "string",
  "action": "add"
}'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/billing/addon/preview', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "addon_slug": "string",
  "action": "add"
}),
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {
  "addon_slug": "string",
  "action": "add"
}

response = httpx.post("https://api.ondayzero.com/api/v1/billing/addon/preview", headers=headers, json=payload)
data = response.json()