Addons
An addon contains additional features that are not part of the subscribed plan, but are made available to customers on purchase of the addon. There are two kinds of addons - one-time and recurring. For a one-time addon, customers pay only once at the time of subscription, whereas for a recurring addon, customers have to pay for the addon each time they pay for the plan’s subscription. An addon can be associated with one or more plans of a product.
Attribute
unit
, volume
, tier
or package
. To know more about pricing schemes click here.recurring
or one_time
.monthly
or yearly
.true
; otherwise, it is set to false
.applicable_to_all_plans
is set to false. Only the plan codes of the plans that need to be associated with are required.active
or inactive
.inter
or intra
.Create an addon
Create a new addon.
OAuth Scope : ZohoSubscriptions.addons.CREATE
Arguments
unit
, volume
, tier
or package
. To know more about pricing schemes click here.recurring
or one_time
.monthly
or yearly
.true
; otherwise, it is set to false
.applicable_to_all_plans
is set to false. Only the plan codes of the plans that need to be associated with are required.inter
or intra
.List all addons
List of all addons.
OAuth Scope : ZohoSubscriptions.addons.READ
Query Parameters
filter_by
. The allowed values for filter_by are AddonStatus.(All
, ACTIVE
, INACTIVE
,ONETIME
and RECURRING
)product_id
.Update an addon
Update details of an existing addon.
OAuth Scope : ZohoSubscriptions.addons.UPDATE
Arguments
unit
, volume
, tier
or package
. To know more about pricing schemes click here.recurring
or one_time
.monthly
or yearly
.true
; otherwise, it is set to false
.applicable_to_all_plans
is set to false. Only the plan codes of the plans that need to be associated with are required.inter
or intra
.Retrieve an addon
Details for an existing Addon.
OAuth Scope : ZohoSubscriptions.addons.READ
Delete an addon
Delete an existing addon.
OAuth Scope : ZohoSubscriptions.addons.DELETE
Mark as active
Change status of the addon to active.
OAuth Scope : ZohoSubscriptions.addons.CREATE
Mark as inactive
Change status of the addon to inactive.
OAuth Scope : ZohoSubscriptions.addons.CREATE