{"id":"5750f834-9d93-4068-8439-41c08c43cc15","createdDate":"2024-03-01T12:27:34.200Z","updatedDate":"2024-03-01T12:27:34.200Z","resourceId":"17949597-fe3a-4ddc-a11d-fdf3f8ba606a","api":{"schema":{"object":{"displayName":"Order Object","description":"An order object includes all of the details related to the purchase of a Pricing Plan.\nYou can manage existing orders, create offline orders, and preview orders not yet purchased.\n\nOrders are based on pricing models based on the payment and duration cycles for each plan. See here to\n[learn more about pricing models](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/introduction#wix-pricing-plans_pricing-plans_introduction_pricing-models).","slug":"order-object","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/app-market.git"},"methods":[{"summary":"Get Order","description":"Retrieves an order by ID.","operationId":"com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Order ID.","x-wix-docs":{"exposure":"PUBLIC"}},{"name":"fieldSet","in":"query","description":"","required":false,"schema":{"description":"","title":"fieldSet","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.FieldSet.Set","x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.member.GetOrderResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/pricing-plans/v2/member","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/member","destinationPath":"/v2/member","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.orders.member.MemberOrdersService","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.READ_OWN_ORDERS"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.pricing-plans-member-orders","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.orders.member.GetOrderRequest","responseMessage":"com.wixpress.membership.v2.orders.member.GetOrderResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v2/member/orders/{id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.orders.member.MemberOrdersService","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.READ_OWN_ORDERS"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.pricing-plans-member-orders","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.orders.member.GetOrderRequest","responseMessage":"com.wixpress.membership.v2.orders.member.GetOrderResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Order","slugifiedName":"member-orders-service-get-order"}},{"summary":"List Orders","description":"Returns orders for currently logged in member.","operationId":"com.wixpress.membership.v2.orders.member.MemberOrdersService.ListOrders","parameters":[{"name":"planIds","in":"query","description":"Filter by plan IDs.","required":false,"schema":{"description":"Filter by plan IDs.","format":"GUID","title":"planIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"autoRenewCanceled","in":"query","description":"Filter for orders where auto renewal was canceled.","required":false,"schema":{"description":"Filter for orders where auto renewal was canceled.","title":"autoRenewCanceled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"orderStatuses","in":"query","description":"Filter by order status.","required":false,"schema":{"description":"Filter by order status.","title":"orderStatuses","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"paymentStatuses","in":"query","description":"Filter by payment status.","required":false,"schema":{"description":"Filter by payment status.","title":"paymentStatuses","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"limit","in":"query","description":"Limit the number of pricing plans returned. Default limit is 50.","required":false,"schema":{"description":"Limit the number of pricing plans returned. Default limit is 50.","minimum":1,"maximum":50,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"offset","in":"query","description":"Number of entries to offset.","required":false,"schema":{"description":"Number of entries to offset.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"sorting","in":"query","description":"Sorting direction (defaults to ASC) and field to sort by. [See available fields here](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort).","required":false,"schema":{"description":"Sorting direction (defaults to ASC) and field to sort by. [See available fields here](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort).","$ref":"#/components/schemas/wix.common.Sorting","summary":"sorting","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"fieldSet","in":"query","description":"","required":false,"schema":{"description":"","title":"fieldSet","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.FieldSet.Set","x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.member.ListOrdersResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/pricing-plans/v2/member","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/member","destinationPath":"/v2/member","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.orders.member.MemberOrdersService","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.READ_OWN_ORDERS"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.pricing-plans-member-orders","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.orders.member.ListOrdersRequest","responseMessage":"com.wixpress.membership.v2.orders.member.ListOrdersResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v2/member/orders","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.orders.member.MemberOrdersService","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.READ_OWN_ORDERS"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.pricing-plans-member-orders","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.orders.member.ListOrdersRequest","responseMessage":"com.wixpress.membership.v2.orders.member.ListOrdersResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"List Orders","slugifiedName":"member-orders-service-list-orders"}},{"summary":"Request Cancellation","description":"Cancels an order. Recurring orders can be canceled either immediately or at the next payment date. One time orders can only be canceled immediately.\n\n>**Note:**\n>This endpoint requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).","operationId":"com.wixpress.membership.v2.orders.member.MemberOrdersService.RequestCancellation","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Order ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.member.RequestCancellationResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/pricing-plans/v2/member","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/member","destinationPath":"/v2/member","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"RequestCancellationRequest","description":"","properties":{"effectiveAt":{"description":"Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately.","title":"effectiveAt","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.CancellationEffectiveAtEnum.CancellationEffectiveAt","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["id","effectiveAt"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Order Canceled","description":"Triggered when an order is canceled.\n\nThis webhook is triggered either immediately or at the end of the current payment cycle, as follows:\n+ If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.\n+ If the order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`, the webhook is triggered at the end of the current payment cycle. In this case, the [Order Auto Renew Canceled Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-auto-renew-canceled-webhook) is triggered immediately.","permissions":["PRICING_PLANS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.membership.v2.orders.OrderCanceled"},"exposure":"PUBLIC","maturity":"BETA","slug":"canceled","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.member.MemberOrdersService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.pricing_plans.v2.order_canceled","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.orders.member.MemberOrdersService","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_OWN_ORDERS"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.pricing-plans-member-orders","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.orders.member.RequestCancellationRequest","responseMessage":"com.wixpress.membership.v2.orders.member.RequestCancellationResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v2/member/orders/{id}/cancel","rpcOnly":false,"triggeredEvents":[{"title":"Order Canceled","description":"Triggered when an order is canceled.\n\nThis webhook is triggered either immediately or at the end of the current payment cycle, as follows:\n+ If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.\n+ If the order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`, the webhook is triggered at the end of the current payment cycle. In this case, the [Order Auto Renew Canceled Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-auto-renew-canceled-webhook) is triggered immediately.","permissions":["PRICING_PLANS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.membership.v2.orders.OrderCanceled"},"exposure":"PUBLIC","maturity":"BETA","slug":"canceled","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.member.MemberOrdersService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.pricing_plans.v2.order_canceled","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.orders.member.MemberOrdersService","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_OWN_ORDERS"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.membership:membership-proto","serviceArtifactId":"com.wixpress.membership.pricing-plans-member-orders","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.membership.v2.orders.member.RequestCancellationRequest","responseMessage":"com.wixpress.membership.v2.orders.member.RequestCancellationResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Request Cancellation","slugifiedName":"request-cancellation"}},{"summary":"Create Offline Order","description":"Creates an order for a buyer who purchased the plan with an offline transaction.\n\nAn offline order is handled off of the Wix site and is marked as `offline` in `type`. If a pricing plan\nhas a limit on the amount of purchases per buyer, that limit is ignored for offline orders.\nTax is only applied if the site [has it configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection).\n\nHandle payment for an offline order in 1 of 2 ways:\n+ When creating the order, select `true` in the `paid` request parameter.\n+ After creation, use [Mark As Paid to mark the order as paid](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/mark-as-paid).","operationId":"com.wixpress.membership.v2.orders.CheckoutService.CreateOfflineOrder","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.CreateOfflineOrderResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/pricing-plans/v2/checkout","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/checkout","destinationPath":"/v2/checkout","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateOfflineOrderRequest","description":"","properties":{"planId":{"description":"ID of the plan being ordered. See [Plans for more information about plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans).","format":"GUID","title":"planId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"memberId":{"description":"ID of the member ordering the plan. See [Members for more information about member IDs](https://dev.wix.com/api/rest/members/members).","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"startDate":{"description":"Start date and time for the ordered plan.\n\nDefault: Current date and time","title":"startDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"paid":{"description":"Whether the order is paid.\n\nDefault: `false`","title":"paid","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"couponCode":{"description":"Coupon code to apply.\n\nSee [Coupons to learn more](https://dev.wix.com/api/rest/coupons).","minLength":1,"maxLength":20,"title":"couponCode","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"submissionId":{"description":"Form submission id that was submitted together with the order","format":"GUID","title":"submissionId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["planId","memberId"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Order Created","description":"Triggered when an order is created.","permissions":["PRICING_PLANS.READ_ORDERS"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.CheckoutService","domainEvent":"CREATED","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.orders.CheckoutService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_IS_DISABLED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_USAGE_EXCEEDED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_IS_NOT_ACTIVE_YET","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_HAS_EXPIRED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_DOES_NOT_EXIST","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_INVALID_SUBTOTAL","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"}],"exposure":"PUBLIC","permissions":["PRICING_PLANS.REGISTER_OFFLINE_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"}],"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.orders.CreateOfflineOrderRequest","responseMessage":"com.wixpress.membership.v2.orders.CreateOfflineOrderResponse"},"legacyExamples":[{"name":"CreateOfflineOrder","serviceName":"CheckoutService","type":"METHOD","version":"v2","order":1,"content":{"title":"Create an Unpaid Offline Order","request":"curl -X POST \\\n 'https://www.wixapis.com/pricing-plans/v2/checkout/orders/offline' \\\n -H 'Authorization: >' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"planId\": \"b90475cd-9000-4cb0-93dd-c81ee100e350\",\n \"memberId\": \"805ce40a-0000-464e-85ed-5bb052d8beb7\",\n \"paid\": false\n }'","response":"{\n \"order\": {\n \"id\": \"333fbc19-319b-4d1f-8e8f-cf68c6e7b30d\",\n \"planId\": \"b90475cd-94d0-4cb0-93dd-c81ee100e350\",\n \"subscriptionId\": \"485ccbfe-e880-492a-b221-a55ec4449937\",\n \"wixPayOrderId\": \"7494d9cf-3004-4101-b923-ffd07fbcf504\",\n \"buyer\": {\n \"memberId\": \"805ce40a-0000-464e-85ed-5bb052d8beb7\",\n \"contactId\": \"805ce40a-0000-464e-85ed-5bb052d8beb7\"\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"DAY\"\n },\n \"cycleCount\": 3\n },\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 3\n },\n \"price\": {\n \"subtotal\": \"100.00\",\n \"discount\": \"0\",\n \"tax\": {\n \"name\": \"Tax\",\n \"rate\": \"21\",\n \"amount\": \"21.00\"\n },\n \"total\": \"121.00\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"type\": \"OFFLINE\",\n \"status\": \"ACTIVE\",\n \"autoRenewCanceled\": false,\n \"lastPaymentStatus\": \"UNPAID\",\n \"startDate\": \"2022-06-02T07:52:51.237281Z\",\n \"endDate\": \"2022-06-05T07:52:51.237281Z\",\n \"earliestEndDate\": \"2022-06-05T07:52:51.237281Z\",\n \"currentCycle\": {\n \"index\": 1,\n \"startedDate\": \"2022-06-02T07:52:51.237281Z\",\n \"endedDate\": \"2022-06-03T07:52:51.237281Z\"\n },\n \"planName\": \"ExpensiveDay\",\n \"planPrice\": \"100\",\n \"createdDate\": \"2022-06-02T07:52:51.237281Z\",\n \"updatedDate\": \"2022-06-02T07:52:51.237281Z\"\n }\n}"}},{"name":"CreateOfflineOrder","serviceName":"CheckoutService","type":"METHOD","version":"v2","content":{"title":"Create a Paid Offline Order With a Future Start Date and Coupon","request":"curl -X POST \\\n 'https://www.wixapis.com/pricing-plans/v2/checkout/orders/offline' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"memberId\": \"805ce40a-9000-464e-85ed-5bb052d8beb7\",\n \"planId\": \"b90475cd-0000-4cb0-93dd-c81ee100e350\",\n \"startDate\": \"2022-06-25T16:23:00Z\",\n \"paid\": true,\n \"couponCode\": \"HalfOff\"\n }'","response":"{\n \"order\": {\n \"id\": \"519f5e34-f11d-483b-8add-58a6aa04b636\",\n \"planId\": \"b90475cd-0000-4cb0-93dd-c81ee100e350\",\n \"subscriptionId\": \"9d6881e5-36e7-47c5-bc0d-7df1079e405c\",\n \"wixPayOrderId\": \"14b2b144-2b61-43df-af63-563390a41fc0\",\n \"buyer\": {\n \"memberId\": \"805ce40a-9000-464e-85ed-5bb052d8beb7\",\n \"contactId\": \"805ce40a-9000-464e-85ed-5bb052d8beb7\"\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"DAY\"\n },\n \"cycleCount\": 3\n },\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 3\n },\n \"price\": {\n \"subtotal\": \"100.0\",\n \"coupon\": {\n \"code\": \"HalfOff\",\n \"amount\": \"50.0\",\n \"id\": \"00f5600a-dc3c-4067-8c6d-b5552a168aa1\"\n },\n \"discount\": \"50.0\",\n \"tax\": {\n \"name\": \"Tax\",\n \"rate\": \"21\",\n \"amount\": \"10.50\"\n },\n \"total\": \"60.50\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"type\": \"OFFLINE\",\n \"status\": \"ACTIVE\",\n \"autoRenewCanceled\": false,\n \"lastPaymentStatus\": \"PAID\",\n \"startDate\": \"2022-06-25T16:23:00Z\",\n \"endDate\": \"2022-06-28T16:23:00Z\",\n \"earliestEndDate\": \"2022-06-28T16:23:00Z\",\n \"planName\": \"ExpensiveDay\",\n \"planPrice\": \"100\",\n \"createdDate\": \"2022-06-02T07:47:13.469959Z\",\n \"updatedDate\": \"2022-06-02T07:47:13.469959Z\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v2/checkout/orders/offline","rpcOnly":false,"triggeredEvents":[{"title":"Order Created","description":"Triggered when an order is created.","permissions":["PRICING_PLANS.READ_ORDERS"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.CheckoutService","domainEvent":"CREATED","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.orders.CheckoutService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_IS_DISABLED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_USAGE_EXCEEDED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_IS_NOT_ACTIVE_YET","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_HAS_EXPIRED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_DOES_NOT_EXIST","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_INVALID_SUBTOTAL","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"}],"exposure":"PUBLIC","permissions":["PRICING_PLANS.REGISTER_OFFLINE_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"}],"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.orders.CreateOfflineOrderRequest","responseMessage":"com.wixpress.membership.v2.orders.CreateOfflineOrderResponse"},"legacyExamples":[{"name":"CreateOfflineOrder","serviceName":"CheckoutService","type":"METHOD","version":"v2","order":1,"content":{"title":"Create an Unpaid Offline Order","request":"curl -X POST \\\n 'https://www.wixapis.com/pricing-plans/v2/checkout/orders/offline' \\\n -H 'Authorization: >' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"planId\": \"b90475cd-9000-4cb0-93dd-c81ee100e350\",\n \"memberId\": \"805ce40a-0000-464e-85ed-5bb052d8beb7\",\n \"paid\": false\n }'","response":"{\n \"order\": {\n \"id\": \"333fbc19-319b-4d1f-8e8f-cf68c6e7b30d\",\n \"planId\": \"b90475cd-94d0-4cb0-93dd-c81ee100e350\",\n \"subscriptionId\": \"485ccbfe-e880-492a-b221-a55ec4449937\",\n \"wixPayOrderId\": \"7494d9cf-3004-4101-b923-ffd07fbcf504\",\n \"buyer\": {\n \"memberId\": \"805ce40a-0000-464e-85ed-5bb052d8beb7\",\n \"contactId\": \"805ce40a-0000-464e-85ed-5bb052d8beb7\"\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"DAY\"\n },\n \"cycleCount\": 3\n },\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 3\n },\n \"price\": {\n \"subtotal\": \"100.00\",\n \"discount\": \"0\",\n \"tax\": {\n \"name\": \"Tax\",\n \"rate\": \"21\",\n \"amount\": \"21.00\"\n },\n \"total\": \"121.00\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"type\": \"OFFLINE\",\n \"status\": \"ACTIVE\",\n \"autoRenewCanceled\": false,\n \"lastPaymentStatus\": \"UNPAID\",\n \"startDate\": \"2022-06-02T07:52:51.237281Z\",\n \"endDate\": \"2022-06-05T07:52:51.237281Z\",\n \"earliestEndDate\": \"2022-06-05T07:52:51.237281Z\",\n \"currentCycle\": {\n \"index\": 1,\n \"startedDate\": \"2022-06-02T07:52:51.237281Z\",\n \"endedDate\": \"2022-06-03T07:52:51.237281Z\"\n },\n \"planName\": \"ExpensiveDay\",\n \"planPrice\": \"100\",\n \"createdDate\": \"2022-06-02T07:52:51.237281Z\",\n \"updatedDate\": \"2022-06-02T07:52:51.237281Z\"\n }\n}"}},{"name":"CreateOfflineOrder","serviceName":"CheckoutService","type":"METHOD","version":"v2","content":{"title":"Create a Paid Offline Order With a Future Start Date and Coupon","request":"curl -X POST \\\n 'https://www.wixapis.com/pricing-plans/v2/checkout/orders/offline' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"memberId\": \"805ce40a-9000-464e-85ed-5bb052d8beb7\",\n \"planId\": \"b90475cd-0000-4cb0-93dd-c81ee100e350\",\n \"startDate\": \"2022-06-25T16:23:00Z\",\n \"paid\": true,\n \"couponCode\": \"HalfOff\"\n }'","response":"{\n \"order\": {\n \"id\": \"519f5e34-f11d-483b-8add-58a6aa04b636\",\n \"planId\": \"b90475cd-0000-4cb0-93dd-c81ee100e350\",\n \"subscriptionId\": \"9d6881e5-36e7-47c5-bc0d-7df1079e405c\",\n \"wixPayOrderId\": \"14b2b144-2b61-43df-af63-563390a41fc0\",\n \"buyer\": {\n \"memberId\": \"805ce40a-9000-464e-85ed-5bb052d8beb7\",\n \"contactId\": \"805ce40a-9000-464e-85ed-5bb052d8beb7\"\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"DAY\"\n },\n \"cycleCount\": 3\n },\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 3\n },\n \"price\": {\n \"subtotal\": \"100.0\",\n \"coupon\": {\n \"code\": \"HalfOff\",\n \"amount\": \"50.0\",\n \"id\": \"00f5600a-dc3c-4067-8c6d-b5552a168aa1\"\n },\n \"discount\": \"50.0\",\n \"tax\": {\n \"name\": \"Tax\",\n \"rate\": \"21\",\n \"amount\": \"10.50\"\n },\n \"total\": \"60.50\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"type\": \"OFFLINE\",\n \"status\": \"ACTIVE\",\n \"autoRenewCanceled\": false,\n \"lastPaymentStatus\": \"PAID\",\n \"startDate\": \"2022-06-25T16:23:00Z\",\n \"endDate\": \"2022-06-28T16:23:00Z\",\n \"earliestEndDate\": \"2022-06-28T16:23:00Z\",\n \"planName\": \"ExpensiveDay\",\n \"planPrice\": \"100\",\n \"createdDate\": \"2022-06-02T07:47:13.469959Z\",\n \"updatedDate\": \"2022-06-02T07:47:13.469959Z\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Create Offline Order","slugifiedName":"create-offline-order"}},{"summary":"Get Offline Order Preview","description":"Performs a dry run of a purchase and provides an order preview.\n\nThe preview uses the same logic as purchasing a plan, but the preview is not saved. Because an order is not actually\ncreated, the preview order's `orderId` and `subscriptionId` are displayed as a string of multiple zero characters\n(`000000-0000`). Tax is only calculated if the site [has it configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection).\n
\nIf a pricing plan has a limit on the amount of purchases per buyer, that limit is not considered for generating the preview.\nBut, if that limit has been reached and this order would then exceed the amount of purchases permitted for this buyer, then\n`purchaseLimitExceeded` will return as `true`.\n\nTo get a general price preview for a plan that's not buyer-specific, use [Get Price Preview](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/get-price-preview).","operationId":"com.wixpress.membership.v2.orders.CheckoutService.GetOfflineOrderPreview","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.GetOfflineOrderPreviewResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/pricing-plans/v2/checkout","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/checkout","destinationPath":"/v2/checkout","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"GetOfflineOrderPreviewRequest","description":"","properties":{"planId":{"description":"ID of the plan of the previewed order. See [Plans for more information about plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans).","format":"GUID","title":"planId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"memberId":{"description":"Member ID of the buyer the previewed order is for. See [Members for more information about member IDs](https://dev.wix.com/api/rest/members/members).","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"startDate":{"description":"Start date and time for plan of the previewed order.\n\nDefault: Current date and time","title":"startDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"couponCode":{"description":"Coupon code to apply. See [Coupons to learn more](https://dev.wix.com/api/rest/coupons).","minLength":1,"maxLength":20,"title":"couponCode","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["planId","memberId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.orders.CheckoutService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_IS_DISABLED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_USAGE_EXCEEDED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_IS_NOT_ACTIVE_YET","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_HAS_EXPIRED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_DOES_NOT_EXIST","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_INVALID_SUBTOTAL","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"}],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"}],"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.orders.GetOfflineOrderPreviewRequest","responseMessage":"com.wixpress.membership.v2.orders.GetOfflineOrderPreviewResponse"},"legacyExamples":[{"name":"GetOfflineOrderPreview","serviceName":"CheckoutService","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/pricing-plans/v2/checkout/orders/preview-offline' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"planId\": \"5779edd3-2994-4bf4-acfe-d739ad2d95bd\",\n \"memberId\": \"805ce40a-9000-464e-85ed-5bb052d8beb7\",\n \"startDate\": \"2022-07-08T00:00:00Z\"\n }'\n~~~","response":"~~~json\n{\n \"order\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"planId\": \"5779edd3-2994-4bf4-acfe-d739ad2d95bd\",\n \"subscriptionId\": \"00000000-0000-0000-0000-000000000000\",\n \"buyer\": {\n \"memberId\": \"805ce40a-9000-464e-85ed-5bb052d8beb7\",\n \"contactId\": \"805ce40a-9000-464e-85ed-5bb052d8beb7\"\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 0\n },\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 1\n },\n \"price\": {\n \"subtotal\": \"15.0\",\n \"coupon\": {\n \"code\": \"FirstHalfOff\",\n \"amount\": \"7.5\",\n \"id\": \"f841bd4a-a053-43e5-b855-204ea6c06188\"\n },\n \"discount\": \"7.5\",\n \"tax\": {\n \"name\": \"Tax\",\n \"rate\": \"21\",\n \"amount\": \"1.58\"\n },\n \"total\": \"9.08\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"duration\": {\n \"cycleFrom\": 2\n },\n \"price\": {\n \"subtotal\": \"15.00\",\n \"discount\": \"0\",\n \"tax\": {\n \"name\": \"Tax\",\n \"rate\": \"21\",\n \"amount\": \"3.15\"\n },\n \"total\": \"18.15\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"type\": \"OFFLINE\",\n \"status\": \"ACTIVE\",\n \"autoRenewCanceled\": false,\n \"lastPaymentStatus\": \"PAID\",\n \"startDate\": \"2022-07-08T00:00:00Z\",\n \"planName\": \"Gym membership\",\n \"planDescription\": \"Get fit fast\",\n \"planPrice\": \"15\",\n \"createdDate\": \"2022-06-02T11:29:30.052417Z\",\n \"updatedDate\": \"2022-06-02T11:29:30.052417Z\"\n },\n \"purchaseLimitExceeded\": false\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v2/checkout/orders/preview-offline","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.orders.CheckoutService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_IS_DISABLED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_USAGE_EXCEEDED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_IS_NOT_ACTIVE_YET","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_HAS_EXPIRED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_DOES_NOT_EXIST","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_INVALID_SUBTOTAL","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"}],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"}],"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.orders.GetOfflineOrderPreviewRequest","responseMessage":"com.wixpress.membership.v2.orders.GetOfflineOrderPreviewResponse"},"legacyExamples":[{"name":"GetOfflineOrderPreview","serviceName":"CheckoutService","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/pricing-plans/v2/checkout/orders/preview-offline' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"planId\": \"5779edd3-2994-4bf4-acfe-d739ad2d95bd\",\n \"memberId\": \"805ce40a-9000-464e-85ed-5bb052d8beb7\",\n \"startDate\": \"2022-07-08T00:00:00Z\"\n }'\n~~~","response":"~~~json\n{\n \"order\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"planId\": \"5779edd3-2994-4bf4-acfe-d739ad2d95bd\",\n \"subscriptionId\": \"00000000-0000-0000-0000-000000000000\",\n \"buyer\": {\n \"memberId\": \"805ce40a-9000-464e-85ed-5bb052d8beb7\",\n \"contactId\": \"805ce40a-9000-464e-85ed-5bb052d8beb7\"\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 0\n },\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 1\n },\n \"price\": {\n \"subtotal\": \"15.0\",\n \"coupon\": {\n \"code\": \"FirstHalfOff\",\n \"amount\": \"7.5\",\n \"id\": \"f841bd4a-a053-43e5-b855-204ea6c06188\"\n },\n \"discount\": \"7.5\",\n \"tax\": {\n \"name\": \"Tax\",\n \"rate\": \"21\",\n \"amount\": \"1.58\"\n },\n \"total\": \"9.08\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"duration\": {\n \"cycleFrom\": 2\n },\n \"price\": {\n \"subtotal\": \"15.00\",\n \"discount\": \"0\",\n \"tax\": {\n \"name\": \"Tax\",\n \"rate\": \"21\",\n \"amount\": \"3.15\"\n },\n \"total\": \"18.15\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"type\": \"OFFLINE\",\n \"status\": \"ACTIVE\",\n \"autoRenewCanceled\": false,\n \"lastPaymentStatus\": \"PAID\",\n \"startDate\": \"2022-07-08T00:00:00Z\",\n \"planName\": \"Gym membership\",\n \"planDescription\": \"Get fit fast\",\n \"planPrice\": \"15\",\n \"createdDate\": \"2022-06-02T11:29:30.052417Z\",\n \"updatedDate\": \"2022-06-02T11:29:30.052417Z\"\n },\n \"purchaseLimitExceeded\": false\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Offline Order Preview","slugifiedName":"get-offline-order-preview"}},{"summary":"Get Price Preview","description":"Retrieves a plan's pricing.\n\nThe price preview uses the same logic as purchasing a plan, but the preview is not saved. Tax is only applied if\nthe site [has it configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection). The price is returned\nin the [pricing model](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/introduction#wix-pricing-plans_pricing-plans_introduction_pricing-models) format used for orders.\n\nBuyers do not have to be logged in to preview the price, as such, the details returned are not buyer-specific. To\ngenerate a preview of a purchase for a specific buyer, use [Get Offline Order Preview](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/get-offline-order-preview).","operationId":"com.wixpress.membership.v2.orders.CheckoutService.GetPricePreview","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.GetPricePreviewResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/pricing-plans/v2/checkout","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/checkout","destinationPath":"/v2/checkout","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"GetPricePreviewRequest","description":"","properties":{"planId":{"description":"ID of plan to preview.","format":"GUID","title":"planId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"couponCode":{"description":"Coupon code to apply.\n\nSee Coupons [to learn more](https://dev.wix.com/api/rest/coupons).","minLength":1,"maxLength":20,"title":"couponCode","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["planId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.orders.CheckoutService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_IS_DISABLED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_USAGE_EXCEEDED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_IS_NOT_ACTIVE_YET","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_HAS_EXPIRED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_DOES_NOT_EXIST","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_INVALID_SUBTOTAL","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"}],"exposure":"PUBLIC","permissions":["PRICING_PLANS.READ_PUBLIC_PLANS"],"externalPermissionScopes":[{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"},{"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.orders.GetPricePreviewRequest","responseMessage":"com.wixpress.membership.v2.orders.GetPricePreviewResponse"},"legacyExamples":[{"name":"GetPricePreview","serviceName":"CheckoutService","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/pricing-plans/v2/checkout/orders/price-preview' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"planId\": \"5779edd3-2994-4bf4-acfe-d739ad2d95ad\",\n \"couponCode\": \"FirstHalfOff\"\n }'\n~~~","response":"~~~json\n{\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 1\n },\n \"price\": {\n \"subtotal\": \"13.70\",\n \"coupon\": {\n \"code\": \"FirstHalfOff\",\n \"amount\": \"7.5\",\n \"id\": \"f841bd4a-a053-43e5-b855-204ea6c06188\"\n },\n \"discount\": \"7.5\",\n \"tax\": {\n \"name\": \"Tax\",\n \"includedInPrice\": true,\n \"rate\": \"21\",\n \"amount\": \"1.30\"\n },\n \"total\": \"7.50\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"duration\": {\n \"cycleFrom\": 2\n },\n \"price\": {\n \"subtotal\": \"12.40\",\n \"discount\": \"0\",\n \"tax\": {\n \"name\": \"Tax\",\n \"includedInPrice\": true,\n \"rate\": \"21\",\n \"amount\": \"2.60\"\n },\n \"total\": \"15.00\",\n \"currency\": \"EUR\"\n }\n }\n ]\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v2/checkout/orders/price-preview","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.orders.CheckoutService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_IS_DISABLED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_USAGE_EXCEEDED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_IS_NOT_ACTIVE_YET","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_HAS_EXPIRED","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_DOES_NOT_EXIST","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ERROR_INVALID_SUBTOTAL","errorSchemaName":"com.wixpress.membership.v2.orders.CouponsError"}],"exposure":"PUBLIC","permissions":["PRICING_PLANS.READ_PUBLIC_PLANS"],"externalPermissionScopes":[{"name":"Read Pricing Plans","scopeId":"SCOPE.DC-PAIDPLANS.READ-PLANS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"},{"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.orders.GetPricePreviewRequest","responseMessage":"com.wixpress.membership.v2.orders.GetPricePreviewResponse"},"legacyExamples":[{"name":"GetPricePreview","serviceName":"CheckoutService","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/pricing-plans/v2/checkout/orders/price-preview' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"planId\": \"5779edd3-2994-4bf4-acfe-d739ad2d95ad\",\n \"couponCode\": \"FirstHalfOff\"\n }'\n~~~","response":"~~~json\n{\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 1\n },\n \"price\": {\n \"subtotal\": \"13.70\",\n \"coupon\": {\n \"code\": \"FirstHalfOff\",\n \"amount\": \"7.5\",\n \"id\": \"f841bd4a-a053-43e5-b855-204ea6c06188\"\n },\n \"discount\": \"7.5\",\n \"tax\": {\n \"name\": \"Tax\",\n \"includedInPrice\": true,\n \"rate\": \"21\",\n \"amount\": \"1.30\"\n },\n \"total\": \"7.50\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"duration\": {\n \"cycleFrom\": 2\n },\n \"price\": {\n \"subtotal\": \"12.40\",\n \"discount\": \"0\",\n \"tax\": {\n \"name\": \"Tax\",\n \"includedInPrice\": true,\n \"rate\": \"21\",\n \"amount\": \"2.60\"\n },\n \"total\": \"15.00\",\n \"currency\": \"EUR\"\n }\n }\n ]\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Price Preview","slugifiedName":"get-price-preview"}},{"summary":"Get Order","description":"Retrieves an order by ID.","operationId":"com.wixpress.membership.v2.orders.OrderManagementService.GetOrder","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Order ID.","x-wix-docs":{"exposure":"PUBLIC"}},{"name":"fieldSet","in":"query","description":"","required":false,"schema":{"description":"","title":"fieldSet","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.FieldSet.Set","x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.GetOrderResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/pricing-plans/v2/orders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/orders","destinationPath":"/v2/orders","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.READ_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"}],"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.orders.GetOrderRequest","responseMessage":"com.wixpress.membership.v2.orders.GetOrderResponse"},"legacyExamples":[{"name":"GetOrder","serviceName":"OrderManagementService","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n 'https://www.wixapis.com/pricing-plans/v2/orders/333fbc19-319b-4d1f-8e8f-cf68c6e7b30d' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"order\": {\n \"id\": \"333fbc19-319b-4d1f-8e8f-cf68c6e7b30d\",\n \"planId\": \"b90475cd-94d0-4cb0-93dd-c81ee100e350\",\n \"subscriptionId\": \"485ccbfe-e880-492a-b221-a55ec4449937\",\n \"wixPayOrderId\": \"7494d9cf-3004-4101-b923-ffd07fbcf504\",\n \"buyer\": {\n \"memberId\": \"805ce40a-0000-464e-85ed-5bb052d8beb7\",\n \"contactId\": \"805ce40a-0000-464e-85ed-5bb052d8beb7\"\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"DAY\"\n },\n \"cycleCount\": 3\n },\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 3\n },\n \"price\": {\n \"subtotal\": \"100.00\",\n \"discount\": \"0\",\n \"tax\": {\n \"name\": \"Tax\",\n \"rate\": \"21\",\n \"amount\": \"21.00\"\n },\n \"total\": \"121.00\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"type\": \"OFFLINE\",\n \"status\": \"ACTIVE\",\n \"autoRenewCanceled\": false,\n \"lastPaymentStatus\": \"UNPAID\",\n \"startDate\": \"2022-06-02T07:52:51.237281Z\",\n \"endDate\": \"2022-06-05T07:52:51.237281Z\",\n \"earliestEndDate\": \"2022-06-05T07:52:51.237281Z\",\n \"currentCycle\": {\n \"index\": 1,\n \"startedDate\": \"2022-06-02T07:52:51.237281Z\",\n \"endedDate\": \"2022-06-03T07:52:51.237281Z\"\n },\n \"planName\": \"ExpensiveDay\",\n \"planPrice\": \"100\",\n \"createdDate\": \"2022-06-02T07:52:51.237281Z\",\n \"updatedDate\": \"2022-06-02T07:52:51.237281Z\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v2/orders/{id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.READ_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"}],"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.orders.GetOrderRequest","responseMessage":"com.wixpress.membership.v2.orders.GetOrderResponse"},"legacyExamples":[{"name":"GetOrder","serviceName":"OrderManagementService","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n 'https://www.wixapis.com/pricing-plans/v2/orders/333fbc19-319b-4d1f-8e8f-cf68c6e7b30d' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"order\": {\n \"id\": \"333fbc19-319b-4d1f-8e8f-cf68c6e7b30d\",\n \"planId\": \"b90475cd-94d0-4cb0-93dd-c81ee100e350\",\n \"subscriptionId\": \"485ccbfe-e880-492a-b221-a55ec4449937\",\n \"wixPayOrderId\": \"7494d9cf-3004-4101-b923-ffd07fbcf504\",\n \"buyer\": {\n \"memberId\": \"805ce40a-0000-464e-85ed-5bb052d8beb7\",\n \"contactId\": \"805ce40a-0000-464e-85ed-5bb052d8beb7\"\n },\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"DAY\"\n },\n \"cycleCount\": 3\n },\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 3\n },\n \"price\": {\n \"subtotal\": \"100.00\",\n \"discount\": \"0\",\n \"tax\": {\n \"name\": \"Tax\",\n \"rate\": \"21\",\n \"amount\": \"21.00\"\n },\n \"total\": \"121.00\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"type\": \"OFFLINE\",\n \"status\": \"ACTIVE\",\n \"autoRenewCanceled\": false,\n \"lastPaymentStatus\": \"UNPAID\",\n \"startDate\": \"2022-06-02T07:52:51.237281Z\",\n \"endDate\": \"2022-06-05T07:52:51.237281Z\",\n \"earliestEndDate\": \"2022-06-05T07:52:51.237281Z\",\n \"currentCycle\": {\n \"index\": 1,\n \"startedDate\": \"2022-06-02T07:52:51.237281Z\",\n \"endedDate\": \"2022-06-03T07:52:51.237281Z\"\n },\n \"planName\": \"ExpensiveDay\",\n \"planPrice\": \"100\",\n \"createdDate\": \"2022-06-02T07:52:51.237281Z\",\n \"updatedDate\": \"2022-06-02T07:52:51.237281Z\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Order","slugifiedName":"order-management-service-get-order"}},{"summary":"Postpone End Date","description":"Extends the duration of a pricing plan order by postponing the order's `endDate`.\n\nNew `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.\nCan't postpone an order while it is [`PAUSED`](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/pause-order).","operationId":"com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Order ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.PostponeEndDateResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/pricing-plans/v2/orders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/orders","destinationPath":"/v2/orders","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"PostponeEndDateRequest","description":"","properties":{"endDate":{"description":"New end date and time.\n\nMust be later than the current end date and time.","title":"endDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["id","endDate"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Order End Date Postponed","description":"Triggered when an order's `endDate` is postponed.","permissions":["PRICING_PLANS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.membership.v2.orders.OrderEndDatePostponed"},"exposure":"PUBLIC","maturity":"BETA","slug":"end_date_postponed","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"}],"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.orders.PostponeEndDateRequest","responseMessage":"com.wixpress.membership.v2.orders.PostponeEndDateResponse"},"legacyExamples":[{"name":"PostponeEndDate","serviceName":"OrderManagementService","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X PATCH \\\n 'https://www.wixapis.com/pricing-plans/v2/orders/d5ce1234-c0a9-476c-abd3-c781bd589a78' \\\n -H 'Authorization: ' \\\n --data-raw '{\"endDate\":\"2022-10-26T13:45:53.129Z\"}'\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"patch","path":"/v2/orders/{id}","rpcOnly":false,"triggeredEvents":[{"title":"Order End Date Postponed","description":"Triggered when an order's `endDate` is postponed.","permissions":["PRICING_PLANS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.membership.v2.orders.OrderEndDatePostponed"},"exposure":"PUBLIC","maturity":"BETA","slug":"end_date_postponed","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"}],"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.orders.PostponeEndDateRequest","responseMessage":"com.wixpress.membership.v2.orders.PostponeEndDateResponse"},"legacyExamples":[{"name":"PostponeEndDate","serviceName":"OrderManagementService","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X PATCH \\\n 'https://www.wixapis.com/pricing-plans/v2/orders/d5ce1234-c0a9-476c-abd3-c781bd589a78' \\\n -H 'Authorization: ' \\\n --data-raw '{\"endDate\":\"2022-10-26T13:45:53.129Z\"}'\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Postpone End Date","slugifiedName":"postpone-end-date"}},{"summary":"List Orders","description":"Retrieves a list of orders and details, given the provided sorting and filtering.\n\nBy default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.\n`sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.","operationId":"com.wixpress.membership.v2.orders.OrderManagementService.ListOrders","parameters":[{"name":"buyerIds","in":"query","description":"Filter by a buyer's member ID. See [Members to learn more about a site's members](https://dev.wix.com/api/rest/members/members).","required":false,"schema":{"description":"Filter by a buyer's member ID. See [Members to learn more about a site's members](https://dev.wix.com/api/rest/members/members).","format":"GUID","title":"buyerIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"planIds","in":"query","description":"Filter by plan IDs. See [Plans to learn more about pricing plans](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans).","required":false,"schema":{"description":"Filter by plan IDs. See [Plans to learn more about pricing plans](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans).","format":"GUID","title":"planIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"autoRenewCanceled","in":"query","description":"Filter by whether or not the auto-renewal of recurring orders was canceled.","required":false,"schema":{"description":"Filter by whether or not the auto-renewal of recurring orders was canceled.","title":"autoRenewCanceled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"orderStatuses","in":"query","description":"Filter by order status.","required":false,"schema":{"description":"Filter by order status.","title":"orderStatuses","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"paymentStatuses","in":"query","description":"Filter by payment status.","required":false,"schema":{"description":"Filter by payment status.","title":"paymentStatuses","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"limit","in":"query","description":"Number of orders to return. See [Pagination](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_paging) for more information.\n\nMax: `50`","required":false,"schema":{"description":"Number of orders to return. See [Pagination](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_paging) for more information.\n\nMax: `50`","minimum":1,"maximum":50,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"offset","in":"query","description":"Number of orders to skip in the current sort order.","required":false,"schema":{"description":"Number of orders to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"sorting","in":"query","description":"Sort order.\n\nUse `ASC` for ascending order or `DESC` for descending order.\n\nDefault: `DESC`","required":false,"schema":{"description":"Sort order.\n\nUse `ASC` for ascending order or `DESC` for descending order.\n\nDefault: `DESC`","$ref":"#/components/schemas/wix.common.Sorting","summary":"sorting","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"fieldSet","in":"query","description":"Parameter to define amount of fields to return. FULL returns each order's submission data. Supported values: UNKNOWN_SET, BASIC, FULL","required":false,"schema":{"description":"Parameter to define amount of fields to return. FULL returns each order's submission data. Supported values: UNKNOWN_SET, BASIC, FULL","title":"fieldSet","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.FieldSet.Set","x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.ListOrdersResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/pricing-plans/v2/orders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/orders","destinationPath":"/v2/orders","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.READ_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"}],"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.orders.ListOrdersRequest","responseMessage":"com.wixpress.membership.v2.orders.ListOrdersResponse"},"legacyExamples":[{"name":"ListOrders","serviceName":"OrderManagementService","type":"METHOD","version":"v2","content":{"title":"List all orders","request":"curl -X GET \\\n 'https://www.wixapis.com/pricing-plans/v2/orders' \\\n -H 'Authorization: '","response":"{\n \"orders\": [\n {\n \"id\": \"757de76f-3961-48fe-a907-f17188e0dfbf\",\n \"planId\": \"8182ba9f-1528-4c6a-9f0c-751bc64ef629\",\n \"subscriptionId\": \"3bd036d6-5eed-472a-a74f-013f00a1e4dc\",\n \"wixPayOrderId\": \"d96b920d-87fa-4e50-95a1-bb21d46719ec\",\n \"buyer\": {\n \"memberId\": \"805ce40a-9000-464e-85ed-5bb052d8beb7\",\n \"contactId\": \"805ce40a-9000-464e-85ed-5bb052d8beb7\"\n },\n \"priceDetails\": {\n \"subtotal\": \"0.99\",\n \"discount\": \"0\",\n \"total\": \"0.99\",\n \"planPrice\": \"0.99\",\n \"currency\": \"EUR\",\n \"singlePaymentForDuration\": {\n \"count\": 3,\n \"unit\": \"MONTH\"\n }\n },\n \"pricing\": {\n \"singlePaymentForDuration\": {\n \"count\": 3,\n \"unit\": \"MONTH\"\n },\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 1\n },\n \"price\": {\n \"subtotal\": \"0.99\",\n \"discount\": \"0\",\n \"total\": \"0.99\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"type\": \"ONLINE\",\n \"status\": \"ACTIVE\",\n \"lastPaymentStatus\": \"PAID\",\n \"startDate\": \"2022-04-27T11:10:05.773Z\",\n \"endDate\": \"2022-07-27T11:10:05.773Z\",\n \"earliestEndDate\": \"2022-07-27T11:10:05.773Z\",\n \"currentCycle\": {\n \"index\": 1,\n \"startedDate\": \"2022-04-27T11:10:05.773Z\",\n \"endedDate\": \"2022-07-27T11:10:05.773Z\"\n },\n \"planName\": \"0,99\",\n \"planPrice\": \"0.99\",\n \"createdDate\": \"2022-04-27T11:10:05.773Z\",\n \"updatedDate\": \"2022-04-27T11:10:23.243Z\"\n },\n ...\n ]\n}"}},{"name":"ListOrders","serviceName":"OrderManagementService","type":"METHOD","version":"v2","order":1,"content":{"title":"List CANCELED or ENDED orders","request":"curl -X GET \\\n 'https://www.wixapis.com/pricing-plans/v2/orders?orderStatuses=CANCELED&orderStatuses=ENDED' \\\n -H 'Authorization: '","response":"{\n \"orders\": [\n {\n \"id\": \"982184d9-fd86-43e2-a1e1-37f5b96d2d1c\",\n \"planId\": \"ab4547ad-b584-4f71-aaba-3e951ef45f2b\",\n \"subscriptionId\": \"e4424ef6-c256-4bc0-a6e0-c0289faaf4c6\",\n \"buyer\": {\n \"memberId\": \"805ce40a-9000-464e-85ed-5bb052d8beb7\",\n \"contactId\": \"805ce40a-9000-464e-85ed-5bb052d8beb7\"\n },\n \"priceDetails\": {\n \"subtotal\": \"0\",\n \"discount\": \"0\",\n \"total\": \"0\",\n \"planPrice\": \"0\",\n \"currency\": \"EUR\",\n \"singlePaymentUnlimited\": true\n },\n \"pricing\": {\n \"singlePaymentUnlimited\": true,\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1\n },\n \"price\": {\n \"subtotal\": \"0\",\n \"discount\": \"0\",\n \"total\": \"0\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"type\": \"ONLINE\",\n \"status\": \"CANCELED\",\n \"cancellation\": {\n \"cause\": \"MEMBER_ACTION\",\n \"effectiveAt\": \"IMMEDIATELY\"\n },\n \"lastPaymentStatus\": \"NOT_APPLICABLE\",\n \"startDate\": \"2022-02-03T11:48:30.792Z\",\n \"endDate\": \"2022-02-07T12:16:04.139Z\",\n \"planName\": \"Chess course+\",\n \"planDescription\": \"Beginner\",\n \"planPrice\": \"0\",\n \"createdDate\": \"2022-02-03T11:48:30.792Z\",\n \"updatedDate\": \"2022-02-07T12:16:04.218Z\"\n },\n ...\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v2/orders","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.READ_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"}],"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.orders.ListOrdersRequest","responseMessage":"com.wixpress.membership.v2.orders.ListOrdersResponse"},"legacyExamples":[{"name":"ListOrders","serviceName":"OrderManagementService","type":"METHOD","version":"v2","content":{"title":"List all orders","request":"curl -X GET \\\n 'https://www.wixapis.com/pricing-plans/v2/orders' \\\n -H 'Authorization: '","response":"{\n \"orders\": [\n {\n \"id\": \"757de76f-3961-48fe-a907-f17188e0dfbf\",\n \"planId\": \"8182ba9f-1528-4c6a-9f0c-751bc64ef629\",\n \"subscriptionId\": \"3bd036d6-5eed-472a-a74f-013f00a1e4dc\",\n \"wixPayOrderId\": \"d96b920d-87fa-4e50-95a1-bb21d46719ec\",\n \"buyer\": {\n \"memberId\": \"805ce40a-9000-464e-85ed-5bb052d8beb7\",\n \"contactId\": \"805ce40a-9000-464e-85ed-5bb052d8beb7\"\n },\n \"priceDetails\": {\n \"subtotal\": \"0.99\",\n \"discount\": \"0\",\n \"total\": \"0.99\",\n \"planPrice\": \"0.99\",\n \"currency\": \"EUR\",\n \"singlePaymentForDuration\": {\n \"count\": 3,\n \"unit\": \"MONTH\"\n }\n },\n \"pricing\": {\n \"singlePaymentForDuration\": {\n \"count\": 3,\n \"unit\": \"MONTH\"\n },\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 1\n },\n \"price\": {\n \"subtotal\": \"0.99\",\n \"discount\": \"0\",\n \"total\": \"0.99\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"type\": \"ONLINE\",\n \"status\": \"ACTIVE\",\n \"lastPaymentStatus\": \"PAID\",\n \"startDate\": \"2022-04-27T11:10:05.773Z\",\n \"endDate\": \"2022-07-27T11:10:05.773Z\",\n \"earliestEndDate\": \"2022-07-27T11:10:05.773Z\",\n \"currentCycle\": {\n \"index\": 1,\n \"startedDate\": \"2022-04-27T11:10:05.773Z\",\n \"endedDate\": \"2022-07-27T11:10:05.773Z\"\n },\n \"planName\": \"0,99\",\n \"planPrice\": \"0.99\",\n \"createdDate\": \"2022-04-27T11:10:05.773Z\",\n \"updatedDate\": \"2022-04-27T11:10:23.243Z\"\n },\n ...\n ]\n}"}},{"name":"ListOrders","serviceName":"OrderManagementService","type":"METHOD","version":"v2","order":1,"content":{"title":"List CANCELED or ENDED orders","request":"curl -X GET \\\n 'https://www.wixapis.com/pricing-plans/v2/orders?orderStatuses=CANCELED&orderStatuses=ENDED' \\\n -H 'Authorization: '","response":"{\n \"orders\": [\n {\n \"id\": \"982184d9-fd86-43e2-a1e1-37f5b96d2d1c\",\n \"planId\": \"ab4547ad-b584-4f71-aaba-3e951ef45f2b\",\n \"subscriptionId\": \"e4424ef6-c256-4bc0-a6e0-c0289faaf4c6\",\n \"buyer\": {\n \"memberId\": \"805ce40a-9000-464e-85ed-5bb052d8beb7\",\n \"contactId\": \"805ce40a-9000-464e-85ed-5bb052d8beb7\"\n },\n \"priceDetails\": {\n \"subtotal\": \"0\",\n \"discount\": \"0\",\n \"total\": \"0\",\n \"planPrice\": \"0\",\n \"currency\": \"EUR\",\n \"singlePaymentUnlimited\": true\n },\n \"pricing\": {\n \"singlePaymentUnlimited\": true,\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1\n },\n \"price\": {\n \"subtotal\": \"0\",\n \"discount\": \"0\",\n \"total\": \"0\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"type\": \"ONLINE\",\n \"status\": \"CANCELED\",\n \"cancellation\": {\n \"cause\": \"MEMBER_ACTION\",\n \"effectiveAt\": \"IMMEDIATELY\"\n },\n \"lastPaymentStatus\": \"NOT_APPLICABLE\",\n \"startDate\": \"2022-02-03T11:48:30.792Z\",\n \"endDate\": \"2022-02-07T12:16:04.139Z\",\n \"planName\": \"Chess course+\",\n \"planDescription\": \"Beginner\",\n \"planPrice\": \"0\",\n \"createdDate\": \"2022-02-03T11:48:30.792Z\",\n \"updatedDate\": \"2022-02-07T12:16:04.218Z\"\n },\n ...\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"List Orders","slugifiedName":"order-management-service-list-orders"}},{"summary":"Cancel Order","description":"Cancels an existing order.\n\nFor orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.\nFor orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.\n\n#### Canceling during the free trial period.\n\nWhen a buyer cancels their order during the free trial period, the buyer's subscription expires at the end\nof the free trial period and they will not be billed. The buyer may continue using the benefits until the end\nof the free trial period.\n\nWhen a site owner cancels an ordered plan during the free trial period, they choose to apply the cancellation\n`IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer\nimmediately, even during the free trial period and the buyer won't be billed. Canceling at the\n`NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.\nThen, the subscription ends and the buyer is not billed.","operationId":"com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Order ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.CancelOrderResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/pricing-plans/v2/orders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/orders","destinationPath":"/v2/orders","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CancelOrderRequest","description":"","properties":{"effectiveAt":{"description":"__Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.","title":"effectiveAt","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.CancellationEffectiveAtEnum.CancellationEffectiveAt","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["id","effectiveAt"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Order Canceled","description":"Triggered when an order is canceled (covers both immediate cancellation and cancellation that takes effect at the next payment date).","permissions":["PRICING_PLANS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.membership.v2.orders.OrderCanceled"},"exposure":"PUBLIC","maturity":"BETA","slug":"canceled","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"}],"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.orders.CancelOrderRequest","responseMessage":"com.wixpress.membership.v2.orders.CancelOrderResponse"},"legacyExamples":[{"name":"CancelOrder","serviceName":"OrderManagementService","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/pricing-plans/v2/orders/d5ce1234-c0a9-476c-abd3-c781bd589a78/cancel' \\\n -H 'Authorization: ' \\\n --data-raw '{\"effectiveAt\":\"IMMEDIATELY\"}'\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v2/orders/{id}/cancel","rpcOnly":false,"triggeredEvents":[{"title":"Order Canceled","description":"Triggered when an order is canceled (covers both immediate cancellation and cancellation that takes effect at the next payment date).","permissions":["PRICING_PLANS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.membership.v2.orders.OrderCanceled"},"exposure":"PUBLIC","maturity":"BETA","slug":"canceled","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"}],"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.orders.CancelOrderRequest","responseMessage":"com.wixpress.membership.v2.orders.CancelOrderResponse"},"legacyExamples":[{"name":"CancelOrder","serviceName":"OrderManagementService","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/pricing-plans/v2/orders/d5ce1234-c0a9-476c-abd3-c781bd589a78/cancel' \\\n -H 'Authorization: ' \\\n --data-raw '{\"effectiveAt\":\"IMMEDIATELY\"}'\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Cancel Order","slugifiedName":"cancel-order"}},{"summary":"Mark As Paid","description":"Marks an offline order as paid.\n> __Note__: Marking separate payment cycles as paid is not yet supported. The entire order will be marked as paid.","operationId":"com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Order ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.MarkAsPaidResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/pricing-plans/v2/orders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/orders","destinationPath":"/v2/orders","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"MarkAsPaidRequest","description":"","properties":{},"deprecated":false,"required":["id"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Order Marked As Paid","description":"Triggered when an offline order is marked as paid.","permissions":["PRICING_PLANS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.membership.v2.orders.OrderMarkedAsPaid"},"exposure":"PUBLIC","maturity":"BETA","slug":"marked_as_paid","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"}],"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.orders.MarkAsPaidRequest","responseMessage":"com.wixpress.membership.v2.orders.MarkAsPaidResponse"},"legacyExamples":[{"name":"MarkAsPaid","serviceName":"OrderManagementService","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/pricing-plans/v2/orders/d5ce1234-c0a9-476c-abd3-c78aa8589a78/mark-as-paid' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v2/orders/{id}/mark-as-paid","rpcOnly":false,"triggeredEvents":[{"title":"Order Marked As Paid","description":"Triggered when an offline order is marked as paid.","permissions":["PRICING_PLANS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.membership.v2.orders.OrderMarkedAsPaid"},"exposure":"PUBLIC","maturity":"BETA","slug":"marked_as_paid","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"}],"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.orders.MarkAsPaidRequest","responseMessage":"com.wixpress.membership.v2.orders.MarkAsPaidResponse"},"legacyExamples":[{"name":"MarkAsPaid","serviceName":"OrderManagementService","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/pricing-plans/v2/orders/d5ce1234-c0a9-476c-abd3-c78aa8589a78/mark-as-paid' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Mark As Paid","slugifiedName":"mark-as-paid"}},{"summary":"Pause Order","description":"Pauses an order.\n\nFor orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.\nPausing an order affects the end date of the order by adding the time the order is paused to the `endDate`. Can only pause orders with an `ACTIVE` status.\n\nUse [Resume Order to resume a paused order](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/resume-order/).","operationId":"com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Order ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.PauseOrderResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/pricing-plans/v2/orders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/orders","destinationPath":"/v2/orders","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"PauseOrderRequest","description":"","properties":{},"deprecated":false,"required":["id"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Order Paused","description":"Triggered when an order is paused.","permissions":["PRICING_PLANS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.membership.v2.orders.OrderPaused"},"exposure":"PUBLIC","maturity":"BETA","slug":"paused","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"}],"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.orders.PauseOrderRequest","responseMessage":"com.wixpress.membership.v2.orders.PauseOrderResponse"},"legacyExamples":[{"name":"PauseOrder","serviceName":"OrderManagementService","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/pricing-plans/v2/orders/9e2f0450-f8ab-4459-a4a9-a851ebbd12d1/pause' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v2/orders/{id}/pause","rpcOnly":false,"triggeredEvents":[{"title":"Order Paused","description":"Triggered when an order is paused.","permissions":["PRICING_PLANS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.membership.v2.orders.OrderPaused"},"exposure":"PUBLIC","maturity":"BETA","slug":"paused","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"}],"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.orders.PauseOrderRequest","responseMessage":"com.wixpress.membership.v2.orders.PauseOrderResponse"},"legacyExamples":[{"name":"PauseOrder","serviceName":"OrderManagementService","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/pricing-plans/v2/orders/9e2f0450-f8ab-4459-a4a9-a851ebbd12d1/pause' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Pause Order","slugifiedName":"pause-order"}},{"summary":"Resume Order","description":"Resumes a paused order.\n\nUpdates `endDate` by adding the time the plan was paused.\nFor orders with recurring payments, it also restarts the payment schedule.\nUse [Pause Order to pause an order](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/pause-order/).","operationId":"com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Order ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.ResumeOrderResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/pricing-plans/v2/orders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/pricing-plans/v2/orders","destinationPath":"/v2/orders","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"ResumeOrderRequest","description":"","properties":{},"deprecated":false,"required":["id"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Order Resumed","description":"Triggered when a paused order is resumed.","permissions":["PRICING_PLANS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.membership.v2.orders.OrderResumed"},"exposure":"PUBLIC","maturity":"BETA","slug":"resumed","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"}],"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.orders.ResumeOrderRequest","responseMessage":"com.wixpress.membership.v2.orders.ResumeOrderResponse"},"legacyExamples":[{"name":"ResumeOrder","serviceName":"OrderManagementService","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/pricing-plans/v2/orders/9e2f0450-f8ab-4459-a4a9-a851ebbd12d1/resume' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v2/orders/{id}/resume","rpcOnly":false,"triggeredEvents":[{"title":"Order Resumed","description":"Triggered when a paused order is resumed.","permissions":["PRICING_PLANS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.membership.v2.orders.OrderResumed"},"exposure":"PUBLIC","maturity":"BETA","slug":"resumed","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","errors":[],"exposure":"PUBLIC","permissions":["PRICING_PLANS.MANAGE_ORDERS"],"externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"}],"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.orders.ResumeOrderRequest","responseMessage":"com.wixpress.membership.v2.orders.ResumeOrderResponse"},"legacyExamples":[{"name":"ResumeOrder","serviceName":"OrderManagementService","type":"METHOD","version":"v2","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/pricing-plans/v2/orders/9e2f0450-f8ab-4459-a4a9-a851ebbd12d1/resume' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Resume Order","slugifiedName":"resume-order"}}],"webhooks":[{"summary":"Order Canceled","title":"Order Canceled","description":"Triggered when an order is canceled.\n\nThis webhook is triggered either immediately or at the end of the current payment cycle, as follows:\n+ If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.\n+ If the order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`, the webhook is triggered at the end of the current payment cycle. In this case, the [Order Auto Renew Canceled Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-auto-renew-canceled-webhook) is triggered immediately.","permissions":["PRICING_PLANS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.membership.v2.orders.OrderCanceled"},"exposure":"PUBLIC","maturity":"BETA","slug":"canceled","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.member.MemberOrdersService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"}],"eventType":"wix.pricing_plans.v2.order_canceled","legacyExamples":[{"name":"OrderCanceled","eventType":"CANCELED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"351700dd-379b-4edb-958e-03ac1068272c\",\n \"entityFqdn\": \"wix.pricing_plans.v2.order\",\n \"slug\": \"canceled\",\n \"entityId\": \"6aaf747a-d1cf-49f4-a9bb-b2e9ec7b5bbc\",\n \"actionEvent\": {\n \"body\": {\n \"order\": {\n \"endDate\": \"2021-11-18T13:51:54.085Z\",\n \"subscriptionId\": \"ba119827-5621-43ae-aa61-ec99537d40ee\",\n \"pausePeriods\": [],\n \"planName\": \"Test Plan\",\n \"id\": \"6aaf747a-d1cf-49f4-a9bb-b2e9ec7b5bbc\",\n \"cancellation\": {\n \"cause\": \"OWNER_ACTION\",\n \"effectiveAt\": \"IMMEDIATELY\"\n },\n \"buyer\": {\n \"memberId\": \"a9811e3f-7282-4ed7-a220-f9115ac37e46\",\n \"contactId\": \"a9811e3f-7282-4ed7-a220-f9115ac37e46\"\n },\n \"lastPaymentStatus\": \"NOT_APPLICABLE\",\n \"status\": \"CANCELED\",\n \"planDescription\": \"\",\n \"type\": \"ONLINE\",\n \"planId\": \"a3cc1a92-a92b-43c2-9db8-f64b9391bb7d\",\n \"startDate\": \"2021-11-18T13:47:43.512Z\",\n \"updatedDate\": \"2021-11-18T13:51:54.229581Z\",\n \"pricing\": {\n \"singlePaymentUnlimited\": true,\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 1\n },\n \"price\": {\n \"subtotal\": \"272.73\",\n \"discount\": \"0\",\n \"tax\": {\n \"name\": \"Tax\",\n \"includedInPrice\": true,\n \"rate\": \"21\",\n \"amount\": \"57.27\"\n },\n \"total\": \"330.00\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"planPrice\": \"330\",\n \"createdDate\": \"2021-11-18T13:47:43.512Z\"\n }\n }\n },\n \"eventTime\": \"2021-11-18T13:51:54.349781Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.OrderCanceled","contentLink":{"displayName":"Order Canceled","slugifiedName":"order-canceled"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Order Created","title":"Order Created","description":"Triggered when an order is created.","permissions":["PRICING_PLANS.READ_ORDERS"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.CheckoutService","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"}],"legacyExamples":[{"name":"OrderCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"2d349c04-7c6f-424f-b948-86d0a61481c7\",\n \"entityFqdn\": \"wix.pricing_plans.v2.order\",\n \"slug\": \"created\",\n \"entityId\": \"5f99efdb-5d56-d8c1-9d6c-298230054c63\",\n \"createdEvent\": {\n \"entity\": {\n \"subscriptionId\": \"558aad5d-3529-4a89-be79-14e77d15e3c7\",\n \"pausePeriods\": [],\n \"planName\": \"Test Plan\",\n \"id\": \"5f99efdb-5d56-d8c1-9d6c-298230054c63\",\n \"buyer\": {\n \"memberId\": \"6bb98a18-dc53-4236-ad88-e4ab6b8de60d\",\n \"contactId\": \"6bb98a18-dc53-4236-ad88-e4ab6b8de60d\"\n },\n \"lastPaymentStatus\": \"NOT_APPLICABLE\",\n \"status\": \"ACTIVE\",\n \"planDescription\": \"\",\n \"type\": \"ONLINE\",\n \"planId\": \"a3cc1a92-a92b-43c2-9db8-f64b9391bb7d\",\n \"startDate\": \"2021-11-18T15:01:52.940526Z\",\n \"updatedDate\": \"2021-11-18T15:01:52.940526Z\",\n \"pricing\": {\n \"singlePaymentUnlimited\": true,\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 1\n },\n \"price\": {\n \"subtotal\": \"272.73\",\n \"discount\": \"0\",\n \"tax\": {\n \"name\": \"Tax\",\n \"includedInPrice\": true,\n \"rate\": \"21\",\n \"amount\": \"57.27\"\n },\n \"total\": \"330.00\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"planPrice\": \"330\",\n \"createdDate\": \"2021-11-18T15:01:52.940526Z\"\n }\n },\n \"eventTime\": \"2021-11-18T15:01:53.309863Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","contentLink":{"displayName":"Order Created","slugifiedName":"order-created"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Order Updated","title":"Order Updated","description":"Triggered when an order is updated.\n\nOrder Updated Webhook is triggered when any of the following happens:\n+ Order is paid for. [Order Purchased Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-purchased-webhook) is also triggered.\n+ Order reaches its start date or end date. [Order Started Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-started-webhook) and [Order Ended Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-ended-webhook), respectively, are also triggered.\n+ New payment cycle of an order starts. [Order Cycle Started Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-cycle-started-webhook) is also triggered.\n+ Offline order is marked as paid. [Order Marked As Paid Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-marked-as-paid-webhook) is also triggered.\n+ End date of the order is postponed. [Order End Date Postponed Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-end-date-postponed-webhook) is also triggered\n+ Order is paused, or a paused order is resumed. [Order Paused Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-paused-webhook)\nand [Order Resumed Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-resumed-webhook), respectively, are also triggered.\n+ Order is canceled, either immediately or at the end of the payment cycle. [Order Canceled Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-canceled-webhook)\nand [Order Auto Renew Canceled Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-auto-renew-canceled-webhook) are also triggered.","permissions":["PRICING_PLANS.READ_ORDERS"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.CheckoutService","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"}],"legacyExamples":[{"name":"OrderUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"51d0cc51-c9d3-406c-a5c8-a8d54cf6707e\",\n \"entityFqdn\": \"wix.pricing_plans.v2.order\",\n \"slug\": \"updated\",\n \"entityId\": \"5aeff997-ecaa-4c1f-9c45-c5f4a511134a\",\n \"updatedEvent\": {\n \"currentEntity\": {\n \"endDate\": \"2022-02-20T10:25:10.816Z\",\n \"subscriptionId\": \"92c27aa1-e037-4a0e-99f4-3a6104d078bf\",\n \"pausePeriods\": [],\n \"planName\": \"Test Plan\",\n \"id\": \"5aeff997-ecaa-4c1f-9c45-c5f4a511134a\",\n \"buyer\": {\n \"memberId\": \"6bb98a18-dc53-4236-ad88-e4ab6b8de60d\",\n \"contactId\": \"6bb98a18-dc53-4236-ad88-e4ab6b8de60d\"\n },\n \"lastPaymentStatus\": \"PENDING\",\n \"status\": \"ACTIVE\",\n \"planDescription\": \"\",\n \"wixPayOrderId\": \"289c289a-a18a-4ad2-ae14-9ebdbbc2fdcb\",\n \"autoRenewCanceled\": false,\n \"type\": \"ONLINE\",\n \"planId\": \"289a9a2a-a18a-4ad2-ae14-9ebdbbc2fdcb\",\n \"startDate\": \"2021-11-19T10:25:10.816Z\",\n \"updatedDate\": \"2021-11-19T10:25:10.816Z\",\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 0\n },\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 1\n },\n \"price\": {\n \"subtotal\": \"15.0\",\n \"coupon\": {\n \"code\": \"FirstHalfOff\",\n \"amount\": \"7.5\",\n \"id\": \"f841bd4a-a053-43e5-b855-204ea6c06188\"\n },\n \"discount\": \"7.5\",\n \"tax\": {\n \"name\": \"Tax\",\n \"rate\": \"21\",\n \"amount\": \"1.58\"\n },\n \"total\": \"9.08\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"duration\": {\n \"cycleFrom\": 2\n },\n \"price\": {\n \"subtotal\": \"15.00\",\n \"discount\": \"0\",\n \"tax\": {\n \"name\": \"Tax\",\n \"rate\": \"21\",\n \"amount\": \"3.15\"\n },\n \"total\": \"18.15\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"currentCycle\": {\n \"index\": 1,\n \"startedDate\": \"2021-11-19T10:25:10.816Z\",\n \"endedDate\": \"2021-12-20T10:25:10.816Z\"\n },\n \"planPrice\": \"15\",\n \"createdDate\": \"2021-11-19T10:25:10.816Z\"\n }\n },\n \"eventTime\": \"2021-11-19T10:27:29.183090Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","contentLink":{"displayName":"Order Updated","slugifiedName":"order-updated"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Order Purchased","title":"Order Purchased","description":"Triggered when an order is purchased.\n\nThis webhook is triggered for any of the following events:\n+ Order is paid in full.\n+ At least 1 order cycle payment is paid for.\n+ Offline order is created, even if not yet marked as paid.\n+ Free order is created.","permissions":["PRICING_PLANS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.membership.v2.orders.OrderPurchased"},"exposure":"PUBLIC","maturity":"BETA","slug":"purchased","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"}],"legacyExamples":[{"name":"OrderPurchased","eventType":"PURCHASED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"1ca4c4b1-80f6-4436-8bc5-cc6420f75b19\",\n \"entityFqdn\": \"wix.pricing_plans.v2.order\",\n \"slug\": \"purchased\",\n \"entityId\": \"5f99efdb-5d56-d8c1-9d6c-298230054c63\",\n \"actionEvent\": {\n \"body\": {\n \"order\": {\n \"subscriptionId\": \"558aad5d-3529-4a89-be79-14e77d15e3c7\",\n \"pausePeriods\": [],\n \"planName\": \"Forever\",\n \"id\": \"5f99efdb-5d56-d8c1-9d6c-298230054c63\",\n \"buyer\": {\n \"memberId\": \"6bb98a18-dc53-4236-ad88-e4ab6b8de60d\",\n \"contactId\": \"6bb98a18-dc53-4236-ad88-e4ab6b8de60d\"\n },\n \"lastPaymentStatus\": \"NOT_APPLICABLE\",\n \"status\": \"ACTIVE\",\n \"planDescription\": \"\",\n \"type\": \"ONLINE\",\n \"planId\": \"a3cc1a92-a92b-43c2-9db8-f64b9391bb7d\",\n \"startDate\": \"2021-11-18T15:01:52.940526Z\",\n \"updatedDate\": \"2021-11-18T15:01:52.940526Z\",\n \"pricing\": {\n \"singlePaymentUnlimited\": true,\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 1\n },\n \"price\": {\n \"subtotal\": \"272.73\",\n \"discount\": \"0\",\n \"tax\": {\n \"name\": \"Tax\",\n \"includedInPrice\": true,\n \"rate\": \"21\",\n \"amount\": \"57.27\"\n },\n \"total\": \"330.00\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"currentCycle\": {\n \"index\": 1,\n \"startedDate\": \"2021-11-18T15:01:52.940526Z\"\n },\n \"planPrice\": \"330\",\n \"createdDate\": \"2021-11-18T15:01:52.940526Z\"\n }\n }\n },\n \"eventTime\": \"2021-11-18T15:01:53.314417Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.OrderPurchased","contentLink":{"displayName":"Order Purchased","slugifiedName":"order-purchased"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Order Started","title":"Order Started","description":"Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.","permissions":["PRICING_PLANS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.membership.v2.orders.OrderStarted"},"exposure":"PUBLIC","maturity":"BETA","slug":"started","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"}],"legacyExamples":[{"name":"OrderStarted","eventType":"STARTED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"6ac3128a-916c-4177-b966-df34b40d52e4\",\n \"entityFqdn\": \"wix.pricing_plans.v2.order\",\n \"slug\": \"started\",\n \"entityId\": \"5f99efdb-5d56-d8c1-9d6c-298230054c63\",\n \"actionEvent\": {\n \"body\": {\n \"order\": {\n \"subscriptionId\": \"558aad5d-3529-4a89-be79-14e77d15e3c7\",\n \"pausePeriods\": [],\n \"planName\": \"Forever\",\n \"id\": \"5f99efdb-5d56-d8c1-9d6c-298230054c63\",\n \"buyer\": {\n \"memberId\": \"6bb98a18-dc53-4236-ad88-e4ab6b8de60d\",\n \"contactId\": \"6bb98a18-dc53-4236-ad88-e4ab6b8de60d\"\n },\n \"lastPaymentStatus\": \"NOT_APPLICABLE\",\n \"status\": \"ACTIVE\",\n \"planDescription\": \"\",\n \"type\": \"ONLINE\",\n \"planId\": \"a3cc1a92-a92b-43c2-9db8-f64b9391bb7d\",\n \"startDate\": \"2021-11-18T15:01:52.940Z\",\n \"updatedDate\": \"2021-11-18T15:01:53.028Z\",\n \"pricing\": {\n \"singlePaymentUnlimited\": true,\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 1\n },\n \"price\": {\n \"subtotal\": \"272.73\",\n \"discount\": \"0\",\n \"tax\": {\n \"name\": \"Tax\",\n \"includedInPrice\": true,\n \"rate\": \"21\",\n \"amount\": \"57.27\"\n },\n \"total\": \"330.00\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"currentCycle\": {\n \"index\": 1,\n \"startedDate\": \"2021-11-18T15:01:52.940Z\"\n },\n \"planPrice\": \"330\",\n \"createdDate\": \"2021-11-18T15:01:52.940Z\"\n }\n }\n },\n \"eventTime\": \"2021-11-18T15:01:53.133879Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.OrderStarted","contentLink":{"displayName":"Order Started","slugifiedName":"order-started"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Order Cycle Started","title":"Order Cycle Started","description":"Triggered at the start of a new payment cycle for an existing order.\n\nThis webhook is not triggered at the initial start of an offline order.","permissions":["PRICING_PLANS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.membership.v2.orders.OrderCycleStarted"},"exposure":"PUBLIC","maturity":"BETA","slug":"cycle_started","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"}],"legacyExamples":[{"name":"OrderCycleStarted","eventType":"STARTED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"2fabeb5c-a9a4-4c75-ab0c-7634e317a5b7\",\n \"entityFqdn\": \"wix.pricing_plans.v2.order\",\n \"slug\": \"cycle_started\",\n \"entityId\": \"5aeff997-ecaa-4c1f-9c45-c5f4a511134a\",\n \"actionEvent\": {\n \"body\": {\n \"order\": {\n \"endDate\": \"2022-02-20T10:25:10.816Z\",\n \"subscriptionId\": \"92c27aa1-e037-4a0e-99f4-3a6104d078bf\",\n \"pausePeriods\": [],\n \"planName\": \"Test Plan\",\n \"id\": \"5aeff997-ecaa-4c1f-9c45-c5f4a511134a\",\n \"buyer\": {\n \"memberId\": \"6bb98a18-dc53-4236-ad88-e4ab6b8de60d\",\n \"contactId\": \"6bb98a18-dc53-4236-ad88-e4ab6b8de60d\"\n },\n \"lastPaymentStatus\": \"UNPAID\",\n \"status\": \"ACTIVE\",\n \"planDescription\": \"\",\n \"wixPayOrderId\": \"289c289a-a18a-4ad2-ae14-9ebdbbc2fdcb\",\n \"autoRenewCanceled\": false,\n \"type\": \"ONLINE\",\n \"planId\": \"289a9a2a-a18a-4ad2-ae14-9ebdbbc2fdcb\",\n \"startDate\": \"2021-11-19T10:25:10.816Z\",\n \"updatedDate\": \"2021-11-19T10:25:10.816Z\",\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 0\n },\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 1\n },\n \"price\": {\n \"subtotal\": \"15.0\",\n \"coupon\": {\n \"code\": \"FirstHalfOff\",\n \"amount\": \"7.5\",\n \"id\": \"f841bd4a-a053-43e5-b855-204ea6c06188\"\n },\n \"discount\": \"7.5\",\n \"tax\": {\n \"name\": \"Tax\",\n \"rate\": \"21\",\n \"amount\": \"1.58\"\n },\n \"total\": \"9.08\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"duration\": {\n \"cycleFrom\": 2\n },\n \"price\": {\n \"subtotal\": \"15.00\",\n \"discount\": \"0\",\n \"tax\": {\n \"name\": \"Tax\",\n \"rate\": \"21\",\n \"amount\": \"3.15\"\n },\n \"total\": \"18.15\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"currentCycle\": {\n \"index\": 0,\n \"startedDate\": \"2021-11-19T10:25:10.816Z\",\n \"endedDate\": \"2021-12-20T10:25:10.816Z\"\n },\n \"planPrice\": \"15\",\n \"freeTrialDays\": \"1\",\n \"createdDate\": \"2021-11-19T10:25:10.816Z\"\n },\n \"cycleNumber\": 0\n }\n },\n \"eventTime\": \"2021-11-19T10:27:28.810908Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.OrderCycleStarted","contentLink":{"displayName":"Order Cycle Started","slugifiedName":"order-cycle-started"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Order Auto Renew Canceled","title":"Order Auto Renew Canceled","description":"Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.\n\nThis webhook is *not* triggered in the following scenarios:\n+ When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, [Order Canceled](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-canceled-webhook) is triggered.\n+ When an order expires at the end of the current payment cycle because it was canceled and `effectiveAt` was set to `NEXT_PAYMENT_DATE`. Instead, at the time of expiration, [Order Canceled](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-canceled-webhook) and [Order Ended](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-ended-webhook) are triggered.","permissions":["PRICING_PLANS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.membership.v2.orders.OrderAutoRenewCanceled"},"exposure":"PUBLIC","maturity":"BETA","slug":"auto_renew_canceled","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"}],"legacyExamples":[{"name":"OrderAutoRenewCanceled","eventType":"CANCELED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"51a05655-54b9-420d-9420-5d6bb43509b2\",\n \"entityFqdn\": \"wix.pricing_plans.v2.order\",\n \"slug\": \"auto_renew_canceled\",\n \"entityId\": \"5aeff997-ecaa-4c1f-9c45-c5f4a511134a\",\n \"actionEvent\": {\n \"body\": {\n \"order\": {\n \"endDate\": \"2021-11-20T10:27:28.466Z\",\n \"subscriptionId\": \"92c27aa1-e037-4a0e-99f4-3a6104d078bf\",\n \"pausePeriods\": [],\n \"planName\": \"Test Plan\",\n \"id\": \"5aeff997-ecaa-4c1f-9c45-c5f4a511134a\",\n \"cancellation\": {\n \"cause\": \"MEMBER_ACTION\",\n \"effectiveAt\": \"NEXT_PAYMENT_DATE\"\n },\n \"buyer\": {\n \"memberId\": \"6bb98a18-dc53-4236-ad88-e4ab6b8de60d\",\n \"contactId\": \"6bb98a18-dc53-4236-ad88-e4ab6b8de60d\"\n },\n \"lastPaymentStatus\": \"PENDING\",\n \"status\": \"ACTIVE\",\n \"planDescription\": \"\",\n \"wixPayOrderId\": \"289c289a-a18a-4ad2-ae14-9ebdbbc2fdcb\",\n \"autoRenewCanceled\": true,\n \"type\": \"ONLINE\",\n \"planId\": \"289a9a2a-a18a-4ad2-ae14-9ebdbbc2fdcb\",\n \"startDate\": \"2021-11-19T10:25:10.816Z\",\n \"updatedDate\": \"2021-11-19T10:38:58.843372Z\",\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 0\n },\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 1\n },\n \"price\": {\n \"subtotal\": \"15.0\",\n \"coupon\": {\n \"code\": \"FirstHalfOff\",\n \"amount\": \"7.5\",\n \"id\": \"f841bd4a-a053-43e5-b855-204ea6c06188\"\n },\n \"discount\": \"7.5\",\n \"tax\": {\n \"name\": \"Tax\",\n \"rate\": \"21\",\n \"amount\": \"1.58\"\n },\n \"total\": \"9.08\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"duration\": {\n \"cycleFrom\": 2\n },\n \"price\": {\n \"subtotal\": \"15.00\",\n \"discount\": \"0\",\n \"tax\": {\n \"name\": \"Tax\",\n \"rate\": \"21\",\n \"amount\": \"3.15\"\n },\n \"total\": \"18.15\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"currentCycle\": {\n \"index\": 1,\n \"startedDate\": \"2021-11-20T10:25:10.816Z\",\n \"endedDate\": \"2021-12-20T10:25:10.816Z\"\n },\n \"planPrice\": \"15\",\n \"freeTrialDays\": \"1\",\n \"createdDate\": \"2021-11-19T10:25:10.816Z\"\n }\n }\n },\n \"eventTime\": \"2021-11-19T10:38:58.970492Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.OrderAutoRenewCanceled","contentLink":{"displayName":"Order Auto Renew Canceled","slugifiedName":"order-auto-renew-canceled"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Order Ended","title":"Order Ended","description":"Triggered when an order ends.\n\nThis webhook is triggered:\n+ When an order expires at the end of the current payment cycle.\n+ When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`..","permissions":["PRICING_PLANS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.membership.v2.orders.OrderEnded"},"exposure":"PUBLIC","maturity":"BETA","slug":"ended","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"}],"legacyExamples":[{"name":"OrderEnded","eventType":"ENDED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"17ee2c77-d40e-4339-ba7f-59cfd015476d\",\n \"entityFqdn\": \"wix.pricing_plans.v2.order\",\n \"slug\": \"ended\",\n \"entityId\": \"5aeff997-ecaa-4c1f-9c45-c5f4a511134a\",\n \"actionEvent\": {\n \"body\": {\n \"order\": {\n \"endDate\": \"2021-11-20T10:27:28.466Z\",\n \"subscriptionId\": \"92c27aa1-e037-4a0e-99f4-3a6104d078bf\",\n \"pausePeriods\": [],\n \"planName\": \"Test Plan\",\n \"id\": \"5aeff997-ecaa-4c1f-9c45-c5f4a511134a\",\n \"cancellation\": {\n \"cause\": \"MEMBER_ACTION\",\n \"effectiveAt\": \"NEXT_PAYMENT_DATE\"\n },\n \"buyer\": {\n \"memberId\": \"6bb98a18-dc53-4236-ad88-e4ab6b8de60d\",\n \"contactId\": \"6bb98a18-dc53-4236-ad88-e4ab6b8de60d\"\n },\n \"lastPaymentStatus\": \"PENDING\",\n \"status\": \"CANCELED\",\n \"planDescription\": \"\",\n \"wixPayOrderId\": \"289c289a-a18a-4ad2-ae14-9ebdbbc2fdcb\",\n \"autoRenewCanceled\": true,\n \"type\": \"ONLINE\",\n \"planId\": \"289a9a2a-a18a-4ad2-ae14-9ebdbbc2fdcb\",\n \"startDate\": \"2021-11-19T10:25:10.816Z\",\n \"updatedDate\": \"2021-11-19T10:38:58.843Z\",\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 12\n },\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 3\n },\n \"price\": {\n \"subtotal\": \"100.0\",\n \"coupon\": {\n \"code\": \"HalfOff\",\n \"amount\": \"50.0\",\n \"id\": \"00f5600a-dc3c-4067-8c6d-b5552a168aa1\"\n },\n \"discount\": \"50.0\",\n \"tax\": {\n \"name\": \"Tax\",\n \"rate\": \"21\",\n \"amount\": \"10.50\"\n },\n \"total\": \"60.50\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"planPrice\": \"100\",\n \"createdDate\": \"2021-11-19T10:25:10.816Z\"\n }\n }\n },\n \"eventTime\": \"2021-11-20T10:28:02.049392Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.OrderEnded","contentLink":{"displayName":"Order Ended","slugifiedName":"order-ended"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Order End Date Postponed","title":"Order End Date Postponed","description":"Triggered when an order's `endDate` is postponed.","permissions":["PRICING_PLANS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.membership.v2.orders.OrderEndDatePostponed"},"exposure":"PUBLIC","maturity":"BETA","slug":"end_date_postponed","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"}],"legacyExamples":[{"name":"OrderEndDatePostponed","eventType":"POSTPONED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"dabfedb7-0d06-4628-a201-0aee321b45ff\",\n \"entityFqdn\": \"wix.pricing_plans.v2.order\",\n \"slug\": \"end_date_postponed\",\n \"entityId\": \"1aaaefc9-d33b-4901-80b7-3d88735e1a8a\",\n \"actionEvent\": {\n \"body\": {\n \"order\": {\n \"endDate\": \"2022-10-31T22:00:00Z\",\n \"subscriptionId\": \"1990614e-c9c1-4ae0-aac5-6e47450fba69\",\n \"pausePeriods\": [],\n \"planName\": \"Test Plan\",\n \"id\": \"1aaaefc9-d33b-4901-80b7-3d88735e1a8a\",\n \"buyer\": {\n \"memberId\": \"6bb98a18-dc53-4236-ad88-e4ab6b8de60d\",\n \"contactId\": \"6bb98a18-dc53-4236-ad88-e4ab6b8de60d\"\n },\n \"lastPaymentStatus\": \"PAID\",\n \"status\": \"ACTIVE\",\n \"planDescription\": \"\",\n \"wixPayOrderId\": \"915433c9-d3ad-48b1-bbdc-d9b13d8f5085\",\n \"autoRenewCanceled\": false,\n \"type\": \"OFFLINE\",\n \"planId\": \"5ac01bd9-af20-4f2d-8f77-cb73ecd8bd2f\",\n \"startDate\": \"2021-10-28T08:22:09.347Z\",\n \"updatedDate\": \"2021-11-19T11:03:46.892813Z\",\n \"pricing\": {\n \"subscription\": {\n \"cycleDuration\": {\n \"count\": 1,\n \"unit\": \"MONTH\"\n },\n \"cycleCount\": 12\n },\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 3\n },\n \"price\": {\n \"subtotal\": \"100.0\",\n \"coupon\": {\n \"code\": \"HalfOff\",\n \"amount\": \"50.0\",\n \"id\": \"00f5600a-dc3c-4067-8c6d-b5552a168aa1\"\n },\n \"discount\": \"50.0\",\n \"tax\": {\n \"name\": \"Tax\",\n \"rate\": \"21\",\n \"amount\": \"10.50\"\n },\n \"total\": \"60.50\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"planPrice\": \"100\",\n \"createdDate\": \"2021-10-28T08:22:09.347Z\"\n }\n }\n },\n \"eventTime\": \"2021-11-19T11:03:47.038913Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.OrderEndDatePostponed","contentLink":{"displayName":"Order End Date Postponed","slugifiedName":"order-end-date-postponed"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Order Marked As Paid","title":"Order Marked As Paid","description":"Triggered when an offline order is marked as paid.","permissions":["PRICING_PLANS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.membership.v2.orders.OrderMarkedAsPaid"},"exposure":"PUBLIC","maturity":"BETA","slug":"marked_as_paid","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"}],"legacyExamples":[{"name":"OrderMarkedAsPaid","eventType":"PAID","type":"DOMAIN_EVENT","content":"{\n \"id\": \"ee99873a-f954-4bea-b432-fb5742d84514\",\n \"entityFqdn\": \"wix.pricing_plans.v2.order\",\n \"slug\": \"marked_as_paid\",\n \"entityId\": \"90a1d9ab-0ab7-43c0-9bc1-2b26c548a368\",\n \"actionEvent\": {\n \"body\": {\n \"order\": {\n \"endDate\": \"2022-02-19T11:06:02.739Z\",\n \"subscriptionId\": \"5e51fac5-0e7b-4123-88f4-ebd316d52498\",\n \"pausePeriods\": [],\n \"planName\": \"Test Plan\",\n \"id\": \"90a1d9ab-0ab7-43c0-9bc1-2b26c548a368\",\n \"buyer\": {\n \"memberId\": \"6bb98a18-dc53-4236-ad88-e4ab6b8de60d\",\n \"contactId\": \"6bb98a18-dc53-4236-ad88-e4ab6b8de60d\"\n },\n \"lastPaymentStatus\": \"PAID\",\n \"status\": \"ACTIVE\",\n \"planDescription\": \"\",\n \"wixPayOrderId\": \"3256209b-a967-4eff-bef4-5c809d6c6978\",\n \"autoRenewCanceled\": false,\n \"type\": \"OFFLINE\",\n \"planId\": \"289a9a2a-a18a-4ad2-ae14-9ebdbbc2fdcb\",\n \"startDate\": \"2021-11-19T11:06:02.739Z\",\n \"updatedDate\": \"2021-11-19T11:09:51.102454Z\",\n \"pricing\": {\n \"singlePaymentUnlimited\": true,\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 1\n },\n \"price\": {\n \"subtotal\": \"272.73\",\n \"discount\": \"0\",\n \"tax\": {\n \"name\": \"Tax\",\n \"includedInPrice\": true,\n \"rate\": \"21\",\n \"amount\": \"57.27\"\n },\n \"total\": \"330.00\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"planPrice\": \"330\",\n \"createdDate\": \"2021-11-19T11:06:19.377Z\"\n }\n }\n },\n \"eventTime\": \"2021-11-19T11:09:51.109621Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.OrderMarkedAsPaid","contentLink":{"displayName":"Order Marked As Paid","slugifiedName":"order-marked-as-paid"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Order Paused","title":"Order Paused","description":"Triggered when an order is paused.","permissions":["PRICING_PLANS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.membership.v2.orders.OrderPaused"},"exposure":"PUBLIC","maturity":"BETA","slug":"paused","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"}],"legacyExamples":[{"name":"OrderPaused","eventType":"PAUSED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"530f91f9-628b-43dc-a319-15bb47d7263c\",\n \"entityFqdn\": \"wix.pricing_plans.v2.order\",\n \"slug\": \"paused\",\n \"entityId\": \"5f99efdb-5d56-d8c1-9d6c-298230054c63\",\n \"actionEvent\": {\n \"body\": {\n \"order\": {\n \"subscriptionId\": \"558aad5d-3529-4a89-be79-14e77d15e3c7\",\n \"pausePeriods\": [\n {\n \"status\": \"ACTIVE\",\n \"pauseDate\": \"2021-11-19T10:40:46.661Z\"\n }\n ],\n \"planName\": \"Test Plan\",\n \"id\": \"5f99efdb-5d56-d8c1-9d6c-298230054c63\",\n \"buyer\": {\n \"memberId\": \"6bb98a18-dc53-4236-ad88-e4ab6b8de60d\",\n \"contactId\": \"6bb98a18-dc53-4236-ad88-e4ab6b8de60d\"\n },\n \"lastPaymentStatus\": \"NOT_APPLICABLE\",\n \"status\": \"PAUSED\",\n \"planDescription\": \"\",\n \"type\": \"ONLINE\",\n \"planId\": \"a3cc1a92-a92b-43c2-9db8-f64b9391bb7d\",\n \"startDate\": \"2021-11-18T15:01:52.940Z\",\n \"updatedDate\": \"2021-11-19T10:40:46.661858Z\",\n \"pricing\": {\n \"singlePaymentUnlimited\": true,\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 1\n },\n \"price\": {\n \"subtotal\": \"272.73\",\n \"discount\": \"0\",\n \"tax\": {\n \"name\": \"Tax\",\n \"includedInPrice\": true,\n \"rate\": \"21\",\n \"amount\": \"57.27\"\n },\n \"total\": \"330.00\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"planPrice\": \"330\",\n \"createdDate\": \"2021-11-18T15:01:52.940Z\"\n }\n }\n },\n \"eventTime\": \"2021-11-19T10:40:46.805912Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.OrderPaused","contentLink":{"displayName":"Order Paused","slugifiedName":"order-paused"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Order Resumed","title":"Order Resumed","description":"Triggered when a paused order is resumed.","permissions":["PRICING_PLANS.READ_ORDERS"],"payload":{"schemaName":"com.wixpress.membership.v2.orders.OrderResumed"},"exposure":"PUBLIC","maturity":"BETA","slug":"resumed","eventTopic":"domain_events_wix.pricing_plans.v2.order","serviceName":"com.wixpress.membership.v2.orders.OrderManagementService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Orders","scopeId":"SCOPE.DC-PAIDPLANS.MANAGE-ORDERS"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Orders","scopeId":"SCOPE.DC-PAIDPLANS.READ-ORDERS"}],"legacyExamples":[{"name":"OrderResumed","eventType":"RESUMED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"a5347825-7062-411e-b0be-281c494d9bb6\",\n \"entityFqdn\": \"wix.pricing_plans.v2.order\",\n \"slug\": \"resumed\",\n \"entityId\": \"5f99efdb-5d56-d8c1-9d6c-298230054c63\",\n \"actionEvent\": {\n \"body\": {\n \"order\": {\n \"subscriptionId\": \"558aad5d-3529-4a89-be79-14e77d15e3c7\",\n \"pausePeriods\": [\n {\n \"status\": \"ENDED\",\n \"pauseDate\": \"2021-11-19T10:40:46.661Z\",\n \"resumeDate\": \"2021-11-19T10:40:49.902Z\"\n }\n ],\n \"planName\": \"Forever\",\n \"id\": \"5f99efdb-5d56-d8c1-9d6c-298230054c63\",\n \"buyer\": {\n \"memberId\": \"6bb98a18-dc53-4236-ad88-e4ab6b8de60d\",\n \"contactId\": \"6bb98a18-dc53-4236-ad88-e4ab6b8de60d\"\n },\n \"lastPaymentStatus\": \"NOT_APPLICABLE\",\n \"status\": \"ACTIVE\",\n \"planDescription\": \"\",\n \"type\": \"ONLINE\",\n \"planId\": \"a3cc1a92-a92b-43c2-9db8-f64b9391bb7d\",\n \"startDate\": \"2021-11-18T15:01:52.940Z\",\n \"updatedDate\": \"2021-11-19T10:40:46.661Z\",\n \"pricing\": {\n \"singlePaymentUnlimited\": true,\n \"prices\": [\n {\n \"duration\": {\n \"cycleFrom\": 1,\n \"numberOfCycles\": 1\n },\n \"price\": {\n \"subtotal\": \"272.73\",\n \"discount\": \"0\",\n \"tax\": {\n \"name\": \"Tax\",\n \"includedInPrice\": true,\n \"rate\": \"21\",\n \"amount\": \"57.27\"\n },\n \"total\": \"330.00\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"currentCycle\": {\n \"index\": 1,\n \"startedDate\": \"2021-11-18T15:01:52.940526Z\"\n },\n \"planPrice\": \"330\",\n \"createdDate\": \"2021-11-18T15:01:52.940Z\"\n }\n }\n },\n \"eventTime\": \"2021-11-19T10:40:50.047031Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.OrderResumed","contentLink":{"displayName":"Order Resumed","slugifiedName":"order-resumed"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Orders API\n\nWith Orders, you can manage orders and create offline orders. You can also change access to content on Wix or external apps upon plan purchase or cancellation.\n\nThe Orders API allows your app to:\n- Create an offline order.\n- Preview an order to show price, tax, and other details.\n- Extend an order's duration or cancel an order.\n- Pause and resume an order.\n\n\n## Terminology\n- **Order:** A purchase of a subscription to a Pricing Plan. The order details include price, duration, and billing schedule information. Orders can be free. Orders can also be partially free using free trial days.\n- **Offline Order:** A purchase of a subscription to a Pricing Plan where the payment isn't handled via Wix. This type of order can be created via API.\n- **Online Order:** A purchase of a subscription to a Pricing Plan where the payment is handled via Wix. This type of order can't be created via API.\n- **Buyer:** A customer.\n\n## Limitations\n- This API supports creating offline orders only. Pricing plan orders created via API can't be paid for using the Wix Payment system.\n- The application of tax to orders is defined at the site level, and isn't accessible via API. If site owners need to collect tax, they must [set up tax collection manually](fallback::https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection).","sourceRepo":"git@github.com:wix-private/app-market.git","path":"docs/order_overview.md"},{"displayName":"Example Flows","slugifyName":"example-flows","content":"# Orders: Sample Use Case & Flow\nThis article shares a possible use case your app could support, as well as a sample flow that could support the use case. \nThis can be a helpful jumping off point as you plan your app's implementation.\n\n## Send an email on successful payment of online orders\n\nSite owners can use your app to reach out to their customers and send a confirmation email that a payment was successful. \nTo begin, create an email template to use for these messages. Site owners can also design their own with their [email marketing dashboard](fallback::https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fshoutout/dashboard). \n\nTo listen for successful payments and send a confirmation email to the customer, follow this flow: \n1. Listen for any new payments using the [Payment Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::27982c84-8591-4a3f-923b-88889483caa9slug::payment*fallback::https://dev.wix.com/api/rest/wix-cashier/cashier-pay/payment-event/payment-webhook).\n1. When the webhook is triggered, check for a `wixAppId` of `1522827f-c56c-a5c9-2ac9-00f9e6ae12d3` (the Wix App ID for Pricing Plans) and extract the `wixAppOrderId`.\n1. Call [Get Order](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::17949597-fe3a-4ddc-a11d-fdf3f8ba606aslug::get-order*fallback::https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/get-order) using the `wixAppOrderId` as the `id` for the order to retrieve.\n1. Extract the `order.buyer.memberId` to retrieve the buyer's `memberId`.\n1. Use the ID to [Get Member](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::c2c7e954-db95-4415-b007-b20819f79374slug::get-member*fallback::https://dev.wix.com/api/rest/members/members/get-member) and extract the member's `loginEmail`.\n1. Call [Query Email Subscriptions](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::bc69514d-4318-4d04-b8aa-aa12eac10cc7slug::query-email-subscriptions*fallback::https://dev.wix.com/api/rest/marketing/email-subscriptions/query-email-subscriptions) and filter by the email address to confirm that the member has agreed to receive emails from the site owner.\n1. Use [Get or Create Conversation](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4f11c5f2-d809-49fe-a0e7-ce3ce2a146dbslug::get-or-create-conversation*fallback::https://dev.wix.com/api/rest/inbox/conversations/get-or-create-conversation) and [Send Message](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::14d3ae9e-5a85-48c3-997d-34d10f87f7cbslug::send-message*fallback::https://dev.wix.com/api/rest/inbox/messages/send-message) to send an email to the buyer.\n","sourceRepo":"git@github.com:wix-private/app-market.git","path":"docs/OrdersExampleFlows.md"}],"components":{"schemas":{"com.wixpress.membership.v2.orders.Order":{"type":"object","properties":{"id":{"description":"Order ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"planId":{"description":"ID of the plan purchased with the order. See [Plans for more information about pricing plans](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/introduction).","format":"GUID","readOnly":true,"title":"planId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"subscriptionId":{"description":"ID of the related Wix subscription.\n\nEvery pricing plan order corresponds to a Wix subscription, including orders for single payment plans. See here\nfor a [Pricing Plans overview](https://support.wix.com/en/article/pricing-plans-an-overview#create-plans-to-suit-your-business).","format":"GUID","readOnly":true,"title":"subscriptionId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"wixPayOrderId":{"description":"Wix Pay order ID.\n\nProvided by Wix whether the order is created online or offline. The field is omitted when the order is free.","format":"GUID","readOnly":true,"title":"wixPayOrderId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"buyer":{"description":"The buyer's IDs. Includes `memberId` and `contactId`.\n\nCurrently, Pricing Plan purchases are limited to members only. `contactId` is returned,\nbut a buyer will not be able to purchase a plan without a `memberId`.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Buyer","summary":"buyer","x-wix-docs":{"exposure":"PUBLIC"}},"priceDetails":{"description":"__Deprecated.__ Use `pricing` instead. This property will be removed on September 30, 2022.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.PriceDetails","summary":"priceDetails","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"message":"__Deprecated.__ Use `pricing` instead. This property will be removed on September 30, 2022.","replacedBy":"pricing","targetRemovalDate":"2022-10-01"}}},"pricing":{"description":"Order pricing model, price, and payment schedule.\n\n[Learn more about pricing models](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/introduction#wix-pricing-plans_pricing-plans_introduction_pricing-models).","readOnly":true,"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.PricingDetails","summary":"pricing","x-wix-docs":{"exposure":"PUBLIC"}},"type":{"description":"How the order was processed. One of:\n+ `ONLINE`: The buyer purchased the plan using the site.\n+ `OFFLINE`: The buyer made a manual, offline purchase without using the site.\n+ `EXTERNAL`: The buyer made a purchase through an external payment provider.","readOnly":true,"title":"type","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.OrderTypeEnum.OrderType","x-wix-docs":{"exposure":"PUBLIC"}},"status":{"description":"Status of the order. One of:\n+ `DRAFT`: Order has been initiated but payment hasn't been processed yet. The plan isn't yet available for use to the buyer.\n+ `PENDING`: Order has been purchased and its start date is set in the future.\n+ `ACTIVE`: Order has been processed. The plan is available for use.\n+ `PAUSED`: Order, and use of the plan, is [paused](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/pause-order). The order, and use of the plan, can be [resumed](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/resume-order).\n+ `ENDED`: Order has completed its duration and is no longer available for use.\n+ `CANCELED`: Order has been [canceled](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/cancel-order).","readOnly":true,"title":"status","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.OrderStatusEnum.OrderStatus","x-wix-docs":{"exposure":"PUBLIC"}},"autoRenewCanceled":{"description":"Whether the order will be canceled at the next payment date.\n\nIf `true`, the order status will be `CANCELED` and the next payment won't be charged. Omitted for single payment orders.","readOnly":true,"title":"autoRenewCanceled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"cancellation":{"description":"Details about the cancellation of an order.\n\nOnly present if the status is `CANCELED`.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Cancellation","summary":"cancellation","x-wix-docs":{"exposure":"PUBLIC"}},"lastPaymentStatus":{"description":"Status of the last payment for the order.\nUpdated automatically for online orders. Updated manually by the site owner for offline orders. One of:\n+ `PAID`: The last payment was paid.\n+ `REFUNDED`: The last payment was refunded.\n+ `FAILED`: The last payment transaction didn't complete.\n+ `UNPAID`: The last payment wasn't paid.\n+ `PENDING`: Awaiting payment.\n+ `NOT_APPLICABLE`: No payment was necessary. For example, for free plans or free trials.","readOnly":true,"title":"lastPaymentStatus","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.PaymentStatusEnum.PaymentStatus","x-wix-docs":{"exposure":"PUBLIC"}},"startDate":{"description":"Start date and time for the ordered plan.","readOnly":true,"title":"startDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"endDate":{"description":"Current end date and time for the ordered plan.\n\n`endDate` may be updated over the course of an order. If the order is [paused](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/pause-order),\nit will have a later `endDate` once it [resumes](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/resume-order). `endDate` may also be [postponed](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/postpone-end-date).\n\nOmitted if the order is valid until canceled and still `ACTIVE`.","readOnly":true,"title":"endDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"pausePeriods":{"description":"List of periods during which the order is paused.","readOnly":true,"title":"pausePeriods","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.PausePeriod"},"x-wix-docs":{"exposure":"PUBLIC"}},"freeTrialDays":{"description":"Free trial period for the order, in days.\n\nOnly available for recurring plans.","readOnly":true,"minimum":1,"maximum":999,"title":"freeTrialDays","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"earliestEndDate":{"description":"Earliest end date and time that the plan for the order can expire.\n\nCalculated by using the original end date plus any pause periods. Omitted if the order is active until canceled. Reserved for future use.","readOnly":true,"title":"earliestEndDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"currentCycle":{"description":"Current payment cycle for the order.\n\n`currentCycle` will be omitted if the order's status is `CANCELED` or `ENDED`, or if the `startDate` hasn't passed yet.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.CurrentCycle","summary":"currentCycle","x-wix-docs":{"exposure":"PUBLIC"}},"planName":{"description":"Plan name at the time of purchase.","readOnly":true,"title":"planName","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"planDescription":{"description":"Plan description at the time of purchase","readOnly":true,"title":"planDescription","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"planPrice":{"description":"Plan price as it was at the moment of order creation.","format":"DECIMAL_VALUE","readOnly":true,"title":"planPrice","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"createdDate":{"description":"Date and time the order was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"updatedDate":{"description":"Date and time the order was updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"formData":{"description":"Information about the form submitted during the plan's checkout.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.FormData","summary":"formData","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Order","description":"An order object includes all of the details related to the purchase of a Pricing Plan.\nYou can manage existing orders, create offline orders, and preview orders not yet purchased.\n\nOrders are based on pricing models based on the payment and duration cycles for each plan. See here to\n[learn more about pricing models](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/introduction#wix-pricing-plans_pricing-plans_introduction_pricing-models)."},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StringValue","description":""},"com.wixpress.membership.v2.orders.Buyer":{"type":"object","properties":{"memberId":{"description":"Member ID for a Wix site member. See [Members to learn more about a site's members](https://dev.wix.com/api/rest/members/members).","format":"GUID","readOnly":true,"title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"contactId":{"description":"Contact ID for a Wix site contact. See [Contacts to learn more about a site's contacts](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object).","format":"GUID","readOnly":true,"title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Buyer","description":""},"com.wixpress.membership.v2.orders.PriceDetails":{"type":"object","properties":{"subtotal":{"description":"Price of the order excluding tax, specified as a monetary amount. for example, `\"9.99\"`.","format":"DECIMAL_VALUE","title":"subtotal","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"discount":{"description":"Total discount applied.","format":"DECIMAL_VALUE","title":"discount","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"tax":{"description":"Tax applied.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Tax","summary":"tax","x-wix-docs":{"exposure":"PUBLIC"}},"total":{"description":"Price after tax and discount is applied, specified as a monetary amount. For example, `\"13.98\"`.\n\nIf no tax is applied, the amount is the same as `subtotal`.","format":"DECIMAL_VALUE","title":"total","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"planPrice":{"description":"Plan price as it was at the moment of order creation.","format":"DECIMAL_VALUE","title":"planPrice","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"currency":{"description":"Currency code. Must be valid ISO 4217 currency code (e.g., USD).","format":"CURRENCY","title":"currency","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"freeTrialDays":{"description":"Free trial period for the order in days. Only available for recurring plans.","minimum":1,"maximum":999,"title":"freeTrialDays","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"coupon":{"description":"Coupon applied to the order. Empty means no coupon was applied.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Coupon","summary":"coupon","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PriceDetails","description":"","oneOf":[{"description":"","summary":"pricingModel","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.PriceDetails.pricingModel"}]},"com.wixpress.membership.v2.orders.PriceDetails.pricingModel":{"type":"object","title":"pricingModel","properties":{"subscription":{"description":"Order has recurring payments.","$ref":"#/components/schemas/com.wixpress.membership.v2.Recurrence","summary":"subscription","x-wix-docs":{"exposure":"PUBLIC"}},"singlePaymentForDuration":{"description":"One-time payment. Order is valid for a specified duration.","$ref":"#/components/schemas/com.wixpress.membership.v2.Duration","summary":"singlePaymentForDuration","x-wix-docs":{"exposure":"PUBLIC"}},"singlePaymentUnlimited":{"description":"One-time payment. Order is valid until it is canceled.","title":"singlePaymentUnlimited","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}}},"com.wixpress.membership.v2.orders.Tax":{"type":"object","properties":{"name":{"description":"Name of the tax. For example, VAT.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"includedInPrice":{"description":"Whether tax is included in the original price. When `false`, tax is added at checkout.","title":"includedInPrice","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"rate":{"description":"Tax rate percentage, as a number between 0 and 100. For example, a 7% tax rate is `\"7.00\"`.","format":"DECIMAL_VALUE","title":"rate","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"amount":{"description":"Total tax, specified as a monetary amount. For example, `\"3.99\"`.","format":"DECIMAL_VALUE","title":"amount","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Tax","description":""},"com.wixpress.membership.v2.Recurrence":{"type":"object","properties":{"cycleDuration":{"description":"Length of one payment cycle.","$ref":"#/components/schemas/com.wixpress.membership.v2.Duration","summary":"cycleDuration","x-wix-docs":{"exposure":"PUBLIC"}},"cycleCount":{"description":"Amount of payment cycles this subscription is valid for.\n\n`0` for unlimited or until-canceled.","title":"cycleCount","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":{"description":"The amount of a duration `unit` in a single payment cycle.\n\nCurrently limited to support only `1`.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"unit":{"description":"Unit of time for the cycle duration.","title":"unit","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.PeriodUnitEnum.PeriodUnit","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Duration","description":"A duration expressed in number of time units."},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"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":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BoolValue","description":""},"com.wixpress.membership.v2.orders.Coupon":{"type":"object","properties":{"code":{"description":"Code of the applied coupon.","minLength":1,"maxLength":20,"title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"amount":{"description":"Total discount of the coupon, as a monetary amount.","format":"DECIMAL_VALUE","title":"amount","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"id":{"description":"Coupon ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Coupon","description":""},"com.wixpress.membership.v2.orders.PricingDetails":{"type":"object","properties":{"prices":{"description":"Pricing details for all pricing models.","readOnly":true,"title":"prices","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.SpannedPrice"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PricingDetails","description":"","oneOf":[{"description":"","summary":"pricingModel","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.PricingDetails.pricingModel"}]},"com.wixpress.membership.v2.orders.PricingDetails.pricingModel":{"type":"object","title":"pricingModel","properties":{"subscription":{"description":"Pricing model for an order with recurring payment cycles.","$ref":"#/components/schemas/com.wixpress.membership.v2.Recurrence","summary":"subscription","x-wix-docs":{"exposure":"PUBLIC"}},"singlePaymentForDuration":{"description":"Pricing model for an order with a one-time payment and the order is valid for a specific amount of time.","$ref":"#/components/schemas/com.wixpress.membership.v2.Duration","summary":"singlePaymentForDuration","x-wix-docs":{"exposure":"PUBLIC"}},"singlePaymentUnlimited":{"description":"Pricing model for an order with a one-time payment and the order is valid until canceled.","title":"singlePaymentUnlimited","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}}},"com.wixpress.membership.v2.orders.SpannedPrice":{"type":"object","properties":{"duration":{"description":"Cycle duration to apply `price` for.\n\nUse with all pricing models.\nCan apply the same price to multiple payment cycles.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.PriceDuration","summary":"duration","x-wix-docs":{"exposure":"PUBLIC"}},"price":{"description":"Order price.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Price","summary":"price","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SpannedPrice","description":""},"com.wixpress.membership.v2.orders.PriceDuration":{"type":"object","properties":{"cycleFrom":{"description":"Price starts to apply with this cycle.\n\n`1` is the first payment cycle for all pricing models.","title":"cycleFrom","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"numberOfCycles":{"description":"Amount of cycles to apply price for.\n\nFor `subscription` pricing models with a finite number of cycles, the `numberOfCycles` is the same as `pricing.subscription.cycleCount`.\n\nFor `subscription` pricing models that are unlimited or until-canceled, the `numberOfCycles` is not returned.\n\nFor `singlePaymentForDuration` and `singlePaymentUnlimited` pricing models, the `numberOfCycles` is `1`.","title":"numberOfCycles","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PriceDuration","description":""},"com.wixpress.membership.v2.orders.Price":{"type":"object","properties":{"subtotal":{"description":"Price of the order excluding tax, specified as a monetary amount. For example, `\"9.99\"`.","format":"DECIMAL_VALUE","title":"subtotal","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"coupon":{"description":"Coupon applied to the order.\n\nSee Coupons [to learn more about coupons](https://dev.wix.com/api/rest/coupons).","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Coupon","summary":"coupon","x-wix-docs":{"exposure":"PUBLIC"}},"discount":{"description":"Total discount applied to the order.","format":"DECIMAL_VALUE","title":"discount","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"tax":{"description":"Tax applied to the order.\n\nTax is only applied if the site [has it configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection).","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Tax","summary":"tax","x-wix-docs":{"exposure":"PUBLIC"}},"total":{"description":"Price after tax and discount is applied. Specified as a monetary amount, for example, `\"13.98\"`.\n\nIf no tax is applied, the amount is the same as `subtotal`.","format":"DECIMAL_VALUE","title":"total","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"currency":{"description":"Three-letter currency code in\n[ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.","format":"CURRENCY","title":"currency","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"proration":{"description":"Price change after billing date was change and price was adjusted. Could be positive and negative values.","format":"DECIMAL_VALUE","title":"proration","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Price","description":""},"com.wixpress.membership.v2.Fee":{"type":"object","properties":{"name":{"description":"Fee name","maxLength":40,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"amount":{"description":"Amount of fee to be charged","title":"amount","type":"string","x-wix-docs":{"exposure":"PUBLIC","decimalValue":{"lt":"1000000000000","gte":"0.000","maxScale":3}}}},"title":"Fee","description":""},"com.wixpress.membership.v2.orders.OrderTypeEnum.OrderType":{"type":"string","description":"","title":"OrderType","enum":["UNDEFINED","ONLINE","OFFLINE","EXTERNAL"]},"com.wixpress.membership.v2.orders.OrderMethodEnum.OrderMethod":{"type":"string","description":"","title":"OrderMethod","enum":["UNKNOWN","MOTO","POS"]},"com.wixpress.membership.v2.orders.OrderStatusEnum.OrderStatus":{"type":"string","description":"","title":"OrderStatus","enum":["UNDEFINED","DRAFT","PENDING","ACTIVE","PAUSED","ENDED","CANCELED"]},"com.wixpress.membership.v2.orders.Cancellation":{"type":"object","properties":{"requestedDate":{"description":"Date and time the cancellation was requested.","title":"requestedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"cause":{"description":"Reason for the cancellation. One of:\n+ `OWNER_ACTION`: Site owner canceled the order.\n+ `MEMBER_ACTION`: Buyer initiated the cancellation.\n+ `PAYMENT_FAILURE`: Payment transaction failed.\n+ `PAYMENT_SETUP_FAILURE`: Buyer's payment details weren't set up correctly.\n+ `UNKNOWN`: Reason for the cancellation is unknown.","title":"cause","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.CancellationCauseEnum.CancellationCause","x-wix-docs":{"exposure":"PUBLIC"}},"effectiveAt":{"description":"When the cancellation takes effect. Set when cancelling the order. One of:\n+ `IMMEDIATELY`: Cancellation occurs immediately and the buyer can no longer use the plan.\n+ `NEXT_PAYMENT_DATE`: Cancellation occurs at the next payment date and time. Buyer can continue to use the plan until that date and time.","title":"effectiveAt","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.CancellationEffectiveAtEnum.CancellationEffectiveAt","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Cancellation","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Timestamp","description":""},"com.wixpress.membership.v2.orders.CancellationCauseEnum.CancellationCause":{"type":"string","description":"","title":"CancellationCause","enum":["UNDEFINED","OWNER_ACTION","MEMBER_ACTION","PAYMENT_FAILURE","PAYMENT_SETUP_FAILURE","UNKNOWN"]},"com.wixpress.membership.v2.orders.CancellationEffectiveAtEnum.CancellationEffectiveAt":{"type":"string","description":"","title":"CancellationEffectiveAt","enum":["UNDEFINED","IMMEDIATELY","NEXT_PAYMENT_DATE"]},"com.wixpress.membership.v2.orders.PaymentStatusEnum.PaymentStatus":{"type":"string","description":"","title":"PaymentStatus","enum":["UNDEFINED","PAID","REFUNDED","FAILED","UNPAID","PENDING","NOT_APPLICABLE"]},"com.wixpress.membership.v2.orders.PausePeriod":{"type":"object","properties":{"status":{"description":"Status of the pause period. One of:\n\n+ `ACTIVE`: Status while the order is [paused](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/pause-order).\n+ `ENDED`: Status when the order is [resumed](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/resume-order).","title":"status","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.PausePeriod.Status","x-wix-docs":{"exposure":"PUBLIC"}},"pauseDate":{"description":"Start date and time of the pause period.","title":"pauseDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"resumeDate":{"description":"End date and time of the pause period.\n\nOmitted while the pause period remains `ACTIVE`.","title":"resumeDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PausePeriod","description":""},"com.wixpress.membership.v2.orders.PausePeriod.Status":{"type":"string","description":"","title":"Status","enum":["UNDEFINED","ACTIVE","ENDED"]},"com.wixpress.membership.v2.orders.CurrentCycle":{"type":"object","properties":{"index":{"description":"Index of the current payment cycle in the order.\n\n`0` when order is in a free trial period. In all other cases, the index starts with `1`.","minimum":0,"title":"index","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"startedDate":{"description":"Start date and time for the current payment cycle.","title":"startedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"endedDate":{"description":"End date and time for the current payment cycle.","title":"endedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CurrentCycle","description":"Current cycle will be empty when order is cancelled, expired or order start date is in the future\nCurrent cycle start and end dates take into account free trial days and suspensions"},"com.wixpress.membership.v2.orders.OrderCycle":{"type":"object","properties":{"index":{"description":"Index of this cycle in the order.\n\n`0` when order is in a free trial period. In all other cases, the index starts with `1`.","minimum":0,"title":"index","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"startedDate":{"description":"Start date and time for this order cycle.","title":"startedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"endedDate":{"description":"End date and time for this order cycle.","title":"endedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderCycle","description":"Order cycle start and end dates take into account free trial days and suspensions"},"com.wixpress.membership.v2.orders.FormData":{"type":"object","properties":{"formId":{"description":"ID of the order form associated with the plan at checkout.\n\nLearn more about [forms](https://dev.wix.com/docs/rest/api-reference/wix-forms/form-submissions/introduction).","format":"GUID","title":"formId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"submissionId":{"description":"ID of a submission to the plan's order form at checkout. Every time a visitor completes the checkout process for a plan, a new submission is created.","format":"GUID","title":"submissionId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"submissionData":{"description":"Data submitted to the plan's order form at checkout.","readOnly":true,"title":"submissionData","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FormData","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Struct","description":""},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","$ref":"#/components/schemas/google.protobuf.Value","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListValue","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"eventTime":{"description":"Event timestamp.","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ActionEvent","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Int64Value","description":""},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""},"com.wixpress.membership.v2.orders.member.GetOrderRequest":{"type":"object","properties":{"id":{"description":"Order ID.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fieldSet":{"description":"","title":"fieldSet","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.FieldSet.Set","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetOrderRequest","description":""},"com.wixpress.membership.v2.orders.FieldSet.Set":{"type":"string","description":"","title":"Set","enum":["UNKNOWN_SET","BASIC","FULL"]},"com.wixpress.membership.v2.orders.member.GetOrderResponse":{"type":"object","properties":{"order":{"description":"Requested order.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetOrderResponse","description":""},"com.wixpress.membership.v2.orders.member.ListOrdersRequest":{"type":"object","properties":{"planIds":{"description":"Filter by plan IDs.","format":"GUID","title":"planIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"autoRenewCanceled":{"description":"Filter for orders where auto renewal was canceled.","title":"autoRenewCanceled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"orderStatuses":{"description":"Filter by order status.","title":"orderStatuses","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"paymentStatuses":{"description":"Filter by payment status.","title":"paymentStatuses","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"limit":{"description":"Limit the number of pricing plans returned. Default limit is 50.","minimum":1,"maximum":50,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"description":"Number of entries to offset.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"sorting":{"description":"Sorting direction (defaults to ASC) and field to sort by. [See available fields here](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort).","$ref":"#/components/schemas/wix.common.Sorting","summary":"sorting","x-wix-docs":{"exposure":"PUBLIC"}},"fieldSet":{"description":"","title":"fieldSet","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.FieldSet.Set","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListOrdersRequest","description":""},"wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"order":{"description":"Sort order.","title":"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"]},"com.wixpress.membership.v2.orders.member.ListOrdersResponse":{"type":"object","properties":{"orders":{"description":"","title":"orders","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order"},"x-wix-docs":{"exposure":"PUBLIC"}},"pagingMetadata":{"description":"Object containing paging-related data (number of orders returned, offset).","$ref":"#/components/schemas/wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListOrdersResponse","description":""},"wix.common.PagingMetadataV2":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"description":"Offset that was requested.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"total":{"description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"tooManyToCount":{"description":"Flag that indicates the server failed to calculate the `total` field.","title":"tooManyToCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"cursors":{"description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.","$ref":"#/components/schemas/wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PagingMetadataV2","description":""},"wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor string pointing to the next page in the list of results.","title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"prev":{"description":"Cursor pointing to the previous page in the list of results.","title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Cursors","description":""},"com.wixpress.membership.v2.orders.member.QueryOrdersRequest":{"type":"object","properties":{"query":{"description":"","$ref":"#/components/schemas/wix.common.QueryV2","summary":"query","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryOrdersRequest","description":"TODO: Write orders filter and sort docs page\nRetrieves a list of up to 1,000 orders, based on the provided paging, [sorting, and filtering](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort)."},"wix.common.QueryV2":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC"}},"sort":{"description":"Sort object in the following format:\n`[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`","title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC"}},"fields":{"description":"Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned.","title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"fieldsets":{"description":"Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned.","title":"fieldsets","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryV2","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/wix.common.QueryV2.pagingMethod"}]},"wix.common.QueryV2.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"paging":{"description":"Paging options to limit and skip the number of items.","$ref":"#/components/schemas/wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC"}},"cursorPaging":{"description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.","$ref":"#/components/schemas/wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC"}}}},"wix.common.Paging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"description":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Paging","description":""},"wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Maximum number of items to return in the results.","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"cursor":{"description":"Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CursorPaging","description":""},"com.wixpress.membership.v2.orders.member.QueryOrdersResponse":{"type":"object","properties":{"plans":{"description":"Order data.","title":"plans","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order"},"x-wix-docs":{"exposure":"PUBLIC"}},"pagingMetadata":{"description":"Paging-related data (number of orders returned, offset).","$ref":"#/components/schemas/wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryOrdersResponse","description":""},"com.wixpress.membership.v2.orders.member.RequestCancellationRequest":{"type":"object","properties":{"id":{"description":"Order ID.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"effectiveAt":{"description":"Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately.","title":"effectiveAt","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.CancellationEffectiveAtEnum.CancellationEffectiveAt","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"RequestCancellationRequest","description":""},"com.wixpress.membership.v2.orders.member.RequestCancellationResponse":{"type":"object","properties":{},"title":"RequestCancellationResponse","description":""},"com.wixpress.membership.v2.orders.OrderCanceled":{"type":"object","properties":{"order":{"description":"Canceled order.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderCanceled","description":"Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal\n\nTo determine the specific reason of the cancellation check `order.cancellation.cause` field."},"com.wixpress.membership.v2.orders.CreateOnlineOrderRequest":{"type":"object","properties":{"planId":{"description":"Plan ID.","format":"GUID","title":"planId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"startDate":{"description":"Start date for the ordered plan.\n\nDefault: Current date","title":"startDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"couponCode":{"description":"Coupon code to apply.","minLength":1,"maxLength":20,"title":"couponCode","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"onBehalf":{"description":"Provided if checkout is initiated on buyer's behalf.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.OnBehalf","summary":"onBehalf","x-wix-docs":{"exposure":"PUBLIC"}},"submissionId":{"description":"Form submission id that was submitted together with the order","format":"GUID","title":"submissionId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateOnlineOrderRequest","description":""},"com.wixpress.membership.v2.orders.OnBehalf":{"type":"object","properties":{"memberId":{"description":"Member ID.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"orderMethod":{"description":"Method by which checkout is initiated on buyer's behalf","title":"orderMethod","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.OrderMethodEnum.OrderMethod","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OnBehalf","description":""},"com.wixpress.membership.v2.orders.CreateOnlineOrderResponse":{"type":"object","properties":{"order":{"description":"Order.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateOnlineOrderResponse","description":""},"com.wixpress.membership.v2.orders.CouponsError":{"type":"object","properties":{"couponCode":{"description":"","title":"couponCode","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"planId":{"description":"","title":"planId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CouponsError","description":""},"com.wixpress.membership.v2.orders.CreateGuestOnlineOrderRequest":{"type":"object","properties":{"planId":{"description":"Plan ID.","format":"GUID","title":"planId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"startDate":{"description":"Start date for the ordered plan.\n\nDefault: Current date","title":"startDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"couponCode":{"description":"Coupon code to apply.","minLength":1,"maxLength":20,"title":"couponCode","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"captcha":{"description":"Captcha data to prove you are not a robot","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Captcha","summary":"captcha","x-wix-docs":{"exposure":"PUBLIC"}},"guest":{"description":"Visitor info","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Guest","summary":"guest","x-wix-docs":{"exposure":"PUBLIC"}},"submissionId":{"description":"Form submission id that was submitted together with the order","format":"GUID","title":"submissionId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateGuestOnlineOrderRequest","description":""},"com.wixpress.membership.v2.orders.Captcha":{"type":"object","properties":{"token":{"description":"Token from captcha","title":"token","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Captcha","description":""},"com.wixpress.membership.v2.orders.Guest":{"type":"object","properties":{"email":{"description":"Email for checkout","format":"EMAIL","title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Guest","description":""},"com.wixpress.membership.v2.orders.CreateGuestOnlineOrderResponse":{"type":"object","properties":{"order":{"description":"Order.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateGuestOnlineOrderResponse","description":""},"com.wixpress.membership.v2.orders.CreateOfflineOrderRequest":{"type":"object","properties":{"planId":{"description":"ID of the plan being ordered. See [Plans for more information about plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans).","format":"GUID","title":"planId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"memberId":{"description":"ID of the member ordering the plan. See [Members for more information about member IDs](https://dev.wix.com/api/rest/members/members).","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"startDate":{"description":"Start date and time for the ordered plan.\n\nDefault: Current date and time","title":"startDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"paid":{"description":"Whether the order is paid.\n\nDefault: `false`","title":"paid","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"couponCode":{"description":"Coupon code to apply.\n\nSee [Coupons to learn more](https://dev.wix.com/api/rest/coupons).","minLength":1,"maxLength":20,"title":"couponCode","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"submissionId":{"description":"Form submission id that was submitted together with the order","format":"GUID","title":"submissionId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateOfflineOrderRequest","description":""},"com.wixpress.membership.v2.orders.CreateOfflineOrderResponse":{"type":"object","properties":{"order":{"description":"Order.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateOfflineOrderResponse","description":""},"com.wixpress.membership.v2.orders.CreateExternalOrderRequest":{"type":"object","properties":{"planId":{"description":"Plan ID.","format":"GUID","title":"planId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"submissionId":{"description":"Form submission id that was submitted together with the order","format":"GUID","title":"submissionId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateExternalOrderRequest","description":""},"com.wixpress.membership.v2.orders.CreateExternalOrderResponse":{"type":"object","properties":{"order":{"description":"Created order","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateExternalOrderResponse","description":""},"com.wixpress.membership.v2.orders.GetOnlineOrderPreviewRequest":{"type":"object","properties":{"planId":{"description":"Plan ID.","format":"GUID","title":"planId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"startDate":{"description":"Start date for the ordered plan.\n\nDefault: Current date","title":"startDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"couponCode":{"description":"Coupon code to apply.","minLength":1,"maxLength":20,"title":"couponCode","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetOnlineOrderPreviewRequest","description":""},"com.wixpress.membership.v2.orders.GetOnlineOrderPreviewResponse":{"type":"object","properties":{"order":{"description":"Will be missing if limit is exceeded","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}},"purchaseLimitExceeded":{"description":"Whether the purchase limit has already been reached for this plan by this member.\nAlways false for plans without purchase limits.","title":"purchaseLimitExceeded","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetOnlineOrderPreviewResponse","description":""},"com.wixpress.membership.v2.orders.GetGuestOnlineOrderPreviewRequest":{"type":"object","properties":{"planId":{"description":"Plan ID.","format":"GUID","title":"planId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"startDate":{"description":"Start date for the ordered plan.\n\nDefault: Current date","title":"startDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"couponCode":{"description":"Coupon code to apply.","minLength":1,"maxLength":20,"title":"couponCode","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"email":{"description":"","format":"EMAIL","title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetGuestOnlineOrderPreviewRequest","description":""},"com.wixpress.membership.v2.orders.GetGuestOnlineOrderPreviewResponse":{"type":"object","properties":{"order":{"description":"Will be missing if limit is exceeded","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}},"purchaseLimitExceeded":{"description":"Whether the purchase limit has already been reached for this plan by this email.\nAlways false for plans without purchase limits.","title":"purchaseLimitExceeded","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetGuestOnlineOrderPreviewResponse","description":""},"com.wixpress.membership.v2.orders.GetOfflineOrderPreviewRequest":{"type":"object","properties":{"planId":{"description":"ID of the plan of the previewed order. See [Plans for more information about plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans).","format":"GUID","title":"planId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"memberId":{"description":"Member ID of the buyer the previewed order is for. See [Members for more information about member IDs](https://dev.wix.com/api/rest/members/members).","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"startDate":{"description":"Start date and time for plan of the previewed order.\n\nDefault: Current date and time","title":"startDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"couponCode":{"description":"Coupon code to apply. See [Coupons to learn more](https://dev.wix.com/api/rest/coupons).","minLength":1,"maxLength":20,"title":"couponCode","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetOfflineOrderPreviewRequest","description":""},"com.wixpress.membership.v2.orders.GetOfflineOrderPreviewResponse":{"type":"object","properties":{"order":{"description":"The previewed order, as if the plan had been ordered.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}},"purchaseLimitExceeded":{"description":"Whether this previewed order would exceed the permitted amount of purchases available\nfor this plan for this buyer.\n\nAlways `false` for plans that do not have purchase limits.","title":"purchaseLimitExceeded","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetOfflineOrderPreviewResponse","description":""},"com.wixpress.membership.v2.orders.GetPricePreviewRequest":{"type":"object","properties":{"planId":{"description":"ID of plan to preview.","format":"GUID","title":"planId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"couponCode":{"description":"Coupon code to apply.\n\nSee Coupons [to learn more](https://dev.wix.com/api/rest/coupons).","minLength":1,"maxLength":20,"title":"couponCode","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetPricePreviewRequest","description":""},"com.wixpress.membership.v2.orders.GetPricePreviewResponse":{"type":"object","properties":{"price":{"description":"__Deprecated.__ Use `prices` instead. This property will be removed on September 30, 2022.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.PriceDetails","summary":"price","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"message":"__Deprecated.__ Use `prices` instead. This property will be removed on September 30, 2022.","replacedBy":"prices","targetRemovalDate":"2022-10-01"}}},"prices":{"description":"Pricing details.","title":"prices","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.SpannedPrice"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetPricePreviewResponse","description":""},"com.wixpress.membership.v2.orders.ChangeStartDateRequest":{"type":"object","properties":{"orderId":{"description":"Draft order ID.","format":"GUID","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"startDate":{"description":"New valid from date (timestamp).","title":"startDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ChangeStartDateRequest","description":""},"com.wixpress.membership.v2.orders.ChangeStartDateResponse":{"type":"object","properties":{"order":{"description":"Updated draft order.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ChangeStartDateResponse","description":""},"com.wixpress.membership.v2.orders.OrderStartDateChanged":{"type":"object","properties":{"order":{"description":"Order whose `startDate` changed.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderStartDateChanged","description":""},"com.wixpress.membership.v2.orders.ApplyCouponRequest":{"type":"object","properties":{"orderId":{"description":"Draft order ID.","format":"GUID","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"couponCode":{"description":"Coupon code to apply.","minLength":1,"maxLength":20,"title":"couponCode","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ApplyCouponRequest","description":""},"com.wixpress.membership.v2.orders.ApplyCouponResponse":{"type":"object","properties":{"order":{"description":"Order with applied coupon and recalculated tax.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ApplyCouponResponse","description":""},"com.wixpress.membership.v2.orders.SetSubmissionRequest":{"type":"object","properties":{"orderId":{"description":"","format":"GUID","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"submissionId":{"description":"","format":"GUID","title":"submissionId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SetSubmissionRequest","description":""},"com.wixpress.membership.v2.orders.SetSubmissionResponse":{"type":"object","properties":{"order":{"description":"Order with submission id","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SetSubmissionResponse","description":""},"com.wixpress.membership.v2.orders.OrderPurchased":{"type":"object","properties":{"order":{"description":"Order that was paid for. If a free or an offline order, the order that was created.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderPurchased","description":""},"com.wixpress.membership.v2.orders.OrderStarted":{"type":"object","properties":{"order":{"description":"Order that reached its `startDate`.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderStarted","description":""},"com.wixpress.membership.v2.orders.OrderCycleStarted":{"type":"object","properties":{"order":{"description":"Order whose new cycle started.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}},"cycleNumber":{"description":"Number of the payment cycle will be 0 when the order is in the free trial period. In other cases, the cycle number starts from 1.","title":"cycleNumber","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderCycleStarted","description":"Triggered at the start of a new payment cycle for an existing order.\n\nThis webhook does not trigger at the initial start of an offline order."},"com.wixpress.membership.v2.orders.OrderAutoRenewCanceled":{"type":"object","properties":{"order":{"description":"Order that is canceled, effective at the end of the current payment cycle.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderAutoRenewCanceled","description":"Emitted when a recurring order is canceled for the next payment cycle"},"com.wixpress.membership.v2.orders.OrderEnded":{"type":"object","properties":{"order":{"description":"Order that ended.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderEnded","description":""},"com.wixpress.membership.v2.orders.GetOrderRequest":{"type":"object","properties":{"id":{"description":"Order ID.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fieldSet":{"description":"","title":"fieldSet","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.FieldSet.Set","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetOrderRequest","description":""},"com.wixpress.membership.v2.orders.GetOrderResponse":{"type":"object","properties":{"order":{"description":"Order.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetOrderResponse","description":""},"com.wixpress.membership.v2.orders.ListOrdersRequest":{"type":"object","properties":{"buyerIds":{"description":"Filter by a buyer's member ID. See [Members to learn more about a site's members](https://dev.wix.com/api/rest/members/members).","format":"GUID","title":"buyerIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"planIds":{"description":"Filter by plan IDs. See [Plans to learn more about pricing plans](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans).","format":"GUID","title":"planIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"autoRenewCanceled":{"description":"Filter by whether or not the auto-renewal of recurring orders was canceled.","title":"autoRenewCanceled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"orderStatuses":{"description":"Filter by order status.","title":"orderStatuses","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"paymentStatuses":{"description":"Filter by payment status.","title":"paymentStatuses","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"limit":{"description":"Number of orders to return. See [Pagination](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_paging) for more information.\n\nMax: `50`","minimum":1,"maximum":50,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"description":"Number of orders to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"sorting":{"description":"Sort order.\n\nUse `ASC` for ascending order or `DESC` for descending order.\n\nDefault: `DESC`","$ref":"#/components/schemas/wix.common.Sorting","summary":"sorting","x-wix-docs":{"exposure":"PUBLIC"}},"fieldSet":{"description":"Parameter to define amount of fields to return. FULL returns each order's submission data. Supported values: UNKNOWN_SET, BASIC, FULL","title":"fieldSet","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.FieldSet.Set","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListOrdersRequest","description":""},"com.wixpress.membership.v2.orders.ListOrdersResponse":{"type":"object","properties":{"orders":{"description":"List of orders.","title":"orders","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order"},"x-wix-docs":{"exposure":"PUBLIC"}},"pagingMetadata":{"description":"Object containing paging-related data (number of orders returned, offset).","$ref":"#/components/schemas/wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListOrdersResponse","description":""},"com.wixpress.membership.v2.orders.QueryOrdersRequest":{"type":"object","properties":{"query":{"description":"[See available fields here](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort).","$ref":"#/components/schemas/wix.common.QueryV2","summary":"query","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryOrdersRequest","description":""},"com.wixpress.membership.v2.orders.QueryOrdersResponse":{"type":"object","properties":{"plans":{"description":"Retrieved orders.","title":"plans","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order"},"x-wix-docs":{"exposure":"PUBLIC"}},"pagingMetadata":{"description":"Paging-related data (number of orders returned, offset).","$ref":"#/components/schemas/wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryOrdersResponse","description":""},"com.wixpress.membership.v2.orders.GetOrdersStatsRequest":{"type":"object","properties":{},"title":"GetOrdersStatsRequest","description":""},"com.wixpress.membership.v2.orders.GetOrdersStatsResponse":{"type":"object","properties":{"totalOrderCount":{"description":"Total number of orders.","title":"totalOrderCount","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"activeOrderCount":{"description":"Number of active orders.","title":"activeOrderCount","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetOrdersStatsResponse","description":""},"com.wixpress.membership.v2.orders.GetAvailableOrderActionsRequest":{"type":"object","properties":{"id":{"description":"Order ID.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetAvailableOrderActionsRequest","description":""},"com.wixpress.membership.v2.orders.GetAvailableOrderActionsResponse":{"type":"object","properties":{"suspendable":{"description":"Whether the order can be suspended.","title":"suspendable","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"notSuspendableReason":{"description":"If the order cannot be suspended, a reason is returned here.","title":"notSuspendableReason","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.ReasonNotSuspendableEnum.ReasonNotSuspendable","x-wix-docs":{"exposure":"PUBLIC"}},"cancelableByBuyer":{"description":"Whether the order can be canceled by the buyer.","title":"cancelableByBuyer","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetAvailableOrderActionsResponse","description":""},"com.wixpress.membership.v2.orders.ReasonNotSuspendableEnum.ReasonNotSuspendable":{"type":"string","description":"","title":"ReasonNotSuspendable","enum":["UNDEFINED","PENDING","TRIAL","CANCELED","ENDED","NOT_STARTED","ALREADY_SUSPENDED","OLD_STRIPE"]},"com.wixpress.membership.v2.orders.PostponeEndDateRequest":{"type":"object","properties":{"id":{"description":"Order ID.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"endDate":{"description":"New end date and time.\n\nMust be later than the current end date and time.","title":"endDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PostponeEndDateRequest","description":""},"com.wixpress.membership.v2.orders.PostponeEndDateResponse":{"type":"object","properties":{},"title":"PostponeEndDateResponse","description":""},"com.wixpress.membership.v2.orders.OrderEndDatePostponed":{"type":"object","properties":{"order":{"description":"Order whose `endDate` was postponed.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderEndDatePostponed","description":""},"com.wixpress.membership.v2.orders.CancelOrderRequest":{"type":"object","properties":{"id":{"description":"Order ID.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"effectiveAt":{"description":"__Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.","title":"effectiveAt","type":"string","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.CancellationEffectiveAtEnum.CancellationEffectiveAt","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CancelOrderRequest","description":""},"com.wixpress.membership.v2.orders.CancelOrderResponse":{"type":"object","properties":{},"title":"CancelOrderResponse","description":""},"com.wixpress.membership.v2.orders.MarkAsPaidRequest":{"type":"object","properties":{"id":{"description":"Order ID.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"MarkAsPaidRequest","description":""},"com.wixpress.membership.v2.orders.MarkAsPaidResponse":{"type":"object","properties":{},"title":"MarkAsPaidResponse","description":""},"com.wixpress.membership.v2.orders.OrderMarkedAsPaid":{"type":"object","properties":{"order":{"description":"Order that was marked as paid.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderMarkedAsPaid","description":""},"com.wixpress.membership.v2.orders.PauseOrderRequest":{"type":"object","properties":{"id":{"description":"Order ID.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PauseOrderRequest","description":""},"com.wixpress.membership.v2.orders.PauseOrderResponse":{"type":"object","properties":{},"title":"PauseOrderResponse","description":""},"com.wixpress.membership.v2.orders.OrderPaused":{"type":"object","properties":{"order":{"description":"Paused order.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderPaused","description":""},"com.wixpress.membership.v2.orders.BulkPauseOrderRequest":{"type":"object","properties":{"ids":{"description":"List of Order IDs.","format":"GUID","minItems":1,"maxItems":100,"title":"ids","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"returnFullEntity":{"description":"Set to true to return Order entity in response.","title":"returnFullEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkPauseOrderRequest","description":""},"com.wixpress.membership.v2.orders.BulkPauseOrderResponse":{"type":"object","properties":{"results":{"description":"","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.BulkOrderResult"},"x-wix-docs":{"exposure":"PUBLIC"}},"bulkActionMetadata":{"description":"","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkPauseOrderResponse","description":""},"com.wixpress.membership.v2.orders.BulkOrderResult":{"type":"object","properties":{"itemMetadata":{"description":"","$ref":"#/components/schemas/wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC"}},"order":{"description":"","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkOrderResult","description":""},"wix.common.ItemMetadata":{"type":"object","properties":{"id":{"description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"originalIndex":{"description":"Index of the item within the request array. Allows for correlation between request and response items.","title":"originalIndex","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"success":{"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated.","title":"success","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"error":{"description":"Details about the error in case of failure.","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ItemMetadata","description":""},"wix.api.ApplicationError":{"type":"object","properties":{"code":{"description":"Error code.","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"description":{"description":"Description of the error.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"data":{"description":"Data related to the error.","title":"data","type":"object","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ApplicationError","description":""},"wix.common.BulkActionMetadata":{"type":"object","properties":{"totalSuccesses":{"description":"Number of items that were successfully processed.","title":"totalSuccesses","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"totalFailures":{"description":"Number of items that couldn't be processed.","title":"totalFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"undetailedFailures":{"description":"Number of failures without details because detailed failure threshold was exceeded.","title":"undetailedFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkActionMetadata","description":""},"com.wixpress.membership.v2.orders.ResumeOrderRequest":{"type":"object","properties":{"id":{"description":"Order ID.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ResumeOrderRequest","description":""},"com.wixpress.membership.v2.orders.ResumeOrderResponse":{"type":"object","properties":{},"title":"ResumeOrderResponse","description":""},"com.wixpress.membership.v2.orders.OrderResumed":{"type":"object","properties":{"order":{"description":"Resumed order.","$ref":"#/components/schemas/com.wixpress.membership.v2.orders.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderResumed","description":""},"com.wixpress.membership.v2.orders.BulkResumeOrderRequest":{"type":"object","properties":{"ids":{"description":"List of Order IDs.","format":"GUID","minItems":1,"maxItems":100,"title":"ids","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"returnFullEntity":{"description":"Set to true to return Order entity in response.","title":"returnFullEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkResumeOrderRequest","description":""},"com.wixpress.membership.v2.orders.BulkResumeOrderResponse":{"type":"object","properties":{"results":{"description":"","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.membership.v2.orders.BulkOrderResult"},"x-wix-docs":{"exposure":"PUBLIC"}},"bulkActionMetadata":{"description":"","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkResumeOrderResponse","description":""}}},"title":"Order","description":"An order object includes all of the details related to the purchase of a Pricing Plan.\nYou can manage existing orders, create offline orders, and preview orders not yet purchased.\n\nOrders are based on pricing models based on the payment and duration cycles for each plan. See here to\n[learn more about pricing models](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/introduction#wix-pricing-plans_pricing-plans_introduction_pricing-models).","fqdn":"wix.pricing_plans.v2.order"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Orders API\n\nWith Orders, you can manage orders and create offline orders. You can also change access to content on Wix or external apps upon plan purchase or cancellation.\n\nThe Orders API allows your app to:\n- Create an offline order.\n- Preview an order to show price, tax, and other details.\n- Extend an order's duration or cancel an order.\n- Pause and resume an order.\n\n\n## Terminology\n- **Order:** A purchase of a subscription to a Pricing Plan. The order details include price, duration, and billing schedule information. Orders can be free. Orders can also be partially free using free trial days.\n- **Offline Order:** A purchase of a subscription to a Pricing Plan where the payment isn't handled via Wix. This type of order can be created via API.\n- **Online Order:** A purchase of a subscription to a Pricing Plan where the payment is handled via Wix. This type of order can't be created via API.\n- **Buyer:** A customer.\n\n## Limitations\n- This API supports creating offline orders only. Pricing plan orders created via API can't be paid for using the Wix Payment system.\n- The application of tax to orders is defined at the site level, and isn't accessible via API. If site owners need to collect tax, they must [set up tax collection manually](fallback::https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection)."},{"displayName":"Example Flows","slugifyName":"example-flows","content":"# Orders: Sample Use Case & Flow\nThis article shares a possible use case your app could support, as well as a sample flow that could support the use case. \nThis can be a helpful jumping off point as you plan your app's implementation.\n\n## Send an email on successful payment of online orders\n\nSite owners can use your app to reach out to their customers and send a confirmation email that a payment was successful. \nTo begin, create an email template to use for these messages. Site owners can also design their own with their [email marketing dashboard](fallback::https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fshoutout/dashboard). \n\nTo listen for successful payments and send a confirmation email to the customer, follow this flow: \n1. Listen for any new payments using the [Payment Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::27982c84-8591-4a3f-923b-88889483caa9slug::payment*fallback::https://dev.wix.com/api/rest/wix-cashier/cashier-pay/payment-event/payment-webhook).\n1. When the webhook is triggered, check for a `wixAppId` of `1522827f-c56c-a5c9-2ac9-00f9e6ae12d3` (the Wix App ID for Pricing Plans) and extract the `wixAppOrderId`.\n1. Call [Get Order](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::17949597-fe3a-4ddc-a11d-fdf3f8ba606aslug::get-order*fallback::https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/get-order) using the `wixAppOrderId` as the `id` for the order to retrieve.\n1. Extract the `order.buyer.memberId` to retrieve the buyer's `memberId`.\n1. Use the ID to [Get Member](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::c2c7e954-db95-4415-b007-b20819f79374slug::get-member*fallback::https://dev.wix.com/api/rest/members/members/get-member) and extract the member's `loginEmail`.\n1. Call [Query Email Subscriptions](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::bc69514d-4318-4d04-b8aa-aa12eac10cc7slug::query-email-subscriptions*fallback::https://dev.wix.com/api/rest/marketing/email-subscriptions/query-email-subscriptions) and filter by the email address to confirm that the member has agreed to receive emails from the site owner.\n1. Use [Get or Create Conversation](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4f11c5f2-d809-49fe-a0e7-ce3ce2a146dbslug::get-or-create-conversation*fallback::https://dev.wix.com/api/rest/inbox/conversations/get-or-create-conversation) and [Send Message](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::14d3ae9e-5a85-48c3-997d-34d10f87f7cbslug::send-message*fallback::https://dev.wix.com/api/rest/inbox/messages/send-message) to send an email to the buyer.\n"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}