{"id":"bd178f9d-0108-4d45-9183-5791c287bd09","createdDate":"2024-09-30T09:49:30.798Z","updatedDate":"2024-09-30T09:49:30.798Z","resourceId":"19bd35f5-20d1-4aa5-9201-31a0224a58da","sdk":{"schema":{"name":"velo-deps_wix-pricing-plans.v2_plans","fqn":"","slug":"velo-deps-wix-pricing-plans-v2-plans","typesMap":{"ArchivePlanResponse":{"name":"ArchivePlanResponse","fqn":"ArchivePlanResponse","slug":"archive-plan-response","actions":[],"properties":[{"name":"plan","slug":"plan","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Plan","referenceFqn":"Plan"},"description":"Archived plan info."}]},"Plan":{"name":"Plan","fqn":"Plan","slug":"plan","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date plan was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Plan ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date plan was last updated."},{"name":"allowFutureStartDate","slug":"allow-future-start-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the buyer can start the plan at a later date.\n\nDefault: `false`."},{"name":"archived","slug":"archived","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the plan is archived. Archived plans are not visible and can't be purchased anymore, but existing purchases remain in effect."},{"name":"buyerCanCancel","slug":"buyer-can-cancel","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the buyer is allowed to cancel their plan. If `false`, calling the [`requestCancellation()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/requestcancellation) function returns an error.\n\nDefault: `true`."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Plan description."},{"name":"formId","slug":"form-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the form associated with the plan at checkout."},{"name":"hasOrders","slug":"has-orders","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the plan has any orders (including pending and unpaid orders)."},{"name":"maxPurchasesPerBuyer","slug":"max-purchases-per-buyer","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of times the same buyer can purchase the plan. Currently limited to support:\n- Empty value or a value of `0`, meaning no limitation.\n- Value of `1`, meaning limited to one purchase per buyer."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Plan name."},{"name":"perks","slug":"perks","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"StringList","referenceFqn":"StringList"},"description":"List of text strings that promote what is included with this plan.\n\nFor example, \"Plenty of parking\" or \"Free gift on your birthday\"."},{"name":"pricing","slug":"pricing","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Pricing","referenceFqn":"Pricing"},"description":"Plan price, payment schedule, and expiration."},{"name":"primary","slug":"primary","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the plan is marked as primary. If `true`, the plan is highlighted on the site with a custom ribbon.\n\nDefault: `false`."},{"name":"public","slug":"public","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the plan is public (visible to site visitors and members)."},{"name":"slug","slug":"slug","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"URL-friendly version of plan name. Unique across all plans in the same site."},{"name":"termsAndConditions","slug":"terms-and-conditions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Any terms and conditions that apply to the plan. This information will be displayed during checkout."}]},"StringList":{"name":"StringList","fqn":"StringList","slug":"string-list","actions":[],"properties":[{"name":"values","slug":"values","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}}}]},"Pricing":{"name":"Pricing","fqn":"Pricing","slug":"pricing","actions":[],"oneofProperties":{"pricingModel":[{"name":"singlePaymentForDuration","slug":"single-payment-for-duration","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Duration","referenceFqn":"Duration"},"description":"One time payment, plan is valid for the specified duration."},{"name":"singlePaymentUnlimited","slug":"single-payment-unlimited","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"One time payment, plan is valid until it is canceled."},{"name":"subscription","slug":"subscription","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Recurrence","referenceFqn":"Recurrence"},"description":"Plan has recurring payments."}]},"properties":[{"name":"freeTrialDays","slug":"free-trial-days","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Free trial period for the plan in days. Available only for recurring plans, meaning plans whose pricing model is `subscription`. Set to `0` to remove the free trial."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Money","referenceFqn":"Money"},"description":"Amount for a single payment. For subscriptions, this is the amount to pay each payment cycle and it is required. For plans that are not recurring plans, it is the single payment amount for the whole subscription."}]},"FeeConfig":{"name":"FeeConfig","fqn":"FeeConfig","slug":"fee-config","actions":[],"properties":[{"name":"appliedAt","slug":"applied-at","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AppliedAt","referenceFqn":"AppliedAt"},"description":"The time this fee will be charged"},{"name":"fee","slug":"fee","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Fee","referenceFqn":"Fee"},"description":"Fee configuration."}]},"AppliedAt":{"name":"AppliedAt","fqn":"AppliedAt","slug":"applied-at","actions":[],"enumValues":["FIRST_PAYMENT","UNKNOWN_CHARGE_EVENT"],"properties":[]},"Fee":{"name":"Fee","fqn":"Fee","slug":"fee","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Amount of fee to be charged"},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Fee name"}]},"Money":{"name":"Money","fqn":"Money","slug":"money","actions":[],"properties":[{"name":"currency","slug":"currency","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Currency code. Three-letter currency code in\n[ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `'USD'`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Monetary amount. Decimal string with a period as a decimal separator. For example, `'3.99'`. Cannot be a negative value."}]},"Duration":{"name":"Duration","fqn":"Duration","slug":"duration","actions":[],"properties":[{"name":"count","slug":"count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of days days, months, weeks, or years in a single payment cycle. Currently limited to support only `1`."},{"name":"unit","slug":"unit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PeriodUnit","referenceFqn":"PeriodUnit"},"description":"Unit of time for the cycle duration."}]},"PeriodUnit":{"name":"PeriodUnit","fqn":"PeriodUnit","slug":"period-unit","actions":[],"enumValues":["DAY","MONTH","UNDEFINED","WEEK","YEAR"],"properties":[]},"Recurrence":{"name":"Recurrence","fqn":"Recurrence","slug":"recurrence","actions":[],"properties":[{"name":"cycleCount","slug":"cycle-count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Amount of payment cycles the subscription is valid for.\n\n`0` for unlimited plans or for plans that are valid until canceled."},{"name":"cycleDuration","slug":"cycle-duration","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Duration","referenceFqn":"Duration"},"description":"Length of one payment cycle. For example, 1 month to have monthly payments. Multiply `cycleDuration`'s `count` by `cycleCount` to get the subscription duration. Currently, only a value of `1` is supported."}]},"BulkArchivePlanOptions":{"name":"BulkArchivePlanOptions","fqn":"BulkArchivePlanOptions","slug":"bulk-archive-plan-options","actions":[],"properties":[{"name":"returnFullEntity","slug":"return-full-entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Set to true to return Plan entity in response."}]},"BulkArchivePlanResponse":{"name":"BulkArchivePlanResponse","fqn":"BulkArchivePlanResponse","slug":"bulk-archive-plan-response","actions":[],"properties":[{"name":"bulkActionMetadata","slug":"bulk-action-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BulkActionMetadata","referenceFqn":"BulkActionMetadata"},"description":"Bulk action metadata."},{"name":"results","slug":"results","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"BulkPlanResult","referenceFqn":"BulkPlanResult"}},"description":"Plans to be archived."}]},"BulkActionMetadata":{"name":"BulkActionMetadata","fqn":"BulkActionMetadata","slug":"bulk-action-metadata","actions":[],"properties":[{"name":"totalFailures","slug":"total-failures","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items that couldn't be processed."},{"name":"totalSuccesses","slug":"total-successes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items that were successfully processed."},{"name":"undetailedFailures","slug":"undetailed-failures","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of failures without details because detailed failure threshold was exceeded."}]},"BulkPlanResult":{"name":"BulkPlanResult","fqn":"BulkPlanResult","slug":"bulk-plan-result","actions":[],"properties":[{"name":"itemMetadata","slug":"item-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemMetadata","referenceFqn":"ItemMetadata"},"description":"Item metadata."},{"name":"plan","slug":"plan","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Plan","referenceFqn":"Plan"},"description":"Pricing plan."}]},"ItemMetadata":{"name":"ItemMetadata","fqn":"ItemMetadata","slug":"item-metadata","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item)."},{"name":"error","slug":"error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ApplicationError","referenceFqn":"ApplicationError"},"description":"Details about the error in case of failure."},{"name":"originalIndex","slug":"original-index","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Index of the item within the request array. Allows for correlation between request and response items."},{"name":"success","slug":"success","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated."}]},"ApplicationError":{"name":"ApplicationError","fqn":"ApplicationError","slug":"application-error","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Error code."},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Data related to the error."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description of the error."}]},"CountPlansOptions":{"name":"CountPlansOptions","fqn":"CountPlansOptions","slug":"count-plans-options","actions":[],"properties":[{"name":"filter","slug":"filter","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"The filter."},{"name":"visibility","slug":"visibility","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"If true, will count only visible plans (visible and not archived). If no value is given all site's plans will be counted."}]},"CountPlansResponse":{"name":"CountPlansResponse","fqn":"CountPlansResponse","slug":"count-plans-response","actions":[],"properties":[{"name":"count","slug":"count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of plans in the response."}]},"GetPlanStatsResponse":{"name":"GetPlanStatsResponse","fqn":"GetPlanStatsResponse","slug":"get-plan-stats-response","actions":[],"properties":[{"name":"totalPlans","slug":"total-plans","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Total number of plans created, including active plans (both public and hidden) and archived plans."}]},"GetPlansPremiumStatusResponse":{"name":"GetPlansPremiumStatusResponse","fqn":"GetPlansPremiumStatusResponse","slug":"get-plans-premium-status-response","actions":[],"properties":[{"name":"hasOldPlans","slug":"has-old-plans","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"True if site has plans that were created before Pricing Plans became a premium app."},{"name":"hasPaidPlans","slug":"has-paid-plans","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"True if site has non-free, non-template plans."}]},"ListPlansOptions":{"name":"ListPlansOptions","fqn":"ListPlansOptions","slug":"list-plans-options","actions":[],"properties":[{"name":"archived","slug":"archived","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ArchivedFilter","referenceFqn":"ArchivedFilter"},"description":"Archived filter.\n\nDefault: `ACTIVE` (not archived)."},{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of pricing plans to list.\n\nDefault: `75`."},{"name":"offset","slug":"offset","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of pricing plans to skip.\n\nDefault: `0`."},{"name":"planIds","slug":"plan-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"IDs of plans to list. If non-existent IDs are specified, they are ignored and don't cause errors. If no IDs are specified, all public and hidden plans (based on `options`) are listed according to the [order](#arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs."},{"name":"public","slug":"public","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PublicFilter","referenceFqn":"PublicFilter"},"description":"Visibility filter.\n\nDefault: `PUBLIC_AND_HIDDEN` (meaning, both public and hidden plans are listed)."}]},"ArchivedFilter":{"name":"ArchivedFilter","fqn":"ArchivedFilter","slug":"archived-filter","actions":[],"enumValues":["ACTIVE","ARCHIVED","ARCHIVED_AND_ACTIVE"],"properties":[]},"PublicFilter":{"name":"PublicFilter","fqn":"PublicFilter","slug":"public-filter","actions":[],"enumValues":["HIDDEN","PUBLIC","PUBLIC_AND_HIDDEN"],"properties":[]},"ListPlansResponse":{"name":"ListPlansResponse","fqn":"ListPlansResponse","slug":"list-plans-response","actions":[],"properties":[{"name":"pagingMetadata","slug":"paging-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PagingMetadataV2","referenceFqn":"PagingMetadataV2"},"description":"Details on the paged set of pricing plans returned."},{"name":"plans","slug":"plans","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Plan","referenceFqn":"Plan"}},"description":"List of all public and hidden pricing plans."}]},"PagingMetadataV2":{"name":"PagingMetadataV2","fqn":"PagingMetadataV2","slug":"paging-metadata-v2","actions":[],"properties":[{"name":"count","slug":"count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items returned in the response."},{"name":"cursors","slug":"cursors","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Cursors","referenceFqn":"Cursors"},"description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used."},{"name":"offset","slug":"offset","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Offset that was requested."},{"name":"tooManyToCount","slug":"too-many-to-count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Flag that indicates the server failed to calculate the `total` field."},{"name":"total","slug":"total","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set."}]},"Cursors":{"name":"Cursors","fqn":"Cursors","slug":"cursors","actions":[],"properties":[{"name":"next","slug":"next","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Cursor string pointing to the next page in the list of results."},{"name":"prev","slug":"prev","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Cursor pointing to the previous page in the list of results."}]},"ListPublicPlansOptions":{"name":"ListPublicPlansOptions","fqn":"ListPublicPlansOptions","slug":"list-public-plans-options","actions":[],"properties":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of pricing plans to list.\n\nDefault: `75`."},{"name":"offset","slug":"offset","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of pricing plans to skip.\n\nDefault: `0`."},{"name":"planIds","slug":"plan-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"IDs of public plans to list. If non-existent IDs are specified, they are ignored and don't cause errors. If no IDs are specified, all public are listed according to the [order](#arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs."}]},"ListPublicPlansResponse":{"name":"ListPublicPlansResponse","fqn":"ListPublicPlansResponse","slug":"list-public-plans-response","actions":[],"properties":[{"name":"pagingMetadata","slug":"paging-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PagingMetadataV2","referenceFqn":"PagingMetadataV2"},"description":"Details on the paged set of public pricing plans returned."},{"name":"plans","slug":"plans","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"PublicPlan","referenceFqn":"PublicPlan"}},"description":"List of public pricing plans."}]},"PublicPlan":{"name":"PublicPlan","fqn":"PublicPlan","slug":"public-plan","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date plan was created."},{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Plan ID."},{"name":"_updatedDate","slug":"updated-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date plan was last updated."},{"name":"allowFutureStartDate","slug":"allow-future-start-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the buyer can start the plan at a later date. Defaults to false."},{"name":"buyerCanCancel","slug":"buyer-can-cancel","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the buyer is allowed to cancel their plan. Defaults to false."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Plan description."},{"name":"formId","slug":"form-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the form associated with the plan at checkout."},{"name":"maxPurchasesPerBuyer","slug":"max-purchases-per-buyer","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of times the same buyer can purchase the plan. An empty value or a value of zero means no limitation."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Plan name."},{"name":"perks","slug":"perks","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"StringList","referenceFqn":"StringList"},"description":"What is included with this plan (e.g., 1 weekly entrance to a specific class)."},{"name":"pricing","slug":"pricing","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Pricing","referenceFqn":"Pricing"},"description":"Plan price, payment schedule, and expiration."},{"name":"primary","slug":"primary","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the plan is marked as primary."},{"name":"slug","slug":"slug","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"URL-friendly version of plan name. Unique across all plans in the same site."},{"name":"termsAndConditions","slug":"terms-and-conditions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Any terms and conditions that apply to the plan. This information will be displayed during checkout."}]},"MakePlanPrimaryResponse":{"name":"MakePlanPrimaryResponse","fqn":"MakePlanPrimaryResponse","slug":"make-plan-primary-response","actions":[],"properties":[{"name":"plan","slug":"plan","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Plan","referenceFqn":"Plan"},"description":"Primary plan info."}]},"QueryPlansOptions":{"name":"QueryPlansOptions","fqn":"QueryPlansOptions","slug":"query-plans-options","actions":[],"properties":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"QueryV2","referenceFqn":"QueryV2"},"description":"Query"}]},"QueryV2":{"name":"QueryV2","fqn":"QueryV2","slug":"query-v2","actions":[],"properties":[{"name":"filter","slug":"filter","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"A filter object. See [supported fields and operators](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/filter-and-sort#wix-pricing-plans_pricing-plans_plans_filter-and-sort_query-public-plans)"},{"name":"paging","slug":"paging","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Paging","referenceFqn":"Paging"},"description":"Pointer to page of results using offset. Can not be used together with 'cursorPaging'"},{"name":"sort","slug":"sort","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Sorting","referenceFqn":"Sorting"}},"description":"Sort object in the form [{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]"}]},"Paging":{"name":"Paging","fqn":"Paging","slug":"paging","actions":[],"properties":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to load."},{"name":"offset","slug":"offset","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to skip in the current sort order."}]},"Sorting":{"name":"Sorting","fqn":"Sorting","slug":"sorting","actions":[],"properties":[{"name":"fieldName","slug":"field-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the field to sort by."},{"name":"order","slug":"order","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SortOrder","referenceFqn":"SortOrder"},"description":"Sort order."}]},"SortOrder":{"name":"SortOrder","fqn":"SortOrder","slug":"sort-order","actions":[],"enumValues":["ASC","DESC"],"properties":[]},"QueryPlansResponse":{"name":"QueryPlansResponse","fqn":"QueryPlansResponse","slug":"query-plans-response","actions":[],"properties":[{"name":"pagingMetadata","slug":"paging-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PagingMetadataV2","referenceFqn":"PagingMetadataV2"},"description":"Object containing paging-related data (number of plans returned, offset)."},{"name":"plans","slug":"plans","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Plan","referenceFqn":"Plan"}},"description":"List of pricing plans that match the specified query."}]},"PlansQueryBuilder":{"name":"PlansQueryBuilder","fqn":"PlansQueryBuilder","slug":"plans-query-builder","actions":[{"name":"ascending","fqn":"PlansQueryBuilder.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PlansQueryBuilder","referenceFqn":"PlansQueryBuilder"},"examples":[{"title":"Add an `ascending` sort to a query","content":"const query = plans.queryPublicPlans.ascending('_id');\n"},{"title":"Create a query, add an `ascending` sort, and run it","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans.queryPublicPlans().ascending('_id').find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyNames","slug":"property-names","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Properties used in the sort. To sort by multiple properties, pass properties as additional arguments."}],"description":"Adds a sort to a query, sorting by the specified properties in ascending order.\n\nThe `ascending()` function refines a `PlansQueryBuilder` to sort by the value of `propertyName` in ascending order.\nYou can specify multiple properties for sorting in ascending order by passing each property name as an additional argument. `ascending()` sorts the results in the order the properties are passed.\nYou can sort the following types:\n- Number: Sorts numerically.\n- Date: Sorts by date and time.\n- String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`.\nIf a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest."},{"name":"descending","fqn":"PlansQueryBuilder.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PlansQueryBuilder","referenceFqn":"PlansQueryBuilder"},"examples":[{"title":"Add a `descending` sort to a query","content":"const query = plans.queryPublicPlans.descending('_id');\n"},{"title":"Create a query, add a `descending` sort, and run it","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans.queryPublicPlans().descending('_id').find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyNames","slug":"property-names","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Properties used in the sort. To sort by multiple properties, pass properties as additional arguments."}],"description":"Adds a sort to a query, sorting by the specified properties in descending order.\n\nThe `descending()` function refines a `PlansQueryBuilder` to sort by the value of `propertyName` in descending order.\nYou can specify multiple properties for sorting in descending order by passing each property name as an additional argument. `descending()` sorts the results in the order the properties are passed.\nYou can sort the following types:\n- Number: Sorts numerically.\n- Date: Sorts by date and time.\n- String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`.\nIf a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest."},{"name":"eq","fqn":"PlansQueryBuilder.eq","slug":"eq","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PlansQueryBuilder","referenceFqn":"PlansQueryBuilder"},"examples":[{"title":"Add an `eq` filter to a query","content":"const query = plans.queryPublicPlans.eq('_id', 'some-id');\n"},{"title":"Create a query, add an `eq` filter, and run it","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans\n .queryPublicPlans()\n .eq('_id', 'bb19b637-74ce-55d3-ae32-430b588051da')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property equals the specified value.\n\nThe `eq()` function refines a `PlansQueryBuilder` to match only items where the value of the specified `propertyName` equals the specified `value`.\n`eq()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nMatching strings with `eq()` is case-sensitive, so `'text'` isn't equal to `'Text'`."},{"name":"exists","fqn":"PlansQueryBuilder.exists","slug":"exists","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PlansQueryBuilder","referenceFqn":"PlansQueryBuilder"},"examples":[{"title":"Add an `exists` filter to a query","content":"const query = plans.queryPublicPlans.exists('description', 'some-description');\n"},{"title":"Create a query, add an `exists` filter, and run it","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans\n .queryPublicPlans()\n .exists('description', 'some-description')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"}}],"description":"Refines a query to match items where the specified property contains a value.\n\nThe `exists()` function refines a `PlansQueryBuilder` to only match items where the value of the specified `propertyName` doesn't equal null or undefined.\n `exists()` checks for either existence or non-existence based on the boolen parameter. Note that `exists()` does match items where the value of the specified `propertyName` is an empty string or an invalid value. `exists()` is only useful for properties which don't contain default values and therefore their values may be unassigned."},{"name":"find","fqn":"PlansQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"PlansQueryResult","referenceFqn":"PlansQueryResult"}},"examples":[{"title":"Run a query with no filters","content":"const query = plans.queryPublicPlans.find();\n"},{"title":"Perform a `find` on a query","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans.queryPublicPlans().find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"description":"Returns the query results.\n\nThe `find()` function returns a Promise that resolves to the query results and metadata.\nThe Promise is rejected if `find()` is called with insufficient permissions or if any of the previous functions used to refine the query are invalid."},{"name":"ge","fqn":"PlansQueryBuilder.ge","slug":"ge","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PlansQueryBuilder","referenceFqn":"PlansQueryBuilder"},"examples":[{"title":"Add a `ge` filter to a query","content":"const query = plans.queryPublicPlans.ge('_createdDate', '2021-03-01');\n"},{"title":"Create a query, add a `ge` filter, and run it","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans\n .queryPublicPlans()\n .ge('_createdDate', '2021-03-01')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is greater than or equal to the specified value.\n\nThe `ge()` function refines a `PlansQueryBuilder` to match only items where the value of the specified `propertyName` is greater than or equal to the specified `value`.\n`ge()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'abc'` is greater than `'ABC'`."},{"name":"gt","fqn":"PlansQueryBuilder.gt","slug":"gt","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PlansQueryBuilder","referenceFqn":"PlansQueryBuilder"},"examples":[{"title":"Add a `gt` filter to a query","content":"const query = plans.queryPublicPlans.gt('_createdDate', '2021-03-01');\n"},{"title":"Create a query, add a `gt` filter, and run it","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans\n .queryPublicPlans()\n .gt('_createdDate', '2021-03-01')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is greater than the specified value.\n\nThe `gt()` function refines a `PlansQueryBuilder` to match only items where the value of the specified `propertyName` is greater than the specified `value`.\n`gt()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'abc'` is greater than `'ABC'`."},{"name":"hasSome","fqn":"PlansQueryBuilder.hasSome","slug":"has-some","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PlansQueryBuilder","referenceFqn":"PlansQueryBuilder"},"examples":[{"title":"Add a `hasSome` filter to a query","content":"const query = plans.queryPublicPlans.hasSome('labelIds', [\n 'red',\n 'blue',\n 'purple',\n]);\n"},{"title":"Create a query, add a `hasSome` filter, and run it","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans\n .queryPublicPlans()\n .hasSome('labelIds', ['red', 'blue', 'purple'])\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `values`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"any"}}}],"description":"Refines a query to match items whose specified property contains any of the specified values.\n\nThe `hasSome()` function refines a `PlansQueryBuilder` to match only items where the value of the specified `propertyName` equals any of the specified `values`.\nMatching strings with `hasSome()` is case-sensitive, so `'text'` isn't equal to `'Text'`.\nIf the specified property is an array, `hasSome()` matches if any of that array's elements equal any of the specified values."},{"name":"in","fqn":"PlansQueryBuilder.in","slug":"in","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PlansQueryBuilder","referenceFqn":"PlansQueryBuilder"},"examples":[{"title":"Add an `in` filter to a query","content":"const query = plans.queryPublicPlans.in(\n ['labelIds', 'colors'],\n ['red', 'blue', 'purple']\n);\n"},{"title":"Create a query, add an `in` filter, and run it","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans\n .queryPublicPlans()\n .in(['labelIds', 'colors'], ['red', 'blue', 'purple'])\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"}}],"description":"Refines a query to only match items where the specified property conatins any of the values in the provided array of values.\n\nThe `in()` function refines a `PlansQueryBuilder` to match only items where the specified `propertyName` is equal to any of the values in the provided array.\nMatching strings with `in()` is case-sensitive, so `'text'` isn't equal to `'Text'`."},{"name":"le","fqn":"PlansQueryBuilder.le","slug":"le","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PlansQueryBuilder","referenceFqn":"PlansQueryBuilder"},"examples":[{"title":"Add an `le` filter to a query","content":"const query = plans.queryPublicPlans.le('_createdDate', '2021-03-01');\n"},{"title":"Create a query, add an `le` filter, and run it","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans\n .queryPublicPlans()\n .le('_createdDate', '2021-03-01')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is less than or equal to the specified value.\n\nThe `le()` function refines a `PlansQueryBuilder` to match only items where the value of the specified `propertyName` is less than or equal to the specified `value`.\n`le()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'ABC'` is less than `'abc'`."},{"name":"limit","fqn":"PlansQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PlansQueryBuilder","referenceFqn":"PlansQueryBuilder"},"examples":[{"title":"Add a `limit` to a query","content":"const query = plans.queryPublicPlans.limit(10);\n"},{"title":"Create a query, add a `limit`, and run it","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans.queryPublicPlans().limit(10).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Add a `limit` to a query","content":"const query = plans.queryPublicPlans.limit(10);\n"},{"title":"Create a query, add a `limit`, and run it","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans.queryPublicPlans().limit(10).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to return, which is also the `pageSize` of the results object."}],"description":"Limits the number of items the query returns.\n\nThe `limit()` function defines the number of results a query returns in each page. Only one page of results is retrieved at a time.\nYou can use the `next()` and `prev()` functions to navigate the pages of a query result."},{"name":"lt","fqn":"PlansQueryBuilder.lt","slug":"lt","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PlansQueryBuilder","referenceFqn":"PlansQueryBuilder"},"examples":[{"title":"Add an `lt` filter to a query","content":"const query = plans.queryPublicPlans.lt('_createdDate', '2021-03-01');\n"},{"title":"Create a query, add an `lt` filter, and run it","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans\n .queryPublicPlans()\n .lt('_createdDate', '2021-03-01')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is less than the specified value.\n\nThe `le()` function refines a `PlansQueryBuilder` to match only items where the value of the specified `propertyName` is less than the specified `value`.\n`le()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'ABC'` is less than `'abc'`."},{"name":"ne","fqn":"PlansQueryBuilder.ne","slug":"ne","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PlansQueryBuilder","referenceFqn":"PlansQueryBuilder"},"examples":[{"title":"Add an `ne` filter to a query","content":"const query = plans.queryPublicPlans.ne(\n '_id',\n 'bb19b637-74ce-55d3-ae32-430b588051da'\n);\n"},{"title":"Create a query, add an `ne` filter, and run it","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans\n .queryPublicPlans()\n .ne('_id', 'bb19b637-74ce-55d3-ae32-430b588051da')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property doesn't equal the specified value.\n\nThe `ne()` function refines a `PlansQueryBuilder` to match only items where the value of the specified `propertyName` doesn't equal the specified `value`.\n`ne()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nMatching strings with `ne()` is case-sensitive, so `'text'` isn't equal to `'Text'`."},{"name":"skip","fqn":"PlansQueryBuilder.skip","slug":"skip","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PlansQueryBuilder","referenceFqn":"PlansQueryBuilder"},"examples":[{"title":"Add a `skip` to a query","content":"const query = plans.queryPublicPlans.skip(10);\n"},{"title":"Create a query, add a `skip`, and run it","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans.queryPublicPlans().skip(10).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Add a `skip` to a query","content":"const query = plans.queryPublicPlans.skip(10);\n"},{"title":"Create a query, add a `skip`, and run it","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans.queryPublicPlans().skip(10).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to skip in the query results before returning the results."}],"description":"Sets the number of items to skip before returning query results.\n\nThe `skip()` function defines the number of results to skip before returning new query results.\nFor example, if you query a collection and 50 items match your query, but you set `skip()` to `10`, the first 10 items that match are ignored, and the 11th through 50th items are returned."},{"name":"startsWith","fqn":"PlansQueryBuilder.startsWith","slug":"starts-with","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PlansQueryBuilder","referenceFqn":"PlansQueryBuilder"},"examples":[{"title":"Add a `startsWith` filter to a query","content":"const query = plans.queryPublicPlans.startsWith('_id', 'L');\n"},{"title":"Create a query, add a `startsWith` filter, and run it","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans.queryPublicPlans();\n startsWith('_id', 'L').find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `string`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}],"description":"Refines a query to match items where the specified property starts with the specified value.\n\nThe `startsWith()` function refines a `PlansQueryBuilder` to match only items where the value of the specified `propertyName` starts with the specified `string`.\nMatching with `startsWith()` is case-sensitive, so `'TEXT'` doesn't start with `'text'`.\nYou can only use `startsWith()` with a property whose value is a string."}],"properties":[]},"PlansQueryResult":{"name":"PlansQueryResult","fqn":"PlansQueryResult","slug":"plans-query-result","actions":[{"name":"hasNext","fqn":"PlansQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean"},"examples":[{"title":"Get whether the query has more results","content":"const hasNext = results.hasNext();\n"},{"title":"Perform a query and get `hasNext` from the result","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans.queryPublicPlans().find();\n\n return results.hasNext();\n}\n"}],"description":"Indicates whether the query has more results.\n\nYou can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `plans` to navigate the pages of a query result."},{"name":"hasPrev","fqn":"PlansQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean"},"examples":[{"title":"Get whether the query has previous results","content":"const hasPrev = results.hasPrev();\n"},{"title":"Perform a query and get `hasPrev` from the result","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans.queryPublicPlans().find();\n\n return results.hasPrev();\n}\n"}],"description":"Indicates whether the query has previous results.\n\nYou can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `plans` to navigate the pages of a query result."},{"name":"next","fqn":"PlansQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"PlansQueryResult","referenceFqn":"PlansQueryResult"}},"examples":[{"title":"Get `next` from a query result","content":"const nextPage = results.next();\n"},{"title":"Perform a query and get `next` from the result","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans.queryPublicPlans().find();\n\n return results.next();\n}\n"},{"title":"Iterate through all pages of query results","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n let allItems = [];\n\n const results = await plans.queryPublicPlans().limit(1000).find();\n allItems.push(results.items);\n\n while (results.hasNext()) {\n results = await results.next();\n allItems.push(results.items);\n }\n\n return allItems;\n}\n"}],"description":"Retrieves the next page of query results.\n\nThe `next()` function retrieves the next page of query results.\nThe page size is defined by the [`limit()`](/plans/plans-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `plans` to navigate the pages of a query result.\nIf items are added or removed between calls to `next()`, the values returned by `PlansQueryBuilder` may change."},{"name":"prev","fqn":"PlansQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"PlansQueryResult","referenceFqn":"PlansQueryResult"}},"examples":[{"title":"Get `prev` from a query result","content":"const previousPage = results.prev();\n"},{"title":"Perform a query and get `prev` from the result","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans.queryPublicPlans().find();\n\n return results.prev();\n}\n"}],"description":"Retrieves the previous page of query results.\n\nThe `prev()` function retrieves the previous page of query results.\nThe page size is defined by the [`limit()`](/plans/plans-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `plans` to navigate the pages of a query result.\nIf items are added or removed between calls to `prev()`, the values returned may change."}],"properties":[{"name":"currentPage","slug":"current-page","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `currentPage` from a query result","content":"const resultPage = results.currentPage;\n"},{"title":"Perform a query and get `currentPage` from the result","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans.queryPublicPlans().find();\n\n return results.currentPage;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the index of the current page of results.\n\n`currentPage` is a zero-based index of the current page of results, meaning the 1st page is `0`, the 2nd page is `1`, and so on.\nIf no results match the query, `currentPage` is undefined.\nThe page size is defined by the [`limit()`](/plans/plans-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `plans` to navigate the pages of a query result."},{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `items` from a query result","content":"const returnedItems = results.items;\n"},{"title":"Perform a query and get `items` from the result","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans.queryPublicPlans().find();\n\n const returnedItems = results.items;\n\n if (returnedItems.length > 0) {\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"PublicPlan","referenceFqn":"PublicPlan"}},"description":"Returns an array of `plans` items that match the query.\n\n`items` contains the current page of results retrieved by the query.\nIf no results match the query, `items` is an empty array.\nThe page size is defined by the [`limit()`](/plans/plans-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `plans` to navigate the pages of a query result."},{"name":"length","slug":"length","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `length` from a query result","content":"const resultLength = results.length;\n"},{"title":"Perform a query and get `length` from the result","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans.queryPublicPlans().find();\n\n return results.length;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current page of results.\n\n`length` returns just the number of items in the current page, not the total number of items that match the query. For the total number of items that match the query, see [`totalCount`](#totalcount).\nThe page size is defined by the [`limit()`](/plans/plans-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `plans` to navigate the pages of a query result."},{"name":"pageSize","slug":"page-size","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the query's page size","content":"const requestedPageSize = results.pageSize;\n"},{"title":"Perform a query and get `pageSize` from the result","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans.queryPublicPlans().find();\n\n return results.pageSize;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the requested page size.\n\n`pageSize` returns the page size set in [`limit()`](/plans/plans-query-builder/limit) in `PlansQueryBuilder`."},{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `query` that produced the current result","content":"const originalQuery = results.query;\n"},{"title":"Perform a query and get `query` from the result","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans.queryPublicPlans().find();\n\n return results.query;\n}\n"}],"type":{"kind":"REFERENCE","name":"PlansQueryBuilder","referenceFqn":"PlansQueryBuilder"},"description":"Returns the `PlansQueryBuilder` object used to get the current results.\n\nUse `query` to create and run a new query by chaining additional `PlansQueryBuilder` functions to it. You can filter only on properties that haven't already been used in the previous `PlansQueryBuilder`."},{"name":"totalCount","slug":"total-count","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `totalCount` from a query result","content":"const resultCount = results.totalCount;\n"},{"title":"Perform a query and get `totalCount` from the result","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans.queryPublicPlans().find();\n\n return results.totalCount;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of items that match the query.\n\n`totalCount` returns the total number of items that match the query, not just the number of items in the current page. For the number of items in the current page, see [`length`](#length)."},{"name":"totalPages","slug":"total-pages","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `totalPages` from a query result","content":"const pageCount = results.totalPages;\n"},{"title":"Perform a query and get `totalPages` from the result","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryFunction() {\n const results = await plans.queryPublicPlans().find();\n\n return results.totalPages;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of pages the query produced.\n\nThe page size is defined by the [`limit()`](/plans/plans-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `plans` to navigate the pages of a query result."}]},"SetPlanVisibilityResponse":{"name":"SetPlanVisibilityResponse","fqn":"SetPlanVisibilityResponse","slug":"set-plan-visibility-response","actions":[],"properties":[{"name":"plan","slug":"plan","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Plan","referenceFqn":"Plan"},"description":"Plan info."}]},"UpdatePlan":{"name":"UpdatePlan","fqn":"UpdatePlan","slug":"update-plan","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date plan was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Plan ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date plan was last updated."},{"name":"allowFutureStartDate","slug":"allow-future-start-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the buyer can start the plan at a later date.\n\nDefault: `false`."},{"name":"archived","slug":"archived","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the plan is archived. Archived plans are not visible and can't be purchased anymore, but existing purchases remain in effect."},{"name":"buyerCanCancel","slug":"buyer-can-cancel","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the buyer is allowed to cancel their plan. If `false`, calling the [`requestCancellation()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/requestcancellation) function returns an error.\n\nDefault: `true`."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Plan description."},{"name":"formId","slug":"form-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the form associated with the plan at checkout."},{"name":"hasOrders","slug":"has-orders","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the plan has any orders (including pending and unpaid orders)."},{"name":"maxPurchasesPerBuyer","slug":"max-purchases-per-buyer","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of times the same buyer can purchase the plan. Currently limited to support:\n- Empty value or a value of `0`, meaning no limitation.\n- Value of `1`, meaning limited to one purchase per buyer."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Plan name."},{"name":"perks","slug":"perks","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"StringList","referenceFqn":"StringList"},"description":"List of text strings that promote what is included with this plan.\n\nFor example, \"Plenty of parking\" or \"Free gift on your birthday\"."},{"name":"pricing","slug":"pricing","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Pricing","referenceFqn":"Pricing"},"description":"Plan price, payment schedule, and expiration."},{"name":"primary","slug":"primary","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the plan is marked as primary. If `true`, the plan is highlighted on the site with a custom ribbon.\n\nDefault: `false`."},{"name":"public","slug":"public","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the plan is public (visible to site visitors and members)."},{"name":"slug","slug":"slug","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"URL-friendly version of plan name. Unique across all plans in the same site."},{"name":"termsAndConditions","slug":"terms-and-conditions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Any terms and conditions that apply to the plan. This information will be displayed during checkout."}]},"UpdatePlanOptions":{"name":"UpdatePlanOptions","fqn":"UpdatePlanOptions","slug":"update-plan-options","actions":[],"properties":[]}},"standaloneTypes":[],"metadata":{"fqdn":"wix.pricing_plans.v2.plan"},"actions":[{"name":"archivePlan","fqn":"archivePlan","slug":"archive-plan","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["_id"],"permissionIds":["PRICING_PLANS.MANAGE_PLANS"],"permissions":["Manage Pricing Plans"],"permissionsScopesIds":["SCOPE.DC-PAIDPLANS.MANAGE-PLANS"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ArchivePlanResponse","referenceFqn":"ArchivePlanResponse"},"description":"Fulfilled - The archived plan.\n\nRejected - Error message."},"examples":[{"title":"Archive a plan (dashboard page code)","description":"","content":"import { plans } from 'wix-pricing-plans.v2';\n\n/* Sample _id value: '1421abaa-44c7-42ae-8a75-960fe7a8aa55' */\n\nexport async function myArchivePlanFunction(_id) {\n try {\n const archivedPlan = await plans.archivePlan(_id);\n\n return archivedPlan;\n } catch(error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to:\n * {\n * \"_createdDate\": \"2023-12-31T11:23:01.664Z\",\n * \"_id\": \"1421abaa-44c7-42ae-8a75-960fe7a8aa55\",\n * \"_updatedDate\": \"2024-01-08T11:24:18.561Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": true,\n * \"buyerCanCancel\": true,\n * \"description\": \"Free Plan\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Basic\",\n * \"perks\": {\n * \"values\": []\n * },\n * \"pricing\": {\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"0\"\n * },\n * \"singlePaymentForDuration\": {\n * \"count\": 3,\n * \"unit\": \"MONTH\"\n * }\n * },\n * \"primary\": false,\n * \"public\": false,\n * \"slug\": \"basic\",\n * \"termsAndConditions\": \"After 90 day free trial ends, your plan will end and you will need to purchase a paid plan.\"\n * } \n */"},{"title":"Archive a plan (export from backend code)","description":"","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { plans } from 'wix-pricing-plans.v2';\nimport { elevate } from 'wix-auth';\n\n/* Sample _id value: '1421abaa-44c7-42ae-8a75-960fe7a8aa55' */\n\nexport const myArchivePlanFunction = webMethod(Permissions.Anyone, async (_id) => {\n try {\n const elevatedArchivePlan = elevate(plans.archivePlan);\n const archivedPlan = await elevatedArchivePlan(_id);\n\n return archivedPlan;\n } catch(error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n * {\n * \"_createdDate\": \"2023-12-31T11:23:01.664Z\",\n * \"_id\": \"1421abaa-44c7-42ae-8a75-960fe7a8aa55\",\n * \"_updatedDate\": \"2024-01-08T11:24:18.561Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": true,\n * \"buyerCanCancel\": true,\n * \"description\": \"Free Plan\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Basic\",\n * \"perks\": {\n * \"values\": []\n * },\n * \"pricing\": {\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"0\"\n * },\n * \"singlePaymentForDuration\": {\n * \"count\": 3,\n * \"unit\": \"MONTH\"\n * }\n * },\n * \"primary\": false,\n * \"public\": false,\n * \"slug\": \"basic\",\n * \"termsAndConditions\": \"After 90 day free trial ends, your plan will end and you will need to purchase a paid plan.\"\n * } \n */"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the active plan to archive."}],"description":"Archives a single plan.\n\n\nThe `archivePlan()` function returns a Promise that resolves to the newly-archived plan.\n\nWhen a plan is archived, the plan\n- Is no longer available for display or selection by visitors. This is because the plan's `public` property is automatically set to `false`.\n- Cannot be purchased.\n- Cannot be \"un-archived\", meaning the plan cannot be made active again.\n\nPlan archiving does not impact existing purchases made for the plan. All purchases for the plan are still active and keep their payment options and terms.\n\nSite owners can see archived plans in the Dashboard under **Pricing Plans -> Archived Plans**.\n\n>**Note:** An attempt to archive an already-archived plan throws an error.","permissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"isAdminMethod":true},{"name":"clearPrimary","fqn":"clearPrimary","slug":"clear-primary","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","permissionIds":["PRICING_PLANS.MANAGE_PLANS"],"permissions":["Manage Pricing Plans"],"permissionsScopesIds":["SCOPE.DC-PAIDPLANS.MANAGE-PLANS"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}},"examples":[{"title":"Clear the primary plan (dashboard page code)","description":"","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myClearPrimaryFunction() {\n try {\n const clearedPrimary = await plans.clearPrimary();\n\n return;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to void */"},{"title":"Clear the primary plan (export from backend code)","description":"","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { plans } from 'wix-pricing-plans.v2';\nimport { elevate } from 'wix-auth';\n\nexport const myClearPrimaryFunction = webMethod(Permissions.Anyone, async () => {\n try {\n const elevatedClearPrimary = elevate(plans.clearPrimary);\n const clearedPrimary = await elevatedClearPrimary();\n\n return;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to void */\n"}],"description":"Sets all pricing plans to no longer be primary.\n\nThe `clearPrimary()` function returns a Promise that is resolved when there are no pricing plans marked as `primary`.\n\nAfter clearing the primary plan, when viewing pricing plans on the site, no plan is highlighted with a customizable ribbon.","permissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"isAdminMethod":true},{"name":"createPlan","fqn":"createPlan","slug":"create-plan","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["plan","plan.name","plan.pricing","plan.pricing.singlePaymentForDuration.count","plan.pricing.subscription.cycleCount","plan.pricing.subscription.cycleDuration","plan.pricing.subscription.cycleDuration.count"],"permissionIds":["PRICING_PLANS.MANAGE_PLANS"],"permissions":["Manage Pricing Plans"],"permissionsScopesIds":["SCOPE.DC-PAIDPLANS.MANAGE-PLANS"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Plan","referenceFqn":"Plan"},"description":"Fulfilled - The created plan.\n\nRejected - Error message."},"examples":[{"title":"Create a plan with optional fields (dashboard page code)","description":"","content":"import { plans } from 'wix-pricing-plans.v2';\n\n/* Sample plan value:\n * {\n * allowFutureStartDate: true,\n * buyerCanCancel: true,\n * description: 'Fun content for our younger users',\n * formId: 'ee62cefa-bdc2-4b5d-baab-6faeef83cecb',\n * maxPurchasesPerBuyer: 1,\n * name: 'Junior',\n * perks: {\n * values: [\n * 'Multiplayer',\n * 'Multiple devices',\n * 'No ads\",\n * 'Unlimited access'\n * ]\n * },\n * pricing: {\n * price: {\n * currency: 'USD',\n * value: '10.00\"\n * },\n * subscription: {\n * cycleCount: 12,\n * cycleDuration: {\n * count: 1,\n * unit: 'MONTH'\n * }\n * }\n * },\n * public: true,\n * termsAndConditions: 'No sharing access with others!'\n * }\n */\n\nexport async function myCreatePlanFunction(plan) {\n try {\n const newPlan = await plans.createPlan(plan);\n\n const planId = newPlan._id;\n const pricingObject = newPlan.pricing;\n const perks = newPlan.perks;\n\n return newPlan;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to:\n * {\n * \"_createdDate\": \"2024-01-21T07:06:06.993Z\",\n * \"_id\": \"046371ff-7e5d-4bdb-a01d-a00ff462bed8\",\n * \"_updatedDate\": \"2024-01-21T07:06:06.993Z\",\n * \"allowFutureStartDate\": true,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Fun content for our younger users\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 1,\n * \"name\": \"Junior\",\n * \"perks\": {\n * \"values\": [\n * \"Multiplayer\",\n * \"Multiple devices\",\n * \"No ads\",\n * \"Unlimited access\"\n * ]\n * },\n * \"pricing\": {\n * \"price\": {\n * \"currency\": \"USD\",\n * \"value\": \"10.00\"\n * },\n * \"public\": true,\n * \"slug\": \"junior\",\n * \"subscription\": {\n * \"cycleCount\": 12,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"MONTH\"\n * }\n * },\n * \"termsAndConditions\": \"No sharing access with others!\"\n * }\n * }\n */ "},{"title":"Create a plan with optional fields (export from backend code)","description":"","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { plans } from 'wix-pricing-plans.v2';\nimport { elevate } from 'wix-auth';\n\n/* Sample plan value:\n * {\n * allowFutureStartDate: true,\n * buyerCanCancel: true,\n * description: 'Fun content for our younger users',\n * formId: 'ee62cefa-bdc2-4b5d-baab-6faeef83cecb',\n * maxPurchasesPerBuyer: 1,\n * name: 'Junior',\n * perks: {\n * values: [\n * 'Multiplayer',\n * 'Multiple devices',\n * 'No ads\",\n * 'Unlimited access'\n * ]\n * },\n * pricing: {\n * price: {\n * currency: 'USD',\n * value: '10.00\"\n * },\n * subscription: {\n * cycleCount: 12,\n * cycleDuration: {\n * count: 1,\n * unit: 'MONTH'\n * }\n * }\n * },\n * public: true,\n * termsAndConditions: 'No sharing access with others!'\n * }\n */\n\nexport const myCreatePlanFunction = webMethod(Permissions.Anyone, async (plan) => {\n try {\n const elevatedCreatePlan = elevate(plans.createPlan);\n const newPlan = await elevatedCreatePlan(plan);\n\n const planId = newPlan._id;\n const pricingObject = newPlan.pricing;\n const perks = newPlan.perks;\n\n return newPlan;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n * {\n * \"_createdDate\": \"2024-01-21T07:06:06.993Z\",\n * \"_id\": \"046371ff-7e5d-4bdb-a01d-a00ff462bed8\",\n * \"_updatedDate\": \"2024-01-21T07:06:06.993Z\",\n * \"allowFutureStartDate\": true,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Fun content for our younger users\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 1,\n * \"name\": \"Junior\",\n * \"perks\": {\n * \"values\": [\n * \"Multiplayer\",\n * \"Multiple devices\",\n * \"No ads\",\n * \"Unlimited access\"\n * ]\n * },\n * \"pricing\": {\n * \"price\": {\n * \"currency\": \"USD\",\n * \"value\": \"10.00\"\n * },\n * \"public\": true,\n * \"slug\": \"junior\",\n * \"subscription\": {\n * \"cycleCount\": 12,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"MONTH\"\n * }\n * },\n * \"termsAndConditions\": \"No sharing access with others!\"\n * }\n * }\n */ \n"},{"title":"Create a simple plan ","description":"","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { plans } from 'wix-pricing-plans.v2';\nimport { elevate } from 'wix-auth';\n\n/* Sample plan object:\n * {\n * name: 'Default',\n * pricing: {\n * singlePaymentUnlimited: true\n * }\n * }\n */\n\nexport const myCreatePlanFunction = webMethod(Permissions.Anyone, async (plan) => {\n try {\n const elevatedCreatePlan = elevate(plans.createPlan);\n const newPlan = await elevatedCreatePlan(plan);\n\n return newPlan;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n * {\n * \"_createdDate\": \"2024-01-16T10:32:05.818Z\",\n * \"_id\": \"aa0d8e0e-99ad-4c95-ac48-4955e37956c5\",\n * \"_updatedDate\": \"2024-01-16T10:32:05.818Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"\",\n * \"hasOrders\": false,\n * \"name\": \"Default\",\n * \"perks\": {\n * \"values\": []\n * },\n * \"pricing\": {\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"0\"\n * },\n * \"singlePaymentUnlimited\": true\n * },\n * \"primary\": false,\n * \"public\": true,\n * \"slug\": \"default\"\n * }\n */"},{"title":"Duplicate a plan ","description":"The `populatePlansDropdown` function retrieves all plans and then populates them into the `#plansDropdown`. The `#plansDropdown` and `#clonePlanBtn` are set to `disabled` by default.","content":"/*************************************\n * Backend code - plan-functions.web.js *\n *************************************/\n\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { plans } from 'wix-pricing-plans.v2';\nimport { elevate } from 'wix-auth';\n\nconst elevatedListPlans = elevate(plans.listPlans);\nconst elevatedGetPlan = elevate(plans.getPlan);\nconst elevatedCreatePlan = elevate(plans.createPlan);\n\nexport const listPlans = webMethod(Permissions.Anyone, async () => {\n try {\n const response = await elevatedListPlans();\n const allPlans = response.plans;\n\n return allPlans;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\nexport const getPlan = webMethod(Permissions.Anyone, async (planId) => {\n try {\n const selectedPlan = await elevatedGetPlan(planId);\n\n return selectedPlan;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\nexport const createPlan = webMethod(Permissions.Anyone, async (plan) => {\n try {\n const newPlan = await elevatedCreatePlan(plan);\n\n return newPlan;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n\n/*************\n * Page code *\n *************/\n\nimport { listPlans, getPlan, createPlan } from 'backend/plan-functions.web';\n$w.onReady(async function () {\n $w('#plansDropdown').disable();\n $w('#clonePlanBtn').disable();\n populatePlansDropdown();\n\n let selectedPlan;\n\n $w('#plansDropdown').onChange(async () => {\n const planId = $w('#plansDropdown').value;\n selectedPlan = await getPlan(planId);\n\n // Set default value for the new plan name\n $w('#planName').value = `${selectedPlan.name}-duplicate`\n $w('#clonePlanBtn').enable();\n });\n \n $w('#clonePlanBtn').onClick(async () => {\n const newPlan = selectedPlan;\n // Use inputs to set the new plan name and price\n newPlan.name = $w('#planName').value;\n newPlan.pricing.price.value = $w('#price').value;\n\n await createPlan(newPlan);\n });\n});\n\nasync function populatePlansDropdown() {\n const plans = await listPlans();\n $w('#plansDropdown').options = plans.map((plan) => {\n return {\n label: plan.name,\n value: plan._id\n }\n });\n $w('#plansDropdown').enable();\n}"}],"actionParams":[{"name":"plan","slug":"plan","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Plan","referenceFqn":"Plan"},"description":"Information for the plan being created."}],"description":"Creates a pricing plan.\n\n\nThe `createPlan()` function returns a Promise that resolves to a newly-created pricing plan after is has successfully been created.\n\nThe passed `plan` object must contain a [pricing model](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/pricing-models). A pricing model can be one of the following:\n- **A subscription**: A subscription with recurring payment and how often the plan occurs. Subscriptions can have free trial days.\n- **A plan that does not renew**: A single payment for a specific duration that doesn't renew.\n- **An unlimited plan**: A single payment for an unlimited amount of time (until canceled).\n\nPricing plans created by this function are available to the site owner in the Pricing Plans section in the Dashboard.","permissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"isAdminMethod":true},{"name":"getPlan","fqn":"getPlan","slug":"get-plan","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["_id"],"permissionIds":["PRICING_PLANS.READ_PLANS"],"permissions":["Read Pricing Plans","Manage Pricing Plans"],"permissionsScopesIds":["SCOPE.DC-PAIDPLANS.READ-PLANS","SCOPE.DC-PAIDPLANS.MANAGE-PLANS"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Plan","referenceFqn":"Plan"},"description":"Fulfilled - The retrieved plan's information."},"examples":[{"title":"Get a plan (dashboard page code)","description":"","content":"import { plans} from 'wix-pricing-plans.v2';\n\n/* Sample _id value: '838f2c9d-c8d0-4799-a10a-e2f23849db10' */\n\nexport async function myGetPlanFunction(_id) {\n try {\n const myPlan = await plans.getPlan(_id);\n\n return myPlan;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to:\n * {\n * \"_createdDate\": \"2024-01-07T07:28:42.863Z\",\n * \"_id\": \"838f2c9d-c8d0-4799-a10a-e2f23849db10\",\n * \"_updatedDate\": \"2024-01-07T08:36:07.520Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Complete with all features. One month free trial.\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Premium Plan - annual - 30 day trial\",\n * \"perks\": {\n * \"values\": [\n * \"Unlimited video library streaming access\",\n * \"File sharing enabled for all channels\"\n * ]\n * },\n * \"pricing\": {\n * \"freeTrialDays\": 30,\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"500\"\n * },\n * \"subscription\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * }\n * }\n * },\n * \"primary\": false,\n * \"public\": true,\n * \"slug\": \"premium-plan-annual-30-day-trial-1\",\n * \"termsAndConditions\": \"Unlimited usage of services, subject to Fair Usage and Code of Conduct policies.\"\n * } \n */"},{"title":"Get a plan (export from backend code)","description":"","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { plans } from 'wix-pricing-plans.v2';\nimport { elevate } from 'wix-auth';\n\n/* Sample _id value: '838f2c9d-c8d0-4799-a10a-e2f23849db10' */\n\nexport const myGetPlanFunction = webMethod(Permissions.Anyone, async (_id) => {\n try {\n const elevatedGetPlan = elevate(plans.getPlan);\n const myPlan = await elevatedGetPlan(_id);\n\n return myPlan;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n * {\n * \"_createdDate\": \"2024-01-07T07:28:42.863Z\",\n * \"_id\": \"838f2c9d-c8d0-4799-a10a-e2f23849db10\",\n * \"_updatedDate\": \"2024-01-07T08:36:07.520Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Complete with all features. One month free trial.\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Premium Plan - annual - 30 day trial\",\n * \"perks\": {\n * \"values\": [\n * \"Unlimited video library streaming access\",\n * \"File sharing enabled for all channels\"\n * ]\n * },\n * \"pricing\": {\n * \"freeTrialDays\": 30,\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"500\"\n * },\n * \"subscription\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * }\n * }\n * },\n * \"primary\": false,\n * \"public\": true,\n * \"slug\": \"premium-plan-annual-30-day-trial-1\",\n * \"termsAndConditions\": \"Unlimited usage of services, subject to Fair Usage and Code of Conduct policies.\"\n * } \n */"},{"title":"Duplicate a plan ","description":"The `populatePlansDropdown` function retrieves all plans and then populates them into the `#plansDropdown`. The `#plansDropdown` and `#clonePlanBtn` are set to `disabled` by default.","content":"/*************************************\n * Backend code - plan-functions.web.js *\n *************************************/\n\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { plans } from 'wix-pricing-plans.v2';\nimport { elevate } from 'wix-auth';\n\nconst elevatedListPlans = elevate(plans.listPlans);\nconst elevatedGetPlan = elevate(plans.getPlan);\nconst elevatedCreatePlan = elevate(plans.createPlan);\n\nexport const listPlans = webMethod(Permissions.Anyone, async () => {\n try {\n const response = await elevatedListPlans();\n const allPlans = response.plans;\n\n return allPlans;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\nexport const getPlan = webMethod(Permissions.Anyone, async (planId) => {\n try {\n const selectedPlan = await elevatedGetPlan(planId);\n\n return selectedPlan;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\nexport const createPlan = webMethod(Permissions.Anyone, async (plan) => {\n try {\n const newPlan = await elevatedCreatePlan(plan);\n\n return newPlan;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n\n/*************\n * Page code *\n *************/\n\nimport { listPlans, getPlan, createPlan } from 'backend/plan-functions.web';\n$w.onReady(async function () {\n $w('#plansDropdown').disable();\n $w('#clonePlanBtn').disable();\n populatePlansDropdown();\n\n let selectedPlan;\n\n $w('#plansDropdown').onChange(async () => {\n const planId = $w('#plansDropdown').value;\n selectedPlan = await getPlan(planId);\n\n // Set default value for the new plan name\n $w('#planName').value = `${selectedPlan.name}-duplicate`\n $w('#clonePlanBtn').enable();\n });\n \n $w('#clonePlanBtn').onClick(async () => {\n const newPlan = selectedPlan;\n // Use inputs to set the new plan name and price\n newPlan.name = $w('#planName').value;\n newPlan.pricing.price.value = $w('#price').value;\n\n await createPlan(newPlan);\n });\n});\n\nasync function populatePlansDropdown() {\n const plans = await listPlans();\n $w('#plansDropdown').options = plans.map((plan) => {\n return {\n label: plan.name,\n value: plan._id\n }\n });\n $w('#plansDropdown').enable();\n}"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Plan ID."}],"description":"Retrieves a pricing plan by the specified ID.\n\nThe `getPlan()` function returns a Promise that resolves to a plan whose ID matched the specified ID.","permissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"},{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"}],"isAdminMethod":true},{"name":"getPlanStats","fqn":"getPlanStats","slug":"get-plan-stats","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","permissionIds":["PRICING_PLANS.READ_PLANS"],"permissions":["Read Pricing Plans","Manage Pricing Plans"],"permissionsScopesIds":["SCOPE.DC-PAIDPLANS.READ-PLANS","SCOPE.DC-PAIDPLANS.MANAGE-PLANS"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"GetPlanStatsResponse","referenceFqn":"GetPlanStatsResponse"},"description":"Fulfilled - Overall statistics about the pricing plans."},"examples":[{"title":"Get number of plans (dashboard page code)","description":"","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myGetPlanStatsFunction() {\n try {\n const planStats = plans.getPlanStats();\n\n return planStats;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to:\n * {\n * \"totalPlans\": 8 \n * }\n */"},{"title":"Get number of plans (export from backend code)","description":"","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { plans } from 'wix-pricing-plans.v2';\nimport { elevate } from 'wix-auth';\n\nexport const myGetPlanStatsFunction = webMethod(Permissions.Anyone, async () => {\n try {\n const elevatedGetPlanStats = elevate(plans.getPlanStats);\n const planStats = elevatedGetPlanStats();\n\n return planStats;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n * {\n * \"totalPlans\": 8 \n * }\n */\n"}],"description":"Retrieves statistics about the pricing plans.\n\n\nThe `getPlanStats()` function returns a Promise that resolves to statistics about the plan on the site.\n\nCurrently this function provides only the total number of pricing plans, including archived plans.","permissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"},{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"}],"isAdminMethod":true},{"name":"listPlans","fqn":"listPlans","slug":"list-plans","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","permissionIds":["PRICING_PLANS.READ_PLANS"],"permissions":["Read Pricing Plans","Manage Pricing Plans"],"permissionsScopesIds":["SCOPE.DC-PAIDPLANS.READ-PLANS","SCOPE.DC-PAIDPLANS.MANAGE-PLANS"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ListPlansResponse","referenceFqn":"ListPlansResponse"},"description":"Fulfilled - List of plans that match the given criteria."},"examples":[{"title":"List all plans (dashboard page code) ","description":"","content":"import { plans } from 'wix-pricing-plans.v2';\nimport { elevate } from 'wix-auth';\n\nconst elevatedListPlans = elevate(plans.listPlans);\n\nexport async function myListPlansFunction() {\n try {\n const plansList = await elevatedListPlans();\n\n return plansList;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to:\n * [\n * {\n * \"_createdDate\": \"2024-01-08T14:33:12.209Z\",\n * \"_id\": \"d2fa5805-0d1a-4cfb-9b43-e683cf5fa990\",\n * \"_updatedDate\": \"2024-01-08T14:33:12.209Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"The value plan\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 1,\n * \"name\": \"Silver Membership - Monthly\",\n * \"perks\": {\n * \"values\": [\n * \"Full site access\",\n * \"Full video access\",\n * \"Consultation booking\"\n * ]\n * },\n * \"pricing\": {\n * \"cycleCount\": 0,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"MONTH\"\n * },\n * \"freeTrialDays\": 14,\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"100\"\n * },\n * \"subscription\": {\n * \"cycleCount\": 0,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"MONTH\"\n * }\n * }\n * },\n * \"primary\": false,\n * \"public\": true,\n * \"slug\": \"silver-membership-monthly\",\n * \"termsAndConditions\": \"\"\n * },\n * {\n * \"_createdDate\": \"2024-01-07T07:33:59.973Z\",\n * \"_id\": \"b20feb39-a452-453e-96ee-01036adcd04e\",\n * \"_updatedDate\": \"2024-01-09T09:08:05.665Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Full feature enablement - lifetime plan\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Premium Plan - Lifetime Membership\",\n * \"perks\": {\n * \"values\": [\n * \"Cloud drive and file upload services\",\n * \"Unlimited video content access\"\n * ]\n * },\n * \"pricing\": {\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"1000\"\n * },\n * \"singlePaymentUnlimited\": true\n * },\n * \"primary\": false,\n * \"public\": true,\n * \"slug\": \"premium-plan-lifetime-membership\",\n * \"termsAndConditions\": \"This plan allows unlimited app and site features usage for all time, subject to our fair usage agreement and basic human decency agreement.\"\n * },\n * {\n * \"_createdDate\": \"2024-01-04T12:51:42.249Z\",\n * \"_id\": \"025a0d1f-7076-4e27-9696-4a67075dc2aa\",\n * \"_updatedDate\": \"2024-01-07T12:53:53.562Z\",\n * \"allowFutureStartDate\": true,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Bronze membership to the MyGame World of Online Gaming\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 1,\n * \"name\": \"Bronze Plan\",\n * \"perks\": {\n * \"values\": [\n * \"Multiplayer\",\n * \"Multiple devices\",\n * \"No ads\",\n * \"Unlimited access\"\n * ]\n * },\n * \"pricing\": {\n * \"price\": {\n * \"currency\": \"USD\",\n * \"value\": \"10.00\"\n * },\n * \"singlePaymentUnlimited\": true\n * },\n * \"primary\": false,\n * \"public\": false,\n * \"slug\": \"bronze-plan-1\",\n * \"termsAndConditions\": \"No sharing access with others!\"\n * }\n * ]\n */"},{"title":"List plans ","description":"","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { plans } from 'wix-pricing-plans.v2';\nimport { elevate } from 'wix-auth';\n\nexport const myListPlansFunction = webMethod(Permissions.Anyone, async () => {\n try {\n const elevatedListPlans = elevate(plans.listPlans);\n const plansList = await elevatedListPlans();\n\n return plansList;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n * {\n * \"pagingMetadata\": {\n * \"count\": 4,\n * \"offset\": 0,\n * \"total\": 4\n * },\n * \"plans\": [\n * {\n * \"_createdDate\": \"2024-01-08T14:33:12.209Z\",\n * \"_id\": \"d2fa5805-0d1a-4cfb-9b43-e683cf5fa990\",\n * \"_updatedDate\": \"2024-01-08T14:33:12.209Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"The value plan\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 1,\n * \"name\": \"Silver Membership - Monthly\",\n * \"perks\": {\n * \"values\": [\n * \"Full site access\",\n * \"Full video access\",\n * \"Consultation booking\"\n * ]\n * },\n * \"pricing\": {\n * \"cycleCount\": 0,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"MONTH\"\n * },\n * \"freeTrialDays\": 14,\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"100\"\n * },\n * \"subscription\": {\n * \"cycleCount\": 0,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"MONTH\"\n * }\n * }\n * },\n * \"primary\": false,\n * \"public\": true,\n * \"slug\": \"silver-membership-monthly\",\n * \"termsAndConditions\": \"\"\n * },\n * {\n * \"_createdDate\": \"2024-01-07T07:33:59.973Z\",\n * \"_id\": \"b20feb39-a452-453e-96ee-01036adcd04e\",\n * \"_updatedDate\": \"2024-01-09T09:08:05.665Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Full feature enablement - lifetime plan\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Premium Plan - Lifetime Membership\",\n * \"perks\": {\n * \"values\": [\n * \"Cloud drive and file upload services\",\n * \"Unlimited video content access\"\n * ]\n * },\n * \"pricing\": {\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"1000\"\n * },\n * \"singlePaymentUnlimited\": true\n * },\n * \"primary\": false,\n * \"public\": true,\n * \"slug\": \"premium-plan-lifetime-membership\",\n * \"termsAndConditions\": \"This plan allows unlimited app and site features usage for all time, subject to our fair usage agreement and basic human decency agreement.\"\n * },\n * {\n * \"_createdDate\": \"2024-01-04T12:51:42.249Z\",\n * \"_id\": \"025a0d1f-7076-4e27-9696-4a67075dc2aa\",\n * \"_updatedDate\": \"2024-01-07T12:53:53.562Z\",\n * \"allowFutureStartDate\": true,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Bronze membership to the MyGame World of Online Gaming\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 1,\n * \"name\": \"Bronze Plan\",\n * \"perks\": {\n * \"values\": [\n * \"Multiplayer\",\n * \"Multiple devices\",\n * \"No ads\",\n * \"Unlimited access\"\n * ]\n * },\n * \"pricing\": {\n * \"price\": {\n * \"currency\": \"USD\",\n * \"value\": \"10.00\"\n * },\n * \"singlePaymentUnlimited\": true\n * },\n * \"primary\": false,\n * \"public\": false,\n * \"slug\": \"bronze-plan-1\",\n * \"termsAndConditions\": \"No sharing access with others!\"\n * }\n * ]\n * } \n */\n"},{"title":"List plans with options ","description":"","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { plans } from 'wix-pricing-plans.v2';\nimport { elevate } from 'wix-auth';\n\n/* Sample options value:\n * {\n * public: 'HIDDEN',\n * archived: 'ARCHIVED_AND_ACTIVE'\n * }\n */\n\nexport const myListPlansFunction = webMethod(Permissions.Anyone, async (options) => {\n try {\n const elevatedListPlans = elevate(plans.listPlans);\n const plansList = await elevatedListPlans(options);\n\n return plansList;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n * {\n * \"pagingMetadata\": {\n * \"count\": 4,\n * \"offset\": 0,\n * \"total\": 4\n * },\n * \"plans\": [\n * {\n * \"_createdDate\": \"2023-12-31T11:23:01.664Z\",\n * \"_id\": \"1421abaa-44c7-42ae-8a75-960fe7a8aa55\",\n * \"_updatedDate\": \"2024-01-08T11:24:18.561Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": true,\n * \"buyerCanCancel\": true,\n * \"description\": \"Free Plan\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Basic\",\n * \"perks\": {\n * \"values\": []\n * },\n * \"pricing\": {\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"0\"\n * },\n * \"singlePaymentForDuration\": {\n * \"count\": 3,\n * \"unit\": \"MONTH\"\n * }\n * },\n * \"primary\": false,\n * \"public\": false,\n * \"slug\": \"basic\",\n * \"termsAndConditions\": \"After 90 day free trial ends, your plan will end and you will need to purchase a paid plan.\"\n * },\n * {\n * \"_createdDate\": \"2024-01-04T12:28:21.004Z\",\n * \"_id\": \"97033d3e-b0ad-47d7-932c-197371aab9ec\",\n * \"_updatedDate\": \"2024-01-04T14:11:39.860Z\",\n * \"allowFutureStartDate\": true,\n * \"archived\": true,\n * \"buyerCanCancel\": true,\n * \"description\": \"Gold membership to the MyGame World of Online Gaming\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 1,\n * \"name\": \"Gold\",\n * \"perks\": {\n * \"values\": [\n * \"Multiplayer\",\n * \"Multiple devices\",\n * \"No ads\",\n * \"Unlimited access\"\n * ]\n * },\n * \"pricing\": {\n * \"price\": {\n * \"currency\": \"USD\",\n * \"value\": \"10.00\"\n * },\n * \"singlePaymentUnlimited\": true\n * },\n * \"primary\": false,\n * \"public\": false,\n * \"slug\": \"gold\",\n * \"termsAndConditions\": \"No sharing access with others!\"\n * },\n * {\n * \"_createdDate\": \"2024-01-04T12:51:42.249Z\",\n * \"_id\": \"025a0d1f-7076-4e27-9696-4a67075dc2aa\",\n * \"_updatedDate\": \"2024-01-07T12:53:53.562Z\",\n * \"allowFutureStartDate\": true,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Bronze membership to the MyGame World of Online Gaming\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 1,\n * \"name\": \"Bronze Plan\",\n * \"perks\": {\n * \"values\": [\n * \"Multiplayer\",\n * \"Multiple devices\",\n * \"No ads\",\n * \"Unlimited access\"\n * ]\n * },\n * \"pricing\": {\n * \"price\": {\n * \"currency\": \"USD\",\n * \"value\": \"10.00\"\n * },\n * \"singlePaymentUnlimited\": true\n * },\n * \"primary\": false,\n * \"public\": false,\n * \"slug\": \"bronze-plan-1\",\n * \"termsAndConditions\": \"No sharing access with others!\"\n * },\n * {\n * \"_createdDate\": \"2024-01-07T07:13:04.076Z\",\n * \"_id\": \"0b9a1993-c1ff-4952-9575-915b48d1a5e0\",\n * \"_updatedDate\": \"2024-01-09T12:32:26.807Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": true,\n * \"buyerCanCancel\": true,\n * \"description\": \"For new users just getting the feel of the product\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Simple Plan\",\n * \"perks\": {\n * \"values\": [\n * \"Login member access\",\n * \"Access to real-time articles\",\n * \"Included in mailing list\"\n * ]\n * },\n * \"pricing\": {\n * \"price\": {\n * \"currency\": \"USD\",\n * \"value\": \"3\"\n * },\n * \"singlePaymentForDuration\": {\n * \"count\": 12,\n * \"unit\": \"MONTH\"\n * }\n * },\n * \"primary\": false,\n * \"public\": false,\n * \"slug\": \"simple-plan\",\n * \"termsAndConditions\": \"I agree to refrain from sharing any of the exclusive content with non-members\"\n * }\n * ]\n * }\n */\n"},{"title":"Duplicate a plan ","description":"The `populatePlansDropdown` function retrieves all plans and then populates them into the `#plansDropdown`. The `#plansDropdown` and `#clonePlanBtn` are set to `disabled` by default.","content":"/*************************************\n * Backend code - plan-functions.jsw *\n *************************************/\n\nimport { plans } from 'wix-pricing-plans.v2';\nimport { elevate } from 'wix-auth';\n\nconst elevatedListPlans = elevate(plans.listPlans);\nconst elevatedGetPlan = elevate(plans.getPlan);\nconst elevatedCreatePlan = elevate(plans.createPlan);\n\nexport async function listPlans() {\n try {\n const response = await elevatedListPlans();\n const allPlans = response.plans;\n\n return allPlans;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\nexport async function getPlan(planId) {\n try {\n const selectedPlan = await elevatedGetPlan(planId);\n\n return selectedPlan;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\nexport async function createPlan(plan) {\n try {\n const newPlan = await elevatedCreatePlan(plan);\n\n return newPlan;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n\n/*************\n * Page code *\n *************/\n\nimport { listPlans, getPlan, createPlan } from 'backend/plan-functions';\n$w.onReady(async function () {\n $w('#plansDropdown').disable();\n $w('#clonePlanBtn').disable();\n populatePlansDropdown();\n\n let selectedPlan;\n\n $w('#plansDropdown').onChange(async () => {\n const planId = $w('#plansDropdown').value;\n selectedPlan = await getPlan(planId);\n\n // Set default value for the new plan name\n $w('#planName').value = `${selectedPlan.name}-duplicate`\n $w('#clonePlanBtn').enable();\n });\n \n $w('#clonePlanBtn').onClick(async () => {\n const newPlan = selectedPlan;\n // Use inputs to set the new plan name and price\n newPlan.name = $w('#planName').value;\n newPlan.pricing.price.value = $w('#price').value;\n\n await createPlan(newPlan);\n });\n});\n\nasync function populatePlansDropdown() {\n const plans = await listPlans();\n $w('#plansDropdown').options = plans.map((plan) => {\n return {\n label: plan.name,\n value: plan._id\n }\n });\n $w('#plansDropdown').enable();\n}"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ListPlansOptions","referenceFqn":"ListPlansOptions"},"description":"Options for filtering and paging the list of plans."}],"description":"Retrieves a list of pricing plans.\n\nThe `listPlans()` function returns a Promise that resolves to a list of up to 100 pricing plans. This includes public, hidden, and archived plans.","permissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"},{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"}],"isAdminMethod":true},{"name":"listPublicPlans","fqn":"listPublicPlans","slug":"list-public-plans","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","permissionIds":["PRICING_PLANS.READ_PUBLIC_PLANS"],"permissions":["Read Pricing Plans","Manage Orders","Manage Bookings Services and Settings","Read Orders","Manage Portfolio","Manage Pricing Plans","Manage Restaurants - all permissions"],"permissionsScopesIds":["SCOPE.DC-PAIDPLANS.READ-PLANS","SCOPE.DC-PAIDPLANS.MANAGE-ORDERS","SCOPE.BOOKINGS.CONFIGURATION","SCOPE.DC-PAIDPLANS.READ-ORDERS","SCOPE.PORTFOLIO.MANAGE-PORTFOLIO","SCOPE.DC-PAIDPLANS.MANAGE-PLANS","SCOPE.RESTAURANTS.MEGA-SCOPES"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ListPublicPlansResponse","referenceFqn":"ListPublicPlansResponse"},"description":"Fulfilled - List of public pricing plans."},"examples":[{"title":"List public plans","description":"","content":"import { plans } from 'wix-pricing-plans.v2';\nimport { elevate } from 'wix-auth';\n\nexport async function myListPublicPlansFunction() {\n try {\n const elevatedListPublicPlans = elevate(plans.listPublicPlans);\n const plansList = await elevatedListPublicPlans();\n\n return plansList;\n } catch(error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to:\n * { \n * \"pagingMetadata\": {\n * \"count\": 5,\n * \"hasNext\": false,\n * \"offset\": 0,\n * \"total\": 5\n * },\n * \"plans\": [\n * {\n * \"_createdDate\": \"2024-01-08T14:33:12.209Z\",\n * \"_id\": \"d2fa5805-0d1a-4cfb-9b43-e683cf5fa990\",\n * \"_updatedDate\": \"2024-01-08T14:33:12.209Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"The value plan\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 1,\n * \"name\": \"Silver Membership - Monthly\",\n * \"perks\": {\n * \"values\": [\n * \"Full site access\",\n * \"Full video access\",\n * \"Consultation booking\"\n * ]\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"freeTrialDays\": 14,\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"100\"\n * },\n * \"slug\": \"silver-membership-monthly\",\n * \"subscription\": {\n * \"cycleCount\": 0,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"MONTH\"\n * }\n * }\n * },\n * \"termsAndConditions\": \"\"\n * },\n * {\n * \"_createdDate\": \"2024-01-07T07:33:59.973Z\",\n * \"_id\": \"b20feb39-a452-453e-96ee-01036adcd04e\",\n * \"_updatedDate\": \"2024-01-09T09:08:05.665Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Full feature enablement - lifetime plan\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Premium Plan - Lifetime Membership\",\n * \"perks\": {\n * \"values\": [\n * \"Cloud drive and file upload services\",\n * \"Unlimited video content access\"\n * ]\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"1000\"\n * },\n * \"singlePaymentUnlimited\": true\n * },\n * \"slug\": \"premium-plan-lifetime-membership\",\n * \"termsAndConditions\": \"This plan allows unlimited app and site features usage for all time, subject to our fair usage agreement and basic human decency agreement.\",\n * },\n * {\n * \"_createdDate\": \"2024-01-07T07:28:42.863Z\",\n * \"_id\": \"838f2c9d-c8d0-4799-a10a-e2f23849db10\",\n * \"_updatedDate\": \"2024-01-07T08:36:07.520Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Complete with all features. One month free trial.\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Premium Plan - annual - 30 day trial\",\n * \"perks\": {\n * \"values\": [\n * \"Unlimited video library streaming access\",\n * \"File sharing enabled for all channels\"\n * ]\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * },\n * \"freeTrialDays\": 30,\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"500\"\n * },\n * \"subscription\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * }\n * }\n * },\n * \"slug\": \"premium-plan-annual-30-day-trial-1\",\n * \"termsAndConditions\": \"Unlimited usage of services, subject to Fair Usage and Code of Conduct policies.\",\n * },\n * {\n * \"_createdDate\": \"2024-01-07T07:10:30.074Z\",\n * \"_id\": \"cb4a8c57-273a-4567-94e3-cc43d5d339f2\",\n * \"_updatedDate\": \"2024-01-07T07:10:30.074Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"3 mo free trial with discount for 1 year\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Beginner's Plan\",\n * \"perks\": {\n * \"values\": []\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * },\n * \"freeTrialDays\": 90,\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"50\"\n * }\n * },\n * \"slug\": \"beginners-plan\",\n * \"termsAndConditions\": \"\"\n * },\n * {\n * \"_createdDate\": \"2024-01-07T08:18:16.411Z\",\n * \"_id\": \"7a3375ce-18a9-42cb-8e39-47918ade45ec\",\n * \"_updatedDate\": \"2024-01-07T08:18:16.411Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Affordable with great functionality. Expires after 1 year\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Basic Plan - monthly subscription\",\n * \"perks\": {\n * \"values\": [\n * \"Access to select video channels\",\n * \"Access to rich site content\",\n * \"Access to designated file store\"\n * ]\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"cycleCount\": 12,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"MONTH\"\n * },\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"5\"\n * },\n * \"slug\": \"basic-plan-monthly-subscription\"\n * },\n * \"termsAndConditions\": \"\"\n * }\n * ],\n * }\n */"},{"title":"List public plans (export from backend code)","description":"","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { plans } from 'wix-pricing-plans.v2';\nimport { elevate } from 'wix-auth';\n\nexport const myListPublicPlansFunction = webMethod(Permissions.Anyone, async () => {\n try {\n const elevatedListPublicPlans = elevate(plans.listPublicPlans);\n const plansList = await elevatedListPublicPlans();\n\n return plansList;\n } catch(error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n * { \n * \"pagingMetadata\": {\n * \"count\": 5,\n * \"hasNext\": false,\n * \"offset\": 0,\n * \"total\": 5\n * },\n * \"plans\": [\n * {\n * \"_createdDate\": \"2024-01-08T14:33:12.209Z\",\n * \"_id\": \"d2fa5805-0d1a-4cfb-9b43-e683cf5fa990\",\n * \"_updatedDate\": \"2024-01-08T14:33:12.209Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"The value plan\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 1,\n * \"name\": \"Silver Membership - Monthly\",\n * \"perks\": {\n * \"values\": [\n * \"Full site access\",\n * \"Full video access\",\n * \"Consultation booking\"\n * ]\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"freeTrialDays\": 14,\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"100\"\n * },\n * \"slug\": \"silver-membership-monthly\",\n * \"subscription\": {\n * \"cycleCount\": 0,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"MONTH\"\n * }\n * }\n * },\n * \"termsAndConditions\": \"\"\n * },\n * {\n * \"_createdDate\": \"2024-01-07T07:33:59.973Z\",\n * \"_id\": \"b20feb39-a452-453e-96ee-01036adcd04e\",\n * \"_updatedDate\": \"2024-01-09T09:08:05.665Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Full feature enablement - lifetime plan\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Premium Plan - Lifetime Membership\",\n * \"perks\": {\n * \"values\": [\n * \"Cloud drive and file upload services\",\n * \"Unlimited video content access\"\n * ]\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"1000\"\n * },\n * \"singlePaymentUnlimited\": true\n * },\n * \"slug\": \"premium-plan-lifetime-membership\",\n * \"termsAndConditions\": \"This plan allows unlimited app and site features usage for all time, subject to our fair usage agreement and basic human decency agreement.\",\n * },\n * {\n * \"_createdDate\": \"2024-01-07T07:28:42.863Z\",\n * \"_id\": \"838f2c9d-c8d0-4799-a10a-e2f23849db10\",\n * \"_updatedDate\": \"2024-01-07T08:36:07.520Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Complete with all features. One month free trial.\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Premium Plan - annual - 30 day trial\",\n * \"perks\": {\n * \"values\": [\n * \"Unlimited video library streaming access\",\n * \"File sharing enabled for all channels\"\n * ]\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * },\n * \"freeTrialDays\": 30,\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"500\"\n * },\n * \"subscription\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * }\n * }\n * },\n * \"slug\": \"premium-plan-annual-30-day-trial-1\",\n * \"termsAndConditions\": \"Unlimited usage of services, subject to Fair Usage and Code of Conduct policies.\",\n * },\n * {\n * \"_createdDate\": \"2024-01-07T07:10:30.074Z\",\n * \"_id\": \"cb4a8c57-273a-4567-94e3-cc43d5d339f2\",\n * \"_updatedDate\": \"2024-01-07T07:10:30.074Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"3 mo free trial with discount for 1 year\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Beginner's Plan\",\n * \"perks\": {\n * \"values\": []\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * },\n * \"freeTrialDays\": 90,\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"50\"\n * }\n * },\n * \"slug\": \"beginners-plan\",\n * \"termsAndConditions\": \"\"\n * },\n * {\n * \"_createdDate\": \"2024-01-07T08:18:16.411Z\",\n * \"_id\": \"7a3375ce-18a9-42cb-8e39-47918ade45ec\",\n * \"_updatedDate\": \"2024-01-07T08:18:16.411Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Affordable with great functionality. Expires after 1 year\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Basic Plan - monthly subscription\",\n * \"perks\": {\n * \"values\": [\n * \"Access to select video channels\",\n * \"Access to rich site content\",\n * \"Access to designated file store\"\n * ]\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"cycleCount\": 12,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"MONTH\"\n * },\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"5\"\n * },\n * \"slug\": \"basic-plan-monthly-subscription\"\n * },\n * \"termsAndConditions\": \"\"\n * }\n * ],\n * }\n */\n"},{"title":"List public plans with options ","description":"","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { plans } from 'wix-pricing-plans.v2';\nimport { elevate } from 'wix-auth';\n\n/* Sample options value:\n * {\n * limit: 3,\n * offset: 1,\n * planIds: [\n * \"d2fa5805-0d1a-4cfb-9b43-e683cf5fa990\",\n * \"b20feb39-a452-453e-96ee-01036adcd04e\",\n * \"025a0d1f-7076-4e27-9696-4a67075dc2aa\",\n * \"838f2c9d-c8d0-4799-a10a-e2f23849db10\",\n * \"cb4a8c57-273a-4567-94e3-cc43d5d339f2\",\n * \"7a3375ce-18a9-42cb-8e39-47918ade45ec\"\n * ]\n * }\n */\n\nexport const myListPublicPlansFunction = webMethod(Permissions.Anyone, async (options) => {\n try {\n const elevatedListPublicPlans = elevate(plans.listPublicPlans);\n const plansList = await elevatedListPublicPlans(options);\n\n return plansList;\n } catch(error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n * {\n * \"pagingMetadata\": {\n * \"count\": 3,\n * \"hasNext\": true,\n * \"offset\": 1,\n * \"total\": 5\n * },\n * \"plans\": [\n * {\n * \"_createdDate\": \"2024-01-07T07:33:59.973Z\",\n * \"_id\": \"b20feb39-a452-453e-96ee-01036adcd04e\",\n * \"_updatedDate\": \"2024-01-09T09:08:05.665Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Full feature enablement - lifetime plan\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Premium Plan - Lifetime Membership\",\n * \"perks\": {\n * \"values\": [\n * \"Cloud drive and file upload services\",\n * \"Unlimited video content access\"\n * ]\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"1000\"\n * },\n * \"singlePaymentUnlimited\": true\n * },\n * \"slug\": \"premium-plan-lifetime-membership\",\n * \"termsAndConditions\": \"This plan allows unlimited app and site features usage for all time, subject to our fair usage agreement and basic human decency agreement.\",\n * },\n * {\n * \"_createdDate\": \"2024-01-07T07:28:42.863Z\",\n * \"_id\": \"838f2c9d-c8d0-4799-a10a-e2f23849db10\",\n * \"_updatedDate\": \"2024-01-07T08:36:07.520Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Complete with all features. One month free trial.\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Premium Plan - annual - 30 day trial\",\n * \"perks\": {\n * \"values\": [\n * \"Unlimited video library streaming access\",\n * \"File sharing enabled for all channels\"\n * ]\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * },\n * \"freeTrialDays\": 30,\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"500\"\n * },\n * \"subscription\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * }\n * }\n * },\n * \"slug\": \"premium-plan-annual-30-day-trial-1\",\n * \"termsAndConditions\": \"Unlimited usage of services, subject to Fair Usage and Code of Conduct policies.\",\n * },\n * {\n * \"_createdDate\": \"2024-01-07T07:10:30.074Z\",\n * \"_id\": \"cb4a8c57-273a-4567-94e3-cc43d5d339f2\",\n * \"_updatedDate\": \"2024-01-07T07:10:30.074Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"3 mo free trial with discount for 1 year\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Beginner's Plan\",\n * \"perks\": {\n * \"values\": []\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * },\n * \"freeTrialDays\": 90,\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"50\"\n * },\n * },\n * \"slug\": \"beginners-plan\",\n * \"termsAndConditions\": \"\",\n * }\n * ]\n * }\n */"},{"title":"Make a plan primary ","description":"Select a public plan from the dropdown to make it appear as a primary plan on the business site.","content":"/*************************************\n * Backend code - plan-functions.web.js *\n *************************************/\n\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { plans } from 'wix-pricing-plans.v2';\nimport { elevate } from 'wix-auth';\n\nconst elevatedListPublicPlans = elevate(plans.listPublicPlans);\nconst elevatedMakePlanPrimary = elevate(plans.makePlanPrimary);\n\nexport const listPublicPlans = webMethod(Permissions.Anyone, async () => {\n try {\n const response = await elevatedListPublicPlans();\n const plansList = response.plans;\n\n return plansList;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\nexport const makePlanPrimaryFunction = webMethod(Permissions.Anyone, async (_id) => {\n try {\n const primaryPlan = await elevatedMakePlanPrimary(_id);\n\n return primaryPlan;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/*************\n * Page code *\n *************/\n\nimport { listPublicPlans, makePlanPrimaryFunction } from 'backend/plan-functions.web';\n\n$w.onReady(function () {\n populateDropdown();\n $w('#plansList').onChange(async () => {\n await makePlanPrimaryFunction(\n $w('#plansList').value\n )\n });\n});\n\nasync function populateDropdown() {\n const plans = await listPublicPlans();\n $w('#plansList').options = plans.map(item => ({\n label: item.name,\n value: item._id\n })\n )\n}"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ListPublicPlansOptions","referenceFqn":"ListPublicPlansOptions"},"description":"Options for filtering and paging the list of public plans."}],"description":"Retrieves a list of public pricing plans.\n\n\nThe `listPublicPlans()` function returns a Promise that resolves to a list of up to 100 public pricing plans. Public plans are visible plans that site visitors can see on the site and purchase.","permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"},{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"},{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":false},{"name":"makePlanPrimary","fqn":"makePlanPrimary","slug":"make-plan-primary","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["_id"],"permissionIds":["PRICING_PLANS.MANAGE_PLANS"],"permissions":["Manage Pricing Plans"],"permissionsScopesIds":["SCOPE.DC-PAIDPLANS.MANAGE-PLANS"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"MakePlanPrimaryResponse","referenceFqn":"MakePlanPrimaryResponse"},"description":"Fulfilled - The primary plan."},"examples":[{"title":"Make a plan a primary plan (dashboard page code)","description":"","content":"import { plans } from 'wix-pricing-plans.v2';\n\n/* Sample _id value: '0b9a1993-c1ff-4952-9575-915b48d1a5e0' */\n\nexport async function myMakePlanPrimaryFunction(_id) {\n try {\n const primaryPlan = await plans.makePlanPrimary(_id);\n\n return primaryPlan;\n } catch(error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to:\n * {\n * \"_id\": \"b20feb39-a452-453e-96ee-01036adcd04e\",\n * \"_createdDate\": \"2024-01-07T07:33:59.973Z\",\n * \"_updatedDate\": \"2024-01-07T13:32:11.263Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Full feature enablement - lifetime plan\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Premium Plan - Lifetime Membership\",\n * \"perks\": {\n * \"values\": [\n * \"Cloud drive and file upload services\",\n * \"Unlimited video content access\"\n * ]\n * },\n * \"pricing\": {\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"1000\"\n * },\n * \"singlePaymentUnlimited\": true\n * },\n * \"primary\": true,\n * \"public\": true,\n * \"slug\": \"premium-plan-lifetime-membership\",\n * \"termsAndConditions\": \"This plan allows unlimited app and site features usage for all time, subject to our fair usage agreement and basic human decency agreement.\"\n * }\n */"},{"title":"Make a plan a primary plan (export from backend code)","description":"","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { plans } from 'wix-pricing-plans.v2';\nimport { elevate } from 'wix-auth';\n\n/* Sample _id value: '0b9a1993-c1ff-4952-9575-915b48d1a5e0' */\n\nexport const myMakePlanPrimaryFunction = webMethod(Permissions.Anyone, async (_id) => {\n try {\n const elevatedMakePlanPrimary = elevate(plans.makePlanPrimary);\n const primaryPlan = await elevatedMakePlanPrimary(_id);\n\n return primaryPlan;\n } catch(error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n * {\n * \"_id\": \"b20feb39-a452-453e-96ee-01036adcd04e\",\n * \"_createdDate\": \"2024-01-07T07:33:59.973Z\",\n * \"_updatedDate\": \"2024-01-07T13:32:11.263Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Full feature enablement - lifetime plan\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Premium Plan - Lifetime Membership\",\n * \"perks\": {\n * \"values\": [\n * \"Cloud drive and file upload services\",\n * \"Unlimited video content access\"\n * ]\n * },\n * \"pricing\": {\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"1000\"\n * },\n * \"singlePaymentUnlimited\": true\n * },\n * \"primary\": true,\n * \"public\": true,\n * \"slug\": \"premium-plan-lifetime-membership\",\n * \"termsAndConditions\": \"This plan allows unlimited app and site features usage for all time, subject to our fair usage agreement and basic human decency agreement.\"\n * }\n */\n"},{"title":"Make a plan primary ","description":"Select a public plan from the dropdown to make it appear as a primary plan on the business site.","content":"/*************************************\n * Backend code - plan-functions.web.js *\n *************************************/\n\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { plans } from 'wix-pricing-plans.v2';\nimport { elevate } from 'wix-auth';\n\nconst elevatedListPublicPlans = elevate(plans.listPublicPlans);\nconst elevatedMakePlanPrimary = elevate(plans.makePlanPrimary);\n\nexport const listPublicPlans = webMethod(Permissions.Anyone, async () => {\n try {\n const response = await elevatedListPublicPlans();\n const plansList = response.plans;\n\n return plansList;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\nexport const makePlanPrimaryFunction = webMethod(Permissions.Anyone, async (_id) => {\n try {\n const primaryPlan = await elevatedMakePlanPrimary(_id);\n\n return primaryPlan;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/*************\n * Page code *\n *************/\n\nimport { listPublicPlans, makePlanPrimaryFunction } from 'backend/plan-functions.web';\n\n$w.onReady(function () {\n populateDropdown();\n $w('#plansList').onChange(async () => {\n await makePlanPrimaryFunction(\n $w('#plansList').value\n )\n });\n});\n\nasync function populateDropdown() {\n const plans = await listPublicPlans();\n $w('#plansList').options = plans.map(item => ({\n label: item.name,\n value: item._id\n })\n )\n}"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the pricing plan to set as the primary plan."}],"description":"Marks a pricing plan as the primary pricing plan.\n\n\nThe `makePlanPrimary()` function returns a Promise that resolves to the now primary pricing plan.\n\nOnly a single plan can be marked as a primary plan at any given time. If there is an existing plan marked as primary, calling `makePlanPrimary()` causes the existing primary plan to lose its primary status.\n\nWhen viewing pricing plans on the site, the primary plan is highlighted with a customizable ribbon.","permissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"isAdminMethod":true},{"name":"queryPublicPlans","fqn":"queryPublicPlans","slug":"query-public-plans","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","permissionIds":["PRICING_PLANS.READ_PUBLIC_PLANS"],"permissions":["Read Pricing Plans","Manage Orders","Manage Bookings Services and Settings","Read Orders","Manage Portfolio","Manage Pricing Plans","Manage Restaurants - all permissions"],"permissionsScopesIds":["SCOPE.DC-PAIDPLANS.READ-PLANS","SCOPE.DC-PAIDPLANS.MANAGE-ORDERS","SCOPE.BOOKINGS.CONFIGURATION","SCOPE.DC-PAIDPLANS.READ-ORDERS","SCOPE.PORTFOLIO.MANAGE-PORTFOLIO","SCOPE.DC-PAIDPLANS.MANAGE-PLANS","SCOPE.RESTAURANTS.MEGA-SCOPES"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"PlansQueryBuilder","referenceFqn":"PlansQueryBuilder"},"examples":[{"title":"Build and execute a query to find all public plans","description":"","content":"import { plans } from 'wix-pricing-plans.v2';\n\nexport async function myQueryPublicPlansFunction() {\n try {\n const results = await plans.queryPublicPlans().find();\n const items = results.items;\n const firstItem = items[0];\n const length = results.length;\n const currentPage = results.currentPage;\n\n return items;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Returned items:\n * [\n * {\n * \"_createdDate\": \"2024-01-07T08:18:16.411Z\",\n * \"_id\": \"7a3375ce-18a9-42cb-8e39-47918ade45ec\",\n * \"_updatedDate\": \"2024-01-07T08:18:16.411Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Affordable with great functionality. Expires after 1 year\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Basic Plan - monthly subscription\",\n * \"perks\": {\n * \"values\": [\n * \"Access to select video channels\",\n * \"Access to rich site content\",\n * \"Access to designated file store\"\n * ]\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"cycleCount\": 12,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"MONTH\"\n * },\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"5\"\n * },\n * \"subscription\": {\n * \"cycleCount\": 12,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"MONTH\"\n * }\n * }\n * },\n * \"slug\": \"basic-plan-monthly-subscription\",\n * \"termsAndConditions\": \"\"\n * },\n * {\n * \"_createdDate\": \"2024-01-07T07:10:30.074Z\",\n * \"_id\": \"cb4a8c57-273a-4567-94e3-cc43d5d339f2\",\n * \"_updatedDate\": \"2024-01-07T07:10:30.074Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"3 mo free trial with discount for 1 year\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Beginner's Plan\",\n * \"perks\": {\n * \"values\": []\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * },\n * \"freeTrialDays\": 90,\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"50\"\n * },\n * \"subscription\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * }\n * }\n * },\n * \"slug\": \"beginners-plan\",\n * \"termsAndConditions\": \"\"\n * },\n * {\n * \"_createdDate\": \"2024-01-07T07:28:42.863Z\",\n * \"_id\": \"838f2c9d-c8d0-4799-a10a-e2f23849db10\",\n * \"_updatedDate\": \"2024-01-07T08:36:07.520Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Complete with all features. One month free trial.\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Premium Plan - annual - 30 day trial\",\n * \"perks\": {\n * \"values\": [\n * \"Unlimited video library streaming access\",\n * \"File sharing enabled for all channels\"\n * ]\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * },\n * \"freeTrialDays\": 30,\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"500\"\n * },\n * \"subscription\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * }\n * }\n * },\n * \"slug\": \"premium-plan-annual-30-day-trial-1\",\n * \"termsAndConditions\": \"Unlimited usage of services, subject to Fair Usage and Code of Conduct policies.\"\n * },\n * {\n * \"_createdDate\": \"2024-01-07T07:33:59.973Z\",\n * \"_id\": \"b20feb39-a452-453e-96ee-01036adcd04e\",\n * \"_updatedDate\": \"2024-01-09T09:08:05.665Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Full feature enablement - lifetime plan\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Premium Plan - Lifetime Membership\",\n * \"perks\": {\n * \"values\": [\n * \"Cloud drive and file upload services\",\n * \"Unlimited video content access\"\n * ]\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"currency\": \"EUR\",\n * \"value\": \"1000\",\n * \"singlePaymentUnlimited\": true\n * },\n * \"slug\": \"premium-plan-lifetime-membership\",\n * \"termsAndConditions\": \"This plan allows unlimited app and site features usage for all time, subject to our fair usage agreement and basic human decency agreement.\"\n * },\n * {\n * \"_createdDate\": \"2024-01-08T14:33:12.209Z\",\n * \"_id\": \"d2fa5805-0d1a-4cfb-9b43-e683cf5fa990\",\n * \"_updatedDate\": \"2024-01-08T14:33:12.209Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"The value plan\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 1,\n * \"name\": \"Silver Membership - Monthly\",\n * \"perks\": {\n * \"values\": [\n * \"Full site access\",\n * \"Full video access\",\n * \"Consultation booking\"\n * ]\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"currency\": \"EUR\",\n * \"value\": \"100\",\n * \"freeTrialDays\": 14,\n * \"subscription\": {\n * \"cycleCount\": 0,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"MONTH\"\n * }\n * }\n * },\n * \"slug\": \"silver-membership-monthly\",\n * \"termsAndConditions\": \"\"\n * }\n * ]\n */"},{"title":"Build and execute a query to find all public plans (export from backend code)","description":"","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { plans } from 'wix-pricing-plans.v2';\n\nexport const myQueryPublicPlansFunction = webMethod(Permissions.Anyone, async () => {\n try {\n const results = await plans.queryPublicPlans().find();\n const items = results.items;\n const firstItem = items[0];\n const length = results.length;\n const currentPage = results.currentPage;\n\n return items;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Returned items:\n * [\n * {\n * \"_createdDate\": \"2024-01-07T08:18:16.411Z\",\n * \"_id\": \"7a3375ce-18a9-42cb-8e39-47918ade45ec\",\n * \"_updatedDate\": \"2024-01-07T08:18:16.411Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Affordable with great functionality. Expires after 1 year\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Basic Plan - monthly subscription\",\n * \"perks\": {\n * \"values\": [\n * \"Access to select video channels\",\n * \"Access to rich site content\",\n * \"Access to designated file store\"\n * ]\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"cycleCount\": 12,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"MONTH\"\n * },\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"5\"\n * },\n * \"subscription\": {\n * \"cycleCount\": 12,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"MONTH\"\n * }\n * }\n * },\n * \"slug\": \"basic-plan-monthly-subscription\",\n * \"termsAndConditions\": \"\"\n * },\n * {\n * \"_createdDate\": \"2024-01-07T07:10:30.074Z\",\n * \"_id\": \"cb4a8c57-273a-4567-94e3-cc43d5d339f2\",\n * \"_updatedDate\": \"2024-01-07T07:10:30.074Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"3 mo free trial with discount for 1 year\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Beginner's Plan\",\n * \"perks\": {\n * \"values\": []\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * },\n * \"freeTrialDays\": 90,\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"50\"\n * },\n * \"subscription\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * }\n * }\n * },\n * \"slug\": \"beginners-plan\",\n * \"termsAndConditions\": \"\"\n * },\n * {\n * \"_createdDate\": \"2024-01-07T07:28:42.863Z\",\n * \"_id\": \"838f2c9d-c8d0-4799-a10a-e2f23849db10\",\n * \"_updatedDate\": \"2024-01-07T08:36:07.520Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Complete with all features. One month free trial.\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Premium Plan - annual - 30 day trial\",\n * \"perks\": {\n * \"values\": [\n * \"Unlimited video library streaming access\",\n * \"File sharing enabled for all channels\"\n * ]\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * },\n * \"freeTrialDays\": 30,\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"500\"\n * },\n * \"subscription\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * }\n * }\n * },\n * \"slug\": \"premium-plan-annual-30-day-trial-1\",\n * \"termsAndConditions\": \"Unlimited usage of services, subject to Fair Usage and Code of Conduct policies.\"\n * },\n * {\n * \"_createdDate\": \"2024-01-07T07:33:59.973Z\",\n * \"_id\": \"b20feb39-a452-453e-96ee-01036adcd04e\",\n * \"_updatedDate\": \"2024-01-09T09:08:05.665Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Full feature enablement - lifetime plan\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Premium Plan - Lifetime Membership\",\n * \"perks\": {\n * \"values\": [\n * \"Cloud drive and file upload services\",\n * \"Unlimited video content access\"\n * ]\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"currency\": \"EUR\",\n * \"value\": \"1000\",\n * \"singlePaymentUnlimited\": true\n * },\n * \"slug\": \"premium-plan-lifetime-membership\",\n * \"termsAndConditions\": \"This plan allows unlimited app and site features usage for all time, subject to our fair usage agreement and basic human decency agreement.\"\n * },\n * {\n * \"_createdDate\": \"2024-01-08T14:33:12.209Z\",\n * \"_id\": \"d2fa5805-0d1a-4cfb-9b43-e683cf5fa990\",\n * \"_updatedDate\": \"2024-01-08T14:33:12.209Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"The value plan\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 1,\n * \"name\": \"Silver Membership - Monthly\",\n * \"perks\": {\n * \"values\": [\n * \"Full site access\",\n * \"Full video access\",\n * \"Consultation booking\"\n * ]\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"currency\": \"EUR\",\n * \"value\": \"100\",\n * \"freeTrialDays\": 14,\n * \"subscription\": {\n * \"cycleCount\": 0,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"MONTH\"\n * }\n * }\n * },\n * \"slug\": \"silver-membership-monthly\",\n * \"termsAndConditions\": \"\"\n * }\n * ]\n */\n"},{"title":"Build and execute query to retrieve primary plan ","description":"","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { plans } from 'wix-pricing-plans.v2';\n\nexport const myQueryPublicPlansFunction = webMethod(Permissions.Anyone, async () => {\n try {\n const results = \n await plans.queryPublicPlans()\n .eq('primary', true)\n .find();\n const primaryPlan = results.items[0];\n\n return primaryPlan;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Returned item:\n * {\n * \"_createdDate\": \"2024-01-07T07:28:42.863Z\",\n * \"_id\": \"838f2c9d-c8d0-4799-a10a-e2f23849db10\",\n * \"_updatedDate\": \"2024-01-16T12:19:54.617Z\",\n * \"allowFutureStartDate\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Complete with all features. One month free trial.\",\n * \"maxPurchasesPerBuyer\": 0,\n * \"perks\": {\n * \"values\": [\n * \"Unlimited video library streaming access\",\n * \"File sharing enabled for all channels\"\n * ]\n * },\n * \"primary\": true,\n * \"pricing\": {\n * \"freeTrialDays\": 30,\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"500\"\n * },\n * \"subscription\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * }\n * }\n * },\n * \"slug\": \"premium-plan-annual-30-day-trial-1\",\n * \"termsAndConditions\": \"Unlimited usage of services, subject to Fair Usage and Code of Conduct policies.\"\n * }\n */ \n"},{"title":"Build and execute a query for a specific plan ID given its slug ","description":"","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { plans } from 'wix-pricing-plans.v2';\n\nexport const myQueryPublicPlansFunction4 = webMethod(Permissions.Anyone, async () => {\n try {\n const results = \n await plans.queryPublicPlans()\n .eq('slug','basic-plan-monthly-subscription')\n .find();\n const planId = results.items[0]._id;\n\n return planId;\n } catch(error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Returned item: '7a3375ce-18a9-42cb-8e39-47918ade45ec' */\n"},{"title":"Sort plans alphabetically ","description":"Select a sorting option to arranage plans in ascending or descending order by plan slug.","content":"/*************************************\n * Backend code - plan-functions.web.js *\n *************************************/\n\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { plans } from 'wix-pricing-plans.v2';\nimport { elevate } from 'wix-auth';\n\nconst elevatedArrangePlans = elevate(plans.arrangePlans);\n\nexport const sortPlansBySlug = webMethod(Permissions.Anyone, async (direction) => {\n let publicPlansQuery = plans.queryPublicPlans();\n\n if (direction === 'ascending') {\n publicPlansQuery = publicPlansQuery.ascending('slug');\n } else {\n publicPlansQuery = publicPlansQuery.descending('slug');\n }\n\n const sortedPlans = await publicPlansQuery.find();\n const planIds = sortedPlans.items.map(item => item._id);\n\n return await elevatedArrangePlans(planIds);\n});\n\n/*************\n * Page code *\n *************/\n\nimport { sortPlansBySlug } from 'backend/plan-functions.web';\nimport wixLocationFrontend from 'wix-location-frontend';\n\n$w.onReady(function () {\n $w('#dropdownSort').options =\n [\n {\n label: 'Ascending',\n value: 'ascending'\n },\n {\n label: 'Decending',\n value: 'descending'\n }\n ];\n\n $w('#dropdownSort').onChange(async () => {\n const direction = $w('#dropdownSort').value;\n sortPlansBySlug(direction);\n const url = wixLocationFrontend.url;\n wixLocationFrontend.to(url);\n })\n});\n"}],"description":"Creates a query to retrieve a list of public pricing plans. \n\n\nThe `queryPublicPlans()` function builds a query to retrieve a list of up to 1,000 public plans and returns a [`PublicPlansQueryBuilder`](#plansquerybuilder) object. \n\nThe returned object contains the query definition which is typically used to run the query using the [`find()`](#plansquerybuilder/find) function. \n\nYou can refine the query by chaining `PublicPlansQueryBuilder` functions onto the query. `PublicPlansQueryBuilder` functions enable you to sort, filter, and control the results that `queryPublicPlans()` returns. \n\n`queryPublicPlans()` runs with the following `PublicPlansQueryBuilder` defaults that you can override:\n- [`skip`](#plansquerybuilder/skip): `0`\n- [`limit`](#plansquerybuilder/limit): `50`\n\nThe functions that are chained to `queryPublicPlans()` are applied in the order they are called. For example, if you sort on the `_createdDate` property in ascending order and then on the `_id` property in ascending order, the results are sorted first by the created date of the items and then, if there are multiple results with the same date, the items are sorted by `_id` in ascending order, per created date value.\n\nThe following `PublicPlansQueryBuilder` functions are supported for the `queryPublicPlans()` function. For a full description of the Plans object, see the object returned for the [`items`](#plansqueryresult/items) property in [`PublicPlansQueryResult`](#plansqueryresult).\n\n\n|PROPERTY\t|SUPPORTED FILTERS & SORTING\t\n|:---:|:---:|\n|`_id`|[`eq()`](/plans/plans-query-builder/eq),[`ne()`](/plans/plans-query-builder/ne),[`exists()`](/plans/plans-query-builder/exists),[`in()`](/plans/plans-query-builder/in),[`hasSome()`](/plans/plans-query-builder/has-some),[`startsWith()`](/plans/plans-query-builder/starts-with),[`ascending()`](/plans/plans-query-builder/ascending),[`descending()`](/plans/plans-query-builder/descending)|\n|`primary`|[`eq()`](/plans/plans-query-builder/eq),[`ne()`](/plans/plans-query-builder/ne),[`exists()`](/plans/plans-query-builder/exists),[`in()`](/plans/plans-query-builder/in),[`hasSome()`](/plans/plans-query-builder/has-some),[`ascending()`](/plans/plans-query-builder/ascending),[`descending()`](/plans/plans-query-builder/descending)|\n|`_createdDate`|[`eq()`](/plans/plans-query-builder/eq),[`ne()`](/plans/plans-query-builder/ne),[`exists()`](/plans/plans-query-builder/exists),[`in()`](/plans/plans-query-builder/in),[`hasSome()`](/plans/plans-query-builder/has-some),[`lt()`](/plans/plans-query-builder/lt),[`le()`](/plans/plans-query-builder/le),[`gt()`](/plans/plans-query-builder/gt),[`ge()`](/plans/plans-query-builder/ge),[`ascending()`](/plans/plans-query-builder/ascending),[`descending()`](/plans/plans-query-builder/descending)|\n|`_updatedDate`|[`eq()`](/plans/plans-query-builder/eq),[`ne()`](/plans/plans-query-builder/ne),[`exists()`](/plans/plans-query-builder/exists),[`in()`](/plans/plans-query-builder/in),[`hasSome()`](/plans/plans-query-builder/has-some),[`lt()`](/plans/plans-query-builder/lt),[`le()`](/plans/plans-query-builder/le),[`gt()`](/plans/plans-query-builder/gt),[`ge()`](/plans/plans-query-builder/ge),[`ascending()`](/plans/plans-query-builder/ascending),[`descending()`](/plans/plans-query-builder/descending)|\n|`slug`|[`eq()`](/plans/plans-query-builder/eq),[`ne()`](/plans/plans-query-builder/ne),[`exists()`](/plans/plans-query-builder/exists),[`in()`](/plans/plans-query-builder/in),[`hasSome()`](/plans/plans-query-builder/has-some),[`startsWith()`](/plans/plans-query-builder/starts-with),[`ascending()`](/plans/plans-query-builder/ascending),[`descending()`](/plans/plans-query-builder/descending)|","permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"},{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"},{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":false},{"name":"setPlanVisibility","fqn":"setPlanVisibility","slug":"set-plan-visibility","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["_id","visible"],"permissionIds":["PRICING_PLANS.MANAGE_PLANS"],"permissions":["Manage Pricing Plans"],"permissionsScopesIds":["SCOPE.DC-PAIDPLANS.MANAGE-PLANS"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"SetPlanVisibilityResponse","referenceFqn":"SetPlanVisibilityResponse"},"description":"Fulfilled - The plan's information.\n\nRejected - Error message."},"examples":[{"title":"Hide a plan (dashboard page code)","description":"","content":"import { plans } from 'wix-pricing-plans.v2';\n\n/* Sample _id value: 'cb4a8c57-273a-4567-94e3-cc43d5d339f2'\n * \n * Sample visible value: false\n */\n\nexport async function mySetPlanVisibilityFunction(_id, visible) {\n try {\n const hiddenPlan = plans.setPlanVisibility(_id,visible);\n\n return hiddenPlan;\n } catch(error) {\n console.error(error);\n // Handle the error\n }\n}\n \n/* Promise resolves to:\n * {\n * \"plan\": {\n * \"_createdDate\": \"2024-01-07T07:10:30.074Z\",\n * \"_id\": \"cb4a8c57-273a-4567-94e3-cc43d5d339f2\",\n * \"_updatedDate\": \"2024-01-14T09:29:12.581Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"3 mo free trial with discount for 1 year\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Beginner's Plan\",\n * \"perks\": {\n * \"values\": []\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * },\n * \"freeTrialDays\": 90,\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"50\"\n * },\n * \"subscription\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * }\n * }\n * },\n * \"public\": false,\n * \"slug\": \"beginners-plan\",\n * \"termsAndConditions\": \"\"\n * }\n * }\n */ "},{"title":"Hide a plan (export from backend code)","description":"","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { plans } from 'wix-pricing-plans.v2';\nimport { elevate } from 'wix-auth';\n\n/* Sample _id value: 'cb4a8c57-273a-4567-94e3-cc43d5d339f2'\n * \n * Sample visible value: false\n */\n\nexport const mySetPlanVisibilityFunction = webMethod(Permissions.Anyone, async (_id, visible) => {\n try {\n const elevatedSetPlanVisibility = elevate(plans.setPlanVisibility);\n const hiddenPlan = elevatedSetPlanVisibility(_id,visible);\n\n return hiddenPlan;\n } catch(error) {\n console.error(error);\n // Handle the error\n }\n});\n \n/* Promise resolves to:\n * {\n * \"plan\": {\n * \"_createdDate\": \"2024-01-07T07:10:30.074Z\",\n * \"_id\": \"cb4a8c57-273a-4567-94e3-cc43d5d339f2\",\n * \"_updatedDate\": \"2024-01-14T09:29:12.581Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"3 mo free trial with discount for 1 year\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Beginner's Plan\",\n * \"perks\": {\n * \"values\": []\n * },\n * \"primary\": false,\n * \"pricing\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * },\n * \"freeTrialDays\": 90,\n * \"price\": {\n * \"currency\": \"EUR\",\n * \"value\": \"50\"\n * },\n * \"subscription\": {\n * \"cycleCount\": 2,\n * \"cycleDuration\": {\n * \"count\": 1,\n * \"unit\": \"YEAR\"\n * }\n * }\n * },\n * \"public\": false,\n * \"slug\": \"beginners-plan\",\n * \"termsAndConditions\": \"\"\n * }\n * }\n */ \n"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the plan to either display or hide on the site page."},{"name":"visible","slug":"visible","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to set the plan as visible."}],"description":"Sets visibility for non-archived pricing plans.\n\nThe `setPlanVisibility()` functions returns a Promise that resolves to a pricing plan when its visibility has successfully been set.\n\nBy default, pricing plans are public, meaning they are visible. [Plans can be hidden](https://support.wix.com/en/article/pricing-plans-removing-a-plan-from-your-site#hiding-plans) so that site members and visitors cannot see or choose them.\n\nAs opposed to archiving, setting visibility can be reversed. This means that a public plan can be hidden, and a hidden plan can be made public (visible).\n\n>**Note:** An archived plan always remains archived and cannot be made active again. When archiving a plan, its `public` property is automatically set to `false` so that it is hidden.\n\nChanging a plan's visibility does not impact existing orders for the plan. All orders for hidden plans are still active and keep their terms and payment options.","permissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"isAdminMethod":true},{"name":"updatePlan","fqn":"updatePlan","slug":"update-plan","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["_id","plan"],"permissionIds":["PRICING_PLANS.MANAGE_PLANS"],"permissions":["Manage Pricing Plans"],"permissionsScopesIds":["SCOPE.DC-PAIDPLANS.MANAGE-PLANS"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Plan","referenceFqn":"Plan"},"description":"Fulfilled - The updated plan.\n\nRejected - Error message."},"examples":[{"title":"Update a plan (dashboard page code)","description":"","content":"import { plans } from 'wix-pricing-plans.v2';\n\n/* Sample _id value: '025a0d1f-7076-4e27-9696-4a67075dc2aa' \n * \n * Sample plan value: \n * {\n * description: 'Bronze membership to the MyGame World of Online Gaming',\n * name: 'Bronze Plan'\n * }\n */\n\nexport async function myUpdatePlanFunction(_id, plan) {\n try {\n const updatedPlan = await plans.updatePlan(_id, plan);\n\n return updatedPlan;\n } catch(errors) {\n console.error(errors);\n // Handle the error\n }\n}\n/* Promise resolves to:\n * {\n * \"_createdDate\": \"2024-01-04T12:51:42.249Z\",\n * \"_id\": \"025a0d1f-7076-4e27-9696-4a67075dc2aa\",\n * \"_updatedDate\": \"2024-01-07T12:53:53.562Z\",\n * \"allowFutureStartDate\": true,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Bronze membership to the MyGame World of Online Gaming\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 1,\n * \"name\": \"Bronze Plan\",\n * \"perks\": {\n * \"values\": [\n * \"Multiplayer\",\n * \"Multiple devices\",\n * \"No ads\",\n * \"Unlimited access\"\n * ]\n * },\n * \"pricing\": {\n * \"price\": {\n * \"currency\": \"USD\",\n * \"value\": \"10.00\"\n * },\n * \"singlePaymentUnlimited\": true\n * },\n * \"primary\": false,\n * \"public\": false,\n * \"slug\": \"bronze-plan-1\",\n * \"termsAndConditions\": \"No sharing access with others!\"\n * }\n */"},{"title":"Update a plan (export from backend code)","description":"","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { plans } from 'wix-pricing-plans.v2';\nimport { elevate } from 'wix-auth';\n\n/* Sample _id value: '025a0d1f-7076-4e27-9696-4a67075dc2aa' \n * \n * Sample plan value: \n * {\n * description: 'Bronze membership to the MyGame World of Online Gaming',\n * name: 'Bronze Plan'\n * }\n */\n\nexport const myUpdatePlanFunction = webMethod(Permissions.Anyone, async (_id, plan) => {\n try {\n const elevateUpdatePlan = elevate(plans.updatePlan);\n const updatedPlan = await elevateUpdatePlan(_id, plan);\n\n return updatedPlan;\n } catch(errors) {\n console.error(errors);\n // Handle the error\n }\n});\n/* Promise resolves to:\n * {\n * \"_createdDate\": \"2024-01-04T12:51:42.249Z\",\n * \"_id\": \"025a0d1f-7076-4e27-9696-4a67075dc2aa\",\n * \"_updatedDate\": \"2024-01-07T12:53:53.562Z\",\n * \"allowFutureStartDate\": true,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"Bronze membership to the MyGame World of Online Gaming\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 1,\n * \"name\": \"Bronze Plan\",\n * \"perks\": {\n * \"values\": [\n * \"Multiplayer\",\n * \"Multiple devices\",\n * \"No ads\",\n * \"Unlimited access\"\n * ]\n * },\n * \"pricing\": {\n * \"price\": {\n * \"currency\": \"USD\",\n * \"value\": \"10.00\"\n * },\n * \"singlePaymentUnlimited\": true\n * },\n * \"primary\": false,\n * \"public\": false,\n * \"slug\": \"bronze-plan-1\",\n * \"termsAndConditions\": \"No sharing access with others!\"\n * }\n */\n"},{"title":"Update a plan with optional fields ","description":"","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { plans } from 'wix-pricing-plans.v2';\nimport { elevate } from 'wix-auth';\n\n/* Sample _id value: '0b9a1993-c1ff-4952-9575-915b48d1a5e0'\n * \n * Sample plan value: \n * {\n * allowFutureStartDate: false,\n * buyerCanCancel: true,\n * description: 'For new users just getting the feel of the product',\n * formId: 'ee62cefa-bdc2-4b5d-baab-6faeef83cecb',\n * hasOrders: false,\n * maxPurchasesPerBuyer: 0,\n * name: 'Simple Plan',\n * perks: {\n * values: [\n * 'Login member access',\n * 'Access to real-time articles',\n * 'Included in mailing list'\n * ]\n * },\n * pricing: {\n * price: {\n * currency: 'USD',\n * value: '3'\n * },\n * singlePaymentForDuration: {\n * count: 12,\n * unit: 'MONTH'\n * }\n * },\n * public: true,\n * slug: 'simple-plan',\n * termsAndConditions: 'I agree to refrain from sharing any of the exclusive content with non-members'\n * }\n */\n\nexport const myUpdatePlanFunction = webMethod(Permissions.Anyone, async (_id, plan) => {\n try {\n const elevateUpdatePlan = elevate(plans.updatePlan);\n const updatedPlan = await elevateUpdatePlan(_id, plan);\n\n return updatedPlan;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n * {\n * \"_createdDate\": \"2024-01-07T07:13:04.076Z\",\n * \"_id\": \"0b9a1993-c1ff-4952-9575-915b48d1a5e0\",\n * \"_updatedDate\": \"2024-01-07T11:02:55.945Z\",\n * \"allowFutureStartDate\": false,\n * \"archived\": false,\n * \"buyerCanCancel\": true,\n * \"description\": \"For new users just getting the feel of the product\",\n * \"formId\": \"ee62cefa-bdc2-4b5d-baab-6faeef83cecb\",\n * \"hasOrders\": false,\n * \"maxPurchasesPerBuyer\": 0,\n * \"name\": \"Simple Plan\",\n * \"perks\": {\n * \"values\": [\n * \"Login member access\",\n * \"Access to real-time articles\",\n * \"Included in mailing list\"\n * ]\n * },\n * \"pricing\": {\n * \"price\": {\n * \"value\": \"3\",\n * \"currency\": \"USD\"\n * },\n * \"singlePaymentForDuration\": {\n * \"count\": 12,\n * \"unit\": \"MONTH\"\n * }\n * },\n * \"primary\": false,\n * \"public\": true,\n * \"slug\": \"simple-plan\"\n * \"termsAndConditions\": \"I agree to refrain from sharing any of the exclusive content with non-members\"\n * }\n */\n"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the plan to update."},{"name":"plan","slug":"plan","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdatePlan","referenceFqn":"UpdatePlan"}},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdatePlanOptions","referenceFqn":"UpdatePlanOptions"},"description":"Options for updating the plan."}],"description":"Updates a pricing plan.\n\n\nThe `updatePlan()` function returns a Promise that resolves to an updated plan.\n\nUpdating a plan does not impact existing purchases made for the plan. All purchases keep the details of the original plan that was active at the time of the purchase.","permissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"isAdminMethod":true}],"webhooks":[],"articles":[{"content":"---\ntitle: Introduction\n---\n\n# Introduction\n \n\n

\n Developer Preview\n
\n APIs in Developer Preview are subject to change and are not intended for use in production.
Send us your suggestions for improving this API. Your feedback is valuable to us.\n

\n\n \n\n\n\nThe Pricing Plans Plans API allows you to manage your pricing plans. \n\nWith the Pricing Plans Plans API, you can:\n- [Create](wix-pricing-plans-v2/plans/create-plan) and [update](wix-pricing-plans-v2/plans/update-plans) orders.\n- [Get](wix-pricing-plans-v2/plans/get-plan), [list](wix-pricing-plans-v2/plans/list-plans) and [query](wix-pricing-plans-v2/plans/query-public-plans) plans. \n- [Set visibility](wix-pricing-plans-v2/plans/set-plan-visibility) for which plans are public and which are hidden.\n- [Archive](archive-Plan) plans.\n- [Set](wix-pricing-plans-v2/plans/make-plan-primary) or [clear](wix-pricing-plans-v2/plans/clear-primary) the primary plan. This determines if a plan is highlighted with a custom ribbon when viewing the plans on a site.\n- [Get statistics](wix-pricing-plans-v2/plans/get-plans-tats) about the plans.\n- [Arrange](wix-pricing-plans-v2/plans/arrange-plans) the order in which you want plans to be displayed. \n\n\nTo use the Pricing Plans Plans API, import `{ plans }` from the `wix-pricing-plans.v2` module. \n\n```javascript\nimport { plans } from 'wix-pricing-plans.v2';\n```\n\n","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[{"kind":"REFERENCE","name":"PlansQueryBuilder","referenceFqn":"PlansQueryBuilder"},{"kind":"REFERENCE","name":"PlansQueryResult","referenceFqn":"PlansQueryResult"}],"properties":[],"namespaces":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.86"}}

getPlan( )