Drippay · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Drip Pricing Plans API

9 actions 9 updates phrasing extends openapi/drippay-pricing-plans-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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/v1/pricing-plans'].get
$.paths['/v1/pricing-plans'].post
$.paths['/v1/pricing-plans/{id}'].get
$.paths['/v1/pricing-plans/{id}'].delete
$.paths['/v1/pricing-plans/{id}'].patch
$.paths['/v1/pricing-plans/{id}/versions'].get
$.paths['/v1/pricing-plans/by-type/{unitType}'].get
$.paths['/v1/pricing-plans/{id}/reprovision-stripe'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Drip Pricing Plans API
  version: 1.0.0
extends: openapi/drippay-pricing-plans-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/pricing-plans'].get
  update:
    x-apievangelist-phrasing:
      intent: List pricing plans
      effect: read
      questions:
      - What per-unit pricing plans have I set up?
      - Can I see every usage pricing plan on my account?
      instructions:
      - text: List my pricing plans.
      - text: Show all the unit prices I've configured.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/pricing-plans'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a pricing plan for a usage type
      effect: write
      questions:
      - How do I set a per-unit price for a usage type like API calls or tokens?
      - Can I create tiered pricing for a unit type?
      - Why can't I add a second active pricing plan for the same unit type?
      instructions:
      - text: Create a pricing plan {name} charging {unitPriceUsd} USD per {unitType}.
        slots:
          name: requestBody.name
          unitPriceUsd: requestBody.unitPriceUsd
          unitType: requestBody.unitType
      - text: Add a {pricingModel} plan {name} for {unitType} at {unitPriceUsd} with tiers {tiers}.
        slots:
          pricingModel: requestBody.pricingModel
          name: requestBody.name
          unitType: requestBody.unitType
          unitPriceUsd: requestBody.unitPriceUsd
          tiers: requestBody.tiers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/pricing-plans/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pricing plan
      effect: read
      questions:
      - What price and pricing model does one plan use?
      - Can I retrieve a pricing plan by its ID?
      instructions:
      - text: Show pricing plan {id}.
        slots:
          id: path.id
      - text: Get the details of plan {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/pricing-plans/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Deactivate a pricing plan
      effect: destructive
      questions:
      - How do I stop a pricing plan from applying to new usage?
      - Do past charges survive if I delete a pricing plan?
      instructions:
      - text: Delete pricing plan {id}.
        slots:
          id: path.id
      - text: Deactivate the plan {id} for new usage.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/pricing-plans/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a pricing plan's price or status
      effect: write
      questions:
      - Can I change my unit price and have it apply to new charges straight away?
      - How do I reactivate a pricing plan I deactivated?
      instructions:
      - text: Change the unit price on plan {id} to {unitPriceUsd} USD.
        slots:
          id: path.id
          unitPriceUsd: requestBody.unitPriceUsd
      - text: Reactivate pricing plan {id} by setting active to {isActive}.
        slots:
          id: path.id
          isActive: requestBody.isActive
      - text: Rename plan {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/pricing-plans/{id}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a pricing plan's version history
      effect: read
      questions:
      - What did a pricing plan cost in its earlier versions?
      - Can I see every archived version of a price?
      instructions:
      - text: List all versions of pricing plan {id}.
        slots:
          id: path.id
      - text: Show the price history for plan {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/pricing-plans/by-type/{unitType}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up the active price for a unit type
      effect: read
      questions:
      - What am I currently charging per unit for a given usage type?
      - Which pricing plan is active for a specific unit type?
      instructions:
      - text: Get the active pricing plan for unit type {unitType}.
        slots:
          unitType: path.unitType
      - text: What price applies to {unitType} right now — look it up.
        slots:
          unitType: path.unitType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/pricing-plans/{id}/reprovision-stripe'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry Stripe provisioning for a pricing plan
      effect: write
      questions:
      - My plan's Stripe product and price didn't get created — can I retry that?
      - Is it safe to rerun Stripe provisioning on a plan that partly succeeded?
      instructions:
      - text: Retry Stripe provisioning for pricing plan {id}.
        slots:
          id: path.id
      - text: Reprovision the Stripe product, meter and price for plan {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'