Drippay · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Drip Tax API
13 actions
13 updates
phrasing
extends
openapi/drippay-tax-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Drippay's API. It is a proposal applied on top of the contract, not a document Drippay publishes.
What the actions change
x-apievangelist-phrasing
Targets 13
$.info
$.paths['/v1/customers/{id}/address'].get
$.paths['/v1/customers/{id}/address'].put
$.paths['/v1/customers/{id}/address'].delete
$.paths['/v1/customers/{id}/tax-exemption'].post
$.paths['/v1/customers/{id}/tax-exemptions'].get
$.paths['/v1/customers/{id}/tax-exemptions/{eid}'].delete
$.paths['/v1/customers/{id}/tax-preview'].post
$.paths['/v1/tax-registrations'].get
$.paths['/v1/tax-registrations'].post
$.paths['/v1/tax-registrations/{id}'].delete
$.paths['/v1/tax-rates'].get
$.paths['/v1/tax-config/readiness'].get
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 Drip Tax API
version: 1.0.0
extends: openapi/drippay-tax-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 12
- target: $.paths['/v1/customers/{id}/address'].get
update:
x-apievangelist-phrasing:
intent: Get a customer's billing address
effect: read
questions:
- What billing address do I have on file for a customer?
- Can I check a customer's stored address used for tax?
instructions:
- text: Show the stored address for customer {id}.
slots:
id: path.id
- text: Get the billing address on file for {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/customers/{id}/address'].put
update:
x-apievangelist-phrasing:
intent: Set a customer's billing address
effect: write
questions:
- How do I save or replace a customer's billing address for tax purposes?
- Does setting a customer address trigger address validation?
instructions:
- text: Set the billing address for customer {id}.
slots:
id: path.id
- text: Replace the address on file for {id} and validate it.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/customers/{id}/address'].delete
update:
x-apievangelist-phrasing:
intent: Remove a customer's address
effect: destructive
questions:
- Can I delete the stored address from a customer?
- How do I clear a customer's billing address?
instructions:
- text: Remove the address from customer {id}.
slots:
id: path.id
- text: Delete the billing address stored for {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/customers/{id}/tax-exemption'].post
update:
x-apievangelist-phrasing:
intent: Add a tax exemption for a customer
effect: write
questions:
- How do I mark a customer as tax exempt?
- Can I exempt a single customer from tax without changing my registrations?
instructions:
- text: Create a tax exemption for customer {id}.
slots:
id: path.id
- text: Make {id} tax exempt.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/customers/{id}/tax-exemptions'].get
update:
x-apievangelist-phrasing:
intent: List a customer's active tax exemptions
effect: read
questions:
- Which tax exemptions are currently active for a customer?
- Is a given customer exempt from tax anywhere?
instructions:
- text: List active tax exemptions for customer {id}.
slots:
id: path.id
- text: Show the exemptions on file for {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/customers/{id}/tax-exemptions/{eid}'].delete
update:
x-apievangelist-phrasing:
intent: Deactivate a customer tax exemption
effect: destructive
questions:
- How do I revoke a customer's tax exemption once it expires?
- Can I deactivate just one exemption for a customer?
instructions:
- text: Deactivate tax exemption {eid} for customer {id}.
slots:
eid: path.eid
id: path.id
- text: Remove exemption {eid} from {id}.
slots:
eid: path.eid
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/customers/{id}/tax-preview'].post
update:
x-apievangelist-phrasing:
intent: Preview tax on a hypothetical charge
effect: read
questions:
- How much tax would a customer pay on a given charge amount?
- Can I estimate tax for a customer before actually charging them?
instructions:
- text: Preview tax for a hypothetical charge to customer {id}.
slots:
id: path.id
- text: Estimate the tax {id} would owe on a charge.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/tax-registrations'].get
update:
x-apievangelist-phrasing:
intent: List the business's tax registrations
effect: read
questions:
- Which jurisdictions is my business registered to collect tax in?
- What tax registrations are active on my account?
instructions:
- text: List my active tax registrations.
- text: Show where my business is registered for tax.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/tax-registrations'].post
update:
x-apievangelist-phrasing:
intent: Add a tax registration for the business
effect: write
questions:
- How do I register my business to collect tax in a new jurisdiction?
- Can I add a VAT or sales tax registration to my account?
instructions:
- text: Create a tax registration for my business.
- text: Add a new jurisdiction registration for tax collection.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/tax-registrations/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Deactivate a tax registration
effect: destructive
questions:
- How do I stop collecting tax in a jurisdiction I've deregistered from?
- Can I deactivate one of my business's tax registrations?
instructions:
- text: Deactivate tax registration {id}.
slots:
id: path.id
- text: Remove business tax registration {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/tax-rates'].get
update:
x-apievangelist-phrasing:
intent: List the global tax rate catalogue
effect: read
questions:
- What tax rates are built into the global catalogue?
- Can I see the seeded tax rates by jurisdiction?
instructions:
- text: List the global tax rate catalogue.
- text: Show all seeded tax rates.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/tax-config/readiness'].get
update:
x-apievangelist-phrasing:
intent: Check tax configuration readiness
effect: read
questions:
- Is my tax setup production-ready, and which jurisdictions aren't covered?
- Which of my customers are missing an address for tax calculation?
instructions:
- text: Check whether my tax configuration is production-ready.
- text: Report tax setup warnings and uncovered jurisdictions.
method: generated
generated: '2026-09-26'