diff --git a/fern/billing/manage-billing-and-credits.mdx b/fern/billing/manage-billing-and-credits.mdx new file mode 100644 index 000000000..9af800f02 --- /dev/null +++ b/fern/billing/manage-billing-and-credits.mdx @@ -0,0 +1,70 @@ +--- +title: "Manage pay-as-you-go billing and credits" +subtitle: "Add a payment method, buy credits, configure auto reload, and download billing records." +description: "Manage pay-as-you-go billing in the Vapi Dashboard: add a payment method, buy credits, configure auto reload, and download PDF statements and invoices." +slug: billing/manage-billing-and-credits +--- + +This guide shows you how to set up billing for a pay-as-you-go subscription. By the end, you can fund the subscription and configure automatic credit purchases. + +## Prerequisites + +- An **Admin** role in the organization. + +## Steps + + + + Sign in to the [Vapi Dashboard](https://dashboard.vapi.ai), select the organization you want to fund, open **Settings**, then select **Billing & Add-Ons**. + + + Billing & Add-Ons selected in the Dashboard Settings navigation + + + + + In **Payment method**, enter the billing email and card details. Select the checkmark beside each field to save it. + + To replace a saved card, select the pencil beside **Payment method**, enter the new card details, then select the checkmark. + + + Full Payment method block with the billing email blurred, card field, and auto reload controls + + + + + At the top of the Billing page, select **Buy credits**. In **Purchase Vapi credits**, enter at least `$10` in **Amount to purchase**, then select **Purchase**. + + Complete any verification requested by the card issuer. A successful purchase increases the credit balance and appears as **Finalized** in **Credit purchase history**. + + + Purchase Vapi credits dialog with the amount to purchase field + + + + + In **Payment method**, turn on **Enable auto reload**. Enter at least `$10` in **Amount to reload**, then enter the balance that should trigger the purchase in **When threshold reaches**. + + Select **Save changes**, review the confirmation, then select **Confirm**. If the current balance is at or below the threshold, saving the plan charges the payment method immediately. + + + Auto reload controls on the live Billing page + + + + + Confirm that the page shows the saved payment method, updated credit balance, and auto reload settings. Check **Credit purchase history** for a **Finalized** payment. + + + +## Download billing records + +Select **Download monthly statement** in **Credit purchase history** to create a statement for a selected month. + +To download an invoice for an eligible payment, select the payment, then select **Download invoice (PDF)**. Enter the requested invoice information and select **Confirm**. + +## Related + + + Resolve calls blocked by an insufficient credit balance or frozen subscription. + diff --git a/fern/chat/non-streaming.mdx b/fern/chat/non-streaming.mdx index 7ca58d880..d7085ea8f 100644 --- a/fern/chat/non-streaming.mdx +++ b/fern/chat/non-streaming.mdx @@ -1,6 +1,7 @@ --- title: Non-streaming chat subtitle: Build reliable chat integrations with complete response patterns for batch processing and simple UIs +description: Build a non-streaming Vapi chat integration that returns complete responses, maintains conversation context, and supports reliable request-response workflows. slug: chat/non-streaming --- diff --git a/fern/chat/openai-compatibility.mdx b/fern/chat/openai-compatibility.mdx index 50de50ca8..b2d026fe8 100644 --- a/fern/chat/openai-compatibility.mdx +++ b/fern/chat/openai-compatibility.mdx @@ -1,6 +1,7 @@ --- title: OpenAI compatibility subtitle: Seamlessly migrate existing OpenAI integrations to Vapi with zero code changes +description: Use Vapi through OpenAI-compatible chat interfaces, migrate existing integrations, and support streaming, non-streaming, and common JavaScript frameworks. slug: chat/openai-compatibility --- diff --git a/fern/chat/quickstart.mdx b/fern/chat/quickstart.mdx index ce18259fc..76537ef01 100644 --- a/fern/chat/quickstart.mdx +++ b/fern/chat/quickstart.mdx @@ -1,6 +1,7 @@ --- title: Chat quickstart subtitle: Build your first text-based conversation with a Vapi assistant in 5 minutes +description: "Create a text chat with a Vapi assistant, send messages through the Chat API, continue conversations, pass variables, and integrate with TypeScript apps." slug: chat/quickstart --- @@ -23,6 +24,7 @@ Build a customer service chat bot that can handle text-based conversations throu * A [Vapi account](https://dashboard.vapi.ai/) * An existing assistant or willingness to create one * Basic knowledge of making API requests +* For a pay-as-you-go subscription, the billing setup described in [Troubleshooting](#troubleshooting) ## Scenario @@ -304,6 +306,43 @@ We'll create a customer support chat for "TechFlow", a software company that wan +## Troubleshooting + +The Chat API returns HTTP `402` when the pay-as-you-go organization does not meet a billing requirement. Use the message to identify the required action. + +| Message | What it means | What to do | +| --- | --- | --- | +| `Add a payment method to use chat. Pay-as-you-go orgs require a card on file.` | The organization does not have a saved payment method. | [Add a payment method](/billing/manage-billing-and-credits). | +| `Purchase credits to use chat. New pay-as-you-go orgs require a completed payment.` | The pay-as-you-go subscription is less than 30 days old and the organization has no completed payment. | [Buy credits](/billing/manage-billing-and-credits) or complete another purchase. Adding a card does not count as a payment. | + +## Frequently asked questions + + + + Every pay-as-you-go organization needs a saved payment method. During the subscription's first 30 days, the organization must also have completed a payment. Enterprise and agency plans do not have these requirements. + + + + No. The purchase requirement applies only to chat. + + + + No. Adding a card authorizes future charges but does not complete a payment. To unblock chat during the first 30 days, [buy credits](/billing/manage-billing-and-credits) or complete another purchase. + + + + No. One completed payment permanently satisfies the requirement for the organization. The payment does not need to be recent or recurring. + + + + The completed-payment requirement ends when the pay-as-you-go subscription reaches 30 days old. The organization still needs a saved payment method to use chat. + + + + Chat access usually returns within one minute after the payment settles. If chat remains blocked, wait one minute, refresh the Dashboard, and try again. + + + ## Limitations diff --git a/fern/chat/session-management.mdx b/fern/chat/session-management.mdx index 6a0a09d79..1175f4f07 100644 --- a/fern/chat/session-management.mdx +++ b/fern/chat/session-management.mdx @@ -1,6 +1,7 @@ --- title: Session management subtitle: Maintain conversation context using previousChatId vs sessionId +description: Manage Vapi chat context with previousChatId or sessionId, understand when to use each method, and build persistent multi-turn conversations safely at scale. slug: chat/session-management --- diff --git a/fern/chat/sms-chat.mdx b/fern/chat/sms-chat.mdx index e2926d388..05dfc937c 100644 --- a/fern/chat/sms-chat.mdx +++ b/fern/chat/sms-chat.mdx @@ -1,6 +1,7 @@ --- title: SMS chat subtitle: Enable text-based conversations with assistants via SMS messaging +description: Connect a 10DLC-approved Twilio number to a Vapi assistant, receive customer-initiated SMS messages, and maintain context through managed chat sessions. slug: chat/sms-chat --- diff --git a/fern/chat/streaming.mdx b/fern/chat/streaming.mdx index 083d58792..6e4cca4f1 100644 --- a/fern/chat/streaming.mdx +++ b/fern/chat/streaming.mdx @@ -1,6 +1,7 @@ --- title: Streaming chat subtitle: Build real-time chat experiences with token-by-token responses like ChatGPT +description: Build a streaming Vapi chat integration with server-sent events, display tokens as they arrive, and maintain context across real-time app conversations. slug: chat/streaming --- diff --git a/fern/chat/variable-substitution.mdx b/fern/chat/variable-substitution.mdx index 980114349..54553663b 100644 --- a/fern/chat/variable-substitution.mdx +++ b/fern/chat/variable-substitution.mdx @@ -1,6 +1,7 @@ --- title: Variable substitution in sessions subtitle: Learn how template variables behave with sessions and chats +description: Use variable substitution in Vapi chat sessions, understand when values are resolved, and choose safe patterns for updating personalized conversation context. slug: chat/variable-substitution --- diff --git a/fern/chat/web-widget.mdx b/fern/chat/web-widget.mdx index 739c1b7dc..4bf010646 100644 --- a/fern/chat/web-widget.mdx +++ b/fern/chat/web-widget.mdx @@ -1,6 +1,7 @@ --- title: Web widget subtitle: Add AI chat and voice capabilities to any website with a simple embeddable widget +description: "Add Vapi's web widget to a website for voice and text conversations, configure its appearance and behavior, and meet pay-as-you-go chat access requirements." slug: chat/web-widget --- diff --git a/fern/docs.yml b/fern/docs.yml index b3231dc3c..0216e7724 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -618,6 +618,12 @@ navigation: - page: FAQ path: faq.mdx icon: fa-light fa-question + - section: Billing + icon: fa-light fa-credit-card + collapsed: true + contents: + - page: Manage billing and credits + path: billing/manage-billing-and-credits.mdx - section: How Vapi works icon: fa-light fa-diagram-project contents: diff --git a/fern/static/images/billing/billing-auto-reload.jpg b/fern/static/images/billing/billing-auto-reload.jpg new file mode 100644 index 000000000..56ae54ecc Binary files /dev/null and b/fern/static/images/billing/billing-auto-reload.jpg differ diff --git a/fern/static/images/billing/billing-navigation.jpg b/fern/static/images/billing/billing-navigation.jpg new file mode 100644 index 000000000..172946213 Binary files /dev/null and b/fern/static/images/billing/billing-navigation.jpg differ diff --git a/fern/static/images/billing/billing-payment-method.jpg b/fern/static/images/billing/billing-payment-method.jpg new file mode 100644 index 000000000..bb61433a9 Binary files /dev/null and b/fern/static/images/billing/billing-payment-method.jpg differ diff --git a/fern/static/images/billing/billing-purchase-credits.jpg b/fern/static/images/billing/billing-purchase-credits.jpg new file mode 100644 index 000000000..53ac250ad Binary files /dev/null and b/fern/static/images/billing/billing-purchase-credits.jpg differ