changeBalance( )


Changes the number of available credits in a balance.

You can adjust or set the number of available credits.

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
SCOPE.BENEFIT_PROGRAMS.MANAGE
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
idempotencyKeystringRequired

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


poolIdstringRequired

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


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?