Refund policies for order items

When placing an order, the system freezes refund policies information related to each activity at the time of processing.
You will always be able to retrieve the proper version of a refund policy even if it changes over time just by passing in details about the order.

Accessing refund policies for a given order#

To access the refund policies for a give order item you can use the endpoint

curl -X GET \
  https://api.musement.com/api/v3/orders/{order_uuid}/items/{order-item_uuid}/refund-policies

That will gives you a response like

[
    {
        "uuid": "cdf7e764-abc9-44a5-9dd5-2084eabe806d",
        "period": "P2DT0H0M",
        "applicable_until": "2019-11-20 12:00",
        "remaining_time": "P1DT3H12M",
        "type": "PERCENTAGE",
        "value": 100
    },
    {
        "uuid": "291ac43a-7036-4c67-b193-f8ed858c4813",
        "period": "P0DT12H0M",
        "applicable_until": "2019-12-22 10:00",
        "remaining_time": "P2DT0H0M",
        "type": "PERCENTAGE",
        "value": 50
    }
]

In the case above the order item has 2 refund policies. The first one tells you that is applicable until 2019-11-20 12:00, that you will get back 100% and that you have one day, 3 hours and 12 minutes left P1DT3H12M. The second one that you will get back the 50% if you cancel before 2019-12-22 10:00.

As you can imagine the values of this response will change with time.

Corner cases#

There are some particular cases you may need to take in consideration:

  1. Order item is always 100% refundable. Please note the P0D as period. In this case applicable_until is the same as the date the activity happens.
[
    {
        "uuid": "cdf7e764-abc9-44a5-9dd5-2084eabe806d",
        "period": "P0D",
        "applicable_until": "2019-11-20 12:00",
        "remaining_time": "P1DT3H12M",
        "type": "PERCENTAGE",
        "value": 100
    }
]
  1. Refund is a fixed amount instead a percentage. Please note the ABSOLUTE. In this case the currency is the one of the supplier and the response is not influenced by X-Musement-Currency
[
    {
        "uuid": "dcbdd55c-3f62-4cf4-9b28-4fb7a14f33ab",
        "period": "P2DT0H0M",
        "applicable_until": "2019-12-22 10:00",
        "remaining_time": "P2DT0H0M",
        "type": "ABSOLUTE",
        "value": 83,
        "currency_code": "USD"
    }
]