changeBalance( )

Developer Preview

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

Changes the number of available credits in a balance.

You can adjust or set the number of available credits.

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
SCOPE.BENEFIT_PROGRAMS.MANAGE
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
poolIdstringRequired

ID of the pool associated with the balance to change. This is also the ID of the balance.

idempotencyKeystringRequired

Unique identifier, generated by the client. Used to recognize repeated attempts to make the same request.

optionsChangeBalanceOptions
Returns
Return Type:Promise<ChangeBalanceResponse>
Errors
409Already Exists

There is 1 error with this status code.

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?