Search.../
  1. APIs

createPlan( )

Creates a pricing plan.

Description

The createPlan() function returns a Promise that resolves to a newly-created pricing plan after it has successfully been created.

The passed PlanInfo object must contain a pricing model. A pricing model is one of the following:

  • A subscription: A subscription with recurring payments and how often the plan recurs. Subscriptions can have free trial days.
  • A plan that does not renew: A single payment for a specific duration that does not renew.
  • An unlimited plan: A single payment for an unlimited amount of time (until cancelled).

Pricing plans created by this function are available to the site owner in the Pricing Plans section in the Dashboard.

Only users with "Manage Pricing Plans" permissions can create plans.

Syntax

function createPlan(planInfo: CreatePlanInfo): Promise<Plan>

createPlan Parameters

NAME
TYPE
DESCRIPTION
planInfo
CreatePlanInfo

The information for the plan being created.

Returns

Fulfilled - The created plan. Rejected - Error message.

Return Type:

Promise<Plan>
NAME
TYPE
DESCRIPTION
_id
string

Plan ID.

name
string

Plan name.

description
string

Plan description.

perks
Array<string>

List of text strings that promote the pricing plan (for example, "Plenty of parking" or "Free gift on your birthday").

pricing
Pricing

Plan price, payment schedule, and expiration.

public
boolean

Whether the plan is public (visible to site visitors).

archived
boolean

Whether the plan is archived. Archived plans are not visible and can't be purchased anymore, but existing purchases remain in effect.

primary
boolean

Whether the plan is marked as primary. If true, the plan is highlighted on the site with a custom ribbon. Defaults to false.

hasOrders
boolean

Whether the plan has any orders (including pending and unpaid orders).

_createdDate
Date

Date plan was created.

_updatedDate
Date

Date plan was last updated.

slug
string

URL-friendly version of the plan name. Unique across all plans in the same site.

allowFutureStartDate
boolean

Whether the buyer can start the plan at a later date.

buyerCanCancel
boolean

Whether the buyer is allowed to cancel their plan. If false, calling the cancelOrder() function returns an error.

maxPurchasesPerBuyer
number

Whether the same buyer can purchase the plan multiple times. 1 means the buyer can only purchase the plan once. An empty value or 0 means no limitation.

termsAndConditions
string

Any terms and conditions that apply to the plan. This information is displayed during checkout.

Was this helpful?

Create a plan

Copy Code
1/*******************************
2 * Backend code - plans.jsw *
3 *******************************/
4

5import wixPricingPlansBackend from 'wix-pricing-plans-backend';
6

7export function myCreatePlanFunction(planInfo) {
8  return wixPricingPlansBackend.createPlan(planInfo);
9}
10

11/*************
12 * Page code *
13 *************/
14

15import { myCreatePlanFunction } from 'backend/plans';
16

17// …
18

19const planInfo = {
20    "name": "Gold",
21    "description": "Gold membership to the MyGame World of Online Gaming",
22    "perks": [ 
23      "Multiplayer", 
24      "Multiple devices", 
25      "No ads",
26      "Unlimited access"
27    ],
28    "pricing": {
29      "price": {
30        "value": "10.00",
31        "currency": "USD"
32      },
33      "singlePaymentUnlimited": true
34    },
35    "public": true,
36    "maxPurchasesPerBuyer": 1,
37    "allowFutureStartDate": true,
38    "buyerCanCancel": true,
39    "termsAndConditions": "No sharing access with others!"
40  }
41

42myCreatePlanFunction(planInfo)
43  .then((plan) => {
44    // plan created
45    const planId = plan._id;
46    const description = plan.description;
47    console.log(plan);
48  })
49  .catch((error) => {
50    // plan not created 
51    const createError = error;
52  });
53

54

55/* Full plan object:
56 *
57 * {
58 *  "_id": "1ff7b4c8-877b-7896-11aa-6c69ae0b18eb",
59 *   "name": "Gold",
60 *   "description": "Gold membership to the MyGame World of Online Gaming",
61 *   "perks": [
62 *     "Multiplayer",
63 *     "Multiple devices",
64 *     "No ads",
65 *     "Unlimited access"
66 *   ],
67 *   "pricing": {
68 *    "price": {
69 *       "value": "10.00",
70 *       "currency": "USD"
71 *     },
72 *     "singlePaymentUnlimited": true
73 *   },
74 *   "public": true,
75 *   "archived": false,
76 *   "primary": false,
77 *   "hasOrders": false,
78 *   "_createdDate": "2020-12-21T09:38:14.939Z",
79 *   "_updatedDate": "2020-12-21T09:38:14.939Z",
80 *   "slug": "gold",
81 *   "maxPurchasesPerBuyer": 1,
82 *   "allowFutureStartDate": true,
83 *   "buyerCanCancel": true,
84 *   "termsAndConditions": "No sharing access with others!" 
85 * }
86 */