Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/flipdish:flipdish-subscriptions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
version: v1.0
title: Flipdish Open API v1.0 Subscriptions API
servers:
- url: https://api.flipdish.co
tags:
- name: Subscriptions
paths:
/api/v1.0/{appId}/subscriptions/{subscriptionId}:
get:
tags:
- Subscriptions
operationId: GetSubscriptionById
parameters:
- name: appId
in: path
required: true
schema:
type: string
- name: subscriptionId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_Subscription'
text/json:
schema:
$ref: '#/components/schemas/RestApiResult_Subscription'
application/xml:
schema:
$ref: '#/components/schemas/RestApiResult_Subscription'
text/xml:
schema:
$ref: '#/components/schemas/RestApiResult_Subscription'
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiErrorResult'
text/json:
schema:
$ref: '#/components/schemas/RestApiErrorResult'
application/xml:
schema:
$ref: '#/components/schemas/RestApiErrorResult'
text/xml:
schema:
$ref: '#/components/schemas/RestApiErrorResult'
'401':
description: Authentication has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiUnauthorizedResult'
text/json:
schema:
$ref: '#/components/schemas/RestApiUnauthorizedResult'
application/xml:
schema:
$ref: '#/components/schemas/RestApiUnauthorizedResult'
text/xml:
schema:
$ref: '#/components/schemas/RestApiUnauthorizedResult'
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiForbiddenResult'
text/json:
schema:
$ref: '#/components/schemas/RestApiForbiddenResult'
application/xml:
schema:
$ref: '#/components/schemas/RestApiForbiddenResult'
text/xml:
schema:
$ref: '#/components/schemas/RestApiForbiddenResult'
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiErrorResult'
text/json:
schema:
$ref: '#/components/schemas/RestApiErrorResult'
application/xml:
schema:
$ref: '#/components/schemas/RestApiErrorResult'
text/xml:
schema:
$ref: '#/components/schemas/RestApiErrorResult'
security:
- oauth2:
- api
summary: Get subscription by id
x-summary-source: derived
/api/v1.0/{appId}/subscriptions/hasPaymentMethod:
get:
tags:
- Subscriptions
operationId: HasCustomerGotPaymentMethodOnFile
parameters:
- name: appId
in: path
required: true
schema:
type: string
- name: email
in: query
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_HasPaymentMethodResponse'
text/json:
schema:
$ref: '#/components/schemas/RestApiResult_HasPaymentMethodResponse'
application/xml:
schema:
$ref: '#/components/schemas/RestApiResult_HasPaymentMethodResponse'
text/xml:
schema:
$ref: '#/components/schemas/RestApiResult_HasPaymentMethodResponse'
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiErrorResult'
text/json:
schema:
$ref: '#/components/schemas/RestApiErrorResult'
application/xml:
schema:
$ref: '#/components/schemas/RestApiErrorResult'
text/xml:
schema:
$ref: '#/components/schemas/RestApiErrorResult'
'401':
description: Authentication has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiUnauthorizedResult'
text/json:
schema:
$ref: '#/components/schemas/RestApiUnauthorizedResult'
application/xml:
schema:
$ref: '#/components/schemas/RestApiUnauthorizedResult'
text/xml:
schema:
$ref: '#/components/schemas/RestApiUnauthorizedResult'
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiForbiddenResult'
text/json:
schema:
$ref: '#/components/schemas/RestApiForbiddenResult'
application/xml:
schema:
$ref: '#/components/schemas/RestApiForbiddenResult'
text/xml:
schema:
$ref: '#/components/schemas/RestApiForbiddenResult'
security:
- oauth2:
- api
summary: Has customer got payment method on file
x-summary-source: derived
/api/v1.0/{appId}/subscriptions:
get:
tags:
- Subscriptions
operationId: GetSubscriptionsForApp
parameters:
- name: appId
in: path
required: true
schema:
type: string
- name: excludeNotOwnedSubscriptions
in: query
required: false
schema:
type: boolean
- name: storeId
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: integer
format: int32
- name: excludeCancelledSubscriptions
in: query
required: false
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiArrayResult_SubscriptionSummary'
text/json:
schema:
$ref: '#/components/schemas/RestApiArrayResult_SubscriptionSummary'
application/xml:
schema:
$ref: '#/components/schemas/RestApiArrayResult_SubscriptionSummary'
text/xml:
schema:
$ref: '#/components/schemas/RestApiArrayResult_SubscriptionSummary'
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiErrorResult'
text/json:
schema:
$ref: '#/components/schemas/RestApiErrorResult'
application/xml:
schema:
$ref: '#/components/schemas/RestApiErrorResult'
text/xml:
schema:
$ref: '#/components/schemas/RestApiErrorResult'
'401':
description: Authentication has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiUnauthorizedResult'
text/json:
schema:
$ref: '#/components/schemas/RestApiUnauthorizedResult'
application/xml:
schema:
$ref: '#/components/schemas/RestApiUnauthorizedResult'
text/xml:
schema:
$ref: '#/components/schemas/RestApiUnauthorizedResult'
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiForbiddenResult'
text/json:
schema:
$ref: '#/components/schemas/RestApiForbiddenResult'
application/xml:
schema:
$ref: '#/components/schemas/RestApiForbiddenResult'
text/xml:
schema:
$ref: '#/components/schemas/RestApiForbiddenResult'
security:
- oauth2:
- api
summary: Get subscriptions for app
x-summary-source: derived
components:
schemas:
UpcomingInvoice:
description: UpcomingInvoice.
required:
- Subtotal
- AmountDue
- Tax
type: object
properties:
Amount:
format: double
description: Amount
type: number
NextBillingDate:
format: date-time
description: Next billing date
type: string
Subtotal:
format: double
description: Subtotal
type: number
TotalExcludingTax:
format: double
description: Total excluding tax
type:
- number
- 'null'
AmountDue:
format: double
description: Amount due
type: number
Tax:
format: double
description: Tax
type: number
Items:
description: Items
type: array
items:
$ref: '#/components/schemas/InvoiceItem'
Discounts:
description: Discounts
type: array
items:
$ref: '#/components/schemas/InvoiceDiscount'
ValidationErrorResult:
description: Validation error result
type: object
properties:
FieldName:
description: Field name
type: string
Errors:
description: List of errors relates to field
type: array
items:
type: string
HasPaymentMethodResponse:
description: Has Payment Method Response
required:
- HasPaymentMethod
type: object
properties:
HasPaymentMethod:
description: Has Payment Method
type: boolean
Subscription:
description: Subscription
required:
- Products
- SubscriptionId
- Name
- Status
- Currency
- User
type: object
properties:
Products:
description: Products
type: array
items:
$ref: '#/components/schemas/SubscriptionProduct'
NextInvoiceAmount:
format: double
description: Next invoice amount
type:
- number
- 'null'
NextInvoiceBillingDate:
format: date-time
description: Next invoice billing date
type:
- string
- 'null'
UpcomingInvoiceItems:
description: Upcoming invoice items
type: array
items:
$ref: '#/components/schemas/InvoiceItem'
UpcomingInvoiceDiscounts:
description: Upcoming invoice discounts
type: array
items:
$ref: '#/components/schemas/InvoiceDiscount'
UpcomingInvoice:
$ref: '#/components/schemas/UpcomingInvoice'
description: Upcoming invoice
SubscriptionId:
description: The subscription identifier
type: string
Name:
description: Name
type: string
Status:
description: Status
enum:
- Incomplete
- IncompleteExpired
- Trialing
- Active
- PastDue
- Canceled
- Unpaid
type: string
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
User:
description: User
type: string
DefaultPaymentDescription:
description: Default payment description
type: string
CancellationRequestDate:
format: date-time
description: Cancellation Date
type:
- string
- 'null'
CancellationDate:
format: date-time
description: Cancel Date
type:
- string
- 'null'
RestApiUnauthorizedResult:
description: Rest api unauthorized result
required:
- Message
type: object
properties:
Message:
description: Message
type: string
readOnly: true
RestApiArrayResult_SubscriptionSummary:
description: Rest api array result
required:
- Data
type: object
properties:
Data:
description: Generic data object.
type: array
items:
$ref: '#/components/schemas/SubscriptionSummary'
InvoiceItem:
description: Invoice Item
required:
- Description
- Quantity
- UnitAmountExcludingTax
- Tax
- Amount
- Period
type: object
properties:
Description:
description: Description
type: string
Quantity:
format: int64
description: Quantity
type: integer
UnitAmountExcludingTax:
format: double
description: Unit Amount Excluding Tax
type: number
Tax:
format: double
description: Tax
type: number
Amount:
format: double
description: Amount
type: number
Period:
$ref: '#/components/schemas/InvoicePeriod'
description: Period
RestApiErrorResult:
description: Rest api error result
required:
- Message
type: object
properties:
Message:
description: Error message
type: string
ErrorCode:
format: int32
description: Error code
type: integer
StackTrace:
description: Stack trace
type: string
Errors:
description: List of errors grouped by field name
type: array
items:
$ref: '#/components/schemas/ValidationErrorResult'
SubscriptionSummary:
description: Subscription Summary
required:
- SubscriptionId
- Name
- Status
- Currency
- User
type: object
properties:
NextInvoiceAmount:
format: double
description: Next invoice amount
type:
- number
- 'null'
NextInvoiceBillingDate:
format: date-time
description: Next invoice billing date
type:
- string
- 'null'
SubscriptionId:
description: The subscription identifier
type: string
Name:
description: Name
type: string
Status:
description: Status
enum:
- Incomplete
- IncompleteExpired
- Trialing
- Active
- PastDue
- Canceled
- Unpaid
type: string
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
User:
description: User
type: string
DefaultPaymentDescription:
description: Default payment description
type: string
CancellationRequestDate:
format: date-time
description: Cancellation Date
type:
- string
- 'null'
CancellationDate:
format: date-time
description: Cancel Date
type:
- string
- 'null'
RestApiResult_Subscription:
description: Rest api result
required:
- Data
type: object
properties:
Data:
$ref: '#/components/schemas/Subscription'
description: Generic data object.
RestApiResult_HasPaymentMethodResponse:
description: Rest api result
required:
- Data
type: object
properties:
Data:
$ref: '#/components/schemas/HasPaymentMethodResponse'
description: Generic data object.
RestApiForbiddenResult:
description: Rest Api Forbidden Result
required:
- Message
type: object
properties:
Message:
description: Message
type: string
readOnly: true
SubscriptionProduct:
description: Product
required:
- ProductId
- Name
- Quantity
- PaymentFrequency
type: object
properties:
ProductId:
description: Product Identifier
type: string
Name:
description: Name
type: string
Quantity:
format: int64
description: Quantity
type: integer
PricePerUnit:
format: double
description: Price Per Unit
type:
- number
- 'null'
PriceTotal:
format: double
description: Price Total
type:
- number
- 'null'
PaymentFrequency:
description: Payment Frequency
enum:
- day
- week
- month
- year
type: string
Stores:
description: Stores
type: array
items:
$ref: '#/components/schemas/SubscriptionStore'
SubscriptionStore:
description: Subscription Store
required:
- Id
- Name
type: object
properties:
Id:
format: int32
description: Store Id
type: integer
Name:
description: Name
type: string
InvoicePeriod:
description: Invoice Period
type: object
properties:
Start:
format: date-time
description: Start
type: string
End:
format: date-time
description: End
type: string
InvoiceDiscount:
description: Invoice Discount
required:
- Name
- Amount
type: object
properties:
Name:
description: Name
type: string
Amount:
format: double
description: Amount
type: number
securitySchemes:
oauth2:
type: oauth2
flows:
implicit:
scopes:
api: Access to Flipdish API
authorizationUrl: https://api.flipdish.co/identity/connect/authorize
description: OAuth2 Implicit Grant
x-samples-languages:
- curl
- node
- csharp
- ruby
- javascript
- python
- swift
x-send-defaults: true
x-flipdish-signalr:
- hubName: AnalyticsHub
events:
- eventName: analytics.website
eventType: AnalyticsClientEvent
- hubName: AppHub
events:
- eventName: app.created
eventType: AppCreatedEvent
- eventName: app.updated
eventType: AppUpdatedEvent
- hubName: AuthorizationHub
events: []
- hubName: BankAccountHub
events:
- eventName: bankaccount.created
eventType: BankAccountCreatedEvent
- eventName: bankaccount.updated
eventType: BankAccountUpdatedEvent
- eventName: bankaccount.deleted
eventType: BankAccountDeletedEvent
- hubName: CampaignHub
events: []
- hubName: CardReaderHub
events:
- eventName: cardreaders.kiosk.bluetooth.initiatepairingmode
eventType: KioskBluetoothPairingModeEvent
- eventName: cardreaders.kiosk.bluetooth.unpaired
eventType: KioskBluetoothTerminalUnpairedEvent
- eventName: cardreaders.kiosk.bluetooth.updated
eventType: KioskBluetoothTerminalUpdatedEvent
- eventName: cardreaders.kiosk.bluetooth.checkforupdates
eventType: KioskBluetoothTerminalInitiateUpdateCheckEvent
- eventName: cardreaders.kiosk.bluetooth.initiateinstallupdatemode
eventType: KioskBluetoothInstallUpdateInitiateEvent
- eventName: cardreaders.kiosk.bluetooth.cancelupdateinstall
eventType: KioskBluetoothTerminalCancelUpdateEvent
- eventName: cardreaders.kiosk.bluetooth.installationstatus
eventType: KioskBluetoothTerminalInstallationStatusEvent
- eventName: cardreaders.kiosk.bluetooth.firmwareupdateversion
eventType: KioskBluetoothTerminalFirmwareVersionStatusEvent
- eventName: cardreaders.kiosk.bluetooth.terminalactionstatechanged
eventType: KioskTerminalActionStateChangedEvent
- hubName: ChannelHub
events: []
- hubName: CustomerHub
events:
- eventName: customer.created
eventType: CustomerCreatedEvent
- eventName: customer.updated
eventType: CustomerUpdatedEvent
- eventName: customer.consent.updated
eventType: CustomerConsentUpdatedEvent
- hubName: HydraHub
events:
- eventName: hydra.assigned
eventType: HydraAssignedEvent
- eventName: hydra.request_reset
eventType: HydraRequestResetEvent
- eventName: hydra.setting_changed
eventType: HydraSettingChangedEvent
- eventName: hydra.conection_status_changed
eventType: HydraConnectionStatusChangedEvent
- eventName: hydra.unassigned
eventType: HydraUnAssignedEvent
- eventName: hydra.store.assigned
eventType: HydraStoreAssignedEvent
- eventName: hydra.store.unassigned
eventType: HydraStoreUnassignedEvent
- hubName: MenuCheckpointHub
events: []
- hubName: MenuHub
events: []
- hubName: OrderHub
events:
- eventName: order.created
eventType: OrderCreatedEvent
- eventName: order.rejected
eventType: OrderRejectedEvent
- eventName: order.accepted
eventType: OrderAcceptedEvent
- eventName: order.refunded
eventType: OrderRefundedEvent
- hubName: PhoneCallHub
events: []
- hubName: PrinterHub
events: []
- hubName: StoreGroupHub
events:
- eventName: store_group.created
eventType: StoreGroupCreatedEvent
- eventName: store_group.updated
eventType: StoreGroupUpdatedEvent
- eventName: store_group.deleted
eventType: StoreGroupDeletedEvent
- hubName: StoreHub
events:
- eventName: store.created
eventType: StoreCreatedEvent
- eventName: store.updated
eventType: StoreUpdatedEvent
- eventName: store.archived
eventType: StoreArchivedEvent
- eventName: store.unarchived
eventType: StoreUnarchivedEvent
- eventName: store.published
eventType: StorePublishedEvent
- eventName: store.unpublished
eventType: StoreUnpublishedEvent
- eventName: store.deleted
eventType: StoreDeletedEvent
- eventName: store.address.updated
eventType: StoreAddressUpdatedEvent
- eventName: store.opening_hours.updated
eventType: StoreOpeningHoursUpdatedEvent
- eventName: store.menu.assigned
eventType: StoreMenuAssignedEvent
- eventName: store.delivery_zone.created
eventType: DeliveryZoneCreatedEvent
- eventName: store.delivery_zone.updated
eventType: DeliveryZoneUpdatedEvent
- eventName: store.delivery_zone.deleted
eventType: DeliveryZoneDeletedEvent
- eventName: store_group.created
eventType: StoreGroupCreatedEvent
- eventName: store_group.updated
eventType: StoreGroupUpdatedEvent
- eventName: store_group.deleted
eventType: StoreGroupDeletedEvent
- eventName: store.business_hours_override.created
eventType: StoreBusinessHoursOverrideCreatedEvent
- eventName: store.business_hours_override.deleted
eventType: StoreBusinessHoursOverrideDeletedEvent
- eventName: store.preorder_config.updated
eventType: StorePreOrderConfigUpdatedEvent
- eventName: store.logo.created
eventType: StoreLogoCreatedEvent
- eventName: store.logo.updated
eventType: StoreLogoUpdatedEvent
- eventName: store.logo.deleted
eventType: StoreLogoDeletedEvent
- eventName: store.kiosk_setting.updated
eventType: StoreKioskSettingUpdatedEvent
- eventName: store.fee_config.updated
eventType: StoreFeeConfigUpdatedEvent
- hubName: TeammateHub
events:
- eventName: teammate.invite.sent
eventType: TeammateInviteSentEvent
- eventName: teammate.invite.accepted
eventType: TeammateInviteAcceptedEvent
- eventName: teammate.updated
eventType: TeammateUpdatedEvent
- eventName: teammate.deleted
eventType: TeammateDeletedEvent
- hubName: TelephonyConfigHub
events: []
- hubName: VoucherHub
events:
- eventName: voucher.created
eventType: VoucherCreatedEvent
- eventName: voucher.deleted
eventType: VoucherDeletedEvent
- eventName: voucher.updated
eventType: VoucherUpdatedEvent
- eventName: voucher.applied
eventType: VoucherAppliedEvent
- hubName: WebhookHub
events: []
- hubName: WebsiteHub
events: []
x-provenance:
method: harvested
publisher: Flipdish
source: https://api.flipdish.co/swagger/docs/v1.0
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)