POST

Get Offline Order Preview


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, call Get Price Preview.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Orders
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/pricing-plans/v2/checkout/orders/preview-offline

Body Params
planIdstringRequiredformat GUID

ID of the plan of the previewed order, from the Plans API.


memberIdstringRequiredformat GUID

Member ID of the buyer the previewed order is for, from the Members API.


startDatestringformat date-time

Start date and time for plan of the previewed order in a YYYY-MM-DDThh:mm[:ss][.sss]Z format.

Default: Current date and time.


couponCodestringminLength 1maxLength 20

Coupon code to apply, from the Coupons API.

Response Object
orderOrder

The previewed order, as if the plan had been ordered.


purchaseLimitExceededboolean

Whether this previewed order would exceed the permitted amount of purchases available for this plan for this buyer.

Always false for plans that do not have purchase limits.

Get Offline Order Preview Example 1
Request
cURL
Response
JSON
Errors
428Failed Precondition

There are 8 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?