{"id":"035ffe41-86b8-4019-89fd-c1e1798a6ab4","createdDate":"2023-08-29T14:20:04.593Z","updatedDate":"2023-08-29T14:20:04.593Z","resourceId":"a58b05ec-66f5-4e67-957f-49cfd43978b5","api":{"schema":{"object":{"displayName":"Plan Object","description":"","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.","operationId":"com.wixpress.membership.v2.plans.PlansServiceV2.ListPublicPlans","parameters":[{"name":"limit","in":"query","description":"Number of items to list. Defaults to 75. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).","required":false,"schema":{"title":"limit","description":"Number of items to list. Defaults to 75. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).","minimum":1,"maximum":100,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"offset","in":"query","description":"Number of items to skip. Defaults to 0. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).","required":false,"schema":{"title":"offset","description":"Number of items to skip. Defaults to 0. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).","minimum":0,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"planIds","in":"query","description":"IDs of plans to list. Non-existent IDs will be ignored and won't cause errors. You can pass a maximum of 100 IDs.","required":false,"schema":{"title":"planIds","description":"IDs of plans to list. Non-existent IDs will be ignored and won't cause errors. You can pass a maximum of 100 IDs.","format":"GUID","maxItems":100,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.ListPublicPlansResponse","description":""}},"deprecated":false,"servers":[{"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"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.READ_PUBLIC_PLANS"],"externalPermissionScopes":[{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"},{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"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,"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.READ_PUBLIC_PLANS"],"externalPermissionScopes":[{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"},{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"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](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,"servers":[{"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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryPublicPlansRequest","description":"","properties":{"query":{"$ref":"#/components/schemas/com.wixpress.membership.v2.common.QueryV2","summary":"query","description":"","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.READ_PUBLIC_PLANS"],"externalPermissionScopes":[{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"},{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"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,"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.READ_PUBLIC_PLANS"],"externalPermissionScopes":[{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"},{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"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"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.GetPlanResponse","description":""}},"deprecated":false,"servers":[{"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"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.READ_PLANS"],"externalPermissionScopes":[{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"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,"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.READ_PLANS"],"externalPermissionScopes":[{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"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":{"title":"archived","description":"Archived filter. Defaults to ACTIVE (not archived) only.","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.ArchivedFilterEnum.ArchivedFilter","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"public","in":"query","description":"Visibility filter. Defaults to PUBLIC_AND_HIDDEN (meaning, both are listed).","required":false,"schema":{"title":"public","description":"Visibility filter. Defaults to PUBLIC_AND_HIDDEN (meaning, both are listed).","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.PublicFilterEnum.PublicFilter","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"limit","in":"query","description":"Number of pricing plans to list. Defaults to 75.","required":false,"schema":{"title":"limit","description":"Number of pricing plans to list. Defaults to 75.","minimum":1,"maximum":100,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"offset","in":"query","description":"Number of pricing plans to skip. Defaults to 0.","required":false,"schema":{"title":"offset","description":"Number of pricing plans to skip. Defaults to 0.","minimum":0,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"planIds","in":"query","description":"Plan ID filter. Non-existent IDs are ignored, and won't cause errors. You can pass a maximum of 100 IDs.","required":false,"schema":{"title":"planIds","description":"Plan ID filter. Non-existent IDs are ignored, and won't cause errors. You can pass a maximum of 100 IDs.","format":"GUID","maxItems":100,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.ListPlansResponse","description":""}},"deprecated":false,"servers":[{"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"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.READ_PLANS"],"externalPermissionScopes":[{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"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,"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.READ_PLANS"],"externalPermissionScopes":[{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"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.","operationId":"com.wixpress.membership.v2.plans.PlansServiceV2.CreatePlan","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.CreatePlanResponse","description":""}},"deprecated":false,"servers":[{"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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreatePlanRequest","description":"","properties":{"plan":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","description":"","x-wix-docs":{"exposure":"PUBLIC"}}},"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":"An event that is triggered when a pricing plan is created.","permissions":["PRICING_PLANS.READ_PLANS"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.pricing_plans.plan","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","domainEvent":"CREATED","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_PLANS"],"externalPermissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"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,"triggeredEvents":[{"title":"Plan Created","description":"An event that is triggered when a pricing plan is created.","permissions":["PRICING_PLANS.READ_PLANS"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.pricing_plans.plan","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","domainEvent":"CREATED","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_PLANS"],"externalPermissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"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 providing only the total number of pricing plans.","operationId":"com.wixpress.membership.v2.plans.PlansServiceV2.GetPlanStats","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.GetPlanStatsResponse","description":""}},"deprecated":false,"servers":[{"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"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.READ_PLANS"],"externalPermissionScopes":[{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"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,"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.READ_PLANS"],"externalPermissionScopes":[{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"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 does not 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"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.UpdatePlanResponse","description":""}},"deprecated":false,"servers":[{"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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdatePlanRequest","description":"","properties":{"plan":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","description":"","x-wix-docs":{"exposure":"PUBLIC"}},"fieldMask":{"title":"fieldMask","description":"","$ref":"#/components/schemas/google.protobuf.FieldMask","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["plan","plan.id"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Plan Buyer Can Cancel Updated","description":"","permissions":["PRICING_PLANS.READ_PLANS"],"payload":{"schemaName":"com.wixpress.membership.v2.plans.BuyerCanCancelUpdated"},"exposure":"PUBLIC","maturity":"BETA","slug":"buyer_can_cancel_updated","eventTopic":"domain_events_wix.pricing_plans.plan","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","domainEvent":"CUSTOM_ACTION","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_PLANS"],"externalPermissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"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,"triggeredEvents":[{"title":"Plan Buyer Can Cancel Updated","description":"","permissions":["PRICING_PLANS.READ_PLANS"],"payload":{"schemaName":"com.wixpress.membership.v2.plans.BuyerCanCancelUpdated"},"exposure":"PUBLIC","maturity":"BETA","slug":"buyer_can_cancel_updated","eventTopic":"domain_events_wix.pricing_plans.plan","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","domainEvent":"CUSTOM_ACTION","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_PLANS"],"externalPermissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"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 cannot 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 cannot be made active again.)\nChanging a plan’s visibility does not 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":"","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.SetPlanVisibilityResponse","description":""}},"deprecated":false,"servers":[{"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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"SetPlanVisibilityRequest","description":"","properties":{"visible":{"title":"visible","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["id","visible"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_PLANS"],"externalPermissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"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,"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_PLANS"],"externalPermissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"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 the site, the primary plan is highlighted with a customizable ribbon.","operationId":"com.wixpress.membership.v2.plans.PlansServiceV2.MakePlanPrimary","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.MakePlanPrimaryResponse","description":""}},"deprecated":false,"servers":[{"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"}}],"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","permissions":["PRICING_PLANS.MANAGE_PLANS"],"externalPermissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"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,"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_PLANS"],"externalPermissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"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 the 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,"servers":[{"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"}}],"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","permissions":["PRICING_PLANS.MANAGE_PLANS"],"externalPermissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"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,"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_PLANS"],"externalPermissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"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 is no longer visible as a public plan that can be chosen by site members or visitors. Archived plans cannot be purchased.\nAn archived plan cannot be made active again.\nPlan archiving does not impact existing orders made for the plan. All orders for the plan are still active and keep their perks.\nSite owners can see archived plans in the Dashboard under Pricing Plans -> Archived Plans.","operationId":"com.wixpress.membership.v2.plans.PlansServiceV2.ArchivePlan","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.ArchivePlanResponse","description":""}},"deprecated":false,"servers":[{"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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"ArchivePlanRequest","description":"","properties":{},"deprecated":false,"required":["id"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Plan Plan Archived","description":"An event that is triggered when a pricing plan is archived.","permissions":["PRICING_PLANS.READ_PLANS"],"payload":{"schemaName":"com.wixpress.membership.v2.plans.PlanArchived"},"exposure":"PUBLIC","maturity":"BETA","slug":"plan_archived","eventTopic":"domain_events_wix.pricing_plans.plan","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","domainEvent":"CUSTOM_ACTION","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_PLANS"],"externalPermissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"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,"triggeredEvents":[{"title":"Plan Plan Archived","description":"An event that is triggered when a pricing plan is archived.","permissions":["PRICING_PLANS.READ_PLANS"],"payload":{"schemaName":"com.wixpress.membership.v2.plans.PlanArchived"},"exposure":"PUBLIC","maturity":"BETA","slug":"plan_archived","eventTopic":"domain_events_wix.pricing_plans.plan","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","domainEvent":"CUSTOM_ACTION","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_PLANS"],"externalPermissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"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},{"summary":"Arrange Plans","description":"Changes the display order of the plans on the site. To rearrange the order of the plans, provide a list of plan IDs in the desired order.\nInclude all public and hidden plans in the list you provide.\nMake sure to provide all non-archived plan IDs to avoid unpredictable results","operationId":"com.wixpress.membership.v2.plans.PlansServiceV2.ArrangePlans","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.ArrangePlansResponse","description":""}},"deprecated":false,"servers":[{"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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"ArrangePlansRequest","description":"","properties":{"ids":{"title":"ids","description":"","format":"GUID","minItems":1,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["ids"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_PLANS"],"externalPermissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.ArrangePlansRequest","responseMessage":"com.wixpress.membership.v2.plans.ArrangePlansResponse"},"legacyExamples":[{"name":"ArrangePlans","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n https://www.wixapis.com/pricing-plans/v2/plans/arrange\n --data-binary '{\"ids\": [\"890016b7-...-a545-681e7d28fc0\", \"804y08a6-15ee-...-02cb5ad8c300\"]}'\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v2/plans/arrange","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_PLANS"],"externalPermissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.membership-api","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.plans.ArrangePlansRequest","responseMessage":"com.wixpress.membership.v2.plans.ArrangePlansResponse"},"legacyExamples":[{"name":"ArrangePlans","serviceName":"PlansServiceV2","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n https://www.wixapis.com/pricing-plans/v2/plans/arrange\n --data-binary '{\"ids\": [\"890016b7-...-a545-681e7d28fc0\", \"804y08a6-15ee-...-02cb5ad8c300\"]}'\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Arrange Plans","slugifiedName":"arrange-plans"},"permissionScopes":[{"name":"Manage Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-PLANS"}],"isAdminMethod":true}],"webhooks":[{"summary":"Plan Updated","title":"Plan Updated","description":"An event that is triggered when a pricing plan is updated.","permissions":["PRICING_PLANS.READ_PLANS"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.pricing_plans.plan","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","domainEvent":"UPDATED","legacyExamples":[],"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":"BETA"},{"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":"An event that is triggered when a pricing plan is created.","permissions":["PRICING_PLANS.READ_PLANS"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.pricing_plans.plan","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","domainEvent":"CREATED","legacyExamples":[],"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":"BETA"},{"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":"An event that is triggered when a pricing plan is archived.","permissions":["PRICING_PLANS.READ_PLANS"],"payload":{"schemaName":"com.wixpress.membership.v2.plans.PlanArchived"},"exposure":"PUBLIC","maturity":"BETA","slug":"plan_archived","eventTopic":"domain_events_wix.pricing_plans.plan","serviceName":"com.wixpress.membership.v2.plans.PlansServiceV2","domainEvent":"CUSTOM_ACTION","legacyExamples":[],"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":"BETA"},{"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":"# About the Plans API\n\nThe Plan entity includes all the details of plans available on a site. \nUsing the Plans API, you can create and manage plans, change the visibility and availability of a plan for purchase, and get plan statistics. Plans provides a customizable pricing page where customers can view the plan perks, prices and other features including free trials, purchase limitations and more. \nAll plans either have a duration or can be valid until canceled by a customer. \n\nUse the Plans API to:\n\n- Create & update plans.\n- Get statistics about the plans.\n- Get specific plan information.\n- Arrange display order for plans.\n- Hide or archive plans.\n\n## Setting usage limits\nPricing plans can be limited to be purchased only one time by a single customer. By default, customers can make unlimited purchases.\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 for a single payment.\n - A **recurring plan** charges the customer on a weekly, monthly or yearly basis for selected duration of time.\n- **Primary plans**: Plans that are labeled with a ribbon that is customizable in the Wix Pricing Plans UI.\n- **Archived plans**: Plans that can no longer be purchased or edited, but existing plan holders can still enjoy purchased membership and will continue to be charged until canceled or expired.\n- **Hidden plans**: Plans that are not currently visible to customers. Hidden plans may still be sold manually to customers.\n- **Free trial**: A feature allowing the site owner to test out the perks of the plan for a selected amount of days before the first charge. Relevant for recurring plans.\n- **Plan Policy**: The definition of terms and conditions for the customer. Plan policy can be displayed per plan on the Wix Pricing Plans 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":{"title":"id","description":"Plan ID.","format":"GUID","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"name":{"title":"name","description":"Plan name.","minLength":1,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"description":{"title":"description","description":"Plan description.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"perks":{"$ref":"#/components/schemas/com.wixpress.membership.v2.StringList","summary":"perks","description":"What is included with this plan (e.g., 1 weekly entrance to a specific class).","x-wix-docs":{"exposure":"PUBLIC"}},"pricing":{"$ref":"#/components/schemas/com.wixpress.membership.v2.Pricing","summary":"pricing","description":"Plan price, payment schedule, and expiration.","x-wix-docs":{"exposure":"PUBLIC"}},"public":{"title":"public","description":"Whether the plan is public (visible to site visitors and members).","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"archived":{"title":"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,"type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"primary":{"title":"primary","description":"Whether the plan is marked as primary.","readOnly":true,"type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"hasOrders":{"title":"hasOrders","description":"Whether the plan has any orders (including pending and unpaid orders).","readOnly":true,"type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"createdDate":{"title":"createdDate","description":"Date plan was created.","readOnly":true,"type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"updatedDate":{"title":"updatedDate","description":"Date plan was last updated.","readOnly":true,"type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"slug":{"title":"slug","description":"URL-friendly version of plan name. Unique across all plans in the same site.","minLength":1,"readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"maxPurchasesPerBuyer":{"title":"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 one purchase per buyer.","minimum":0,"maximum":1,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"allowFutureStartDate":{"title":"allowFutureStartDate","description":"Whether the buyer can start the plan at a later date. Defaults to false.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"buyerCanCancel":{"title":"buyerCanCancel","description":"Whether the buyer is allowed to cancel their plan. Defaults to false.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"termsAndConditions":{"title":"termsAndConditions","description":"Any terms and conditions that apply to the plan. This information will be displayed during checkout.","maxLength":3000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"formId":{"title":"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","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Plan","description":"Information about the pricing plan."},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StringValue","description":""},"com.wixpress.membership.v2.StringList":{"type":"object","properties":{"values":{"title":"values","description":"List of strings","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StringList","description":"This wrapper type exist in order to distinguish an empty string list from no list at all in update requests."},"com.wixpress.membership.v2.Pricing":{"type":"object","properties":{"price":{"$ref":"#/components/schemas/com.wixpress.membership.v2.common.Money","summary":"price","description":"Amount for a single payment (or the whole subscription if it's not a recurring plan)","x-wix-docs":{"exposure":"PUBLIC"}},"freeTrialDays":{"title":"freeTrialDays","description":"Free trial period for the plan in days. It’s available only for recurring plans. Set to 0 to remove free trial.","minimum":0,"maximum":999,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},"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":{"$ref":"#/components/schemas/com.wixpress.membership.v2.Recurrence","summary":"subscription","description":"Plan has recurring payments.","x-wix-docs":{"exposure":"PUBLIC"}},"singlePaymentForDuration":{"$ref":"#/components/schemas/com.wixpress.membership.v2.Duration","summary":"singlePaymentForDuration","description":"One time payment, plan is valid for the specified duration.","x-wix-docs":{"exposure":"PUBLIC"}},"singlePaymentUnlimited":{"title":"singlePaymentUnlimited","description":"One time payment, plan is valid until it is canceled.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}}},"com.wixpress.membership.v2.Recurrence":{"type":"object","properties":{"cycleDuration":{"$ref":"#/components/schemas/com.wixpress.membership.v2.Duration","summary":"cycleDuration","description":"Length of one payment cycle.","x-wix-docs":{"exposure":"PUBLIC"}},"cycleCount":{"title":"cycleCount","description":"Amount of payment cycles this subscription is valid for.\n\n`0` for unlimited or until-canceled.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},"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":{"title":"count","description":"The amount of a duration `unit` in a single payment cycle.\n\nCurrently limited to support only `1`.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"unit":{"title":"unit","description":"Unit of time for the cycle duration.","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.PeriodUnitEnum.PeriodUnit","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Duration","description":"A duration expressed in number of time units."},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"title":"value","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Int32Value","description":""},"com.wixpress.membership.v2.PeriodUnitEnum.PeriodUnit":{"type":"string","description":"","title":"PeriodUnit","enum":["UNDEFINED","DAY","WEEK","MONTH","YEAR"]},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BoolValue","description":""},"com.wixpress.membership.v2.common.Money":{"type":"object","properties":{"value":{"title":"value","description":"Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99).","type":"string","x-wix-docs":{"exposure":"PUBLIC","decimalValue":{"lt":"1000000000000","gte":"0.000","maxScale":3}}},"currency":{"title":"currency","description":"Currency code. Must be valid ISO 4217 currency code (e.g., USD).","format":"CURRENCY","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Money","description":""},"com.wixpress.membership.v2.FeeConfig":{"type":"object","properties":{"fee":{"$ref":"#/components/schemas/com.wixpress.membership.v2.Fee","summary":"fee","description":"","x-wix-docs":{"exposure":"PUBLIC"}},"appliedAt":{"title":"appliedAt","description":"The time this fee will be charged","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.FeeConfig.AppliedAt","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FeeConfig","description":""},"com.wixpress.membership.v2.Fee":{"type":"object","properties":{"name":{"title":"name","description":"Fee name","maxLength":40,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"amount":{"title":"amount","description":"Amount of fee to be charged","type":"string","x-wix-docs":{"exposure":"PUBLIC","decimalValue":{"lt":"1000000000000","gte":"0.000","maxScale":3}}}},"title":"Fee","description":""},"com.wixpress.membership.v2.FeeConfig.AppliedAt":{"type":"string","description":"","title":"AppliedAt","enum":["UNKNOWN_CHARGE_EVENT","FIRST_PAYMENT"]},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"title":"seconds","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"nanos":{"title":"nanos","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Timestamp","description":""},"com.wixpress.membership.v2.plans.ListPublicPlansRequest":{"type":"object","properties":{"limit":{"title":"limit","description":"Number of items to list. Defaults to 75. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).","minimum":1,"maximum":100,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"title":"offset","description":"Number of items to skip. Defaults to 0. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).","minimum":0,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"planIds":{"title":"planIds","description":"IDs of plans to list. Non-existent IDs will be ignored and won't cause errors. You can pass a maximum of 100 IDs.","format":"GUID","maxItems":100,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListPublicPlansRequest","description":""},"com.wixpress.membership.v2.plans.ListPublicPlansResponse":{"type":"object","properties":{"plans":{"title":"plans","description":"List of public pricing plans.","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.PublicPlan"},"x-wix-docs":{"exposure":"PUBLIC"}},"pagingMetadata":{"$ref":"#/components/schemas/wix.common.PagingMetadataV2","summary":"pagingMetadata","description":"Object containing paging-related data (number of plans returned, offset).","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListPublicPlansResponse","description":""},"com.wixpress.membership.v2.plans.PublicPlan":{"type":"object","properties":{"id":{"title":"id","description":"Plan ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"name":{"title":"name","description":"Plan name.","minLength":1,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"description":{"title":"description","description":"Plan description.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"perks":{"$ref":"#/components/schemas/com.wixpress.membership.v2.StringList","summary":"perks","description":"What is included with this plan (e.g., 1 weekly entrance to a specific class).","x-wix-docs":{"exposure":"PUBLIC"}},"pricing":{"$ref":"#/components/schemas/com.wixpress.membership.v2.Pricing","summary":"pricing","description":"Plan price, payment schedule, and expiration.","x-wix-docs":{"exposure":"PUBLIC"}},"primary":{"title":"primary","description":"Whether the plan is marked as primary.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"createdDate":{"title":"createdDate","description":"Date plan was created.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"updatedDate":{"title":"updatedDate","description":"Date plan was last updated.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"slug":{"title":"slug","description":"URL-friendly version of plan name. Unique across all plans in the same site.","minLength":1,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"maxPurchasesPerBuyer":{"title":"maxPurchasesPerBuyer","description":"Number of times the same buyer can purchase the plan. An empty value or a value of zero means no limitation.","minimum":0,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"allowFutureStartDate":{"title":"allowFutureStartDate","description":"Whether the buyer can start the plan at a later date. Defaults to false.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"buyerCanCancel":{"title":"buyerCanCancel","description":"Whether the buyer is allowed to cancel their plan. Defaults to false.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"termsAndConditions":{"title":"termsAndConditions","description":"Any terms and conditions that apply to the plan. This information will be displayed during checkout.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"formId":{"title":"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","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"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":{"title":"count","description":"Number of items returned in the response.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"title":"offset","description":"Offset that was requested.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"total":{"title":"total","description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"tooManyToCount":{"title":"tooManyToCount","description":"Flag that indicates the server failed to calculate the `total` field.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"cursors":{"$ref":"#/components/schemas/wix.common.Cursors","summary":"cursors","description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PagingMetadataV2","description":""},"wix.common.Cursors":{"type":"object","properties":{"next":{"title":"next","description":"Cursor pointing to next page in the list of results.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"prev":{"title":"prev","description":"Cursor pointing to previous page in the list of results.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Cursors","description":""},"com.wixpress.membership.v2.plans.QueryPublicPlansRequest":{"type":"object","properties":{"query":{"$ref":"#/components/schemas/com.wixpress.membership.v2.common.QueryV2","summary":"query","description":"","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryPublicPlansRequest","description":""},"com.wixpress.membership.v2.common.QueryV2":{"type":"object","properties":{"filter":{"title":"filter","description":"A filter object. See [supported fields and operators](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/filter-and-sort#wix-pricing-plans_pricing-plans_plans_filter-and-sort_query-public-plans)","type":"object","x-wix-docs":{"exposure":"PUBLIC"}},"sort":{"title":"sort","description":"Sort object in the form [{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC"}},"paging":{"$ref":"#/components/schemas/wix.common.Paging","summary":"paging","description":"Pointer to page of results using offset. Can not be used together with 'cursorPaging'","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryV2","description":""},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"title":"fields","description":"","type":"object","format":"map","properties":{"key:value":{"type":"object","description":"\"key\" of type string, \"value\" of type object","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"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":{"title":"nullValue","description":"","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC"}},"numberValue":{"title":"numberValue","description":"","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"stringValue":{"title":"stringValue","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"boolValue":{"title":"boolValue","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"structValue":{"title":"structValue","description":"","type":"object","x-wix-docs":{"exposure":"PUBLIC"}},"listValue":{"title":"listValue","description":"","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"title":"values","description":"","$ref":"#/components/schemas/google.protobuf.Value","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListValue","description":""},"wix.common.Sorting":{"type":"object","properties":{"fieldName":{"title":"fieldName","description":"Name of the field to sort by.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"order":{"title":"order","description":"Sort order.","type":"string","$ref":"#/components/schemas/wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Sorting","description":""},"wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"wix.common.Paging":{"type":"object","properties":{"limit":{"title":"limit","description":"Number of items to load.","minimum":0,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"title":"offset","description":"Number of items to skip in the current sort order.","minimum":0,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Paging","description":""},"com.wixpress.membership.v2.plans.QueryPublicPlansResponse":{"type":"object","properties":{"plans":{"title":"plans","description":"List of public pricing plans that match the specified query.","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.PublicPlan"},"x-wix-docs":{"exposure":"PUBLIC"}},"pagingMetadata":{"$ref":"#/components/schemas/wix.common.PagingMetadataV2","summary":"pagingMetadata","description":"Object containing paging-related data (number of plans returned, offset).","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryPublicPlansResponse","description":""},"com.wixpress.membership.v2.plans.GetPlanRequest":{"type":"object","properties":{"id":{"title":"id","description":"Plan ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetPlanRequest","description":""},"com.wixpress.membership.v2.plans.GetPlanResponse":{"type":"object","properties":{"plan":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","description":"Pricing plan.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetPlanResponse","description":""},"com.wixpress.membership.v2.plans.ListPlansRequest":{"type":"object","properties":{"archived":{"title":"archived","description":"Archived filter. Defaults to ACTIVE (not archived) only.","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.ArchivedFilterEnum.ArchivedFilter","x-wix-docs":{"exposure":"PUBLIC"}},"public":{"title":"public","description":"Visibility filter. Defaults to PUBLIC_AND_HIDDEN (meaning, both are listed).","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.plans.PublicFilterEnum.PublicFilter","x-wix-docs":{"exposure":"PUBLIC"}},"limit":{"title":"limit","description":"Number of pricing plans to list. Defaults to 75.","minimum":1,"maximum":100,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"title":"offset","description":"Number of pricing plans to skip. Defaults to 0.","minimum":0,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"planIds":{"title":"planIds","description":"Plan ID filter. Non-existent IDs are ignored, and won't cause errors. You can pass a maximum of 100 IDs.","format":"GUID","maxItems":100,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListPlansRequest","description":""},"com.wixpress.membership.v2.plans.ArchivedFilterEnum.ArchivedFilter":{"type":"string","description":"","title":"ArchivedFilter","enum":["ACTIVE","ARCHIVED","ARCHIVED_AND_ACTIVE"]},"com.wixpress.membership.v2.plans.PublicFilterEnum.PublicFilter":{"type":"string","description":"","title":"PublicFilter","enum":["PUBLIC_AND_HIDDEN","PUBLIC","HIDDEN"]},"com.wixpress.membership.v2.plans.ListPlansResponse":{"type":"object","properties":{"plans":{"title":"plans","description":"List of all public and hidden pricing plans.","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan"},"x-wix-docs":{"exposure":"PUBLIC"}},"pagingMetadata":{"$ref":"#/components/schemas/wix.common.PagingMetadataV2","summary":"pagingMetadata","description":"Object containing paging-related data (number of plans returned, offset).","x-wix-docs":{"exposure":"PUBLIC"}}},"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":{"title":"totalPlans","description":"Total number of plans created, including active plans (both public and hidden) and archived plans.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetPlanStatsResponse","description":""},"com.wixpress.membership.v2.plans.CreatePlanRequest":{"type":"object","properties":{"plan":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","description":"","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreatePlanRequest","description":""},"com.wixpress.membership.v2.plans.CreatePlanResponse":{"type":"object","properties":{"plan":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","description":"","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreatePlanResponse","description":""},"com.wixpress.membership.v2.plans.UpdatePlanRequest":{"type":"object","properties":{"plan":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","description":"","x-wix-docs":{"exposure":"PUBLIC"}},"fieldMask":{"title":"fieldMask","description":"","$ref":"#/components/schemas/google.protobuf.FieldMask","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdatePlanRequest","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"title":"paths","description":"","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FieldMask","description":""},"com.wixpress.membership.v2.plans.UpdatePlanResponse":{"type":"object","properties":{"plan":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","description":"","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdatePlanResponse","description":""},"com.wixpress.membership.v2.plans.BuyerCanCancelUpdated":{"type":"object","properties":{"plan":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","description":"","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BuyerCanCancelUpdated","description":""},"com.wixpress.membership.v2.plans.SetPlanVisibilityRequest":{"type":"object","properties":{"id":{"title":"id","description":"","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"visible":{"title":"visible","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SetPlanVisibilityRequest","description":""},"com.wixpress.membership.v2.plans.SetPlanVisibilityResponse":{"type":"object","properties":{"plan":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","description":"","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SetPlanVisibilityResponse","description":""},"com.wixpress.membership.v2.plans.MakePlanPrimaryRequest":{"type":"object","properties":{"id":{"title":"id","description":"","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"MakePlanPrimaryRequest","description":""},"com.wixpress.membership.v2.plans.MakePlanPrimaryResponse":{"type":"object","properties":{"plan":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","description":"","x-wix-docs":{"exposure":"PUBLIC"}}},"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":{"title":"id","description":"","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ArchivePlanRequest","description":""},"com.wixpress.membership.v2.plans.ArchivePlanResponse":{"type":"object","properties":{"plan":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","description":"","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ArchivePlanResponse","description":""},"com.wixpress.membership.v2.plans.PlanArchived":{"type":"object","properties":{"plan":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","description":"","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PlanArchived","description":""},"com.wixpress.membership.v2.plans.BulkArchivePlanRequest":{"type":"object","properties":{"ids":{"title":"ids","description":"List of Plan IDs.","format":"GUID","minItems":1,"maxItems":100,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"returnFullEntity":{"title":"returnFullEntity","description":"Set to true to return Plan entity in response.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkArchivePlanRequest","description":""},"com.wixpress.membership.v2.plans.BulkArchivePlanResponse":{"type":"object","properties":{"results":{"title":"results","description":"","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.BulkPlanResult"},"x-wix-docs":{"exposure":"PUBLIC"}},"bulkActionMetadata":{"$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","description":"","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkArchivePlanResponse","description":""},"com.wixpress.membership.v2.plans.BulkPlanResult":{"type":"object","properties":{"itemMetadata":{"$ref":"#/components/schemas/wix.common.ItemMetadata","summary":"itemMetadata","description":"","x-wix-docs":{"exposure":"PUBLIC"}},"plan":{"$ref":"#/components/schemas/com.wixpress.membership.v2.plans.Plan","summary":"plan","description":"","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkPlanResult","description":""},"wix.common.ItemMetadata":{"type":"object","properties":{"id":{"title":"id","description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"originalIndex":{"title":"originalIndex","description":"Index of the item within the request array. Allows for correlation between request and response items.","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"success":{"title":"success","description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"error":{"$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","description":"Details about the error in case of failure.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ItemMetadata","description":""},"wix.api.ApplicationError":{"type":"object","properties":{"code":{"title":"code","description":"Error code.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"description":{"title":"description","description":"Description of the error.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"data":{"title":"data","description":"Data related to the error.","type":"object","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ApplicationError","description":""},"wix.common.BulkActionMetadata":{"type":"object","properties":{"totalSuccesses":{"title":"totalSuccesses","description":"Number of items that were successfully processed.","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"totalFailures":{"title":"totalFailures","description":"Number of items that couldn't be processed.","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"undetailedFailures":{"title":"undetailedFailures","description":"Number of failures without details because detailed failure threshold was exceeded.","type":"number","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkActionMetadata","description":""},"com.wixpress.membership.v2.plans.ArrangePlansRequest":{"type":"object","properties":{"ids":{"title":"ids","description":"","format":"GUID","minItems":1,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ArrangePlansRequest","description":""},"com.wixpress.membership.v2.plans.ArrangePlansResponse":{"type":"object","properties":{},"title":"ArrangePlansResponse","description":""}}},"title":"Plan","description":"","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":"# About the Plans API\n\nThe Plan entity includes all the details of plans available on a site. \nUsing the Plans API, you can create and manage plans, change the visibility and availability of a plan for purchase, and get plan statistics. Plans provides a customizable pricing page where customers can view the plan perks, prices and other features including free trials, purchase limitations and more. \nAll plans either have a duration or can be valid until canceled by a customer. \n\nUse the Plans API to:\n\n- Create & update plans.\n- Get statistics about the plans.\n- Get specific plan information.\n- Arrange display order for plans.\n- Hide or archive plans.\n\n## Setting usage limits\nPricing plans can be limited to be purchased only one time by a single customer. By default, customers can make unlimited purchases.\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 for a single payment.\n - A **recurring plan** charges the customer on a weekly, monthly or yearly basis for selected duration of time.\n- **Primary plans**: Plans that are labeled with a ribbon that is customizable in the Wix Pricing Plans UI.\n- **Archived plans**: Plans that can no longer be purchased or edited, but existing plan holders can still enjoy purchased membership and will continue to be charged until canceled or expired.\n- **Hidden plans**: Plans that are not currently visible to customers. Hidden plans may still be sold manually to customers.\n- **Free trial**: A feature allowing the site owner to test out the perks of the plan for a selected amount of days before the first charge. Relevant for recurring plans.\n- **Plan Policy**: The definition of terms and conditions for the customer. Plan policy can be displayed per plan on the Wix Pricing Plans checkout page."}]},"reviewStatus":"APPROVED","isLocked":true}