Coupons
Coupons are used to provide discounts and special offers to customers. These coupons can be applied to a subscription at any time.
Attribute
one_time
, duration
, forever
.active
, inactive
, expired
or maxed_out
flat
or percentage
.discount_by
, it can be flat discount or a percentage value. Discount will be deducted from the plans/addons the coupon is associated with.maxed_out
once this limit is reached.type
=forever
already applied to subscriptions can still be redeemed.all
, none
or select
.apply_to_plans
is set to be selected. Only the plan codes of the plans that need to be associated with the coupon are required.all_addons
, all_recurring
,all_onetime
, none
or select
.apply_to_addons
is set to be selected. Only the addon codes of the addons that need to be associated with the coupon are required.Create an coupon
Create a new coupon.
OAuth Scope : ZohoSubscriptions.coupons.CREATE
Arguments
one_time
, duration
, forever
.flat
or percentage
.discount_by
, it can be flat discount or a percentage value. Discount will be deducted from the plans/addons the coupon is associated with.maxed_out
once this limit is reached.type
=forever
already applied to subscriptions can still be redeemed.all
, none
or select
. apply_to_plans
is selected
apply_to_plans
is set to be selected. Only the plan codes of the plans that need to be associated with the coupon are required.all_addons
, all_recurring
,all_onetime
, none
or select
. apply_to_addons
is selected
apply_to_addons
is set to be selected. Only the addon codes of the addons that need to be associated with the coupon are required.List all coupons
List of all coupons.
OAuth Scope : ZohoSubscriptions.coupons.READ
Query Parameters
filter_by
. The allowed values for filter_by are CouponStatus.(All
, ACTIVE
, INACTIVE
and EXPIRED
).product_id
.Update a coupon
Update details of an existing coupon.
OAuth Scope : ZohoSubscriptions.coupons.UPDATE
Arguments
maxed_out
once this limit is reached.type
=forever
already applied to subscriptions can still be redeemed.Retrieve a coupon
Details of an existing coupon.
OAuth Scope : ZohoSubscriptions.coupons.READ
Delete a coupon
Delete an existing coupon.
OAuth Scope : ZohoSubscriptions.coupons.DELETE
Mark as active
status of the coupon will be changed to active.
OAuth Scope : ZohoSubscriptions.coupons.CREATE
Mark as inactive
status of the coupon will be changed to inactive.
OAuth Scope : ZohoSubscriptions.coupons.CREATE