LogoLogo
Contact API support
  • Build apps
  • Site Templates
  • REST API Reference
  • Storefronts (JS API)
  • Webhook automations
  • Discounts
  • Guides
  • Changelog
  • Overview
  • Payments
    • Online payments overview
    • Provide additional online payment method
    • Process online payment requests
      • Step 1. Decode and parse payment request from Ecwid
      • Step 2. Collect essential data for payment processing
      • Step 3. Initialize the transaction from payment provider
      • Step 4. Place order and return customer back to the store
    • Customize payments
      • Set up payment fees
      • Collect tips/donations at the checkout
      • Add payment instructions to the checkout
      • Show payment icons near your payment method at the checkout
      • Collect additional information before payment
      • Limit payments by selected shipping method
  • Shipping methods
    • Online shipping methods overview
    • Provide additional online shipping method
    • Process online shipping requests
      • Step 1. Parse shipping request
      • Step 2. Calculate shipping rates externally
      • Step 3. Send a response with shipping options
    • Shipping glossary
  • Orders
    • Get order details
      • Customer data in order details
      • Product prices in order details
      • Discounts in order details
      • Taxes in order details
    • Create orders
      • Calculate order details
      • Place new order with API
      • Place a new order from the abandoned cart
    • Sync orders with external services
      • Sync orders manually
      • Automated orders sync

Lightspeed® 2025

On this page

Was this helpful?

  1. Payments
  2. Customize payments

Collect tips/donations at the checkout

PreviousSet up payment feesNextAdd payment instructions to the checkout

Last updated 2 days ago

Was this helpful?

You can collect tips or donations in your store by enabling a specific section at the last checkout step:

To do so, simply send a PUT request with the JSON-formatted body. There, define the `tipsSettings` object with all the settings inside.

Request example:

PUT https://app.ecwid.com/api/v3/{storeId}/profile

{
    "tipsSettings": {
        "enabled": true,  //  must be `true`
        "type": "PERCENT",  //  `PERCENT` or `ABSOLUTE`
        "options": [
            0,
            5,
            10
        ],
        "defaultOption": 10,
        "title": "Support us with a donation",
        "subtitle": "We appreciate all donations, and even the tiniest bit helps us continue what we’re doing."
    }
}

You can specify one of the donation types:

  • PERCENT to collect tips tied to the order total, for example, 10% extra tip

  • ABSOLUTE to collect tips unrelated to the order total, for example, $15

The options array and the defaultOption are predefined values for the tip, and the title and `subtitle` fields describe why customers should leave a tip.

In response you’ll see `200 OK` HTTP status with the response body:

{
    "updateCount": 1
}

Which means that you’ve successfully enabled tips at the checkout.