regenerateReceiptDocument( )

Developer Preview

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

Retries generating a receipt document that has a FAILED status.

Note that you can access a receipt document with an AVAILABLE status with the URL provided in document.downloadUrl without regenerating.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Receipts
Manage Stores
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
receiptIdstringRequired

Receipt ID.

Errors
428Failed Precondition

There is 1 error with this status code.

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

Did this help?