createPlan( )

Creates a plan with specified billing terms and a pricing strategy.

To create the most common types of plans:

  • One-time: Specify a billingCycle that's the desired duration and set endType to CYCLES_COMPLETED and cyclesCompletedDetails.billingCycleCount to 1.
  • Recurring: Define the recurrence rule using the plan's billingCycle object.
  • Free plan: Set the plan's flatRate.amount to 0 and maxPurchasesPerBuyer to 1.
Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage Pricing Plans
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
planPlanRequired

Plan to create.

optionsCreatePlanOptions
Returns
Return Type:Promise<Plan>
Errors
400Invalid Argument

There are 9 errors with this status code.

404Not Found

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?