2025-05 Sale with Ecom custom charges

In this release, we are adding the ecom_custom_charges field to the Sale object. This field represents additional checkout surcharges that you can set up for your Lightspeed eCom solution.

eCom custom charges are not included in total_price or total_tax. It is the API consumer’s responsibility to account for them when calculating the total for a sale.
eCom custom charge tax components are not included in the Sale Line Item's tax_components, as they are a separate entity.
eCom custom charges are stored as adjustments, so you will also see a new type of Sale adjustment: ECOM_CUSTOM_CHARGE.
Currently, eCom custom charges are read-only and cannot be created or modified via the API.

Example:

"ecom_custom_charges": {
    "total": 8.26000,
    "total_tax": 1.74,
    "total_incl": 10.00000,
    "charges": [
        {
            "source_id": "dcq0jek",
            "total": 8.26000,
            "name": "Gift Wrapping",
            "tax_components": [
                {
                    "rate_id": "f47c0c62-00bf-11f0-a104-0683d8846097",
                    "total_tax": 0.96667
                },
                {
                    "rate_id": "fa1cab06-00bf-11f0-a104-0683d8846097",
                    "total_tax": 0.77333
                }
            ],
            "total_tax": 1.74,
            "total_incl": 10.00000
        },
    ]
}

Follow the Personalizing the checkout experience in eCom (E-Series) to learn how to setup custom checkout charges for your eCom.

Affected APIs: