get
https://api.zenoti.com/v1/classes/memberships?search_type=&page_number=&page_size=&item_ids=
This API helps you to retrieve the memberships that have a benefit associated with the specified class.
You must provide the appropriate details in the API request for the search_type and item_ids parameters. Optionally, you can also specify the required details in the API request for several other parameters to filter the search results in the API response. Refer to the Request Parameters table for more information.
Response Details
| Name | Type | Description |
|---|---|---|
| error | object | Object that contains error message and error code details. For more information, refer to the error Object table. |
| memberships | object | Object that contains detailed information on the various memberships that have a benefit associated with the specified class. For more information, refer to the memberships Object table. |
| page_details | object | Object that contains the number of search results in the API response, number of pages of search results, and number of search results displayed per page. |
memberships Object
| Name | Type | Description |
|---|---|---|
| id | guid | Unique 32-character identifier of the membership that has a benefit associated with the class. |
| version_id | guid | Unique 32-character identifier of the version of the membership. |
| type | enum | Type of the membership. |
| name | string | Name of the membership. |
| price_details | object | Object that contains detailed information on the various price elements of the membership. For more information, refer to the price_details Object table. |
| can_book | boolean | Indicates whether the membership can be booked. |
| show_price | boolean | Indicates whether the price of the membership is to be displayed. |
| display_name | string | Name of the membership that is displayed. |
| display_price | int | Price of the membership that is displayed. |
| image_paths | dictionary? | Name-value pairs of membership images that contain pixel sizes and location respectively. |
| is_recurrring_membership | boolean | Indicates whether the membership is a recurring one. |
| membership_type | int | Type of membership: 0-Non-recurring, 1-Recurring, and 2-Setup. |
| first_collection_after | int | Number of days after which the first collection occurs. |
| description | string | Description of the membership. |
| description_html | string | Description of the membership that contains HTML elements. |
| terms_and_conditions | string | Text that contains terms and conditions of the membership. |
| terms_and_conditionsAcceptance | string | Acceptance text of the terms and conditions. |
| enforce_mandatory_fields | boolean | Enforce mandatory fields in the membership. |
| frequency_text | string | In days or months - the frequency of the payment in case of a recurring membership. |
price_details Object
| Name | Type | Description |
|---|---|---|
| currency_code | int | Unique identifier of the currency used to buy the membership. |
| currency_symbol | string | Symbol of the currency used to buy the membership. |
| sale_price | double | Sales price of the membership. |
| sale_tax | double | Sale tax on the price of the membership. |
| final_price | double | Final price of the membership. |
error Object
| code | message |
|---|---|
| 503 - MissingInput | Search Type is not provided. (Hint: 0: Class, 1: Category, 2: Center). |
| 502 - InvalidInput | Search Type is invalid. (Hint: 0: Class, 1: Category, 2: Center). |
| 503 - MissingInput | Item Ids list is not provided. |
| 404 - ObjectNotFound | No Data found. |
| 506 - IOException Something went wrong. | Message: "exception_message", StackTrace: "exception_stacktrace". |