GET/2010-04-01/Accounts/{AccountSid}/Usage/Triggers.json

List usage triggers for an account

Lists usage triggers belonging to an account. Filter the results by recurrence, trigger field, or usage category, and use the page parameters to navigate the results. The response includes pagination metadata and the matching usage triggers.

7 parameters
AccountSidstringrequired
The account SID, in the format `AC` followed by 32 hexadecimal characters.
Recurringstringoptional
Filter by recurrence: `daily`, `monthly`, or `yearly` for recurring triggers, or `alltime` for non-recurring triggers.
Allowed:dailymonthlyyearlyalltime
TriggerBystringoptional
Filter by the usage record field that fires the trigger: `count`, `usage`, or `price`.
Allowed:countusageprice
UsageCategorystringoptional
Filter by a supported usage category.
PageSizeintegeroptional
Number of usage triggers to return per page. Defaults to 50 when omitted. Must be between 1 and 1000.
Pageintegeroptional
Page index for client state. Must be zero or greater.
PageTokenstringoptional
API-provided token for retrieving a page of results.

1 status code
200Returns a paginated response containing matching usage triggers and pagination metadata, including page, page size, and links to adjacent pages.
endintegeroptional
first_page_uristringoptional
next_page_uristringoptional
pageintegeroptional
page_sizeintegeroptional
previous_page_uristringoptional
startintegeroptional
uristringoptional
usage_triggersarray<object>optional

Error handling

The AccountSid path parameter must be a 34-character SID beginning with AC followed by 32 hexadecimal characters. Recurring accepts daily, monthly, yearly, or alltime, and TriggerBy accepts count, usage, or price. PageSize must be between 1 and 1000, Page must be zero or greater, and PageToken is supplied by the API for pagination.