Stripe · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Stripe Accounts Account Billing Meters API
9 actions
9 updates
phrasing
extends
openapi/stripe-billing-meters-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Stripe's API. It is a proposal applied on top of the contract, not a document Stripe publishes.
What the actions change
x-apievangelist-phrasing
Targets 9
$.info
$.paths['/v1/billing/meters'].get
$.paths['/v1/billing/meters'].post
$.paths['/v1/billing/meters/{id}'].get
$.paths['/v1/billing/meters/{id}'].post
$.paths['/v1/billing/meters/{id}/deactivate'].post
$.paths['/v1/billing/meters/{id}/reactivate'].post
$.paths['/v1/billing/meters/{id}/event_summaries'].get
$.paths['/v1/billing/meter_events'].post
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 Stripe Accounts Account Billing Meters API
version: 1.0.0
extends: openapi/stripe-billing-meters-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: 8
- target: $.paths['/v1/billing/meters'].get
update:
x-apievangelist-phrasing:
intent: List usage billing meters
effect: read
questions:
- Which billing meters have I set up for usage-based pricing?
- Can I list only active or only inactive meters?
instructions:
- text: List my billing meters.
- text: List billing meters with status {status}.
slots:
status: query.status
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/billing/meters'].post
update:
x-apievangelist-phrasing:
intent: Create a usage billing meter
effect: write
questions:
- How do I start metering usage so I can bill customers for it?
- Can a meter sum usage values instead of just counting events?
instructions:
- text: Create a meter called {display_name} for event {event_name}.
slots:
display_name: requestBody.display_name
event_name: requestBody.event_name
- text: Create a meter {display_name} on event {event_name} aggregated by {default_aggregation}.
slots:
display_name: requestBody.display_name
event_name: requestBody.event_name
default_aggregation: requestBody.default_aggregation
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/billing/meters/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a billing meter
effect: read
questions:
- How do I see how a billing meter is configured?
- Which event name does a given meter listen for?
instructions:
- text: Show billing meter {id}.
slots:
id: path.id
- text: Get the aggregation and event settings of meter {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/billing/meters/{id}'].post
update:
x-apievangelist-phrasing:
intent: Rename a billing meter
effect: write
questions:
- How do I change the display name of a billing meter?
- What can I edit on a meter after creating it?
instructions:
- text: Rename billing meter {id} to {display_name}.
slots:
id: path.id
display_name: requestBody.display_name
- text: Update the display name of meter {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/billing/meters/{id}/deactivate'].post
update:
x-apievangelist-phrasing:
intent: Deactivate a billing meter
effect: write
questions:
- How do I stop a billing meter from being used?
- Can I turn a meter off without deleting it?
instructions:
- text: Deactivate billing meter {id}.
slots:
id: path.id
- text: Turn off meter {id} so it stops tracking usage.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/billing/meters/{id}/reactivate'].post
update:
x-apievangelist-phrasing:
intent: Reactivate a billing meter
effect: write
questions:
- How do I bring a deactivated billing meter back?
- Can I reuse a meter I switched off earlier?
instructions:
- text: Reactivate billing meter {id}.
slots:
id: path.id
- text: Turn meter {id} back on.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/billing/meters/{id}/event_summaries'].get
update:
x-apievangelist-phrasing:
intent: Summarize a customer's metered usage
effect: read
questions:
- How much usage has a customer recorded on a meter this period?
- Can I get a customer's metered usage broken down by hour or day?
instructions:
- text: Summarize usage on meter {id} for customer {customer} from {start_time} to {end_time}.
slots:
id: path.id
customer: query.customer
start_time: query.start_time
end_time: query.end_time
- text: Show {customer}'s usage on meter {id} between {start_time} and {end_time} grouped by {value_grouping_window}.
slots:
customer: query.customer
id: path.id
start_time: query.start_time
end_time: query.end_time
value_grouping_window: query.value_grouping_window
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/billing/meter_events'].post
update:
x-apievangelist-phrasing:
intent: Record a usage event
effect: write
questions:
- How do I report customer usage so it can be billed?
- Can I backdate a usage event with my own timestamp?
- How do I avoid counting the same usage event twice?
instructions:
- text: Record a {event_name} usage event with payload {payload}.
slots:
event_name: requestBody.event_name
payload: requestBody.payload
- text: Report {event_name} usage {payload} at {timestamp}.
slots:
event_name: requestBody.event_name
payload: requestBody.payload
timestamp: requestBody.timestamp
- text: Send meter event {event_name} with payload {payload} and unique identifier {identifier}.
slots:
event_name: requestBody.event_name
payload: requestBody.payload
identifier: requestBody.identifier
method: generated
generated: '2026-09-26'