Flipdish · Schema
SubscriptionInvoice
Invoice
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks
Properties
| Name | Type | Description |
|---|---|---|
| InvoiceId | string | The invoice identifier |
| Number | string | Invoice number |
| Total | number | Total |
| Currency | string | Currency |
| Status | string | Status |
| SubscriptionId | string | The subscription identifier |
| PaidAt | string | Paid At |
| FinalisedAt | string | Finalised At |
| PdfLink | string | Pdf Link |
| HostedUrl | string | Hosted Url |
| Overdue | boolean | Overdue |
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-invoice-schema.json",
"title": "SubscriptionInvoice",
"description": "Invoice",
"type": "object",
"properties": {
"InvoiceId": {
"description": "The invoice identifier",
"type": "string",
"example": "500123"
},
"Number": {
"description": "Invoice number",
"type": "string",
"example": "string"
},
"Total": {
"format": "double",
"description": "Total",
"type": "number",
"example": 12.5
},
"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"
},
"Status": {
"description": "Status",
"enum": [
"Draft",
"Open",
"Paid",
"UnCollectible",
"Void"
],
"type": "string",
"example": "Draft"
},
"SubscriptionId": {
"description": "The subscription identifier",
"type": "string",
"example": "500123"
},
"PaidAt": {
"format": "date-time",
"description": "Paid At",
"type": "string",
"nullable": true,
"example": "2026-06-02T12:00:00Z"
},
"FinalisedAt": {
"format": "date-time",
"description": "Finalised At",
"type": "string",
"nullable": true,
"example": "2026-06-02T12:00:00Z"
},
"PdfLink": {
"description": "Pdf Link",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"HostedUrl": {
"description": "Hosted Url",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"Overdue": {
"description": "Overdue",
"type": "boolean",
"example": true
}
},
"required": [
"InvoiceId",
"Number",
"Currency",
"Status",
"PdfLink",
"HostedUrl",
"Overdue"
]
}