List Feature Templates
Lists the feature templates defined for your site, active (non-archived) ones by default. Pass status=archived or status=all to widen the result set.
Supply page or per_page to paginate. Without either parameter, the response includes the full result set.
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Query Parameters
Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query page=1.
1 <= value1This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query per_page=200.
value <= 20020Filters by archived state. Defaults to active (non-archived templates only).
"active"Value in
- "active"
- "archived"
- "all"
Filters to feature templates whose name contains this substring (case-insensitive).
Filters by feature kind.
Value in
- "access_right"
- "usage_limit"
- "service_right"
- "all"
Returns feature templates updated on or after this date.
dateReturns feature templates updated on or before this date.
dateThe field to sort results by.
"name"Value in
- "name"
- "updated_at"
- "kind"
- "value_type"
The sort direction of the returned feature templates.
"asc"Value in
- "asc"
- "desc"
Response Body
application/json
application/json
curl -X GET "https://example.com/features.json"{ "items": [ { "id": 1001, "key": "sso", "name": "Single Sign-On", "description": null, "kind": "access_right", "unit": null, "value_type": "boolean", "default_value": "true", "default_periodicity_interval": null, "default_periodicity_unit": null, "archived_at": null, "created_at": "2024-01-15T10:00:00-05:00", "updated_at": "2024-01-15T10:00:00-05:00", "products_count": 2, "plans_count": 5 } ], "total_count": 1, "archived_count": 0}