v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
UsagePlans

Search usage plans

Search for one or more usage plans.

get/v1/UsagePlans

Query parameters

search.plan_idinteger[]

Query by usage plan identifier.

search.descriptionstring[]

Query by all or part of description.

search.activeboolean

Null: All; True: Active only; False: Inactive only.

search.created_date_startstring date-time

Query by created date range start.

search.created_date_endstring date-time

Query by created date range end.

search.page_sizeinteger

Defines how many items to return at a time.

search.pageinteger

Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)

search.sortstring

Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.

Response

OK

okboolean
has_moreboolean

Helper for pagination. Indicates there are more records returned.

record_countinteger

Total number of records found by the search.