Prices
Prices for activities appear in the responses for the following endpoints:
-
/activities/{activityUuid}
-
/activities/{activityUuid}/dates
-
/activities/{activityUuid}/dates/{date}
Currency
The currency for prices is based on the value of the X-Musement-Currency
header. If the header is missing, USD
will be used by default.
To learn more about currencies in responses, check out the currency guide.
Price properties
Multiple properties describe prices and their characteristics:
-
original_retail_price_without_service_fee
- The "base price" without a service fee or discounts.
-
discount_amount
- A discount to subtract from the base price due to promotions or special events.
-
This property does not appear for the
/activities/{activityUuid}
endpoint.
-
service_fee
- An extra fee to add to the base price to cover additional costs for creating a booking.
-
retail_price
-
The final price for customers:
original_retail_price_without_service_fee - discount_amount + service_fee
-
The final price for customers:
-
original_retail_price
-
The base price with a service fee, but no discount:
original_retail_price_without_service_fee + service_fee
-
The base price with a service fee, but no discount:
-
retail_price_without_service_fee
-
The base price with a discount, but no service fee:
original_retail_price_without_service_fee − discount_amount
-
The base price with a discount, but no service fee:
-
merchant_price
-
Authenticated partners may see this price, which follows specific commercial agreements made between partners and the Strategic Partnerships team. When present, we expect partners to pay Musement the
merchant_price
.
-
Authenticated partners may see this price, which follows specific commercial agreements made between partners and the Strategic Partnerships team. When present, we expect partners to pay Musement the
In the example response below, the activity has a discount, service fee and a merchant_price
:
{
[...]
"service_fee": {
"currency": "USD",
"value": 1.0,
"formatted_value": "$ 1.00",
"formatted_iso_value": "$1.00"
},
[...]
"original_retail_price": {
"currency": "USD",
"value": 49.0,
"formatted_value": "$ 49.00",
"formatted_iso_value": "$49.00"
},
"original_retail_price_without_service_fee": {
"currency": "USD",
"value": 48.0,
"formatted_value": "$ 48.00",
"formatted_iso_value": "$48.00"
},
"discount_amount": {
"currency": "USD",
"value": 4.9,
"formatted_value": "$ 4.90",
"formatted_iso_value": "$4.90"
},
"retail_price": {
"currency": "USD",
"value": 44.1,
"formatted_value": "$ 44.10",
"formatted_iso_value": "$44.10"
},
"retail_price_without_service_fee": {
"currency": "USD",
"value": 43.1,
"formatted_value": "$ 43.10",
"formatted_iso_value": "$43.10"
},
"merchant_price": {
"currency": "USD",
"value": 40.18,
"formatted_value": "$ 40.18",
"formatted_iso_value": "$40.18"
},
[...]
}
In the above example, customers are expected to pay the retail_price
of $44.10. Partners are expected to pay Musement the merchant_price
of $40.18.
Sorting
You can sort results in the /activities
endpoint by price, using the sort_by
query parameter.
A sort_by
value of price
will sort results from the lowest to the highest prices:
curl -X GET '{baseUrl}/activities?sort_by=price' \
-H 'X-Musement-Application: {applicationValue}' \
-H 'X-Musement-Version: 3.4.0' \
-H 'Authorization: Bearer {accessToken}'
To sort results from highest to lowest prices, use a sort_by
value of -price
:
curl -X GET '{baseUrl}/activities?sort_by=-price' \
-H 'X-Musement-Application: {applicationValue}' \
-H 'X-Musement-Version: 3.4.0' \
-H 'Authorization: Bearer {accessToken}'
A note on sandbox prices
Be aware that prices in the sandbox environment may be fake prices set for testing purposes and do not necessarily represent the prices shown in the production environment.