POST

Query Balances


Developer Preview

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

Retrieves a list of balances, given the provided paging, filtering, and sorting.

Query Balances has a default paging limit of 50, which you can override.

For field support for filters and sorting, see Filtering and Sorting.

To learn how to query balances, see API Query Language.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
SCOPE.BENEFIT_PROGRAMS.MANAGE
SCOPE.BENEFIT_PROGRAMS.READ
Manage Events
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/benefit-programs/v1/balances/query

Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?