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.
You can only call this method when authenticated as a Wix app or Wix user identity.
There are 8 errors with this status code:
See the entire list and learn more about Wix errors.