API ReferenceSpend Controls

List spend control rule types

List the supported spend control rule types along with the open configuration schema — accepted keys and an example payload — for each. Use this to discover how to populate rule_configs[].configuration when creating or updating a spend control.

Required permissions: spend_control:read.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Penny-As-Businessstring or nullOptional

Act on behalf of another business that has granted you access. Requires the business:act_as permission.

Response

The supported rule types and their configuration schemas.
itemslist of objects
The list of items returned by the API.
countinteger
The total number of items returned in this response.
next_page_tokenstring or nullOptional
A token for retrieving the next page of results, if applicable.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error