MembershipRates
List MembershipRates
This endpoint lists the MembershipRates which are associated to the provided site.
get/customers/membership-rates
Query parameters
membership_type_idstring
Filter membership rates by membership type ID
site_idstring uuid
Filters membership rates that belong to a membership rate that has been enabled for the given site
brand_idstring uuid
Filters membership rates that belong to a membership rate that has been enabled for the given site
archivedboolean
Whether to include archived resources in the response. When true, archived resources are returned; when false or omitted, only non-archived resources are returned.
querystring
Filters membership rates with a similar name to the given value
pageinteger
The page to retrieve results from
per_pageinteger
The number of results to return per page
Response
The MembershipRates were successfully retrieved
Example response
{
"data": [
{
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"default_duration": "P1Y",
"notice_period": "P1M",
"private": true
}
],
"meta": {
"from": 1,
"to": 2,
"total": 2,
"current_page": 1,
"last_page": 2,
"per_page": 15,
"path": "http://example.com/api"
},
"links": {
"first": "http://example.com?page=1",
"next": "https://example.com?page=3",
"prev": "https://example.com?page=1",
"last": "https://example.com?page=4"
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.