Appwrite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Appwrite Organizations API

46 actions 46 updates phrasing extends openapi/appwrite-organizations-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Appwrite's API. It is a proposal applied on top of the contract, not a document Appwrite publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 46 · first 16 shown; the file carries all of them

$.info
$.paths['/organizations'].get
$.paths['/organizations'].post
$.paths['/organizations/estimations/create-organization'].patch
$.paths['/organizations/{organizationId}'].delete
$.paths['/organizations/{organizationId}/addons'].get
$.paths['/organizations/{organizationId}/addons/baa'].post
$.paths['/organizations/{organizationId}/addons/premium-geo-db'].post
$.paths['/organizations/{organizationId}/addons/{addonId}'].get
$.paths['/organizations/{organizationId}/addons/{addonId}'].delete
$.paths['/organizations/{organizationId}/addons/{addonId}/confirmations'].post
$.paths['/organizations/{organizationId}/addons/{addon}/price'].get
$.paths['/organizations/{organizationId}/aggregations'].get
$.paths['/organizations/{organizationId}/aggregations/{aggregationId}'].get
$.paths['/organizations/{organizationId}/billing-address'].delete
$.paths['/organizations/{organizationId}/billing-address'].patch

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 Appwrite Organizations API
  version: 1.0.0
extends: openapi/appwrite-organizations-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: 45
- target: $.paths['/organizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List organizations I belong to
      effect: read
      questions:
      - Which Appwrite organizations am I a member of?
      - Can I search the organizations on my account by name?
      instructions:
      - text: List all organizations I'm a member of.
      - text: Search my organizations for {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new billed organization
      effect: write
      questions:
      - How do I create a new organization on a paid billing plan?
      - Can I invite teammates and apply a coupon while creating an organization?
      instructions:
      - text: Create organization {organizationId} named {name} on plan {billingPlan}.
        slots:
          organizationId: requestBody.organizationId
          name: requestBody.name
          billingPlan: requestBody.billingPlan
      - text: Start org {organizationId} called {name} on {billingPlan}, paying with {paymentMethodId} and coupon {couponId}.
        slots:
          organizationId: requestBody.organizationId
          name: requestBody.name
          billingPlan: requestBody.billingPlan
          paymentMethodId: requestBody.paymentMethodId
          couponId: requestBody.couponId
      - text: Create organization {organizationId} named {name} on {billingPlan} and invite {invites}.
        slots:
          organizationId: requestBody.organizationId
          name: requestBody.name
          billingPlan: requestBody.billingPlan
          invites: requestBody.invites
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/estimations/create-organization'].patch
  update:
    x-apievangelist-phrasing:
      intent: Estimate the cost of a new organization
      effect: read
      questions:
      - What would it cost to open a new organization on a given plan before I commit?
      - Does inviting extra members change the estimate for creating an organization?
      instructions:
      - text: Estimate the price of creating an organization on {billingPlan}.
        slots:
          billingPlan: requestBody.billingPlan
      - text: Quote a new org on {billingPlan} with invites {invites} and coupon {couponId}.
        slots:
          billingPlan: requestBody.billingPlan
          invites: requestBody.invites
          couponId: requestBody.couponId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization
      effect: destructive
      questions:
      - How do I delete one of my organizations entirely?
      - Can I remove an organization by ID from my account?
      instructions:
      - text: Delete organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Permanently remove org {organizationId}.
        slots:
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/addons'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's billing addons
      effect: read
      questions:
      - Which paid addons are active on my organization?
      - Does my org already have the BAA or Premium Geo DB addon?
      instructions:
      - text: List billing addons for organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Show which addons {organizationId} pays for.
        slots:
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/addons/baa'].post
  update:
    x-apievangelist-phrasing:
      intent: Add the BAA addon to an organization
      effect: write
      questions:
      - How do I get a Business Associate Agreement for HIPAA workloads on my organization?
      - Is the BAA a separate billing addon I have to enable?
      instructions:
      - text: Add the BAA addon to organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Enable the Business Associate Agreement for {organizationId}.
        slots:
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/addons/premium-geo-db'].post
  update:
    x-apievangelist-phrasing:
      intent: Add the Premium Geo DB addon
      effect: write
      questions:
      - How do I turn on the Premium Geo DB addon for more detailed geolocation?
      - Can I buy the premium geo database as an organization addon?
      instructions:
      - text: Add the Premium Geo DB addon to organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Enable premium geolocation data for {organizationId}.
        slots:
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/addons/{addonId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a billing addon's details
      effect: read
      questions:
      - What is the status of a specific addon on my organization?
      - Is my addon still awaiting payment confirmation?
      instructions:
      - text: Show addon {addonId} on organization {organizationId}.
        slots:
          addonId: path.addonId
          organizationId: path.organizationId
      - text: Get the details of billing addon {addonId} for {organizationId}.
        slots:
          addonId: path.addonId
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/addons/{addonId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a billing addon
      effect: destructive
      questions:
      - How do I stop paying for an addon I no longer need?
      - Can I remove the BAA addon from my organization?
      instructions:
      - text: Delete addon {addonId} from organization {organizationId}.
        slots:
          addonId: path.addonId
          organizationId: path.organizationId
      - text: Cancel billing addon {addonId} on {organizationId}.
        slots:
          addonId: path.addonId
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/addons/{addonId}/confirmations'].post
  update:
    x-apievangelist-phrasing:
      intent: Confirm an addon payment after 3DS
      effect: write
      questions:
      - My card required 3D Secure when buying an addon; how do I finish the payment?
      - What do I call after 3DS authentication to activate an addon?
      instructions:
      - text: Confirm payment for addon {addonId} on organization {organizationId}.
        slots:
          addonId: path.addonId
          organizationId: path.organizationId
      - text: Complete the 3DS-authenticated charge for addon {addonId} in {organizationId}.
        slots:
          addonId: path.addonId
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/addons/{addon}/price'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the price of a billing addon
      effect: read
      questions:
      - How much does an addon like BAA cost for my organization?
      - Can I check an addon's price before enabling it?
      instructions:
      - text: Get the price of the {addon} addon for organization {organizationId}.
        slots:
          addon: path.addon
          organizationId: path.organizationId
      - text: Quote addon {addon} for {organizationId}.
        slots:
          addon: path.addon
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/aggregations'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's billing aggregations
      effect: read
      questions:
      - Where can I see the billing-period usage aggregations for my organization?
      - Can I filter an organization's aggregations with queries?
      instructions:
      - text: List billing aggregations for organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Show aggregations for {organizationId} matching {queries}.
        slots:
          organizationId: path.organizationId
          queries: query.queries
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/aggregations/{aggregationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one billing aggregation
      effect: read
      questions:
      - What usage was billed in a particular aggregation period?
      - Can I page through the breakdown inside a single aggregation?
      instructions:
      - text: Show aggregation {aggregationId} for organization {organizationId}.
        slots:
          aggregationId: path.aggregationId
          organizationId: path.organizationId
      - text: Get {limit} items of aggregation {aggregationId} in {organizationId} starting at {offset}.
        slots:
          limit: query.limit
          aggregationId: path.aggregationId
          organizationId: path.organizationId
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/billing-address'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an organization's billing address
      effect: destructive
      questions:
      - How do I clear the billing address from my organization?
      - Can I unset the address that appears on my invoices?
      instructions:
      - text: Delete the billing address of organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Clear the invoice address on {organizationId}.
        slots:
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/billing-address'].patch
  update:
    x-apievangelist-phrasing:
      intent: Set an organization's billing address
      effect: write
      questions:
      - How do I choose which saved address goes on my organization's invoices?
      - Can I switch my org to a different billing address?
      instructions:
      - text: Set organization {organizationId}'s billing address to {billingAddressId}.
        slots:
          organizationId: path.organizationId
          billingAddressId: requestBody.billingAddressId
      - text: Use saved address {billingAddressId} for billing on {organizationId}.
        slots:
          billingAddressId: requestBody.billingAddressId
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/billing-addresses/{billingAddressId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a billing address
      effect: read
      questions:
      - What billing address is saved under a given ID for my organization?
      - Can I view the full details of one billing address?
      instructions:
      - text: Show billing address {billingAddressId} of organization {organizationId}.
        slots:
          billingAddressId: path.billingAddressId
          organizationId: path.organizationId
      - text: Fetch address {billingAddressId} for {organizationId}.
        slots:
          billingAddressId: path.billingAddressId
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/billing-email'].patch
  update:
    x-apievangelist-phrasing:
      intent: Set an organization's billing email
      effect: write
      questions:
      - How do I send invoices to our finance team's email instead of mine?
      - Can I change the billing contact email for an organization?
      instructions:
      - text: Set the billing email of organization {organizationId} to {billingEmail}.
        slots:
          organizationId: path.organizationId
          billingEmail: requestBody.billingEmail
      - text: Send {organizationId}'s invoices to {billingEmail}.
        slots:
          organizationId: path.organizationId
          billingEmail: requestBody.billingEmail
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/budget'].patch
  update:
    x-apievangelist-phrasing:
      intent: Set an organization's spending budget
      effect: write
      questions:
      - How do I cap my organization's monthly spend?
      - Can I get alerts as my organization approaches its budget limit?
      instructions:
      - text: Set the budget for organization {organizationId} to {budget}.
        slots:
          organizationId: path.organizationId
          budget: requestBody.budget
      - text: Cap {organizationId} spend at {budget} with alerts at {alerts} percent.
        slots:
          organizationId: path.organizationId
          budget: requestBody.budget
          alerts: requestBody.alerts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/credits'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's credits
      effect: read
      questions:
      - Which credits and coupons have been applied to my organization?
      - Can I filter an organization's credit history with queries?
      instructions:
      - text: List credits for organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Show {organizationId}'s credits matching {queries}.
        slots:
          organizationId: path.organizationId
          queries: query.queries
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/credits'].post
  update:
    x-apievangelist-phrasing:
      intent: Redeem a coupon for organization credits
      effect: write
      questions:
      - How do I redeem a promo coupon for credits on my organization?
      - Can a coupon code be added to an existing organization?
      instructions:
      - text: Redeem coupon {couponId} on organization {organizationId}.
        slots:
          couponId: requestBody.couponId
          organizationId: path.organizationId
      - text: Add credits from coupon {couponId} to {organizationId}.
        slots:
          couponId: requestBody.couponId
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/credits/available'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization's available credit balance
      effect: read
      questions:
      - How much valid credit does my organization have left to spend?
      - What's my total remaining credit balance?
      instructions:
      - text: Show the available credit balance for organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Total up the unused credits on {organizationId}.
        slots:
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/credits/{creditId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one credit's details
      effect: read
      questions:
      - When does a specific credit on my organization expire?
      - How much of one applied credit has been used?
      instructions:
      - text: Show credit {creditId} on organization {organizationId}.
        slots:
          creditId: path.creditId
          organizationId: path.organizationId
      - text: Get details for credit {creditId} in {organizationId}.
        slots:
          creditId: path.creditId
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/estimations/delete-organization'].patch
  update:
    x-apievangelist-phrasing:
      intent: Estimate the charges for deleting an organization
      effect: read
      questions:
      - Will I be charged anything outstanding if I delete my organization?
      - Can I preview the final bill before deleting an org?
      instructions:
      - text: Estimate the cost of deleting organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Preview what I'd owe if {organizationId} were deleted.
        slots:
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/estimations/update-plan'].patch
  update:
    x-apievangelist-phrasing:
      intent: Estimate a plan change for an organization
      effect: read
      questions:
      - What would my bill look like if I switched my organization to another plan?
      - Does a coupon lower the estimate for changing plans?
      instructions:
      - text: Estimate switching organization {organizationId} to plan {billingPlan}.
        slots:
          organizationId: path.organizationId
          billingPlan: requestBody.billingPlan
      - text: Get a plan-update estimate for {organizationId} on {billingPlan} with coupon {couponId} and invites {invites}.
        slots:
          organizationId: path.organizationId
          billingPlan: requestBody.billingPlan
          couponId: requestBody.couponId
          invites: requestBody.invites
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/feedbacks/downgrade'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit feedback about a plan downgrade
      effect: write
      questions:
      - Where can I tell the team why I'm downgrading my plan?
      - What details are asked for when leaving downgrade feedback?
      instructions:
      - text: 'Send downgrade feedback for {organizationId} from {fromPlanId} to {toPlanId}: reason {reason}, message {message}.'
        slots:
          organizationId: path.organizationId
          fromPlanId: requestBody.fromPlanId
          toPlanId: requestBody.toPlanId
          reason: requestBody.reason
          message: requestBody.message
      - text: 'Record why {organizationId} moved from {fromPlanId} to {toPlanId}: {reason}, {message}.'
        slots:
          organizationId: path.organizationId
          fromPlanId: requestBody.fromPlanId
          toPlanId: requestBody.toPlanId
          reason: requestBody.reason
          message: requestBody.message
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/invoices'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's invoices
      effect: read
      questions:
      - Where can I see all past invoices for my organization?
      - Can I filter invoices to only unpaid ones with a query?
      instructions:
      - text: List invoices for organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Show {organizationId}'s invoices matching {queries}.
        slots:
          organizationId: path.organizationId
          queries: query.queries
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/invoices/{invoiceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an invoice
      effect: read
      questions:
      - What's the amount and status of a specific invoice?
      - How do I look up one invoice's line items by its ID?
      instructions:
      - text: Show invoice {invoiceId} for organization {organizationId}.
        slots:
          invoiceId: path.invoiceId
          organizationId: path.organizationId
      - text: Get the details of invoice {invoiceId} in {organizationId}.
        slots:
          invoiceId: path.invoiceId
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/invoices/{invoiceId}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an invoice PDF
      effect: read
      questions:
      - How do I download an invoice as a PDF file for my accountant?
      - Can I save a copy of an invoice PDF locally?
      instructions:
      - text: Download the PDF of invoice {invoiceId} for organization {organizationId}.
        slots:
          invoiceId: path.invoiceId
          organizationId: path.organizationId
      - text: Save invoice {invoiceId} from {organizationId} as a PDF file.
        slots:
          invoiceId: path.invoiceId
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/invoices/{invoiceId}/payments'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry payment on a failed invoice
      effect: write
      questions:
      - An invoice payment failed; how do I pay it now with another card?
      - Can I choose which payment method settles a failed invoice?
      instructions:
      - text: Pay failed invoice {invoiceId} of organization {organizationId} with payment method {paymentMethodId}.
        slots:
          invoiceId: path.invoiceId
          organizationId: path.organizationId
          paymentMethodId: requestBody.paymentMethodId
      - text: Charge {paymentMethodId} for the unpaid invoice {invoiceId} in {organizationId}.
        slots:
          paymentMethodId: requestBody.paymentMethodId
          invoiceId: path.invoiceId
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/invoices/{invoiceId}/status'].patch
  update:
    x-apievangelist-phrasing:
      intent: Re-check an invoice's payment status
      effect: write
      questions:
      - I paid an invoice but it still shows unpaid; how do I refresh its status?
      - Can I sync an invoice's status with its payment after it changes?
      instructions:
      - text: Validate the payment for invoice {invoiceId} in organization {organizationId}.
        slots:
          invoiceId: path.invoiceId
          organizationId: path.organizationId
      - text: Refresh the status of invoice {invoiceId} for {organizationId} from its payment.
        slots:
          invoiceId: path.invoiceId
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/invoices/{invoiceId}/view'].get
  update:
    x-apievangelist-phrasing:
      intent: View an invoice PDF in the browser
      effect: read
      questions:
      - Can I open an invoice PDF inline to view it rather than download it?
      - How do I preview an invoice in the browser?
      instructions:
      - text: Open invoice {invoiceId} of organization {organizationId} for viewing.
        slots:
          invoiceId: path.invoiceId
          organizationId: path.organizationId
      - text: Display the invoice {invoiceId} from {organizationId} inline.
        slots:
          invoiceId: path.invoiceId
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/payment-method'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an organization's default payment method
      effect: destructive
      questions:
      - How do I remove the primary card on my organization?
      - Can I unset the default payment method for an org?
      instructions:
      - text: Remove the default payment method from organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Unset the primary card on {organizationId}.
        slots:
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/payment-method'].patch
  update:
    x-apievangelist-phrasing:
      intent: Set an organization's default payment method
      effect: write
      questions:
      - How do I change which card my organization is charged on by default?
      - Can I make a newly added card the primary payment method?
      instructions:
      - text: Set payment method {paymentMethodId} as the default for organization {organizationId}.
        slots:
          paymentMethodId: requestBody.paymentMethodId
          organizationId: path.organizationId
      - text: Charge {organizationId} on card {paymentMethodId} from now on.
        slots:
          organizationId: path.organizationId
          paymentMethodId: requestBody.paymentMethodId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/payment-method/backup'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an organization's backup payment method
      effect: destructive
      questions:
      - How do I remove the fallback card from my organization?
      - Can I delete a backup payment method but keep the primary one?
      instructions:
      - text: Remove the backup payment method from organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Delete the fallback card on {organizationId}.
        slots:
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/payment-method/backup'].patch
  update:
    x-apievangelist-phrasing:
      intent: Set an organization's backup payment method
      effect: write
      questions:
      - Can I add a second card that is charged if the primary one fails?
      - How do I set a fallback payment method for my organization?
      instructions:
      - text: Set {paymentMethodId} as the backup payment method for organization {organizationId}.
        slots:
          paymentMethodId: requestBody.paymentMethodId
          organizationId: path.organizationId
      - text: Use card {paymentMethodId} as the fallback for {organizationId}.
        slots:
          paymentMethodId: requestBody.paymentMethodId
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/payment-methods/{paymentMethodId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization's payment method
      effect: read
      questions:
      - Which card brand and expiry is on a given payment method?
      - How can I look up one of my organization's payment methods by ID?
      instructions:
      - text: Show payment method {paymentMethodId} of organization {organizationId}.
        slots:
          paymentMethodId: path.paymentMethodId
          organizationId: path.organizationId
      - text: Get card details for {paymentMethodId} in {organizationId}.
        slots:
          paymentMethodId: path.paymentMethodId
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/plan'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization's current billing plan
      effect: read
      questions:
      - Which billing plan is my organization on right now?
      - What limits come with my organization's current plan?
      instructions:
      - text: Show the current plan for organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Get the billing plan details of {organizationId}.
        slots:
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/plan'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an organization's billing plan
      effect: write
      questions:
      - How do I upgrade my organization to a higher plan?
      - Can I set a budget and tax ID while switching plans?
      instructions:
      - text: Switch organization {organizationId} to plan {billingPlan}.
        slots:
          organizationId: path.organizationId
          billingPlan: requestBody.billingPlan
      - text: Move {organizationId} to {billingPlan} paying with {paymentMethodId} and coupon {couponId}.
        slots:
          organizationId: path.organizationId
          billingPlan: requestBody.billingPlan
          paymentMethodId: requestBody.paymentMethodId
          couponId: requestBody.couponId
      - text: Change {organizationId}'s plan to {billingPlan} with budget {budget} and tax ID {taxId}.
        slots:
          organizationId: path.organizationId
          billingPlan: requestBody.billingPlan
          budget: requestBody.budget
          taxId: requestBody.taxId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/plan/cancel'].patch
  update:
    x-apievangelist-phrasing:
      intent: Cancel a pending plan downgrade
      effect: write
      questions:
      - I scheduled a downgrade by mistake; can I cancel it?
      - How do I keep my current plan after initiating a downgrade?
      instructions:
      - text: Cancel the pending downgrade on organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Undo the scheduled plan change for {organizationId}.
        slots:
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/plan/estimations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an upgrade or downgrade plan estimate
      effect: read
      questions:
      - How do I create a saved estimation for upgrading or downgrading my organization's plan?
      - Can I factor extra member invites into a plan upgrade or downgrade estimation?
      instructions:
      - text: Create a plan estimation for {organizationId} moving to {billingPlan}.
        slots:
          organizationId: path.organizationId
          billingPlan: requestBody.billingPlan
      - text: Build an upgrade/downgrade estimation for {organizationId} to {billingPlan} with {invites} invites and coupon {couponId}.
        slots:
          organizationId: path.organizationId
          billingPlan: requestBody.billingPlan
          invites: requestBody.invites
          couponId: requestBody.couponId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/regions'].get
  update:
    x-apievangelist-phrasing:
      intent: List regions available to an organization
      effect: read
      questions:
      - Which regions can my organization deploy projects into?
      - Is a given hosting region available on my organization's plan?
      instructions:
      - text: List available regions for organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Show where {organizationId} can host projects.
        slots:
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'


# --- truncated at 32 KB (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/overlays/appwrite-organizations-api-phrasing-overlay.yaml