Flipdish · Schema

SubscriptionSummary

Subscription Summary

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name	Type	Description
NextInvoiceAmount	number	Next invoice amount
NextInvoiceBillingDate	string	Next invoice billing date
SubscriptionId	string	The subscription identifier
Name	string	Name
Status	string	Status
Currency	string	Currency
User	string	User
DefaultPaymentDescription	string	Default payment description
CancellationRequestDate	string	Cancellation Date
CancellationDate	string	Cancel Date

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/payments-subscription-summary-schema.json",
  "title": "SubscriptionSummary",
  "description": "Subscription Summary",
  "type": "object",
  "properties": {
    "NextInvoiceAmount": {
      "format": "double",
      "description": "Next invoice amount",
      "type": "number",
      "nullable": true,
      "example": 12.5
    },
    "NextInvoiceBillingDate": {
      "format": "date-time",
      "description": "Next invoice billing date",
      "type": "string",
      "nullable": true,
      "example": "2026-06-02T12:00:00Z"
    },
    "SubscriptionId": {
      "description": "The subscription identifier",
      "type": "string",
      "example": "500123"
    },
    "Name": {
      "description": "Name",
      "type": "string",
      "example": "Example Name"
    },
    "Status": {
      "description": "Status",
      "enum": [
        "Incomplete",
        "IncompleteExpired",
        "Trialing",
        "Active",
        "PastDue",
        "Canceled",
        "Unpaid"
      ],
      "type": "string",
      "example": "Incomplete"
    },
    "Currency": {
      "description": "Currency",
      "enum": [
        "EUR",
        "USD",
        "GBP",
        "CAD",
        "AUD",
        "DJF",
        "ZAR",
        "ETB",
        "AED",
        "BHD",
        "DZD",
        "EGP",
        "IQD",
        "JOD",
        "KWD",
        "LBP",
        "LYD",
        "MAD",
        "OMR",
        "QAR",
        "SAR",
        "SYP",
        "TND",
        "YER",
        "CLP",
        "INR",
        "AZN",
        "RUB",
        "BYN",
        "BGN",
        "NGN",
        "BDT",
        "CNY",
        "BAM",
        "CZK",
        "DKK",
        "CHF",
        "MVR",
        "BTN",
        "XCD",
        "BZD",
        "HKD",
        "IDR",
        "JMD",
        "MYR",
        "NZD",
        "PHP",
        "SGD",
        "TTD",
        "XDR",
        "ARS",
        "BOB",
        "COP",
        "CRC",
        "CUP",
        "DOP",
        "GTQ",
        "HNL",
        "MXN",
        "NIO",
        "PAB",
        "PEN",
        "PYG",
        "UYU",
        "VEF",
        "IRR",
        "XOF",
        "CDF",
        "XAF",
        "HTG",
        "ILS",
        "HRK",
        "HUF",
        "AMD",
        "ISK",
        "JPY",
        "GEL",
        "KZT",
        "KHR",
        "KRW",
        "KGS",
        "LAK",
        "MKD",
        "MNT",
        "BND",
        "MMK",
        "NOK",
        "NPR",
        "PKR",
        "PLN",
        "AFN",
        "BRL",
        "MDL",
        "RON",
        "RWF",
        "SEK",
        "LKR",
        "SOS",
        "ALL",
        "RSD",
        "KES",
        "TJS",
        "THB",
        "ERN",
        "TMT",
        "BWP",
        "TRY",
        "UAH",
        "UZS",
        "VND",
        "MOP",
        "TWD",
        "BMD"
      ],
      "type": "string",
      "example": "EUR"
    },
    "User": {
      "description": "User",
      "type": "string",
      "example": "string"
    },
    "DefaultPaymentDescription": {
      "description": "Default payment description",
      "type": "string",
      "example": "string"
    },
    "CancellationRequestDate": {
      "format": "date-time",
      "description": "Cancellation Date",
      "type": "string",
      "nullable": true,
      "example": "2026-06-02T12:00:00Z"
    },
    "CancellationDate": {
      "format": "date-time",
      "description": "Cancel Date",
      "type": "string",
      "nullable": true,
      "example": "2026-06-02T12:00:00Z"
    }
  },
  "required": [
    "SubscriptionId",
    "Name",
    "Status",
    "Currency",
    "User"
  ]
}