> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# Resource: Orders

# Type: Order Object

# Link: https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/orders/order-object.md

## Description: An order object includes all of the details related to the purchase of a Pricing Plan.
You can manage existing orders, create offline orders, and preview orders not yet purchased.

Orders are based on pricing models based on the payment and duration cycles for each plan.
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).

## Schema:

```json
 Type: Order Object | type: Order
 Description: An order object includes all of the details related to the purchase of a Pricing Plan.
You can manage existing orders, create offline orders, and preview orders not yet purchased.

Orders are based on pricing models based on the payment and duration cycles for each plan.
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).
       - name: id  | type: string | description: Order ID.
       - name: planId  | type: string | description: ID of the plan purchased with the order, from the Plans API.
       - name: subscriptionId  | type: string | description: ID of the related Wix subscription.  Every pricing plan order corresponds to a Wix subscription, including orders for single payment plans. Learn more in a [Pricing Plans overview](https://support.wix.com/en/article/pricing-plans-an-overview#create-plans-to-suit-your-business).
       - name: wixPayOrderId  | type: string | description: Wix Pay order ID.  Provided by Wix whether the order is created online or offline. The field is omitted when the order is free.
           - name: value  | type: string | description: 
       - name: buyer  | type: Buyer | description: The buyer's IDs. Includes `memberId` and `contactId`.  Currently, Pricing Plan purchases are limited to members only. `contactId` is returned, but a buyer will not be able to purchase a plan without a `memberId`.
           - name: memberId  | type: string | description: Member ID for a Wix site member, from the Members API.
           - name: contactId  | type: string | description: Contact ID for a Wix site contact, from the Contacts API.
       - name: priceDetails  | type: PriceDetails | description: __Deprecated.__ Use `pricing` instead. This property will be removed on September 30, 2022.
           - name: subtotal  | type: string | description: Price of the order excluding tax, specified as a monetary amount. for example, `"9.99"`.
           - name: discount  | type: string | description: Total discount applied.
           - name: tax  | type: Tax | description: Tax applied.
               - name: name  | type: string | description: Name of the tax. For example, VAT.
               - name: includedInPrice  | type: boolean | description: Whether tax is included in the original price. When `false`, tax is added at checkout.
               - name: rate  | type: string | description: Tax rate percentage, as a number between 0 and 100. For example, a 7% tax rate is `"7.00"`.
               - name: amount  | type: string | description: Total tax, specified as a monetary amount. For example, `"3.99"`.
           - name: total  | type: string | description: Price after tax and discount is applied, specified as a monetary amount. For example, `"13.98"`.  If no tax is applied, the amount is the same as `subtotal`.
           - name: planPrice  | type: string | description: Plan price as it was at the moment of order creation.
           - name: currency  | type: string | description: Currency code. Must be valid ISO 4217 currency code (e.g., USD).
           - name: freeTrialDays  | type: number | description: Free trial period for the order in days. Only available for recurring plans.
               - name: value  | type: number | description: 
           - name: coupon  | type: Coupon | description: Coupon applied to the order. Empty means no coupon was applied.
               - name: code  | type: string | description: Code of the applied coupon.
               - name: amount  | type: string | description: Total discount of the coupon, as a monetary amount.
               - name: id  | type: string | description: Coupon ID.
       - name: pricing  | type: PricingDetails | description: Order pricing model, price, and payment schedule.  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).
           - name: prices  | type: Array<SpannedPrice> | description: Pricing details for all pricing models.
               - name: duration  | type: PriceDuration | description: Cycle duration to apply `price` for.  Use with all pricing models. Can apply the same price to multiple payment cycles.
               - name: price  | type: Price | description: Order price.
       - name: type  | type: string | description: How the order was processed.
           enum: UNDEFINED, ONLINE, OFFLINE, EXTERNAL
       - name: status  | type: string | description: Status of the order.
           enum: UNDEFINED, DRAFT, PENDING, ACTIVE, PAUSED, ENDED, CANCELED
       - name: autoRenewCanceled  | type: boolean | description: Whether the order will be canceled at the next payment date.  If `true`, the order status will be `CANCELED` and the next payment won't be charged. Omitted for single payment orders.
           - name: value  | type: boolean | description: 
       - name: cancellation  | type: Cancellation | description: Details about the cancellation of an order.  Only present if the status is `CANCELED`.
           - name: requestedDate  | type: string | description: Date and time the cancellation was requested.
               - name: seconds  | type: string | description: 
               - name: nanos  | type: number | description: 
           - name: cause  | type: string | description: Reason for the cancellation.
               enum: UNDEFINED, OWNER_ACTION, MEMBER_ACTION, PAYMENT_FAILURE, PAYMENT_SETUP_FAILURE, UNKNOWN
           - name: effectiveAt  | type: string | description: When the cancellation takes effect. Set when cancelling the order.
               enum: UNDEFINED, IMMEDIATELY, NEXT_PAYMENT_DATE
       - name: lastPaymentStatus  | type: string | description: Status of the last payment for the order. Updated automatically for online orders. Updated manually by the Wix user for offline orders.
           enum: UNDEFINED, PAID, REFUNDED, FAILED, UNPAID, PENDING, NOT_APPLICABLE
       - name: startDate  | type: string | description: Start date and time for the ordered plan.
       - name: endDate  | type: string | description: Current end date and time for the ordered plan.  `endDate` may be updated over the course of an order. If the order is paused, it will have a later `endDate` once it is resumed. `endDate` may also be postponed.  Omitted if the order is valid until canceled and still `ACTIVE`.
       - name: pausePeriods  | type: Array<PausePeriod> | description: List of periods during which the order is paused.
           - name: status  | type: string | description: Status of the pause period.
               enum: UNDEFINED, ACTIVE, ENDED
           - name: pauseDate  | type: string | description: Start date and time of the pause period.
           - name: resumeDate  | type: string | description: End date and time of the pause period.  Omitted while the pause period remains `ACTIVE`.
       - name: freeTrialDays  | type: number | description: Free trial period for the order, in days.  Only available for recurring plans.
       - name: earliestEndDate  | type: string | description: Earliest end date and time that the plan for the order can expire.  Calculated by using the original end date plus any pause periods. Omitted if the order is active until canceled. Reserved for future use.
       - name: currentCycle  | type: CurrentCycle | description: Current payment cycle for the order.  `currentCycle` will be omitted if the order's status is `CANCELED` or `ENDED`, or if the `startDate` hasn't passed yet.
           - name: index  | type: number | description: Index of the current payment cycle in the order.  `0` when order is in a free trial period. In all other cases, the index starts with `1`.
           - name: startedDate  | type: string | description: Start date and time for the current payment cycle.
           - name: endedDate  | type: string | description: End date and time for the current payment cycle.
       - name: planName  | type: string | description: Plan name at the time of purchase.
       - name: planDescription  | type: string | description: Plan description at the time of purchase
       - name: planPrice  | type: string | description: Plan price as it was at the moment of order creation.
       - name: createdDate  | type: string | description: Date and time the order was created.
       - name: updatedDate  | type: string | description: Date and time the order was updated.
       - name: formData  | type: FormData | description: Information about the form submitted during the plan's checkout.
           - name: formId  | type: string | description: ID of the [order form](https://dev.wix.com/docs/rest/api-reference/wix-forms/form-submissions/introduction.md) associated with the plan at checkout.
           - name: submissionId  | type: string | 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.
           - name: submissionData  | type: object | description: Data submitted to the plan's order form at checkout.

```