Generated by API Evangelist
Written by API Evangelist tooling for Kit's API. It is a proposal applied on top of the contract, not a document Kit publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Kit Purchases API
version: 1.0.0
extends: openapi/convertkit-purchases-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-02'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/v4/purchases'].get
update:
x-apievangelist-phrasing:
intent: List purchases
effect: read
questions:
- What purchases have been recorded against my subscribers?
- Can I page through all sales logged in my creator account?
instructions:
- text: List all recorded purchases.
- text: Show my purchases, {per_page} per page.
slots:
per_page: query.per_page
method: generated
generated: '2026-10-02'
- target: $.paths['/v4/purchases'].post
update:
x-apievangelist-phrasing:
intent: Record a purchase
effect: write
questions:
- How do I log a sale from my own store against a subscriber?
- Can I send purchase data from an external checkout into my email account?
instructions:
- text: 'Record this purchase: {purchase}.'
slots:
purchase: requestBody.purchase
- text: 'Create a purchase record with these transaction details: {purchase}.'
slots:
purchase: requestBody.purchase
method: generated
generated: '2026-10-02'
- target: $.paths['/v4/purchases/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a single purchase
effect: read
questions:
- Can I look up the details of one specific purchase?
- What products and totals were on a given purchase?
instructions:
- text: Get purchase {id}.
slots:
id: path.id
- text: Show me the line items and total for purchase {id}.
slots:
id: path.id
method: generated
generated: '2026-10-02'
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.