About the Orders API

With 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.

The Orders API allows your app to:

  • Create an offline 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.

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 via Wix. This type of order can be created via API.
  • 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.
  • Buyer: A customer.

Limitations

  • This API supports creating offline orders only. Pricing plan orders created via API can't be paid for using the Wix Payment system.
  • 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.
Was this helpful?
Yes
No

Orders: Sample Use Case & Flow

This article shares a possible use case your app 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 app's implementation.

Send an email on successful payment of online orders

Site owners can use your app to reach out to their customers and send a confirmation email that a payment was successful. To begin, create an email template to use for these messages. Site owners can also design their own with their email marketing dashboard.

To listen for successful payments and send a confirmation email to the customer, follow this flow:

  1. Listen for any new payments using the Payment Webhook.
  2. 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.
  3. Call Get Order using the wixAppOrderId as the id for the order to retrieve.
  4. Extract the order.buyer.memberId to retrieve the buyer's memberId.
  5. Use the ID to Get Member and extract the member's loginEmail.
  6. Call Query Email Subscriptions and filter by the email address to confirm that the member has agreed to receive emails from the site owner.
  7. Use Get or Create Conversation and Send Message to send an email to the buyer.
Was this helpful?
Yes
No

Order Object

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. See here to learn more about pricing models.

Properties
idstringRead-onlyformat GUID

Order ID.


planIdstringRead-onlyformat GUID

ID of the plan purchased with the order. See Plans for more information about pricing plans.


subscriptionIdstringRead-onlyformat GUID

ID of the related Wix subscription.

Every pricing plan order corresponds to a Wix subscription, including orders for single payment plans. See here for a Pricing Plans overview.


wixPayOrderIdstringRead-onlyformat GUID

Wix Pay order ID.

Provided by Wix whether the order is created online or offline. The field is omitted when the order is free.


buyerobjectRead-only

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.


priceDetailsobjectRead-onlydeprecated - use pricing instead

Deprecated. Use pricing instead. This property will be removed on September 30, 2022.


pricingobjectRead-only

Order pricing model, price, and payment schedule.

Learn more about pricing models.


typestringRead-only
4 enum supported values:
UNDEFINEDONLINEOFFLINEEXTERNAL

How the order was processed. One of:

  • ONLINE: The buyer purchased the plan using the site.
  • OFFLINE: The buyer made a manual, offline purchase without using the site.
  • EXTERNAL: The buyer made a purchase through an external payment provider.

statusstringRead-only
7 enum supported values:
UNDEFINEDDRAFTPENDINGACTIVEPAUSEDENDEDCANCELED

Status of the order. One of:

  • DRAFT: Order has been initiated but payment hasn't been processed yet. The plan isn't yet available for use to the buyer.
  • PENDING: Order has been purchased and its start date is set in the future.
  • ACTIVE: Order has been processed. The plan is available for use.
  • PAUSED: Order, and use of the plan, is paused. The order, and use of the plan, can be resumed.
  • ENDED: Order has completed its duration and is no longer available for use.
  • CANCELED: Order has been canceled.

autoRenewCanceledbooleanRead-only

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.


cancellationobjectRead-only

Details about the cancellation of an order.

Only present if the status is CANCELED.


lastPaymentStatusstringRead-only
7 enum supported values:
UNDEFINEDPAIDREFUNDEDFAILEDUNPAIDPENDINGNOT_APPLICABLE

Status of the last payment for the order. Updated automatically for online orders. Updated manually by the site owner for offline orders. One of:

  • PAID: The last payment was paid.
  • REFUNDED: The last payment was refunded.
  • FAILED: The last payment transaction didn't complete.
  • UNPAID: The last payment wasn't paid.
  • PENDING: Awaiting payment.
  • NOT_APPLICABLE: No payment was necessary. For example, for free plans or free trials.

startDatestringRead-onlyformat date-time

Start date and time for the ordered plan.


endDatestringRead-onlyformat date-time

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 resumes. endDate may also be postponed.

Omitted if the order is valid until canceled and still ACTIVE.


pausePeriodsArray <PausePeriod>Read-only

List of periods during which the order is paused.


freeTrialDaysintegerRead-onlyminimum 1maximum 999format int32

Free trial period for the order, in days.

Only available for recurring plans.


earliestEndDatestringRead-onlyformat date-time

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.


currentCycleobjectRead-only

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.


planNamestringRead-only

Plan name at the time of purchase.


planDescriptionstringRead-only

Plan description at the time of purchase


planPricestringRead-onlyformat DECIMAL_VALUE

Plan price as it was at the moment of order creation.


createdDatestringRead-onlyformat date-time

Date and time the order was created.


updatedDatestringRead-onlyformat date-time

Date and time the order was updated.


formDataobjectRead-only

Information about the form submitted during the plan's checkout.

Was this helpful?
Yes
No

GetGet Order

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves an order by ID.

Endpoint
GET
https://www.wixapis.com/pricing-plans/v2/member/orders/{id}

Was this helpful?
Yes
No

GetList Orders

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Returns orders for currently logged in member.

Endpoint
GET
https://www.wixapis.com/pricing-plans/v2/member/orders

Was this helpful?
Yes
No

PostRequest Cancellation

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Cancels an order. Recurring orders can be canceled either immediately or at the next payment date. One time orders can only be canceled immediately.

Note: This endpoint requires visitor or member authentication.

Endpoint
POST
https://www.wixapis.com/pricing-plans/v2/member/orders/{id}/cancel

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostCreate Offline Order

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates an order for a buyer who purchased the plan with an offline transaction.

An offline order is handled off of the Wix site and is marked as offline in type. If a pricing plan has a limit on the amount of purchases per buyer, that limit is ignored for offline orders. Tax is only applied if the site has it configured.

Handle payment for an offline order in 1 of 2 ways:

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/pricing-plans/v2/checkout/orders/offline

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostGet Offline Order Preview

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Performs a dry run of a purchase and provides an order preview.

The preview uses the same logic as purchasing a plan, but the preview is not saved. Because an order is not actually created, the preview order's orderId and subscriptionId are displayed as a string of multiple zero characters (000000-0000). Tax is only calculated if the site has it configured.
If a pricing plan has a limit on the amount of purchases per buyer, that limit is not considered for generating the preview. But, if that limit has been reached and this order would then exceed the amount of purchases permitted for this buyer, then purchaseLimitExceeded will return as true.

To get a general price preview for a plan that's not buyer-specific, use Get Price Preview.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/pricing-plans/v2/checkout/orders/preview-offline

Was this helpful?
Yes
No

PostGet Price Preview

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a plan's pricing.

The price preview uses the same logic as purchasing a plan, but the preview is not saved. Tax is only applied if the site has it configured. The price is returned in the pricing model format used for orders.

Buyers do not have to be logged in to preview the price, as such, the details returned are not buyer-specific. To generate a preview of a purchase for a specific buyer, use Get Offline Order Preview.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Pricing Plans
Manage Orders
Manage Bookings Services and Settings
Read Orders
Manage Pricing Plans
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/pricing-plans/v2/checkout/orders/price-preview

Was this helpful?
Yes
No

GetGet Order

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves an order by ID.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Bookings Services and Settings
Read Orders
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/pricing-plans/v2/orders/{id}

Was this helpful?
Yes
No

PatchPostpone End Date

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Extends the duration of a pricing plan order by postponing the order's endDate.

New endDate must be later than the order's current endDate. Can't postpone orders that are unlimited. Can't postpone an order while it is PAUSED.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Learn more about permission scopes.
Endpoint
PATCH
https://www.wixapis.com/pricing-plans/v2/orders/{id}

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

GetList Orders

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of orders and details, given the provided sorting and filtering.

By default, this endpoint will retrieve all orders and return them sorted by createdDate in DESC, descending order. sort.fieldName supports endDate and createdDate fields and defaults to ASC, ascending order.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Bookings Services and Settings
Read Orders
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/pricing-plans/v2/orders

Was this helpful?
Yes
No

PostCancel Order

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Cancels an existing order.

For orders with recurring payments, a cancellation can be set to occur either IMMEDIATELY or at the NEXT_PAYMENT_DATE. For orders with one-time payments, a cancellation can only be set for IMMEDIATELY.

Canceling during the free trial period.

When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end of the free trial period and they will not be billed. The buyer may continue using the benefits until the end of the free trial period.

When a site owner cancels an ordered plan during the free trial period, they choose to apply the cancellation IMMEDIATELY or at the NEXT_PAYMENT_DATE. Canceling IMMEDIATELY will end the subscription for the buyer immediately, even during the free trial period and the buyer won't be billed. Canceling at the NEXT_PAYMENT_DATE allows the buyer to continue using the benefits of the subscription until the end of the free trial period. Then, the subscription ends and the buyer is not billed.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/pricing-plans/v2/orders/{id}/cancel

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostMark As Paid

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Marks an offline order as paid.

Note: Marking separate payment cycles as paid is not yet supported. The entire order will be marked as paid.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/pricing-plans/v2/orders/{id}/mark-as-paid

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostPause Order

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Pauses an order.

For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused. Pausing 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.

Use Resume Order to resume a paused order.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/pricing-plans/v2/orders/{id}/pause

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostResume Order

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Resumes a paused order.

Updates endDate by adding the time the plan was paused. For orders with recurring payments, it also restarts the payment schedule. Use Pause Order to pause an order.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/pricing-plans/v2/orders/{id}/resume

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

Order Canceled

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when an order is canceled.

This webhook is triggered either immediately or at the end of the current payment cycle, as follows:

  • If the order is canceled and effectiveAt is set to IMMEDIATELY, the webhook is triggered immediately when canceled.
  • 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 is triggered immediately.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Bookings Services and Settings
Read Orders
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.pricing_plans.v2.order.


slugstring

Event name. Expected canceled.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


actionEventobject

Event information.


Was this helpful?
Yes
No

Order Created

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when an order is created.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Bookings Services and Settings
Read Orders
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.pricing_plans.v2.order.


slugstring

Event name. Expected created.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


createdEventobject

Event information.


Was this helpful?
Yes
No

Order Updated

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when an order is updated.

Order Updated Webhook is triggered when any of the following happens:

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Bookings Services and Settings
Read Orders
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.pricing_plans.v2.order.


slugstring

Event name. Expected updated.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


updatedEventobject

Event information.


Was this helpful?
Yes
No

Order Purchased

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when an order is purchased.

This webhook is triggered for any of the following events:

  • Order is paid in full.
  • At least 1 order cycle payment is paid for.
  • Offline order is created, even if not yet marked as paid.
  • Free order is created.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Bookings Services and Settings
Read Orders
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.pricing_plans.v2.order.


slugstring

Event name. Expected purchased.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


actionEventobject

Event information.


Was this helpful?
Yes
No

Order Started

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when an order reaches its startDate. Applies to both purchased and free orders.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Bookings Services and Settings
Read Orders
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.pricing_plans.v2.order.


slugstring

Event name. Expected started.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


actionEventobject

Event information.


Was this helpful?
Yes
No

Order Cycle Started

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered at the start of a new payment cycle for an existing order.

This webhook is not triggered at the initial start of an offline order.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Bookings Services and Settings
Read Orders
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.pricing_plans.v2.order.


slugstring

Event name. Expected cycle_started.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


actionEventobject

Event information.


Was this helpful?
Yes
No

Order Auto Renew Canceled

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when an order is canceled and effectiveAt is set to NEXT_PAYMENT_DATE.

This webhook is not triggered in the following scenarios:

  • When an order is canceled and effectiveAt is set to IMMEDIATELY. Instead, at the time of cancellation, Order Canceled is triggered.
  • 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 and Order Ended are triggered.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Bookings Services and Settings
Read Orders
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.pricing_plans.v2.order.


slugstring

Event name. Expected auto_renew_canceled.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


actionEventobject

Event information.


Was this helpful?
Yes
No

Order Ended

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when an order ends.

This webhook is triggered:

  • When an order expires at the end of the current payment cycle.
  • When an order is canceled and effectiveAt is set to IMMEDIATELY..

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Bookings Services and Settings
Read Orders
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.pricing_plans.v2.order.


slugstring

Event name. Expected ended.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


actionEventobject

Event information.


Was this helpful?
Yes
No

Order End Date Postponed

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when an order's endDate is postponed.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Bookings Services and Settings
Read Orders
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.pricing_plans.v2.order.


slugstring

Event name. Expected end_date_postponed.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


actionEventobject

Event information.


Was this helpful?
Yes
No

Order Marked As Paid

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when an offline order is marked as paid.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Bookings Services and Settings
Read Orders
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.pricing_plans.v2.order.


slugstring

Event name. Expected marked_as_paid.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


actionEventobject

Event information.


Was this helpful?
Yes
No

Order Paused

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when an order is paused.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Bookings Services and Settings
Read Orders
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.pricing_plans.v2.order.


slugstring

Event name. Expected paused.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


actionEventobject

Event information.


Was this helpful?
Yes
No

Order Resumed

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a paused order is resumed.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Bookings Services and Settings
Read Orders
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.pricing_plans.v2.order.


slugstring

Event name. Expected resumed.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


actionEventobject

Event information.


Was this helpful?
Yes
No