Flipdish · Schema

TipConfiguration

Describes the configuration of tipping

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
StoreId integer Configuration is for this StoreId
IsEnabled boolean Are tips enabled?
AllowCustomTips boolean Are custom tips allowed?
AllowRoundUp boolean Is round up allowed?
AllowEmojis boolean Are emojis allowed?
Percentages array Ordered list of tip breakpoints (smallest -> largest)
DefaultPercentage number Defines a default percentage, it must be in the list of Percentages
View JSON Schema on GitHub

JSON Schema

orders-tip-configuration-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/orders-tip-configuration-schema.json",
  "title": "TipConfiguration",
  "description": "Describes the configuration of tipping",
  "type": "object",
  "properties": {
    "StoreId": {
      "format": "int32",
      "description": "Configuration is for this StoreId",
      "type": "integer",
      "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": {
        "format": "double",
        "type": "number"
      },
      "example": [
        1.0
      ]
    },
    "DefaultPercentage": {
      "format": "double",
      "description": "Defines a default percentage, it must be in the list of Percentages",
      "type": "number",
      "nullable": true,
      "example": 1.0
    }
  }
}