This API helps you to retrieve the packages 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.
packages
object
Object that contains detailed information on the various packages that have a benefit associated with the specified class. For more information, refer to the packages 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.
packages Object
Name
Type
Description
id
guid
Unique 32-character identifier of the package that has a benefit associated with the class.
name
string
Name of the package.
description
string?
Description of the package.
code
string?
Code related to the package.
has_bundled_products
boolean
Indicates whether the package contains any bundled products.
duration
int
Length in minutes of the service associated with the package.
bundled_product_priceCheck
int
Price of the products bundled with the package.
bundled_product_price_percentage
double
Percentage of the price of the products bundled with the package.
package_price_with_out_tax
double
Price of the package without tax.
type
int
Unique identifier of the type of the package.
price
object
Object that contains detailed information on the various price elements of the package. For more information, refer to the Price Object table.
package_cost_inc_bundled_products
double
Cost of the package including bundled products.
services
string?
Services associated with the package.
items
string?
Items associated with the package.
can_book
boolean
Indicates whether the package can be booked.
package_display_name
string
Name of the package that is displayed.
package_display_price
int
Price of the package that is displayed.
description_html
string
Description of the package that contains HTML elements.
terms_and_conditions
string
Text that contains terms and conditions of the package.
expiration_date
datetime?
Date on which the package expires.
expiration_days
int
Days after which the package expires.
scheduled_payment_frequency
int
In days or months - the frequency of scheduled payment for the package.
scheduled_payment_frequency_type
int
Type of scheduled payment for the package.
restrict_redemption_to_this_center
int
Indicates whether the package can be redeemed only at the specified center.
center_name
string
Name of the specified center.
package_category_name
string
Name of the package category.
price_details Object
Name
Type
Description
currency_code
int
Unique identifier of the currency used to buy the package.
currency_symbol
string
Symbol of the currency used to buy the package.
sale_price
double
Sales price of the package.
sale_tax
double
Sale tax on the price of the package.
final_price
double
Final price of the package.
error Object
code
message
503 - MissingInput
Search Type is not provided. (Hint: 0: Class, 1: Center).
502 - InvalidInput
Search Type is invalid. (Hint: 0: Class, 1: Center).
