{"id":"da7334fd-58ca-4a23-a9a7-9d92e8268fee","createdDate":"2024-12-19T13:45:34.687Z","updatedDate":"2024-12-19T13:45:34.687Z","resourceId":"a58b05ec-66f5-4e67-957f-49cfd43978b5","api":{"schema":{"object":{"displayName":"Plan Object","description":"Information about the pricing plan.","slug":"plan-object","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/app-market.git"},"methods":[{"summary":"List Public Plans","description":"Retrieves a list of up to 100 public pricing plans. Public plans are visible plans that are available to site visitors and can be purchased.","operationId":"com.wixpress.membership.v2.plans.PlansServiceV2.ListPublicPlans","parameters":[{"name":"limit","in":"query","description":"Number of items to list. Defaults to `75`. See limits ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/list-public-plans) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging)).","required":false,"schema":{"description":"Number of items to list. Defaults to `75`. See limits ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/list-public-plans) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging)).","minimum":1,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"offset","in":"query","description":"Number of items to skip. Defaults to `0`. See paging ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/list-public-plans) |[REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging)).","required":false,"schema":{"description":"Number of items to skip. Defaults to `0`. See paging ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/list-public-plans) |[REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging)).","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"planIds","in":"query","description":"IDs of plans to list. Non-existent IDs are ignored and don't cause errors. You can specify a maximum of 100 IDs.","required":false,"schema":{"description":"IDs of plans to list. Non-existent IDs are ignored and don't cause errors. You can specify a maximum of 100 IDs.","format":"GUID","maxItems":100,"title":"planIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.ListPublicPlansResponse","description":""}},"deprecated":false,"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["PRICING_PLANS.READ_PUBLIC_PLANS"],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.pricing-plans.proxy.plan-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.ListPublicPlansRequest","responseMessage":"com.wixpress.membership.v2.plans.ListPublicPlansResponse"},"legacyExamples":[{"name":"ListPublicPlans","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n https://www.wixapis.com/pricing-plans/v2/plans/public?offset=15&limit=2\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"plans\": [\n {\n \"id\": \"31e40c78-...-980f-0bf8436307fb\",\n \"name\": \"VIP Monthly\",\n \"description\": \"\",\n \"perks\": {\n \"values\": [\n \"Free consulting\",\n \"Multi-user\"\n ]\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 3\n },\n \"price\": {\n \"value\": \"23\",\n \"currency\": \"USD\"\n }\n },\n \"primary\": false,\n \"createdDate\": \"2020-06-18T09:05:20.063Z\",\n \"updatedDate\": \"2021-02-09T09:21:47.649Z\",\n \"slug\": \"vip-monthly\",\n \"maxPurchasesPerBuyer\": 1,\n \"allowFutureStartDate\": true,\n \"buyerCanCancel\": true,\n \"termsAndConditions\": \"No sharing please.\"\n },\n {\n \"id\": \"31e40c78-...-980f-0bf8436307fb\",\n \"name\": \"Silver membership\",\n \"description\": \"\",\n \"perks\": {\n \"values\": [\n \"Free consulting\",\n \"Multi-user\"\n ]\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"WEEK\"\n },\n \"cycleCount\": 12\n },\n \"price\": {\n \"value\": \"10\",\n \"currency\": \"USD\"\n }\n },\n \"primary\": false,\n \"createdDate\": \"2020-06-18T09:05:20.063Z\",\n \"updatedDate\": \"2021-02-09T09:21:47.649Z\",\n \"slug\": \"silver-membership\",\n \"maxPurchasesPerBuyer\": 1,\n \"allowFutureStartDate\": true,\n \"buyerCanCancel\": true,\n \"termsAndConditions\": \"No sharing please.\"\n }\n ]\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v2/plans/public","rpcOnly":false,"servers":[{"url":"https://*.dev.wix-code.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.dev.wix-code.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://*.pub.wix-code.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.pub.wix-code.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://*.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://_/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor-flow.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor-flow.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://blocks.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"blocks._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://create.editorx/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"create.editorx","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://forums.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"forums._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://forums.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"forums.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://manage.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"manage._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://manage.wix.com/_api/pricing-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/pricing-plans/v2/plans","destinationPath":"/v2/plans","url":"manage._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://www.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"www._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://www.wixapis.com/pricing-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/plans","destinationPath":"/v2/plans","url":"www.wixapis.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}}],"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["PRICING_PLANS.READ_PUBLIC_PLANS"],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.pricing-plans.proxy.plan-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.ListPublicPlansRequest","responseMessage":"com.wixpress.membership.v2.plans.ListPublicPlansResponse"},"legacyExamples":[{"name":"ListPublicPlans","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n https://www.wixapis.com/pricing-plans/v2/plans/public?offset=15&limit=2\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"plans\": [\n {\n \"id\": \"31e40c78-...-980f-0bf8436307fb\",\n \"name\": \"VIP Monthly\",\n \"description\": \"\",\n \"perks\": {\n \"values\": [\n \"Free consulting\",\n \"Multi-user\"\n ]\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 3\n },\n \"price\": {\n \"value\": \"23\",\n \"currency\": \"USD\"\n }\n },\n \"primary\": false,\n \"createdDate\": \"2020-06-18T09:05:20.063Z\",\n \"updatedDate\": \"2021-02-09T09:21:47.649Z\",\n \"slug\": \"vip-monthly\",\n \"maxPurchasesPerBuyer\": 1,\n \"allowFutureStartDate\": true,\n \"buyerCanCancel\": true,\n \"termsAndConditions\": \"No sharing please.\"\n },\n {\n \"id\": \"31e40c78-...-980f-0bf8436307fb\",\n \"name\": \"Silver membership\",\n \"description\": \"\",\n \"perks\": {\n \"values\": [\n \"Free consulting\",\n \"Multi-user\"\n ]\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"WEEK\"\n },\n \"cycleCount\": 12\n },\n \"price\": {\n \"value\": \"10\",\n \"currency\": \"USD\"\n }\n },\n \"primary\": false,\n \"createdDate\": \"2020-06-18T09:05:20.063Z\",\n \"updatedDate\": \"2021-02-09T09:21:47.649Z\",\n \"slug\": \"silver-membership\",\n \"maxPurchasesPerBuyer\": 1,\n \"allowFutureStartDate\": true,\n \"buyerCanCancel\": true,\n \"termsAndConditions\": \"No sharing please.\"\n }\n ]\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"List Public Plans","slugifiedName":"list-public-plans"},"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},{"summary":"Query Public Plans","description":"Retrieves a list of up to 1,000 public pricing plans, given the provided pagination, sorting, and filtering ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/query-public-plans) | [REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/filter-and-sort)).","operationId":"com.wixpress.membership.v2.plans.PlansServiceV2.QueryPublicPlans","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.QueryPublicPlansResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryPublicPlansRequest","description":"","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/com.wixpress.membership.v2.common.QueryV2","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["PRICING_PLANS.READ_PUBLIC_PLANS"],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.pricing-plans.proxy.plan-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.QueryPublicPlansRequest","responseMessage":"com.wixpress.membership.v2.plans.QueryPublicPlansResponse"},"legacyExamples":[{"name":"QueryPublicPlans","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n https://www.wixapis.com/pricing-plans/v2/plans/public/query\n --data-binary '{\n \"query\": {\n \"paging\" : {\n \"offset\": 0,\n \"limit\": 1\n },\n \"sort\": [\n {\n \"fieldName\": \"createdDate\",\n \"order\": \"DESC\"\n }\n ],\n \"filter\": {\n \"id\": {\n \"$ne\": \"ee187a1b-...-9f7a-936f2cd9d100\"\n }\n }\n }\n }'\n -H 'Authorization: '\n~~~","response":"~~~json\n{ \"plans\":\n [\n {\n \"id\": \"31e40c78-3ac0-443d-980f-0bf8436307fb\",\n \"name\": \"VIP Monthly\",\n \"description\": \"\",\n \"perks\": {\n \"values\": [\n \"Free consulting\",\n \"Multi-user\"\n ]\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 3\n },\n \"price\": {\n \"value\": \"23\",\n \"currency\": \"USD\"\n }\n },\n \"primary\": false,\n \"createdDate\": \"2020-06-18T09:05:20.063Z\",\n \"updatedDate\": \"2021-02-09T09:21:47.649Z\",\n \"slug\": \"vip-monthly\",\n \"maxPurchasesPerBuyer\": 1,\n \"allowFutureStartDate\": true,\n \"buyerCanCancel\": true,\n \"termsAndConditions\": \"No sharing please.\"\n }\n ]\n }\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v2/plans/public/query","rpcOnly":false,"servers":[{"url":"https://*.dev.wix-code.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.dev.wix-code.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://*.pub.wix-code.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.pub.wix-code.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://*.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://_/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor-flow.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor-flow.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://blocks.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"blocks._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://create.editorx/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"create.editorx","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://forums.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"forums._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://forums.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"forums.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://manage.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"manage._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://manage.wix.com/_api/pricing-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/pricing-plans/v2/plans","destinationPath":"/v2/plans","url":"manage._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://www.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"www._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://www.wixapis.com/pricing-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/plans","destinationPath":"/v2/plans","url":"www.wixapis.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}}],"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["PRICING_PLANS.READ_PUBLIC_PLANS"],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.pricing-plans.proxy.plan-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.QueryPublicPlansRequest","responseMessage":"com.wixpress.membership.v2.plans.QueryPublicPlansResponse"},"legacyExamples":[{"name":"QueryPublicPlans","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n https://www.wixapis.com/pricing-plans/v2/plans/public/query\n --data-binary '{\n \"query\": {\n \"paging\" : {\n \"offset\": 0,\n \"limit\": 1\n },\n \"sort\": [\n {\n \"fieldName\": \"createdDate\",\n \"order\": \"DESC\"\n }\n ],\n \"filter\": {\n \"id\": {\n \"$ne\": \"ee187a1b-...-9f7a-936f2cd9d100\"\n }\n }\n }\n }'\n -H 'Authorization: '\n~~~","response":"~~~json\n{ \"plans\":\n [\n {\n \"id\": \"31e40c78-3ac0-443d-980f-0bf8436307fb\",\n \"name\": \"VIP Monthly\",\n \"description\": \"\",\n \"perks\": {\n \"values\": [\n \"Free consulting\",\n \"Multi-user\"\n ]\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 3\n },\n \"price\": {\n \"value\": \"23\",\n \"currency\": \"USD\"\n }\n },\n \"primary\": false,\n \"createdDate\": \"2020-06-18T09:05:20.063Z\",\n \"updatedDate\": \"2021-02-09T09:21:47.649Z\",\n \"slug\": \"vip-monthly\",\n \"maxPurchasesPerBuyer\": 1,\n \"allowFutureStartDate\": true,\n \"buyerCanCancel\": true,\n \"termsAndConditions\": \"No sharing please.\"\n }\n ]\n }\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Query Public Plans","slugifiedName":"query-public-plans"},"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},{"summary":"Get Plan","description":"Retrieves a pricing plan by ID.","operationId":"com.wixpress.membership.v2.plans.PlansServiceV2.GetPlan","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Plan ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.GetPlanResponse","description":""}},"deprecated":false,"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["PRICING_PLANS.READ_PLANS"],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.pricing-plans.proxy.plan-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.GetPlanRequest","responseMessage":"com.wixpress.membership.v2.plans.GetPlanResponse"},"legacyExamples":[{"name":"GetPlan","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n https://www.wixapis.com/pricing-plans/v2/plans/ee187a1b-...-9f7a-936f2cd9d100\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n plan: {\n \"id\": \"ee187a1b-...-9f7a-936f2cd9d100\",\n \"name\": \"VIP monthly\",\n \"description\": \"\",\n \"perks\": {\n \"values\": [\n \"Free consulting\",\n \"Multi-user\"\n ]\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 3\n },\n \"price\": {\n \"value\": \"23\",\n \"currency\": \"USD\"\n }\n },\n \"public\": true,\n \"archived\": false,\n \"primary\": false,\n \"hasOrders\": true,\n \"createdDate\": \"2021-01-10T09:05:20.063Z\",\n \"updatedDate\": \"2021-02-09T09:21:47.649Z\",\n \"slug\": \"vip-monthly\",\n \"maxPurchasesPerBuyer\": 1,\n \"allowFutureStartDate\": true,\n \"buyerCanCancel\": true,\n \"termsAndConditions\": \"No sharing please.\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v2/plans/{id}","rpcOnly":false,"servers":[{"url":"https://*.dev.wix-code.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.dev.wix-code.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://*.pub.wix-code.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.pub.wix-code.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://*.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://_/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor-flow.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor-flow.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://blocks.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"blocks._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://create.editorx/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"create.editorx","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://forums.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"forums._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://forums.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"forums.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://manage.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"manage._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://manage.wix.com/_api/pricing-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/pricing-plans/v2/plans","destinationPath":"/v2/plans","url":"manage._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://www.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"www._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://www.wixapis.com/pricing-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/plans","destinationPath":"/v2/plans","url":"www.wixapis.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}}],"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["PRICING_PLANS.READ_PLANS"],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.pricing-plans.proxy.plan-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.GetPlanRequest","responseMessage":"com.wixpress.membership.v2.plans.GetPlanResponse"},"legacyExamples":[{"name":"GetPlan","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n https://www.wixapis.com/pricing-plans/v2/plans/ee187a1b-...-9f7a-936f2cd9d100\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n plan: {\n \"id\": \"ee187a1b-...-9f7a-936f2cd9d100\",\n \"name\": \"VIP monthly\",\n \"description\": \"\",\n \"perks\": {\n \"values\": [\n \"Free consulting\",\n \"Multi-user\"\n ]\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 3\n },\n \"price\": {\n \"value\": \"23\",\n \"currency\": \"USD\"\n }\n },\n \"public\": true,\n \"archived\": false,\n \"primary\": false,\n \"hasOrders\": true,\n \"createdDate\": \"2021-01-10T09:05:20.063Z\",\n \"updatedDate\": \"2021-02-09T09:21:47.649Z\",\n \"slug\": \"vip-monthly\",\n \"maxPurchasesPerBuyer\": 1,\n \"allowFutureStartDate\": true,\n \"buyerCanCancel\": true,\n \"termsAndConditions\": \"No sharing please.\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Plan","slugifiedName":"get-plan"},"permissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"},{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"}],"isAdminMethod":true},{"summary":"List Plans","description":"Retrieves a list of up to 100 pricing plans (including public, hidden, and archived plans).","operationId":"com.wixpress.membership.v2.plans.PlansServiceV2.ListPlans","parameters":[{"name":"archived","in":"query","description":"Archived filter. Defaults to `ACTIVE` (not archived) only.","required":false,"schema":{"description":"Archived filter. Defaults to `ACTIVE` (not archived) only.","title":"archived","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.ArchivedFilterEnum.ArchivedFilter","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"public","in":"query","description":"Visibility filter. Defaults to `PUBLIC_AND_HIDDEN` (meaning, both are listed).","required":false,"schema":{"description":"Visibility filter. Defaults to `PUBLIC_AND_HIDDEN` (meaning, both are listed).","title":"public","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.PublicFilterEnum.PublicFilter","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"limit","in":"query","description":"Number of pricing plans to list. Defaults to `75`.","required":false,"schema":{"description":"Number of pricing plans to list. Defaults to `75`.","minimum":1,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"offset","in":"query","description":"Number of pricing plans to skip. Defaults to `0`.","required":false,"schema":{"description":"Number of pricing plans to skip. Defaults to `0`.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"planIds","in":"query","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 are listed according to the order displayed in a site's dashboard (which you can set with Arrange Plans). You can specify a maximum of 100 IDs.","required":false,"schema":{"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 are listed according to the order displayed in a site's dashboard (which you can set with Arrange Plans). You can specify a maximum of 100 IDs.","format":"GUID","maxItems":100,"title":"planIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.ListPlansResponse","description":""}},"deprecated":false,"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["PRICING_PLANS.READ_PLANS"],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.pricing-plans.proxy.plan-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.ListPlansRequest","responseMessage":"com.wixpress.membership.v2.plans.ListPlansResponse"},"legacyExamples":[{"name":"ListPlans","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n https://www.wixapis.com/pricing-plans/v2/plans?planIds=e9e1d210-...-b6e8-92e56705b937&planIds=2cb7396c-...-bb2e-cb27ac741d78&offset=1&archived=ACTIVE\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n plans: [\n {\n \"id\": \"e9e1d210-...-b6e8-92e56705b937\",\n \"name\": \"VIP monthly\",\n \"description\": \"\",\n \"perks\": {\n \"values\": [\n \"Free consulting\",\n \"Multi-user\"\n ]\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 3\n },\n \"price\": {\n \"value\": \"23\",\n \"currency\": \"USD\"\n }\n },\n \"public\": true,\n \"archived\": false,\n \"primary\": false,\n \"hasOrders\": true,\n \"createdDate\": \"2021-01-10T09:05:20.063Z\",\n \"updatedDate\": \"2021-02-09T09:21:47.649Z\",\n \"slug\": \"vip-monthly\",\n \"maxPurchasesPerBuyer\": 1,\n \"allowFutureStartDate\": true,\n \"buyerCanCancel\": true,\n \"termsAndConditions\": \"No sharing please.\"\n },\n {\n \"id\": \"2cb7396c-...-bb2e-cb27ac741d78\",\n \"name\": \"Silver membership\",\n \"description\": \"\",\n \"perks\": {\n \"values\": [\n \"Free consulting\",\n \"Multi-user\"\n ]\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"WEEK\"\n },\n \"cycleCount\": 12\n },\n \"price\": {\n \"value\": \"10\",\n \"currency\": \"USD\"\n }\n },\n \"public\": true,\n \"archived\": false,\n \"primary\": false,\n \"hasOrders\": true,\n \"createdDate\": \"2021-01-10T09:05:20.063Z\",\n \"updatedDate\": \"2021-02-09T09:21:47.649Z\",\n \"slug\": \"silver-membership\",\n \"maxPurchasesPerBuyer\": 1,\n \"allowFutureStartDate\": true,\n \"buyerCanCancel\": true,\n \"termsAndConditions\": \"No sharing please.\"\n }\n ]\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v2/plans","rpcOnly":false,"servers":[{"url":"https://*.dev.wix-code.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.dev.wix-code.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://*.pub.wix-code.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.pub.wix-code.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://*.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://_/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor-flow.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor-flow.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://blocks.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"blocks._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://create.editorx/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"create.editorx","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://forums.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"forums._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://forums.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"forums.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://manage.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"manage._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://manage.wix.com/_api/pricing-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/pricing-plans/v2/plans","destinationPath":"/v2/plans","url":"manage._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://www.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"www._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://www.wixapis.com/pricing-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/plans","destinationPath":"/v2/plans","url":"www.wixapis.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}}],"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["PRICING_PLANS.READ_PLANS"],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.pricing-plans.proxy.plan-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.ListPlansRequest","responseMessage":"com.wixpress.membership.v2.plans.ListPlansResponse"},"legacyExamples":[{"name":"ListPlans","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n https://www.wixapis.com/pricing-plans/v2/plans?planIds=e9e1d210-...-b6e8-92e56705b937&planIds=2cb7396c-...-bb2e-cb27ac741d78&offset=1&archived=ACTIVE\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n plans: [\n {\n \"id\": \"e9e1d210-...-b6e8-92e56705b937\",\n \"name\": \"VIP monthly\",\n \"description\": \"\",\n \"perks\": {\n \"values\": [\n \"Free consulting\",\n \"Multi-user\"\n ]\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 3\n },\n \"price\": {\n \"value\": \"23\",\n \"currency\": \"USD\"\n }\n },\n \"public\": true,\n \"archived\": false,\n \"primary\": false,\n \"hasOrders\": true,\n \"createdDate\": \"2021-01-10T09:05:20.063Z\",\n \"updatedDate\": \"2021-02-09T09:21:47.649Z\",\n \"slug\": \"vip-monthly\",\n \"maxPurchasesPerBuyer\": 1,\n \"allowFutureStartDate\": true,\n \"buyerCanCancel\": true,\n \"termsAndConditions\": \"No sharing please.\"\n },\n {\n \"id\": \"2cb7396c-...-bb2e-cb27ac741d78\",\n \"name\": \"Silver membership\",\n \"description\": \"\",\n \"perks\": {\n \"values\": [\n \"Free consulting\",\n \"Multi-user\"\n ]\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"WEEK\"\n },\n \"cycleCount\": 12\n },\n \"price\": {\n \"value\": \"10\",\n \"currency\": \"USD\"\n }\n },\n \"public\": true,\n \"archived\": false,\n \"primary\": false,\n \"hasOrders\": true,\n \"createdDate\": \"2021-01-10T09:05:20.063Z\",\n \"updatedDate\": \"2021-02-09T09:21:47.649Z\",\n \"slug\": \"silver-membership\",\n \"maxPurchasesPerBuyer\": 1,\n \"allowFutureStartDate\": true,\n \"buyerCanCancel\": true,\n \"termsAndConditions\": \"No sharing please.\"\n }\n ]\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"List Plans","slugifiedName":"list-plans"},"permissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"},{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"}],"isAdminMethod":true},{"summary":"Create Plan","description":"Creates a pricing plan. The specified `plan` object must contain a pricing model. A pricing model can be 1 of the following:\n- **A subscription**: A subscription with recurring payments and how often the plan occurs. Subscriptions can have free trial days.\n- **A plan that doesn't 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).\nPricing plans are available to the Wix user in the Pricing Plans section in a site's dashboard.","operationId":"com.wixpress.membership.v2.plans.PlansServiceV2.CreatePlan","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.CreatePlanResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreatePlanRequest","description":"","properties":{"plan":{"description":"Plan details.","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["plan","plan.name","plan.pricing","plan.pricing.pricingModel","plan.pricing.pricingModel.singlePaymentForDuration.count","plan.pricing.pricingModel.subscription.cycleCount","plan.pricing.pricingModel.subscription.cycleDuration","plan.pricing.pricingModel.subscription.cycleDuration.count"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Plan Created","description":"Triggered when a pricing plan is created.","permissions":["PRICING_PLANS.READ_PLANS"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.pricing_plans.plan","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.pricing_plans.plan_created","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["PRICING_PLANS.MANAGE_PLANS"],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.pricing-plans.proxy.plan-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.CreatePlanRequest","responseMessage":"com.wixpress.membership.v2.plans.CreatePlanResponse"},"legacyExamples":[{"name":"CreatePlan","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n https://www.wixapis.com/pricing-plans/v2/plans\n --data-binary '{\n \"plan\": {\n \"name\": \"VIP monthly\",\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n }\n \"cycleCount\": 3 \n },\n \"price\": {\n \"value\": \"23\",\n \"currency\": \"USD\"\n }\n }\n }\n }'\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n plan: {\n \"id\": \"31e40c78-...-0bf8436307fb\",\n \"name\": \"VIP monthly\",\n \"description\": \"\",\n \"perks\": {\n \"values\": [\n \"Free consulting\",\n \"Multi-user\"\n ]\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 3\n },\n \"price\": {\n \"value\": \"23\",\n \"currency\": \"USD\"\n }\n },\n \"public\": true,\n \"archived\": false,\n \"primary\": false,\n \"hasOrders\": true,\n \"createdDate\": \"2021-01-10T09:05:20.063Z\",\n \"updatedDate\": \"2021-01-10T09:05:20.063Z\",\n \"slug\": \"vip-monthly\",\n \"maxPurchasesPerBuyer\": 1,\n \"allowFutureStartDate\": true,\n \"buyerCanCancel\": true,\n \"termsAndConditions\": \"No sharing please.\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v2/plans","rpcOnly":false,"servers":[{"url":"https://*.dev.wix-code.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.dev.wix-code.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://*.pub.wix-code.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.pub.wix-code.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://*.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://_/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor-flow.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor-flow.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://blocks.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"blocks._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://create.editorx/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"create.editorx","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://forums.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"forums._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://forums.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"forums.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://manage.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"manage._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://manage.wix.com/_api/pricing-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/pricing-plans/v2/plans","destinationPath":"/v2/plans","url":"manage._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://www.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"www._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://www.wixapis.com/pricing-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/plans","destinationPath":"/v2/plans","url":"www.wixapis.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}}],"triggeredEvents":[{"title":"Plan Created","description":"Triggered when a pricing plan is created.","permissions":["PRICING_PLANS.READ_PLANS"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.pricing_plans.plan","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.pricing_plans.plan_created","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["PRICING_PLANS.MANAGE_PLANS"],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.pricing-plans.proxy.plan-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.CreatePlanRequest","responseMessage":"com.wixpress.membership.v2.plans.CreatePlanResponse"},"legacyExamples":[{"name":"CreatePlan","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n https://www.wixapis.com/pricing-plans/v2/plans\n --data-binary '{\n \"plan\": {\n \"name\": \"VIP monthly\",\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n }\n \"cycleCount\": 3 \n },\n \"price\": {\n \"value\": \"23\",\n \"currency\": \"USD\"\n }\n }\n }\n }'\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n plan: {\n \"id\": \"31e40c78-...-0bf8436307fb\",\n \"name\": \"VIP monthly\",\n \"description\": \"\",\n \"perks\": {\n \"values\": [\n \"Free consulting\",\n \"Multi-user\"\n ]\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 3\n },\n \"price\": {\n \"value\": \"23\",\n \"currency\": \"USD\"\n }\n },\n \"public\": true,\n \"archived\": false,\n \"primary\": false,\n \"hasOrders\": true,\n \"createdDate\": \"2021-01-10T09:05:20.063Z\",\n \"updatedDate\": \"2021-01-10T09:05:20.063Z\",\n \"slug\": \"vip-monthly\",\n \"maxPurchasesPerBuyer\": 1,\n \"allowFutureStartDate\": true,\n \"buyerCanCancel\": true,\n \"termsAndConditions\": \"No sharing please.\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Create Plan","slugifiedName":"create-plan"},"permissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"isAdminMethod":true},{"summary":"Get Plan Stats","description":"Gets statistics about the pricing plans. Currently provides only the total number of pricing plans, including archived plans.","operationId":"com.wixpress.membership.v2.plans.PlansServiceV2.GetPlanStats","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.GetPlanStatsResponse","description":""}},"deprecated":false,"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["PRICING_PLANS.READ_PLANS"],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.pricing-plans.proxy.plan-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.GetPlanStatsRequest","responseMessage":"com.wixpress.membership.v2.plans.GetPlanStatsResponse"},"legacyExamples":[{"name":"GetPlanStats","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n https://www.wixapis.com/pricing-plans/v2/plans/stats\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"totalPlans\": 80\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v2/plans/stats","rpcOnly":false,"servers":[{"url":"https://*.dev.wix-code.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.dev.wix-code.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://*.pub.wix-code.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.pub.wix-code.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://*.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://_/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor-flow.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor-flow.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://blocks.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"blocks._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://create.editorx/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"create.editorx","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://forums.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"forums._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://forums.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"forums.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://manage.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"manage._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://manage.wix.com/_api/pricing-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/pricing-plans/v2/plans","destinationPath":"/v2/plans","url":"manage._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://www.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"www._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://www.wixapis.com/pricing-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/plans","destinationPath":"/v2/plans","url":"www.wixapis.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}}],"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["PRICING_PLANS.READ_PLANS"],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.pricing-plans.proxy.plan-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.GetPlanStatsRequest","responseMessage":"com.wixpress.membership.v2.plans.GetPlanStatsResponse"},"legacyExamples":[{"name":"GetPlanStats","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n https://www.wixapis.com/pricing-plans/v2/plans/stats\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"totalPlans\": 80\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Plan Stats","slugifiedName":"get-plan-stats"},"permissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"},{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"}],"isAdminMethod":true},{"summary":"Update Plan","description":"Updates a pricing plan.\nUpdating a plan doesn't impact existing orders made for the plan. All orders keep the details of the original plan that was active at the time of purchase.","operationId":"com.wixpress.membership.v2.plans.PlansServiceV2.UpdatePlan","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"plan.id","description":"Plan ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.UpdatePlanResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdatePlanRequest","description":"","properties":{"plan":{"description":"ID of the plan to update.","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["plan","plan.id"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Plan Buyer Can Cancel Updated","description":"Triggered when a plan's `buyerCanCancel` field is updated.","permissions":["PRICING_PLANS.READ_PLANS"],"payload":{"schemaName":"com.wixpress.membership.v2.plans.BuyerCanCancelUpdated"},"exposure":"PUBLIC","maturity":"GA","slug":"buyer_can_cancel_updated","eventTopic":"domain_events_wix.pricing_plans.plan","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.pricing_plans.plan_buyer_can_cancel_updated","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["PRICING_PLANS.MANAGE_PLANS"],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.pricing-plans.proxy.plan-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.UpdatePlanRequest","responseMessage":"com.wixpress.membership.v2.plans.UpdatePlanResponse"},"legacyExamples":[{"name":"UpdatePlan","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X PATCH \\\n https://www.wixapis.com/pricing-plans/v2/plans/31e40c78-...-0bf8436307fb\n --data-binary '{\n \"plan\": {\n \"id\": \"31e40c78-...-0bf8436307fb\",\n \"name\": {\n \"value\": \"VIP Monthly Updated\"\n },\n \"archived\": false,\n \"primary\": false\n }\n }'\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n plan: {\n \"id\": \"31e40c78-...-0bf8436307fb\",\n \"name\": \"VIP Monthly Updated\",\n \"description\": \"\",\n \"perks\": {\n \"values\": [\n \"Free consulting\",\n \"Multi-user\"\n ]\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 3\n },\n \"price\": {\n \"value\": \"23\",\n \"currency\": \"USD\"\n }\n },\n \"public\": true,\n \"archived\": false,\n \"primary\": false,\n \"hasOrders\": true,\n \"createdDate\": \"2021-01-10T09:05:20.063Z\",\n \"updatedDate\": \"2021-02-09T09:21:47.649Z\",\n \"slug\": \"vip-monthly-updated\",\n \"maxPurchasesPerBuyer\": 1,\n \"allowFutureStartDate\": true,\n \"buyerCanCancel\": true,\n \"termsAndConditions\": \"No sharing please.\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"patch","path":"/v2/plans/{plan.id}","rpcOnly":false,"servers":[{"url":"https://*.dev.wix-code.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.dev.wix-code.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://*.pub.wix-code.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.pub.wix-code.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://*.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://_/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor-flow.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor-flow.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://blocks.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"blocks._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://create.editorx/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"create.editorx","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://forums.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"forums._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://forums.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"forums.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://manage.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"manage._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://manage.wix.com/_api/pricing-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/pricing-plans/v2/plans","destinationPath":"/v2/plans","url":"manage._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://www.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"www._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://www.wixapis.com/pricing-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/plans","destinationPath":"/v2/plans","url":"www.wixapis.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}}],"triggeredEvents":[{"title":"Plan Buyer Can Cancel Updated","description":"Triggered when a plan's `buyerCanCancel` field is updated.","permissions":["PRICING_PLANS.READ_PLANS"],"payload":{"schemaName":"com.wixpress.membership.v2.plans.BuyerCanCancelUpdated"},"exposure":"PUBLIC","maturity":"GA","slug":"buyer_can_cancel_updated","eventTopic":"domain_events_wix.pricing_plans.plan","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.pricing_plans.plan_buyer_can_cancel_updated","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["PRICING_PLANS.MANAGE_PLANS"],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.pricing-plans.proxy.plan-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.UpdatePlanRequest","responseMessage":"com.wixpress.membership.v2.plans.UpdatePlanResponse"},"legacyExamples":[{"name":"UpdatePlan","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X PATCH \\\n https://www.wixapis.com/pricing-plans/v2/plans/31e40c78-...-0bf8436307fb\n --data-binary '{\n \"plan\": {\n \"id\": \"31e40c78-...-0bf8436307fb\",\n \"name\": {\n \"value\": \"VIP Monthly Updated\"\n },\n \"archived\": false,\n \"primary\": false\n }\n }'\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n plan: {\n \"id\": \"31e40c78-...-0bf8436307fb\",\n \"name\": \"VIP Monthly Updated\",\n \"description\": \"\",\n \"perks\": {\n \"values\": [\n \"Free consulting\",\n \"Multi-user\"\n ]\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 3\n },\n \"price\": {\n \"value\": \"23\",\n \"currency\": \"USD\"\n }\n },\n \"public\": true,\n \"archived\": false,\n \"primary\": false,\n \"hasOrders\": true,\n \"createdDate\": \"2021-01-10T09:05:20.063Z\",\n \"updatedDate\": \"2021-02-09T09:21:47.649Z\",\n \"slug\": \"vip-monthly-updated\",\n \"maxPurchasesPerBuyer\": 1,\n \"allowFutureStartDate\": true,\n \"buyerCanCancel\": true,\n \"termsAndConditions\": \"No sharing please.\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Update Plan","slugifiedName":"update-plan"},"permissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"isAdminMethod":true},{"summary":"Set Plan Visibility","description":"Sets visibility for pricing plans. Visible plans are considered public plans.\nBy default, pricing plans are public, meaning they are visible. Plans can be hidden so that site members and visitors can't choose them.\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). (An archived plan always remains archived and can't be made active again.)\nChanging a plan’s visibility doesn't impact existing orders for the plan. All orders for hidden plans are still active and keep their perks.","operationId":"com.wixpress.membership.v2.plans.PlansServiceV2.SetPlanVisibility","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"The ID of the plan to either display or hide on a site page.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.SetPlanVisibilityResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"SetPlanVisibilityRequest","description":"","properties":{"visible":{"description":"Whether a plan is visible to members and site visitors. Updates the `public` field.","title":"visible","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["id","visible"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["PRICING_PLANS.MANAGE_PLANS"],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.pricing-plans.proxy.plan-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.SetPlanVisibilityRequest","responseMessage":"com.wixpress.membership.v2.plans.SetPlanVisibilityResponse"},"legacyExamples":[{"name":"SetPlanVisibility","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X PATCH \\\n https://www.wixapis.com/pricing-plans/v2/plans/890016b7-...-a545-681e7d28fc00/visibility\n --data-binary '{\"visible\": false}'\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"put","path":"/v2/plans/{id}/visibility","rpcOnly":false,"servers":[{"url":"https://*.dev.wix-code.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.dev.wix-code.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://*.pub.wix-code.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.pub.wix-code.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://*.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://_/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor-flow.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor-flow.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://blocks.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"blocks._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://create.editorx/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"create.editorx","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://forums.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"forums._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://forums.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"forums.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://manage.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"manage._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://manage.wix.com/_api/pricing-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/pricing-plans/v2/plans","destinationPath":"/v2/plans","url":"manage._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://www.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"www._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://www.wixapis.com/pricing-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/plans","destinationPath":"/v2/plans","url":"www.wixapis.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}}],"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["PRICING_PLANS.MANAGE_PLANS"],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.pricing-plans.proxy.plan-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.SetPlanVisibilityRequest","responseMessage":"com.wixpress.membership.v2.plans.SetPlanVisibilityResponse"},"legacyExamples":[{"name":"SetPlanVisibility","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X PATCH \\\n https://www.wixapis.com/pricing-plans/v2/plans/890016b7-...-a545-681e7d28fc00/visibility\n --data-binary '{\"visible\": false}'\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Set Plan Visibility","slugifiedName":"set-plan-visibility"},"permissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"isAdminMethod":true},{"summary":"Make Plan Primary","description":"Marks a pricing plan as the primary pricing plan. When viewing pricing plans on a site, the primary plan is highlighted with a customizable ribbon. Only a single plan can be marked as a primary plan at any given time. If there is an existing plan marked as primary, calling Make Plan Primary causes the existing primary plan to lose its primary status.","operationId":"com.wixpress.membership.v2.plans.PlansServiceV2.MakePlanPrimary","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Pricing plan ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.MakePlanPrimaryResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"MakePlanPrimaryRequest","description":"","properties":{},"deprecated":false,"required":["id"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["PRICING_PLANS.MANAGE_PLANS"],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.pricing-plans.proxy.plan-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.MakePlanPrimaryRequest","responseMessage":"com.wixpress.membership.v2.plans.MakePlanPrimaryResponse"},"legacyExamples":[{"name":"MakePlanPrimary","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n https://www.wixapis.com/pricing-plans/v2/plans/e9e1d210-...-b6e8-92e56705b937/make-primary\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n plan: {\n \"id\": \"e9e1d210-...-b6e8-92e56705b937\",\n \"name\": \"VIP monthly\",\n \"description\": \"\",\n \"perks\": {\n \"values\": [\n \"Free consulting\",\n \"Multi-user\"\n ]\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 3\n },\n \"price\": {\n \"value\": \"23\",\n \"currency\": \"USD\"\n }\n },\n \"public\": true,\n \"archived\": false,\n \"primary\": true,\n \"hasOrders\": true,\n \"createdDate\": \"2021-01-10T09:05:20.063Z\",\n \"updatedDate\": \"2021-02-09T09:21:47.649Z\",\n \"slug\": \"vip-monthly\",\n \"maxPurchasesPerBuyer\": 1,\n \"allowFutureStartDate\": true,\n \"buyerCanCancel\": true,\n \"termsAndConditions\": \"No sharing please.\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v2/plans/{id}/make-primary","rpcOnly":false,"servers":[{"url":"https://*.dev.wix-code.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.dev.wix-code.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://*.pub.wix-code.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.pub.wix-code.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://*.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://_/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor-flow.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor-flow.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://blocks.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"blocks._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://create.editorx/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"create.editorx","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://forums.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"forums._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://forums.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"forums.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://manage.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"manage._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://manage.wix.com/_api/pricing-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/pricing-plans/v2/plans","destinationPath":"/v2/plans","url":"manage._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://www.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"www._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://www.wixapis.com/pricing-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/plans","destinationPath":"/v2/plans","url":"www.wixapis.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}}],"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["PRICING_PLANS.MANAGE_PLANS"],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.pricing-plans.proxy.plan-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.MakePlanPrimaryRequest","responseMessage":"com.wixpress.membership.v2.plans.MakePlanPrimaryResponse"},"legacyExamples":[{"name":"MakePlanPrimary","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n https://www.wixapis.com/pricing-plans/v2/plans/e9e1d210-...-b6e8-92e56705b937/make-primary\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n plan: {\n \"id\": \"e9e1d210-...-b6e8-92e56705b937\",\n \"name\": \"VIP monthly\",\n \"description\": \"\",\n \"perks\": {\n \"values\": [\n \"Free consulting\",\n \"Multi-user\"\n ]\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 3\n },\n \"price\": {\n \"value\": \"23\",\n \"currency\": \"USD\"\n }\n },\n \"public\": true,\n \"archived\": false,\n \"primary\": true,\n \"hasOrders\": true,\n \"createdDate\": \"2021-01-10T09:05:20.063Z\",\n \"updatedDate\": \"2021-02-09T09:21:47.649Z\",\n \"slug\": \"vip-monthly\",\n \"maxPurchasesPerBuyer\": 1,\n \"allowFutureStartDate\": true,\n \"buyerCanCancel\": true,\n \"termsAndConditions\": \"No sharing please.\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Make Plan Primary","slugifiedName":"make-plan-primary"},"permissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"isAdminMethod":true},{"summary":"Clear Primary","description":"Sets all pricing plans as not primary. When viewing pricing plans on a site, no plan is highlighted with a customizable ribbon.","operationId":"com.wixpress.membership.v2.plans.PlansServiceV2.ClearPrimary","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.ClearPrimaryResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"ClearPrimaryRequest","description":"","properties":{},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["PRICING_PLANS.MANAGE_PLANS"],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.pricing-plans.proxy.plan-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.ClearPrimaryRequest","responseMessage":"com.wixpress.membership.v2.plans.ClearPrimaryResponse"},"legacyExamples":[{"name":"ClearPrimary","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n https://www.wixapis.com/pricing-plans/v2/plans/clear-primary\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v2/plans/clear-primary","rpcOnly":false,"servers":[{"url":"https://*.dev.wix-code.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.dev.wix-code.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://*.pub.wix-code.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.pub.wix-code.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://*.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://_/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor-flow.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor-flow.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://blocks.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"blocks._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://create.editorx/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"create.editorx","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://forums.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"forums._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://forums.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"forums.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://manage.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"manage._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://manage.wix.com/_api/pricing-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/pricing-plans/v2/plans","destinationPath":"/v2/plans","url":"manage._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://www.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"www._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://www.wixapis.com/pricing-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/plans","destinationPath":"/v2/plans","url":"www.wixapis.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}}],"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["PRICING_PLANS.MANAGE_PLANS"],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.pricing-plans.proxy.plan-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.ClearPrimaryRequest","responseMessage":"com.wixpress.membership.v2.plans.ClearPrimaryResponse"},"legacyExamples":[{"name":"ClearPrimary","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n https://www.wixapis.com/pricing-plans/v2/plans/clear-primary\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Clear Primary","slugifiedName":"clear-primary"},"permissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"isAdminMethod":true},{"summary":"Archive Plan","description":"Archives a single plan.\nWhen a plan is archived, it's no longer visible as a public plan that can be chosen by site members or visitors.\nThis is because the plan's `public` property is automatically set to `false`.\nArchived plans can't be purchased or reactivated.\nPlan archiving doesn't impact existing orders made for the plan. All orders for the plan are still active and keep their perks, payment options, and terms.\nWix users can see archived plans in a site's dashboard under **Pricing Plans -> Archived Plans**.\n> **Note:** An attempt to archive an already-archived plan throws an error.","operationId":"com.wixpress.membership.v2.plans.PlansServiceV2.ArchivePlan","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"ID of the active plan to archive.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.ArchivePlanResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"ArchivePlanRequest","description":"","properties":{},"deprecated":false,"required":["id"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Plan Archived","description":"Triggered when a pricing plan is archived.","permissions":["PRICING_PLANS.READ_PLANS"],"payload":{"schemaName":"com.wixpress.membership.v2.plans.PlanArchived"},"exposure":"PUBLIC","maturity":"GA","slug":"plan_archived","eventTopic":"domain_events_wix.pricing_plans.plan","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.pricing_plans.plan_plan_archived","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["PRICING_PLANS.MANAGE_PLANS"],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.pricing-plans.proxy.plan-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.ArchivePlanRequest","responseMessage":"com.wixpress.membership.v2.plans.ArchivePlanResponse"},"legacyExamples":[{"name":"ArchivePlan","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n https://www.wixapis.com/pricing-plans/v2/plans/31e40c78-...-0bf8436307fb/archive\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n plan:{\n \"id\": \"31e40c78-...-0bf8436307fb\",\n \"name\": \"VIP monthly\",\n \"description\": \"\",\n \"perks\": {\n \"values\": [\n \"Free consulting\",\n \"Multi-user\"\n ]\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 3\n },\n \"price\": {\n \"value\": \"23\",\n \"currency\": \"USD\"\n }\n },\n \"public\": false,\n \"archived\": true,\n \"primary\": false,\n \"hasOrders\": true,\n \"createdDate\": \"2021-01-10T09:05:20.063Z\",\n \"updatedDate\": \"2021-02-09T09:21:47.649Z\",\n \"slug\": \"vip-monthly\",\n \"maxPurchasesPerBuyer\": 1,\n \"allowFutureStartDate\": true,\n \"buyerCanCancel\": true,\n \"termsAndConditions\": \"No sharing please.\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v2/plans/{id}/archive","rpcOnly":false,"servers":[{"url":"https://*.dev.wix-code.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.dev.wix-code.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://*.pub.wix-code.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.pub.wix-code.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://*.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"*.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://_/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor-flow.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor-flow.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://blocks.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"blocks._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://create.editorx/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"create.editorx","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://editor.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"editor.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://forums.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"forums._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://forums.wixapps.net/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"forums.wixapps.net","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://manage.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"manage._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://manage.wix.com/_api/pricing-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/pricing-plans/v2/plans","destinationPath":"/v2/plans","url":"manage._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://www.wix.com/_api/paid-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/paid-plans/v2/plans","destinationPath":"/v2/plans","url":"www._base_domain_","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}},{"url":"https://www.wixapis.com/pricing-plans/v2/plans","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/plans","destinationPath":"/v2/plans","url":"www.wixapis.com","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2"}}],"triggeredEvents":[{"title":"Plan Archived","description":"Triggered when a pricing plan is archived.","permissions":["PRICING_PLANS.READ_PLANS"],"payload":{"schemaName":"com.wixpress.membership.v2.plans.PlanArchived"},"exposure":"PUBLIC","maturity":"GA","slug":"plan_archived","eventTopic":"domain_events_wix.pricing_plans.plan","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.pricing_plans.plan_plan_archived","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["PRICING_PLANS.MANAGE_PLANS"],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.pricing-plans.proxy.plan-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.ArchivePlanRequest","responseMessage":"com.wixpress.membership.v2.plans.ArchivePlanResponse"},"legacyExamples":[{"name":"ArchivePlan","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n https://www.wixapis.com/pricing-plans/v2/plans/31e40c78-...-0bf8436307fb/archive\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n plan:{\n \"id\": \"31e40c78-...-0bf8436307fb\",\n \"name\": \"VIP monthly\",\n \"description\": \"\",\n \"perks\": {\n \"values\": [\n \"Free consulting\",\n \"Multi-user\"\n ]\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 3\n },\n \"price\": {\n \"value\": \"23\",\n \"currency\": \"USD\"\n }\n },\n \"public\": false,\n \"archived\": true,\n \"primary\": false,\n \"hasOrders\": true,\n \"createdDate\": \"2021-01-10T09:05:20.063Z\",\n \"updatedDate\": \"2021-02-09T09:21:47.649Z\",\n \"slug\": \"vip-monthly\",\n \"maxPurchasesPerBuyer\": 1,\n \"allowFutureStartDate\": true,\n \"buyerCanCancel\": true,\n \"termsAndConditions\": \"No sharing please.\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Archive Plan","slugifiedName":"archive-plan"},"permissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"isAdminMethod":true}],"webhooks":[{"summary":"Plan Buyer Can Cancel Updated","title":"Plan Buyer Can Cancel Updated","description":"Triggered when a plan's `buyerCanCancel` field is updated.","permissions":["PRICING_PLANS.READ_PLANS"],"payload":{"schemaName":"com.wixpress.membership.v2.plans.BuyerCanCancelUpdated"},"exposure":"PUBLIC","maturity":"GA","slug":"buyer_can_cancel_updated","eventTopic":"domain_events_wix.pricing_plans.plan","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","domainEvent":"CUSTOM_ACTION","eventType":"wix.pricing_plans.plan_buyer_can_cancel_updated","legacyExamples":[{"name":"PlanBuyerCanCancelUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"plan\": {\n \"id\": \"e12bef18-1094-4ad5-b38b-86bfdabab27e\",\n \"name\": \"Forever\",\n \"description\": \"\",\n \"perks\": {\n \"values\": []\n },\n \"pricing\": {\n \"singlePaymentUnlimited\": true,\n \"price\": {\n \"value\": \"330\",\n \"currency\": \"USD\"\n },\n \"feeConfigs\": []\n },\n \"public\": true,\n \"archived\": false,\n \"primary\": false,\n \"hasOrders\": false,\n \"createdDate\": \"2022-06-02T13:08:40.458Z\",\n \"updatedDate\": \"2024-11-12T10:28:06.689Z\",\n \"slug\": \"forever\",\n \"maxPurchasesPerBuyer\": 0,\n \"allowFutureStartDate\": false,\n \"buyerCanCancel\": false,\n \"termsAndConditions\": \"\"\n }\n}\n"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.BuyerCanCancelUpdated","contentLink":{"displayName":"Plan Buyer Can Cancel Updated","slugifiedName":"plan-buyer-can-cancel-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"},{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"}]},{"summary":"Plan Created","title":"Plan Created","description":"Triggered when a pricing plan is created.","permissions":["PRICING_PLANS.READ_PLANS"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.pricing_plans.plan","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","domainEvent":"CREATED","eventType":"wix.pricing_plans.plan_created","legacyExamples":[{"name":"PlanCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"//Subscription (i.e. recurring payment) plan archived:\n{\n \"id\": \"68117b5d-ddc7-4b7c-bb8f-ee8ffeb6ae06\",\n \"entityFqdn\": \"wix.pricing_plans.plan\",\n \"slug\": \"created\",\n \"entityId\": \"b5d4d289-394c-464d-8133-41891a413f0f\",\n \"createdEvent\": {\n \"entityAsJson\": {\n \"id\": \"b5d4d289-394c-464d-8133-41891a413f0f\",\n \"name\": \"Advanced plan\",\n \"description\": \"\",\n \"perks\": {},\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 3\n },\n \"price\": {\n \"value\": \"45\",\n \"currency\": \"USD\"\n },\n \"freeTrialDays\": 7\n },\n \"public\": true,\n \"createdDate\": \"2021-01-05T15:37:43.437Z\",\n \"updatedDate\": \"2021-01-05T15:37:43.437Z\",\n \"slug\": \"advanced-plan\",\n \"allowFutureStartDate\": false,\n \"buyerCanCancel\": true,\n \"termsAndConditions\": \"\"\n }\n },\n \"eventTime\": \"2021-01-05T15:37:43.544020Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n\n//Pricing for single payment plan with duration:\n{\n \"pricing\": {\n \"singlePaymentForDuration\": {\n \"count\": 3,\n \"unit\": \"MONTH\"\n },\n \"price\": {\n \"value\": \"23\",\n \"currency\": \"USD\"\n }\n }\n}\n\n//Pricing for single payment unlimited duration plan (i.e. valid until canceled):\n{\n \"pricing\": {\n \"singlePaymentUnlimited\": true,\n \"price\": {\n \"value\": \"47\",\n \"currency\": \"USD\"\n }\n }\n}\n"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","contentLink":{"displayName":"Plan Created","slugifiedName":"plan-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"},{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"}]},{"summary":"Plan Archived","title":"Plan Plan Archived","description":"Triggered when a pricing plan is archived.","permissions":["PRICING_PLANS.READ_PLANS"],"payload":{"schemaName":"com.wixpress.membership.v2.plans.PlanArchived"},"exposure":"PUBLIC","maturity":"GA","slug":"plan_archived","eventTopic":"domain_events_wix.pricing_plans.plan","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","domainEvent":"CUSTOM_ACTION","eventType":"wix.pricing_plans.plan_plan_archived","legacyExamples":[{"name":"PlanArchived","eventType":"ARCHIVED","type":"DOMAIN_EVENT","content":"//Subscription (i.e. recurring payment) plan archived:\n{\n \"id\": \"5748fa2d-5b8f-4f0e-b7c1-8fd0d800cb0b\",\n \"entityFqdn\": \"wix.pricing_plans.plan\",\n \"slug\": \"plan_archived\",\n \"entityId\": \"b5d4d289-394c-464d-8133-41891a413f0f\",\n \"actionEvent\": {\n \"bodyAsJson\": {\n \"plan\": {\n \"id\": \"b5d4d289-394c-464d-8133-41891a413f0f\",\n \"name\": \"Advanced plan\",\n \"description\": \"\",\n \"perks\": {},\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"WEEK\"\n },\n \"cycleCount\": 2\n },\n \"price\": {\n \"value\": \"45\",\n \"currency\": \"USD\"\n },\n \"freeTrialDays\": 7\n },\n \"public\": false,\n \"archived\": true,\n \"hasOrders\": true,\n \"createdDate\": \"2020-06-03T11:06:38.950Z\",\n \"updatedDate\": \"2021-01-05T15:36:56.162Z\",\n \"slug\": \"advanced-plan\",\n \"allowFutureStartDate\": false,\n \"buyerCanCancel\": true,\n \"termsAndConditions\": \"\"\n }\n }\n },\n \"eventTime\": \"2021-01-05T15:36:56.289502Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n\n//Pricing for single payment plan with duration\n{\n \"pricing\": {\n \"singlePaymentForDuration\": {\n \"count\": 3,\n \"unit\": \"MONTH\"\n },\n \"price\": {\n \"value\": \"23\",\n \"currency\": \"USD\"\n }\n }\n}\n\n//Pricing for single payment unlimited duration plan (i.e. valid until canceled):\n{\n \"pricing\": {\n \"singlePaymentUnlimited\": true,\n \"price\": {\n \"value\": \"47\",\n \"currency\": \"USD\"\n }\n }\n}\n\n"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.PlanArchived","contentLink":{"displayName":"Plan Archived","slugifiedName":"plan-archived"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"},{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"}]},{"summary":"Plan Updated","title":"Plan Updated","description":"Triggered when a pricing plan is updated.","permissions":["PRICING_PLANS.READ_PLANS"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.pricing_plans.plan","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","domainEvent":"UPDATED","eventType":"wix.pricing_plans.plan_updated","legacyExamples":[{"name":"PlanUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"//Subscription (i.e. recurring payment) plan archived:\n{\n \"id\": \"e110a720-2c62-4e40-8b75-269d98b4bdec\",\n \"entityFqdn\": \"wix.pricing_plans.plan\",\n \"slug\": \"updated\",\n \"entityId\": \"b5d4d289-394c-464d-8133-41891a413f0f\",\n \"updatedEvent\": {\n \"currentEntityAsJson\": {\n \"id\": \"b5d4d289-394c-464d-8133-41891a413f0f\",\n \"name\": \"Advanced plan\",\n \"description\": \"\",\n \"perks\": {},\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"WEEK\"\n },\n \"cycleCount\": 2\n },\n \"price\": {\n \"value\": \"45\",\n \"currency\": \"USD\"\n },\n \"freeTrialDays\": 7\n },\n \"public\": false,\n \"archived\": true,\n \"hasOrders\": true,\n \"createdDate\": \"2020-06-03T11:06:38.950Z\",\n \"updatedDate\": \"2021-01-05T15:36:56.162Z\",\n \"slug\": \"advanced-plan\",\n \"allowFutureStartDate\": false,\n \"buyerCanCancel\": true,\n \"termsAndConditions\": \"\"\n }\n },\n \"eventTime\": \"2021-01-05T15:36:56.209579Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n\n//Pricing for single payment plan with duration:\n{\n \"pricing\": {\n \"singlePaymentForDuration\": {\n \"count\": 3,\n \"unit\": \"MONTH\"\n },\n \"price\": {\n \"value\": \"23\",\n \"currency\": \"USD\"\n }\n }\n}\n\n//Pricing for single payment unlimited duration plan (i.e. valid until canceled):\n{\n \"pricing\": {\n \"singlePaymentUnlimited\": true,\n \"price\": {\n \"value\": \"47\",\n \"currency\": \"USD\"\n }\n }\n}\n"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","contentLink":{"displayName":"Plan Updated","slugifiedName":"plan-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"},{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"}]}],"articles":[{"displayName":"Filter and Sort","slugifyName":"filter-and-sort","content":"# Filter and Sort\n\nSelect endpoints allow sorting results by field. Use `\"order\": \"ASC\"` to sort results in ascending order, and `\"order\": \"DESC\"` to sort in descending order.\n\nFor example, to sort plans by created date in descending order:\n\n```json\n\"sort\": { \"fieldName\": \"createdDate\", \"order\": \"DESC\" }\n```\n\nRefer to the following tables to check which fields support sorting.\n\n## Query Public Plans\n[//]: # (https://bo.wix.com/wix-docs/rest/drafts/pricing-plans/plan-v2/query-public-plans)\n\n| Field | Description | Query Filter Operators | Sorting | \n|-----------|-------------------|---------------------------------------------------------|---------|\n| id | Plan ID | $eq, $ne, $hasSome | | \n| primary | Whether the plan is marked as primary, and highlighted in the site with a custom ribbon | $eq, $ne | Allowed | \n| slug | URL-friendly version of the plan name. Unique across all plans in the same site | $eq, $ne, $startsWith, $endsWith, $contains | Allowed | \n| createdDate | Date plan was created | $eq, $ne, $gt, $ge, $lt, $le, $between | Allowed | \n| updatedDate | Date plan was updated | $eq, $ne, $gt, $ge, $lt, $le, $between | Allowed | \n","sourceRepo":"git@github.com:wix-private/app-market.git","path":"docs/FilterAndSort.md"},{"displayName":"Introduction","slugifyName":"introduction","content":"---\ntitle: Introduction\n---\n# About the Plans API\n\nUsing the Plans API, you can create and manage pricing plans.\n\nThis includes building a customized membership plan experience, including implementing a customizable pricing page where customers can view the plans, including their perks, prices, and other features including free trials, purchase limitations, and more. \n\nWith the Plans API, you can:\n\n- Create and update plans. This includes:\n\n - Setting up pricing models for plans, such as free, one-time payment, and recurring payments (subscriptions). \n \n - Determining if pricing plans should have a duration or be valid until canceled by a customer. \n \n - Limiting plans so they can be purchased only 1 time by a single customer. By default, customers can make unlimited purchases of the same plan. \n \n Note that updating the properties of an existing pricing plan doesn't affect any current orders or purchases of the plan. Existing orders retain their existing terms and pricing.\n \n- Get, list, and query plans. \n\n- Change the visibility, availability, and accessibility of a plan.\n\n- Get statistics about plans. \n\n- Archive plans. \n\n- Set or clear the primary plan. This determines if a plan is highlighted with a custom ribbon when viewing the plans on a site.\n\n## More about plans\n\nIt's important to explore the types of plans available and other specifications, such as payment options and purchasing constraints.\n\n### Pricing plan types\n\nPricing plans can be: \n\n- **Free plans**. There is no charge to the site visitor or member.\n\n- **One-time payment plans**. The site visitor or member is charged once. These plans can be set to expire or continue indefinitely until they cancel.\n\n- **Recurring plans**. The site visitor or member is charged at predefined intervals (such as weekly, monthly, yearly). These plans can be set to expire or continue indefinitely until they cancel the subscription. Recurring plans can have free trial days.\n\n### Free trial plans\nRecurring plans can be set to have free trial days using the plan's `freeTrialDays` property.\n\nDuring free trial days, site visitor and members can cancel the plan and they won’t be charged.\n\nFree trial days are applied only once per site visitor or member for a plan. This means that if a plan with a free trial was purchased once, the second time they purchase it, the free trial days aren't applied. In this case, the site visitor or member is charged for the plan right away.\n\n### Purchase limitations\n\nSome plans can be purchased only a limited number of times by a single site visitor or member based on the value of the plan's `purchaseLimitations` property. \n\nIf the plan is updated, the limit is checked by the current plan details. For example, let's assume a plan's purchase limit was initially set to 1 and a site visitor or member purchased the plan. If later the limit is updated to 2, they can still purchase the same plan a second time.\n\n### Plan expiration\n\nA plan can be active for specified periods of time from the date of purchase. The active period is established in the same intervals as the payment periods (weeks, months, years). Plans can also be defined so they never expire (meaning, the plan continues indefinitely until the member cancels). This is true for both one-time and recurring plans.\n\n### The slug property\n\nSlugs are used to support [dynamic pages](fallback::https://support.wix.com/en/article/cms-setting-up-a-dynamic-item-page). \n\nA slug is generated on a plan's creation and is updated when a plan's name is updated. For example, if the plan's name is \"Test Plan,\" the generated slug is \"test-plan.\" If a plan already exists with a slug \"test-plan\" for the site, a number is appended to it. The slug becomes \"test-plan-1\". \n\n\n## Before you begin\n\nIt's important to note the following point before starting to code:\n\n- This API requires [Wix Pricing Plans](fallback::https://support.wix.com/en/article/pricing-plans-an-overview) to be installed on a site calling the API. \n\n## Terminology\n\n- **Plan**: A membership plan or package, offering bundles of features or “perks.” \n - A **free plan** can be purchased free of charge.\n - A **one-time plan** can be purchased with a single payment.\n - A **recurring plan** charges the customer on a weekly, monthly, or yearly basis for a selected duration of time.\n \n- **Primary plans**: Plans that are labeled with a ribbon that is customizable on a site.\n\n- **Archived plans**: Plans that can no longer be purchased or edited, but existing plan holders can still enjoy purchased membership and continue to be charged until canceled or expired.\n\n- **Hidden plans**: Plans that are not currently visible to customers. Hidden plans may still be sold manually to customers.\n\n- **Free trial**: A feature allowing for the trying out of the perks of the plan for a selected amount of days before the first charge. Relevant for recurring plans.\n\n- **Plan Policy**: The definition of terms and conditions for the customer. A plan's policy can be displayed on a site's checkout page.","sourceRepo":"git@github.com:wix-private/app-market.git","path":"docs/public_plan_overview.md"}],"components":{"schemas":{"com.wixpress.membership.v2.plans.Plan":{"type":"object","properties":{"id":{"description":"Plan ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Plan name.","minLength":1,"maxLength":50,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Plan description.","maxLength":450,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"perks":{"description":"List of text strings that promote what is included with this plan. For example, \"Plenty of parking\" or \"Free gift on your birthday.\"","$ref":"#/components/schemas/com.wixpress.membership.v2.StringList","summary":"perks","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pricing":{"description":"Plan price, payment schedule, and expiration.","$ref":"#/components/schemas/com.wixpress.membership.v2.Pricing","summary":"pricing","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"public":{"description":"Whether the plan is public (visible to site visitors and members).","title":"public","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"archived":{"description":"Whether the plan is archived. Archived plans are not visible and can't be purchased anymore, but existing purchases remain in effect.","readOnly":true,"title":"archived","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"primary":{"description":"Whether the plan is marked as primary.","readOnly":true,"title":"primary","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hasOrders":{"description":"Whether the plan has any orders (including pending and unpaid orders).","readOnly":true,"title":"hasOrders","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date plan was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date plan was last updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"URL-friendly version of plan name. Unique across all plans in the same site.","minLength":1,"readOnly":true,"format":"URL_SLUG","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"maxPurchasesPerBuyer":{"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 1 purchase per buyer.","minimum":0,"maximum":1,"title":"maxPurchasesPerBuyer","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"allowFutureStartDate":{"description":"Whether the buyer can start the plan at a later date. Defaults to false.","title":"allowFutureStartDate","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"buyerCanCancel":{"description":"Whether the buyer is allowed to cancel their plan. Defaults to false.\nIf false, calling Request Cancellation returns an error.","title":"buyerCanCancel","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"termsAndConditions":{"description":"Any terms and conditions that apply to the plan. This information is displayed during checkout.","maxLength":3000,"title":"termsAndConditions","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"formId":{"description":"ID of the form associated with the plan at checkout.\n\nLearn more about [forms](https://support.wix.com/en/article/wix-forms-an-overview).","format":"GUID","title":"formId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Plan","description":"Information about the pricing plan."},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"com.wixpress.membership.v2.StringList":{"type":"object","properties":{"values":{"description":"","minLength":1,"maxLength":1400,"maxItems":500,"title":"values","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringList","description":"This wrapper type exists to distinguish an empty string list from no list at all in update requests."},"com.wixpress.membership.v2.Pricing":{"type":"object","properties":{"price":{"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.","$ref":"#/components/schemas/com.wixpress.membership.v2.common.Money","summary":"price","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"freeTrialDays":{"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.","minimum":0,"maximum":999,"title":"freeTrialDays","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Pricing","description":"Plan pricing information. Includes the price of the plan and payment details.","oneOf":[{"description":"","summary":"pricingModel","$ref":"#/components/schemas/com.wixpress.membership.v2.Pricing.pricingModel"}]},"com.wixpress.membership.v2.Pricing.pricingModel":{"type":"object","title":"pricingModel","properties":{"subscription":{"description":"Pricing model indicating that the plan has recurring payments. This type of subscription is not a \"Wix subscription,\" which encompasses various types of subscriptions, such as Wix Stores subscriptions, Wix invoice subscriptions, and all pricing plan models.","$ref":"#/components/schemas/com.wixpress.membership.v2.Recurrence","summary":"subscription","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"singlePaymentForDuration":{"description":"Pricing model indicating a single payment per cycle and the length of the cycle. The cycle is the duration of the plan, not a payment cycle.","$ref":"#/components/schemas/com.wixpress.membership.v2.Duration","summary":"singlePaymentForDuration","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"singlePaymentUnlimited":{"description":"Pricing model indicating the plan is paid in a single payment. The plan is valid until canceled.","title":"singlePaymentUnlimited","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.membership.v2.Recurrence":{"type":"object","properties":{"cycleDuration":{"description":"Number of payment cycles the subscription is valid for.\n`0` for unlimited plans or for plans that are valid until canceled.","$ref":"#/components/schemas/com.wixpress.membership.v2.Duration","summary":"cycleDuration","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cycleCount":{"description":"Length of a payment cycle. For example, 1 month to have monthly payments.\nMultiply `cycleDuration`'s `count` by `cycleCount` to get the subscription duration.\nCurrently, only a value of `1` is supported.","minimum":0,"maximum":2000,"title":"cycleCount","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Recurrence","description":"An object specifying how often and for how long payments recur (may be forever)."},"com.wixpress.membership.v2.Duration":{"type":"object","properties":{"count":{"description":"Number of days, months, weeks, or years in a single payment cycle. Currently limited to support only `1`.","minimum":1,"title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"unit":{"description":"Unit of time for the cycle duration.","title":"unit","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.PeriodUnitEnum.PeriodUnit","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Duration","description":"A duration expressed in number of time units."},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"com.wixpress.membership.v2.PeriodUnitEnum.PeriodUnit":{"type":"string","description":"","title":"PeriodUnit","enum":[{"order":0,"value":"UNDEFINED","description":"Not defined.","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"DAY","description":"Time unit is a day.","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"WEEK","description":"Time unit is a week.","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"MONTH","description":"Time unit is a month.","maturity":"GA","exposure":"PUBLIC"},{"order":4,"value":"YEAR","description":"Time unit is a year.","maturity":"GA","exposure":"PUBLIC"}]},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"com.wixpress.membership.v2.common.Money":{"type":"object","properties":{"value":{"description":"Monetary amount. Decimal string with a period as a decimal separator. For example, `'3.99'`. Can't be negative.","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"lt":"1000000000000","gte":"0.000","maxScale":3}}},"currency":{"description":"Currency code. Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `'USD'`.","format":"CURRENCY","title":"currency","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Money","description":""},"com.wixpress.membership.v2.FeeConfig":{"type":"object","properties":{"fee":{"description":"Fee configuration.","$ref":"#/components/schemas/com.wixpress.membership.v2.Fee","summary":"fee","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appliedAt":{"description":"The time this fee will be charged.","title":"appliedAt","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.FeeConfig.AppliedAt","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FeeConfig","description":""},"com.wixpress.membership.v2.Fee":{"type":"object","properties":{"name":{"description":"Fee name","minLength":1,"maxLength":40,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"amount":{"description":"Amount of fee to be charged","title":"amount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"lt":"1000000000000","gt":"0.000","maxScale":3}}}},"title":"Fee","description":""},"com.wixpress.membership.v2.FeeConfig.AppliedAt":{"type":"string","description":"","title":"AppliedAt","enum":[{"order":0,"value":"UNKNOWN_CHARGE_EVENT","description":"","maturity":"NOT_IMPLEMENTED","exposure":"PUBLIC"},{"order":1,"value":"FIRST_PAYMENT","description":"Will charge the fee on the first payment. If the order has a free trial, it will charge after the free trial.","maturity":"GA","exposure":"PUBLIC"}]},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"com.wixpress.membership.v2.plans.ListPublicPlansRequest":{"type":"object","properties":{"limit":{"description":"Number of items to list. Defaults to `75`. See limits ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/list-public-plans) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging)).","minimum":1,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of items to skip. Defaults to `0`. See paging ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/list-public-plans) |[REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging)).","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"planIds":{"description":"IDs of plans to list. Non-existent IDs are ignored and don't cause errors. You can specify a maximum of 100 IDs.","format":"GUID","maxItems":100,"title":"planIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListPublicPlansRequest","description":""},"com.wixpress.membership.v2.plans.ListPublicPlansResponse":{"type":"object","properties":{"plans":{"description":"List of public pricing plans.","title":"plans","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.PublicPlan"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Object containing paging-related data (such as the number of plans returned, the offset, and so on).","$ref":"#/components/schemas/wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListPublicPlansResponse","description":""},"com.wixpress.membership.v2.plans.PublicPlan":{"type":"object","properties":{"id":{"description":"Plan ID.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Plan name.","minLength":1,"maxLength":50,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Plan description.","maxLength":450,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"perks":{"description":"What is included with this plan (for example, 1 weekly entrance to a specific class).","$ref":"#/components/schemas/com.wixpress.membership.v2.StringList","summary":"perks","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pricing":{"description":"Plan price, payment schedule, and expiration.","$ref":"#/components/schemas/com.wixpress.membership.v2.Pricing","summary":"pricing","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"primary":{"description":"Whether the plan is marked as primary.","title":"primary","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date plan was created.","title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date plan was last updated.","title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"URL-friendly version of plan name. Unique across all plans in the same site.","minLength":1,"title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"maxPurchasesPerBuyer":{"description":"Number of times the same buyer can purchase the plan. An empty value or a value of 0 means no limitation.","minimum":0,"title":"maxPurchasesPerBuyer","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"allowFutureStartDate":{"description":"Whether the buyer can start the plan at a later date. Defaults to false.","title":"allowFutureStartDate","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"buyerCanCancel":{"description":"Whether the buyer is allowed to cancel their plan. Defaults to false.","title":"buyerCanCancel","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"termsAndConditions":{"description":"Any terms and conditions that apply to the plan. This information is displayed during checkout.","title":"termsAndConditions","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"formId":{"description":"ID of the form associated with the plan at checkout.\n\nLearn more about [forms](https://support.wix.com/en/article/wix-forms-an-overview).","format":"GUID","title":"formId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PublicPlan","description":"Public plan entity containing information about the pricing plan. Can be read by any site member or visitor."},"wix.common.PagingMetadataV2":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Offset that was requested.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tooManyToCount":{"description":"Flag that indicates the server failed to calculate the `total` field.","title":"tooManyToCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.","$ref":"#/components/schemas/wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadataV2","description":""},"wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor string pointing to the next page in the list of results.","maxLength":16000,"title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to the previous page in the list of results.","maxLength":16000,"title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"com.wixpress.membership.v2.plans.QueryPublicPlansRequest":{"type":"object","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/com.wixpress.membership.v2.common.QueryV2","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryPublicPlansRequest","description":""},"com.wixpress.membership.v2.common.QueryV2":{"type":"object","properties":{"filter":{"description":"A filter object. See supported fields and operators ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/query-public-plans) | [REST](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)).","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the form [{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}].","title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paging":{"description":"Pointer to page of results using offset. Can't be used together with 'cursorPaging'.","$ref":"#/components/schemas/wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryV2","description":""},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":[{"order":0,"value":"NULL_VALUE","description":"","maturity":"GA","exposure":"PUBLIC"}]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","maxLength":512,"title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":[{"order":0,"value":"ASC","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"DESC","description":"","maturity":"GA","exposure":"PUBLIC"}]},"wix.common.Paging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Paging","description":""},"com.wixpress.membership.v2.plans.QueryPublicPlansResponse":{"type":"object","properties":{"plans":{"description":"List of public pricing plans that match the specified query.","title":"plans","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.PublicPlan"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Object containing paging-related data (such as the number of plans returned, the offset, and so on).","$ref":"#/components/schemas/wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryPublicPlansResponse","description":""},"com.wixpress.membership.v2.plans.GetPlanRequest":{"type":"object","properties":{"id":{"description":"Plan ID.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetPlanRequest","description":""},"com.wixpress.membership.v2.plans.GetPlanResponse":{"type":"object","properties":{"plan":{"description":"Pricing plan.","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetPlanResponse","description":""},"com.wixpress.membership.v2.plans.ListPlansRequest":{"type":"object","properties":{"archived":{"description":"Archived filter. Defaults to `ACTIVE` (not archived) only.","title":"archived","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.ArchivedFilterEnum.ArchivedFilter","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"public":{"description":"Visibility filter. Defaults to `PUBLIC_AND_HIDDEN` (meaning, both are listed).","title":"public","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.PublicFilterEnum.PublicFilter","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"limit":{"description":"Number of pricing plans to list. Defaults to `75`.","minimum":1,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of pricing plans to skip. Defaults to `0`.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"planIds":{"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 are listed according to the order displayed in a site's dashboard (which you can set with Arrange Plans). You can specify a maximum of 100 IDs.","format":"GUID","maxItems":100,"title":"planIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListPlansRequest","description":""},"com.wixpress.membership.v2.plans.ArchivedFilterEnum.ArchivedFilter":{"type":"string","description":"","title":"ArchivedFilter","enum":[{"order":0,"value":"ACTIVE","description":"Returns all plans that are active.","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"ARCHIVED","description":"Returns all plans that are archived.","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"ARCHIVED_AND_ACTIVE","description":"Returns all plans that are active and archived.","maturity":"GA","exposure":"PUBLIC"}]},"com.wixpress.membership.v2.plans.PublicFilterEnum.PublicFilter":{"type":"string","description":"","title":"PublicFilter","enum":[{"order":0,"value":"PUBLIC_AND_HIDDEN","description":"Returns all public and hidden plans.","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"PUBLIC","description":"Returns only public plans.","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"HIDDEN","description":"Returns only hidden plans.","maturity":"GA","exposure":"PUBLIC"}]},"com.wixpress.membership.v2.plans.ListPlansResponse":{"type":"object","properties":{"plans":{"description":"List of all public and hidden pricing plans.","title":"plans","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Object containing paging-related data (such as the number of plans returned, the offset, and so on).","$ref":"#/components/schemas/wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListPlansResponse","description":""},"com.wixpress.membership.v2.plans.GetPlanStatsRequest":{"type":"object","properties":{},"title":"GetPlanStatsRequest","description":""},"com.wixpress.membership.v2.plans.GetPlanStatsResponse":{"type":"object","properties":{"totalPlans":{"description":"Total number of plans created, including active plans (both public and hidden) and archived plans.","title":"totalPlans","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetPlanStatsResponse","description":""},"com.wixpress.membership.v2.plans.CreatePlanRequest":{"type":"object","properties":{"plan":{"description":"Plan details.","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreatePlanRequest","description":""},"com.wixpress.membership.v2.plans.CreatePlanResponse":{"type":"object","properties":{"plan":{"description":"Created plan.","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreatePlanResponse","description":""},"com.wixpress.membership.v2.plans.UpdatePlanRequest":{"type":"object","properties":{"plan":{"description":"ID of the plan to update.","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdatePlanRequest","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"description":"","title":"paths","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FieldMask","description":""},"com.wixpress.membership.v2.plans.UpdatePlanResponse":{"type":"object","properties":{"plan":{"description":"Updated plan.","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdatePlanResponse","description":""},"com.wixpress.membership.v2.plans.BuyerCanCancelUpdated":{"type":"object","properties":{"plan":{"description":"Pricing plan.","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BuyerCanCancelUpdated","description":""},"com.wixpress.membership.v2.plans.SetPlanVisibilityRequest":{"type":"object","properties":{"id":{"description":"The ID of the plan to either display or hide on a site page.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"visible":{"description":"Whether a plan is visible to members and site visitors. Updates the `public` field.","title":"visible","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SetPlanVisibilityRequest","description":""},"com.wixpress.membership.v2.plans.SetPlanVisibilityResponse":{"type":"object","properties":{"plan":{"description":"Pricing plan.","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SetPlanVisibilityResponse","description":""},"com.wixpress.membership.v2.plans.MakePlanPrimaryRequest":{"type":"object","properties":{"id":{"description":"Pricing plan ID.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MakePlanPrimaryRequest","description":""},"com.wixpress.membership.v2.plans.MakePlanPrimaryResponse":{"type":"object","properties":{"plan":{"description":"Pricing plan.","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MakePlanPrimaryResponse","description":""},"com.wixpress.membership.v2.plans.ClearPrimaryRequest":{"type":"object","properties":{},"title":"ClearPrimaryRequest","description":""},"com.wixpress.membership.v2.plans.ClearPrimaryResponse":{"type":"object","properties":{},"title":"ClearPrimaryResponse","description":""},"com.wixpress.membership.v2.plans.ArchivePlanRequest":{"type":"object","properties":{"id":{"description":"ID of the active plan to archive.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ArchivePlanRequest","description":""},"com.wixpress.membership.v2.plans.ArchivePlanResponse":{"type":"object","properties":{"plan":{"description":"Archived plan.","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ArchivePlanResponse","description":""},"com.wixpress.membership.v2.plans.PlanArchived":{"type":"object","properties":{"plan":{"description":"Pricing plan.","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PlanArchived","description":""},"com.wixpress.membership.v2.plans.BulkArchivePlanRequest":{"type":"object","properties":{"ids":{"description":"List of Plan IDs to archive.","format":"GUID","minItems":1,"maxItems":100,"title":"ids","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnFullEntity":{"description":"Set to `true` to return the `Plan` entity in the response.","title":"returnFullEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkArchivePlanRequest","description":""},"com.wixpress.membership.v2.plans.BulkArchivePlanResponse":{"type":"object","properties":{"results":{"description":"Plans to be archived.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.BulkPlanResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkArchivePlanResponse","description":""},"com.wixpress.membership.v2.plans.BulkPlanResult":{"type":"object","properties":{"itemMetadata":{"description":"Item metadata.","$ref":"#/components/schemas/wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"plan":{"description":"Pricing plan.","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkPlanResult","description":""},"wix.common.ItemMetadata":{"type":"object","properties":{"id":{"description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originalIndex":{"description":"Index of the item within the request array. Allows for correlation between request and response items.","title":"originalIndex","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"success":{"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated.","title":"success","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Details about the error in case of failure.","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemMetadata","description":""},"wix.api.ApplicationError":{"type":"object","properties":{"code":{"description":"Error code.","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Description of the error.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Data related to the error.","title":"data","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ApplicationError","description":""},"wix.common.BulkActionMetadata":{"type":"object","properties":{"totalSuccesses":{"description":"Number of items that were successfully processed.","title":"totalSuccesses","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalFailures":{"description":"Number of items that couldn't be processed.","title":"totalFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"undetailedFailures":{"description":"Number of failures without details because detailed failure threshold was exceeded.","title":"undetailedFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkActionMetadata","description":""},"com.wixpress.membership.v2.plans.ArrangePlansRequest":{"type":"object","properties":{"ids":{"description":"IDs of all non-archived plans in the order you want them arranged.","format":"GUID","minItems":1,"title":"ids","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ArrangePlansRequest","description":""},"com.wixpress.membership.v2.plans.ArrangePlansResponse":{"type":"object","properties":{},"title":"ArrangePlansResponse","description":""},"com.wixpress.membership.v2.plans.CountPlansRequest":{"type":"object","properties":{"filter":{"description":"The filter.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"visibility":{"description":"If true, counts only visible plans (visible and not archived). If no value is specified, all plans are counted.","title":"visibility","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountPlansRequest","description":""},"com.wixpress.membership.v2.plans.CountPlansResponse":{"type":"object","properties":{"count":{"description":"Number of plans in the response.","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountPlansResponse","description":""},"com.wixpress.membership.v2.plans.GetPlansPremiumStatusRequest":{"type":"object","properties":{},"title":"GetPlansPremiumStatusRequest","description":""},"com.wixpress.membership.v2.plans.GetPlansPremiumStatusResponse":{"type":"object","properties":{"hasPaidPlans":{"description":"True if a site has non-free, non-template plans.","title":"hasPaidPlans","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hasOldPlans":{"description":"True if a site has plans that were created before Pricing Plans became a premium app.","title":"hasOldPlans","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetPlansPremiumStatusResponse","description":""},"com.wixpress.membership.v2.plans.SearchPlansRequest":{"type":"object","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/com.wixpress.membership.v2.common.QueryV2","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"searchPhrase":{"description":"Search phrase for the plan name.","maxLength":50,"title":"searchPhrase","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SearchPlansRequest","description":""},"com.wixpress.membership.v2.plans.SearchPlansResponse":{"type":"object","properties":{"plans":{"description":"List of pricing plans that match the specified filter and search phrase.","title":"plans","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Object containing paging-related data (such as the number of plans returned, the offset, and so on).","$ref":"#/components/schemas/wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SearchPlansResponse","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"restoreInfo":{"description":"Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity","$ref":"#/components/schemas/wix.common.domainevents.RestoreInfo","summary":"restoreInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.RestoreInfo":{"type":"object","properties":{"deletedDate":{"description":"","title":"deletedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreInfo","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":[{"order":0,"value":"UNKNOWN","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"ANONYMOUS_VISITOR","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"MEMBER","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"WIX_USER","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":4,"value":"APP","description":"","maturity":"GA","exposure":"PUBLIC"}]}}},"title":"Plan","description":"Information about the pricing plan.","fqdn":"wix.pricing_plans.v2.plan"},"articles":[{"displayName":"Filter and Sort","slugifyName":"filter-and-sort","content":"# Filter and Sort\n\nSelect endpoints allow sorting results by field. Use `\"order\": \"ASC\"` to sort results in ascending order, and `\"order\": \"DESC\"` to sort in descending order.\n\nFor example, to sort plans by created date in descending order:\n\n```json\n\"sort\": { \"fieldName\": \"createdDate\", \"order\": \"DESC\" }\n```\n\nRefer to the following tables to check which fields support sorting.\n\n## Query Public Plans\n[//]: # (https://bo.wix.com/wix-docs/rest/drafts/pricing-plans/plan-v2/query-public-plans)\n\n| Field | Description | Query Filter Operators | Sorting | \n|-----------|-------------------|---------------------------------------------------------|---------|\n| id | Plan ID | $eq, $ne, $hasSome | | \n| primary | Whether the plan is marked as primary, and highlighted in the site with a custom ribbon | $eq, $ne | Allowed | \n| slug | URL-friendly version of the plan name. Unique across all plans in the same site | $eq, $ne, $startsWith, $endsWith, $contains | Allowed | \n| createdDate | Date plan was created | $eq, $ne, $gt, $ge, $lt, $le, $between | Allowed | \n| updatedDate | Date plan was updated | $eq, $ne, $gt, $ge, $lt, $le, $between | Allowed | \n"},{"displayName":"Introduction","slugifyName":"introduction","content":"---\ntitle: Introduction\n---\n# About the Plans API\n\nUsing the Plans API, you can create and manage pricing plans.\n\nThis includes building a customized membership plan experience, including implementing a customizable pricing page where customers can view the plans, including their perks, prices, and other features including free trials, purchase limitations, and more. \n\nWith the Plans API, you can:\n\n- Create and update plans. This includes:\n\n - Setting up pricing models for plans, such as free, one-time payment, and recurring payments (subscriptions). \n \n - Determining if pricing plans should have a duration or be valid until canceled by a customer. \n \n - Limiting plans so they can be purchased only 1 time by a single customer. By default, customers can make unlimited purchases of the same plan. \n \n Note that updating the properties of an existing pricing plan doesn't affect any current orders or purchases of the plan. Existing orders retain their existing terms and pricing.\n \n- Get, list, and query plans. \n\n- Change the visibility, availability, and accessibility of a plan.\n\n- Get statistics about plans. \n\n- Archive plans. \n\n- Set or clear the primary plan. This determines if a plan is highlighted with a custom ribbon when viewing the plans on a site.\n\n## More about plans\n\nIt's important to explore the types of plans available and other specifications, such as payment options and purchasing constraints.\n\n### Pricing plan types\n\nPricing plans can be: \n\n- **Free plans**. There is no charge to the site visitor or member.\n\n- **One-time payment plans**. The site visitor or member is charged once. These plans can be set to expire or continue indefinitely until they cancel.\n\n- **Recurring plans**. The site visitor or member is charged at predefined intervals (such as weekly, monthly, yearly). These plans can be set to expire or continue indefinitely until they cancel the subscription. Recurring plans can have free trial days.\n\n### Free trial plans\nRecurring plans can be set to have free trial days using the plan's `freeTrialDays` property.\n\nDuring free trial days, site visitor and members can cancel the plan and they won’t be charged.\n\nFree trial days are applied only once per site visitor or member for a plan. This means that if a plan with a free trial was purchased once, the second time they purchase it, the free trial days aren't applied. In this case, the site visitor or member is charged for the plan right away.\n\n### Purchase limitations\n\nSome plans can be purchased only a limited number of times by a single site visitor or member based on the value of the plan's `purchaseLimitations` property. \n\nIf the plan is updated, the limit is checked by the current plan details. For example, let's assume a plan's purchase limit was initially set to 1 and a site visitor or member purchased the plan. If later the limit is updated to 2, they can still purchase the same plan a second time.\n\n### Plan expiration\n\nA plan can be active for specified periods of time from the date of purchase. The active period is established in the same intervals as the payment periods (weeks, months, years). Plans can also be defined so they never expire (meaning, the plan continues indefinitely until the member cancels). This is true for both one-time and recurring plans.\n\n### The slug property\n\nSlugs are used to support [dynamic pages](fallback::https://support.wix.com/en/article/cms-setting-up-a-dynamic-item-page). \n\nA slug is generated on a plan's creation and is updated when a plan's name is updated. For example, if the plan's name is \"Test Plan,\" the generated slug is \"test-plan.\" If a plan already exists with a slug \"test-plan\" for the site, a number is appended to it. The slug becomes \"test-plan-1\". \n\n\n## Before you begin\n\nIt's important to note the following point before starting to code:\n\n- This API requires [Wix Pricing Plans](fallback::https://support.wix.com/en/article/pricing-plans-an-overview) to be installed on a site calling the API. \n\n## Terminology\n\n- **Plan**: A membership plan or package, offering bundles of features or “perks.” \n - A **free plan** can be purchased free of charge.\n - A **one-time plan** can be purchased with a single payment.\n - A **recurring plan** charges the customer on a weekly, monthly, or yearly basis for a selected duration of time.\n \n- **Primary plans**: Plans that are labeled with a ribbon that is customizable on a site.\n\n- **Archived plans**: Plans that can no longer be purchased or edited, but existing plan holders can still enjoy purchased membership and continue to be charged until canceled or expired.\n\n- **Hidden plans**: Plans that are not currently visible to customers. Hidden plans may still be sold manually to customers.\n\n- **Free trial**: A feature allowing for the trying out of the perks of the plan for a selected amount of days before the first charge. Relevant for recurring plans.\n\n- **Plan Policy**: The definition of terms and conditions for the customer. A plan's policy can be displayed on a site's checkout page."}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}