createPlan( )

Creates a pricing plan. The specified plan object must contain a pricing model. A pricing model can be 1 of the following:

  • A subscription: A subscription with recurring payments and how often the plan occurs. Subscriptions can have free trial days.
  • A plan that doesn't renew: A single payment for a specific duration that doesn't renew.
  • An unlimited plan: A single payment for an unlimited amount of time (until canceled). Pricing plans are available to the Wix user in the Pricing Plans section in a site's dashboard.
Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Pricing Plans
Learn more about app permissions.
Method Declaration
Copy
function createPlan(plan: Plan): Promise<Plan>;
Method Parameters
planPlanRequired

Information for the plan being created.

Returns
Return Type:Promise<Plan>
JavaScript
import { plans } from "@wix/pricing-plans";

async function createPlan(plan) {
  const response = await plans.createPlan(plan);
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?