# About the Orders API

With Orders, Wix users can manage orders and create offline orders. They can also change access to content on Wix or external apps upon plan purchase or cancellation.

The Orders API allows you to:
- Create an order.
- Preview an order to show price, tax, and other details.
- Extend an order's duration or cancel an order.
- Pause and resume an order.

## Before you begin
The application of tax to orders is defined at the site level, and isn't accessible using the API. If Wix users need to collect tax, they must [set up tax collection manually](fallback::https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection).

## Use cases
- [Send an email on successful payment of online orders](fallback::https://dev.wix.com/docs/rest/business-solutions/pricing-plans/pricing-plans/orders/example-flows)

  
## Terminology
- **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.
- **Offline order:** A purchase of a subscription to a pricing plan where the payment isn't handled on a site. This type of order can be created using APIs.
- **Online order:** A purchase of a subscription to a pricing plan where the payment is handled on a site. This type of order can't be created using an API.
- **Buyer:** A customer, usually a member or a site visitor.

@sdk_package_setup

# Orders: Sample Use Case & Flow
This article shares a possible use case you could support, as well as a sample flow that could support the use case. 
This can be a helpful jumping off point as you plan your implementation.

## Send an email on successful payment of online orders

You can create an implementation that sends a [Wix Inbox](fallback::https://support.wix.com/en/article/wix-inbox-an-overview) confirmation email to customers that a payment was successful. 

To listen for successful payments and send a confirmation email to the customer, follow this flow:  
1. Listen to the [Payment Event](fallback::https://dev.wix.com/docs/rest/business-management/payments/cashier/cashier-pay/payment-event/payment).
1. When the event is triggered, check for a `wixAppId` of `1522827f-c56c-a5c9-2ac9-00f9e6ae12d3` (the Wix App ID for Pricing Plans) and extract the `wixAppOrderId`.
1. Call [Get Order](fallback::https://dev.wix.com/docs/rest/business-solutions/pricing-plans/pricing-plans/orders/member-orders-service-get-order) using the `wixAppOrderId` as the `id` for the order to retrieve.
1. Extract the `order.buyer.memberId` to retrieve the buyer's `memberId`.
1. Call [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) with the `memberId` and extract the member's `loginEmail`.
1. 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 Wix user.
1. 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.

Mintlify Sandbox

Coding Examples

Overview

Sled Tests

Go Headless

Studio Two

Dashboard Extensions

Backend Extensions

Site Extensions

Extend Websites with SDK

Wix APIs and References

Build Apps

Wix Design System (WDS)

Client (Deprecated)

API Preview

Wix CLI

Contexts

Ricos

Extend Websites with Velo

API Reference

Velo

Picasso

Order Ended