Flipdish · JSON Structure

Orders Tip Configuration Structure

Describes the configuration of tipping

Type: object Properties: 7
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

TipConfiguration is a JSON Structure definition published by Flipdish, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

StoreId IsEnabled AllowCustomTips AllowRoundUp AllowEmojis Percentages DefaultPercentage

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-structure/orders-tip-configuration-structure.json",
  "name": "TipConfiguration",
  "description": "Describes the configuration of tipping",
  "type": "object",
  "properties": {
    "StoreId": {
      "description": "Configuration is for this StoreId",
      "type": "int32",
      "example": 500123
    },
    "IsEnabled": {
      "description": "Are tips enabled?",
      "type": "boolean",
      "example": true
    },
    "AllowCustomTips": {
      "description": "Are custom tips allowed?",
      "type": "boolean",
      "example": true
    },
    "AllowRoundUp": {
      "description": "Is round up allowed?",
      "type": "boolean",
      "example": true
    },
    "AllowEmojis": {
      "description": "Are emojis allowed?",
      "type": "boolean",
      "example": true
    },
    "Percentages": {
      "description": "Ordered list of tip breakpoints (smallest -> largest)",
      "type": "array",
      "items": {
        "type": "double"
      },
      "example": [
        1.0
      ]
    },
    "DefaultPercentage": {
      "description": "Defines a default percentage, it must be in the list of Percentages",
      "type": "double",
      "nullable": true,
      "example": 1.0
    }
  }
}