Plans
A plan object contains the billing and pricing information of a plan. Your organization may consist of plans that differ either by features or by the plan’s billing frequency. You can have a $10 basic plan, $20 professional plan, $24 monthly or a $240 yearly plan.
Attribute
active
or inactive
.months
or years
. For interval=2 and interval_unit=months, the customer is billed every two months.inter
or intra
.addon_code
and name
as properties. active
or inactive
.Create a plan
Create a new plan.
OAuth Scope : ZohoSubscriptions.plans.CREATE
Arguments
months
or years
. For interval=2 and interval_unit=months, the customer is billed every two months.inter
or intra
.List all plans
List of all plans created.
OAuth Scope : ZohoSubscriptions.plans.READ
Query Parameters
filter_by
. The allowed values for filter_by are PlanStatus.(All
, ACTIVE
and INACTIVE
).product_id
. Update a plan
Update details of an existing plan.
OAuth Scope : ZohoSubscriptions.plans.UPDATE
Arguments
months
or years
. For interval=2 and interval_unit=months, the customer is billed every two months.addon_code
and name
as properties.inter
or intra
.Retrieve a plan
Retrieve details of an existing plan.
OAuth Scope : ZohoSubscriptions.plans.READ
Delete a plan
Delete an existing plan. A plan can only be deleted if it has no transactions associated with it.
OAuth Scope : ZohoSubscriptions.plans.DELETE
Mark as active
Change the status of the plan to active.
OAuth Scope : ZohoSubscriptions.plans.CREATE
Mark as inactive
Change the status of the plan to inactive.
OAuth Scope : ZohoSubscriptions.plans.CREATE