# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Relevance AI Endpoints Billing API version: 1.0.0 extends: openapi/relevance-ai-billing-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: 22 - target: $.paths['/organizations/{organization_id}/billing/totals'].get update: x-apievangelist-phrasing: intent: Get an organization's total cost for a period effect: read questions: - How much has my organization spent over a given date range? - What are our total billed costs this month? instructions: - text: Get total billing cost for organization {organization_id}. slots: organization_id: path.organization_id - text: Show organization {organization_id}'s total cost for {date_range}. slots: organization_id: path.organization_id date_range: query.date_range method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/billing/get_billing_frontend_link'].get update: x-apievangelist-phrasing: intent: Get a link to the billing portal effect: read questions: - Where can I open the billing portal to manage my organization's payment details? - Can I get a link that takes me straight to a specific billing flow? instructions: - text: Get the billing portal link for organization {organization_id}. slots: organization_id: path.organization_id - text: Open the billing page for {organization_id} at the {flow} flow. slots: organization_id: path.organization_id flow: query.flow method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/billing/checkout'].get update: x-apievangelist-phrasing: intent: Start a subscription checkout session effect: write questions: - How do I get a checkout page to pay for a subscription plan? - Can I start a checkout session for a particular checkout type? instructions: - text: Create a checkout session for organization {organization_id}. slots: organization_id: path.organization_id - text: Start a {type} checkout for organization {organization_id}. slots: type: query.type organization_id: path.organization_id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/billing/update'].post update: x-apievangelist-phrasing: intent: Set an organization's plan and billing cycle effect: write questions: - Can I move my organization onto a different plan with annual billing? - What's needed to update the plan and billing cycle on our account? instructions: - text: Update organization {organization_id} to plan {plan} billed {billing_cycle}. slots: organization_id: path.organization_id plan: requestBody.plan billing_cycle: requestBody.billing_cycle - text: Set billing for {organization_id} to the {plan} plan on a {billing_cycle} cycle. slots: organization_id: path.organization_id plan: requestBody.plan billing_cycle: requestBody.billing_cycle method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/subscription/sync'].post update: x-apievangelist-phrasing: intent: Resync an organization's subscription state effect: write questions: - My plan looks out of date - can I resync the subscription from the payment processor? - Is there a way to refresh our organization's subscription status? instructions: - text: Sync the subscription for organization {organization_id}. slots: organization_id: path.organization_id - text: Refresh subscription state for {organization_id} from billing. slots: organization_id: path.organization_id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/subscription/downgrade'].post update: x-apievangelist-phrasing: intent: Downgrade an organization's subscription effect: write questions: - How do I downgrade to a cheaper plan? - Can I leave feedback when downgrading my organization's subscription? instructions: - text: Downgrade organization {organization_id} to plan {plan} with idempotency key {idempotency_key}. slots: organization_id: path.organization_id plan: requestBody.plan idempotency_key: requestBody.idempotency_key - text: Downgrade {organization_id} to {plan} and note the reason as {feedback}, key {idempotency_key}. slots: organization_id: path.organization_id plan: requestBody.plan feedback: requestBody.feedback idempotency_key: requestBody.idempotency_key method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/billing/subscription/change'].post update: x-apievangelist-phrasing: intent: Change subscription plan, optionally with a coupon effect: write questions: - Can I switch my subscription to a new plan and apply a coupon code? - What do I need to change our plan to a different tier and billing cycle? instructions: - text: Change organization {organization_id} to plan {new_plan_name} billed {billing_cycle}, key {idempotency_key}. slots: organization_id: path.organization_id new_plan_name: requestBody.new_plan_name billing_cycle: requestBody.billing_cycle idempotency_key: requestBody.idempotency_key - text: Switch {organization_id} to {new_plan_name} {billing_cycle} using coupon {coupon_code}, key {idempotency_key}. slots: organization_id: path.organization_id new_plan_name: requestBody.new_plan_name billing_cycle: requestBody.billing_cycle coupon_code: requestBody.coupon_code idempotency_key: requestBody.idempotency_key method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/downgrade/cancel'].post update: x-apievangelist-phrasing: intent: Cancel a scheduled plan downgrade effect: write questions: - I scheduled a downgrade - can I undo it and stay on my current plan? - Is it possible to call off a pending subscription downgrade? instructions: - text: Cancel the pending downgrade for organization {organization_id}, key {idempotency_key}. slots: organization_id: path.organization_id idempotency_key: requestBody.idempotency_key - text: Keep {organization_id} on its current plan by calling off the scheduled downgrade, key {idempotency_key}. slots: organization_id: path.organization_id idempotency_key: requestBody.idempotency_key method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/subscription/cancel'].post update: x-apievangelist-phrasing: intent: Cancel an organization's subscription effect: destructive questions: - How do I cancel my organization's paid subscription? - What happens when I cancel the subscription entirely? instructions: - text: Cancel the subscription for organization {organization_id}. slots: organization_id: path.organization_id - text: End {organization_id}'s paid subscription with idempotency key {idempotency_key}. slots: organization_id: path.organization_id idempotency_key: requestBody.idempotency_key method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/credits/buy'].post update: x-apievangelist-phrasing: intent: Buy credits for an organization effect: write questions: - Can I purchase additional credits directly on my saved payment method? - How many credits can I top up at once? instructions: - text: Buy {quantity} credits for organization {organization_id}, key {idempotency_key}. slots: quantity: requestBody.quantity organization_id: path.organization_id idempotency_key: requestBody.idempotency_key - text: Purchase {quantity} extra credits for {organization_id} with idempotency key {idempotency_key}. slots: quantity: requestBody.quantity organization_id: path.organization_id idempotency_key: requestBody.idempotency_key method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/credits/checkout'].post update: x-apievangelist-phrasing: intent: Start a checkout to buy credits and actions effect: write questions: - Can I get a checkout page to pay for credits and actions together? - Which quantities do I choose when checking out a credit purchase? instructions: - text: Open a credit checkout for organization {organization_id} with {credits_quantity} credits and {actions_quantity} actions. slots: organization_id: path.organization_id credits_quantity: requestBody.credits_quantity actions_quantity: requestBody.actions_quantity - text: Start a checkout for {credits_quantity} credits and {actions_quantity} actions on {organization_id}. slots: credits_quantity: requestBody.credits_quantity actions_quantity: requestBody.actions_quantity organization_id: path.organization_id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/checkout/status'].get update: x-apievangelist-phrasing: intent: Check whether a checkout completed effect: read questions: - Did my checkout session actually go through? - How can I tell if a payment checkout has completed? instructions: - text: Check checkout status for organization {organization_id}. slots: organization_id: path.organization_id - text: Tell me whether checkout session {checkout_session_id} for {organization_id} completed. slots: checkout_session_id: query.checkout_session_id organization_id: path.organization_id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/trial/trigger'].post update: x-apievangelist-phrasing: intent: Start a plan trial for an organization effect: write questions: - Can my organization start a free trial of a paid plan? - What does it take to kick off a plan trial for our team? instructions: - text: Start a plan trial for organization {organization_id}. slots: organization_id: path.organization_id - text: Trigger the trial for {organization_id} using idempotency key {idempotency_key}. slots: organization_id: path.organization_id idempotency_key: requestBody.idempotency_key method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/aggregate/agents/credits'].post update: x-apievangelist-phrasing: intent: Total credits used per agent effect: read questions: - Which of my agents are using the most credits? - How many credits did all our agents consume between two dates? instructions: - text: Aggregate agent credit usage for organization {organization_id}. slots: organization_id: path.organization_id - text: Show credits used by each agent in {organization_id} from {start_date} to {end_date}. slots: organization_id: path.organization_id start_date: requestBody.start_date end_date: requestBody.end_date method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/aggregate/tools/credits'].post update: x-apievangelist-phrasing: intent: Total credits used per tool effect: read questions: - Which tools are burning through our credits? - What was the credit spend across all tools for a date range? instructions: - text: Aggregate tool credit usage for organization {organization_id}. slots: organization_id: path.organization_id - text: Break down credits used by tools in {organization_id} between {start_date} and {end_date}. slots: organization_id: path.organization_id start_date: requestBody.start_date end_date: requestBody.end_date method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/retention-offer/eligibility'].get update: x-apievangelist-phrasing: intent: Check eligibility for a retention discount effect: read questions: - Is my organization eligible for a discount if we're thinking of cancelling? - Can we get a retention offer before leaving? instructions: - text: Check retention offer eligibility for organization {organization_id}. slots: organization_id: path.organization_id - text: See whether {organization_id} qualifies for the retention discount. slots: organization_id: path.organization_id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/retention-offer/accept'].post update: x-apievangelist-phrasing: intent: Accept a retention discount offer effect: write questions: - How do I accept the 30% or 50% discount offered instead of cancelling? - Can I record why I was going to cancel when taking the retention offer? instructions: - text: Accept the retention offer for organization {organization_id}. slots: organization_id: path.organization_id - text: Take the retention discount for {organization_id} with cancellation reason {cancellation_reason}. slots: organization_id: path.organization_id cancellation_reason: requestBody.cancellation_reason method: generated generated: '2026-09-26' - target: $.paths['/billing/{organization_id}/overage'].get update: x-apievangelist-phrasing: intent: Get overage settings for credits, actions, concurrency effect: read questions: - What are my organization's overage settings for credits and actions? - Is concurrency overage turned on for our account? instructions: - text: Show overage configuration for organization {organization_id}. slots: organization_id: path.organization_id - text: Get the credits, actions and concurrency overage settings for {organization_id}. slots: organization_id: path.organization_id method: generated generated: '2026-09-26' - target: $.paths['/billing/{organization_id}/overage'].put update: x-apievangelist-phrasing: intent: Change overage settings effect: write questions: - Can I allow overage on credits but not on concurrency? - How do I change only the actions overage setting and leave the rest alone? instructions: - text: Update credits overage for organization {organization_id} to {credits}. slots: organization_id: path.organization_id credits: requestBody.credits - text: Set concurrency overage for {organization_id} to {concurrency} and actions overage to {actions}. slots: organization_id: path.organization_id concurrency: requestBody.concurrency actions: requestBody.actions method: generated generated: '2026-09-26' - target: $.paths['/billing/{organization_id}/auto-recharge/{currency}'].get update: x-apievangelist-phrasing: intent: Get auto-recharge settings for a currency effect: read questions: - Is auto-recharge set up for my credits balance? - What threshold triggers an automatic top-up in a given currency? instructions: - text: Show the auto-recharge config for organization {organization_id} in {currency}. slots: organization_id: path.organization_id currency: path.currency - text: Get {currency} auto-recharge threshold and amount for {organization_id}. slots: currency: path.currency organization_id: path.organization_id method: generated generated: '2026-09-26' - target: $.paths['/billing/{organization_id}/auto-recharge/{currency}'].put update: x-apievangelist-phrasing: intent: Set up or change auto-recharge effect: write questions: - Can I automatically top up when my balance falls below a threshold? - How is the recharge amount calculated when auto-recharge fires? instructions: - text: Set {currency} auto-recharge for organization {organization_id} at threshold {threshold} with amount {amount}. slots: currency: path.currency organization_id: path.organization_id threshold: requestBody.threshold amount: requestBody.amount - text: Change auto-recharge for {organization_id} in {currency} to trigger below {threshold}, amount {amount}. slots: organization_id: path.organization_id currency: path.currency threshold: requestBody.threshold amount: requestBody.amount method: generated generated: '2026-09-26' - target: $.paths['/billing/{organization_id}/auto-recharge/{currency}'].delete update: x-apievangelist-phrasing: intent: Turn off auto-recharge for a currency effect: destructive questions: - How do I stop automatic top-ups on my account? - Can I remove auto-recharge for just one currency? instructions: - text: Delete the {currency} auto-recharge config for organization {organization_id}. slots: currency: path.currency organization_id: path.organization_id - text: Turn off auto-recharge in {currency} for {organization_id}. slots: currency: path.currency organization_id: path.organization_id method: generated generated: '2026-09-26'