The tier object
Whenever you fetch, create, or edit a tier, the API responds with an array of one or more tier objects. By default, the API doesn’t return monthly/yearly prices or benefits. To include them in the response, use theinclude
parameter with any or all of the following values: monthly_price
, yearly_price
, benefits
.
Parameters
When retrieving tiers from the Admin API, it’s possible to use theinclude
and filter
parameters.
Available include values:
monthly_price
- include monthly price datayearly_price
- include yearly price databenefits
- include benefits data
type:free|paid
- for filtering paid or free tiersvisibility:public|none
- for filtering tiers based on their visibilityactive:true|false
- for filtering active or archived tiers
limit
, page
, and order
parameters as documented in the Content API.
By default, tiers are ordered by ascending monthly price amounts.