Vendasta · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Platform REST Subscriptions API

3 actions 3 updates phrasing extends openapi/vendasta-subscriptions-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Vendasta's API. It is a proposal applied on top of the contract, not a document Vendasta publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/subscriptions'].get

$.paths['/subscriptions'].options

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Platform REST Subscriptions API
  version: 1.0.0
extends: openapi/vendasta-subscriptions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List product subscriptions for a partner
      effect: read
      questions:
      - Which products has a business location subscribed to through my partner account?
      - Do multi-activatable products show up as separate subscription records?
      instructions:
      - text: List subscriptions for partner {partner} at business location {location}.
        slots:
          partner: query.filter[partner.id]
          location: query.filter[businessLocation.id]
      - text: Show the first {limit} subscriptions of partner {partner} for location {location}.
        slots:
          limit: query.page[limit]
          partner: query.filter[partner.id]
          location: query.filter[businessLocation.id]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for subscriptions
      effect: read
      questions:
      - Which HTTP verbs does the subscriptions endpoint accept from a browser?
      - Does the subscription list pass a CORS preflight?
      instructions:
      - text: Send OPTIONS to the subscriptions endpoint for partner {partner}.
        slots:
          partner: query.filter[partner.id]
      - text: Preflight subscriptions cross-origin for partner {partner} and location {location}.
        slots:
          partner: query.filter[partner.id]
          location: query.filter[businessLocation.id]
      method: generated
      generated: '2026-10-01'

Work with this as data

Every overlay 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 openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
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.

All 92 tools →

Call it yourself

curl for this page

This overlay

curl "https://apis.io/api/v1/overlays/vendasta-subscriptions-api-phrasing-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.