Zoho Billing icon

Zoho Billing

Consume Zoho Billing API v1 (Subscriptions, Plans, Addons, Coupons, Invoices)

Addon → Create

AI-generated

Summary

Creates a new addon in Zoho Billing by POSTing to /billing/v1/addons within the selected organization. Returns the API response for the created addon.

Inputs

  • organizationId (required) — Zoho organization, chosen from a list loaded from the API; sent as the X-com-zoho-subscriptions-organizationid header.
  • addonCode (required) — Unique code for the addon (sent as addon_code).
  • addonName (required) — Display name of the addon.
  • addonUnitName (required) — Unit name (e.g. the unit the addon is measured in), sent as unit_name.
  • addonPricingScheme (required) — Pricing scheme: unit, volume, tier or package.
  • addonType (required) — Recurring or one_time.
  • addonIntervalUnit — Monthly or yearly. Shown and sent only when type is recurring.
  • addonProductId (required) — ID of the product the addon belongs to.
  • addonApplicableToAllPlans — Whether the addon applies to all plans (default true).
  • addonPlanCodes (required) — Comma-separated plan codes; shown and sent (as plans: [{plan_code}]) only when Applicable To All Plans is false.
  • addonPriceBrackets (required) — One or more brackets with start quantity, end quantity and price, sent as price_brackets. Non-numeric fields are omitted.
  • addonDescription — Optional description; omitted if blank.

Output shape

One output item per input item containing the JSON response from Zoho Billing (typically the created addon object).

If Continue On Fail is enabled, failed items return {error: message} instead of throwing. Each output item is paired with its input item.

Examples

Example 1: Add a monthly per-seat addon available on all plans

Addon Code=extra_seat, Name=Extra Seat, Unit Name=seat, Pricing Scheme=unit, Type=Recurring, Interval Unit=Monthly, Product ID set, Applicable To All Plans=true, one bracket 1–1 price 10.

Example 2: Create a one-time setup addon limited to specific plans

Type=One Time, Applicable To All Plans=false, Plan Codes='basic,pro', one price bracket.

Links

Discussion