updateReceiptsSettings( )

Developer Preview

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

Updates a site's receipt settings, or creates them if none exist.

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
Learn more about app permissions.
Method Declaration
Copy
function updateReceiptsSettings(
  receiptsSettings: ReceiptsSettings,
): Promise<ReceiptsSettings>;
Method Parameters
receiptsSettingsReceiptsSettingsRequired

Receipt settings to update. Partial update is supported, but if no receipt settings entity exists, the full entity must be specified.

Returns
Return Type:Promise<ReceiptsSettings>
JavaScript
import { receiptsSettings } from "@wix/get-paid";

async function updateReceiptsSettings(receiptsSettings) {
  const response =
    await receiptsSettings.updateReceiptsSettings(receiptsSettings);
}
Errors
400Invalid Argument

There are 5 errors with this status code.

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

Did this help?