API - Planyo Web Services - list_additional_products

You are here: Planyo » Help » API » list_additional_products



Returns additional products defined in a Planyo site.


site_id int optional
Planyo site ID. This parameter is only required if using an API key for a meta site.
method string required
must be set to list_additional_products
language string optional
by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned
api_key string required
your API key - Click here to get your key. If your API key uses a hash key, you must also include the parameters hash_key and hash_timestamp.


products array
Array of products. Each item is a named array with the following keys: id (internal ID), name, currency, price, description, is_recurring, max_quantity, is_reserved_by_customer, is_per_person, is_default, priority, tax_rate, extra_field. If a product is not compatible with some resources, their IDs will be listed in incompatible_resources.

API playground:

Click here to test this function in the API playground.