Create a plan

This query allows you to create a plan without using the Billsby application. You will need to add the plan to an existing product, which can be created via the query above, or through the Billsby application.

Returned variables

Variable name	Description
planId	The unique identifier of the plan in the Billsby platform
name	The name of the plan
displayName	The display name of the plan
description	The description of the plan
pricingModelType	The type of plan; flat fee, volume, tiered, etc.; FlatFee = 1, PerUnit = 2, Tiered = 4, Volume = 5, Ranged = 6
productId	The unique identifier of the product that the plan sits under
cycleId	The unique identifier of the plan in the Billsby platform
pricingModelId	The unique identifier of the pricing model in the Billsby platform
frequency	The frequency of the billing cycle
frequencyType	The frequency type; days, months, years, etc.; Daily = 1, Weekly = 2, Monthly = 3, Yearly = 4
freeTrial	Does the plan have a free trial
freeTrialFrequencyType	The length of the free trial; Daily = 1, Weekly = 2, Monthly = 3, Yearly = 4
contractTerm	Does the plan have a contract term
contractTermFrequencyType	Contract term frequency;
setupFeePrice	The price of the set up fee for the plan
freeQuantity	Quantity of free units
billingDateType	The type of billing date for the plan; on the anniversary of the customer signing up or on a fixed day. Anniversary = 1, FixedDayEachMonth = 2, FixedDayOfTheWeek = 3
fixedBillingDateDay	The fixed billing date if there is one
proRateOption	The chose option for pro-rating; DoNotProRate = 1, DoNotChargeUntilNextCycle = 2, ProRateBasedOnDaysRemaining = 3
visibility	The visibility of the plan; public or hidden
featureTags	Any feature tags associated with the plan
redirectUrl	The redirect URL that has been set up for this plan
hasActiveSubscription	Does the plan have any active subscribers; true or false
alertEmail	The alert email that has been set for this plan