Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 47 additions & 1 deletion fern/apis/api/openapi-overrides.yml
Original file line number Diff line number Diff line change
Expand Up @@ -783,6 +783,20 @@ components:
description: >-
A saved outbound calling campaign, including its calling configuration,
schedule, status, customers, calls, and call-progress counters.
properties:
schedulePlan:
description: >-
This is the schedule plan for the campaign. Calls will start at
startedAt and continue until your subscription's concurrency limit
is reached. Any remaining calls will be retried for up to one hour
as capacity becomes available. After that hour or after latestAt,
whichever comes first, any calls that couldn't be placed won't be
retried.
maxConcurrency:
description: >-
This is the maximum number of concurrent calls that will be made
for the campaign. Defaults to 10. Maximum of 500, and may not
exceed your subscription's concurrency limit.
CampaignPaginatedResponse:
description: >-
A paginated collection of outbound calling campaigns and metadata
Expand All @@ -792,11 +806,40 @@ components:
description: The campaigns returned for the current page.
metadata:
description: Pagination metadata for the campaign result set.
CampaignSummary:
properties:
schedulePlan:
description: >-
This is the schedule plan for the campaign. Calls will start at
startedAt and continue until your subscription's concurrency limit
is reached. Any remaining calls will be retried for up to one hour
as capacity becomes available. After that hour or after latestAt,
whichever comes first, any calls that couldn't be placed won't be
retried.
maxConcurrency:
description: >-
This is the maximum number of concurrent calls that will be made
for the campaign. Defaults to 10. Maximum of 500, and may not
exceed your subscription's concurrency limit.
CreateCampaignDTO:
description: >-
Configuration used to create an outbound calling campaign. Choose an
assistant, squad, or workflow, then provide customers, phone-number or
dial-plan settings, and an optional schedule.
properties:
schedulePlan:
description: >-
This is the schedule plan for the campaign. Calls will start at
startedAt and continue until your subscription's concurrency limit
is reached. Any remaining calls will be retried for up to one hour
as capacity becomes available. After that hour or after latestAt,
whichever comes first, any calls that couldn't be placed won't be
retried.
maxConcurrency:
description: >-
This is the maximum number of concurrent calls that will be made
for the campaign. Defaults to 10. Maximum of 500, and may not
exceed your subscription's concurrency limit.
UpdateCampaignDTO:
description: >-
Fields used to update an outbound calling campaign, including its name,
Expand Down Expand Up @@ -3851,7 +3894,10 @@ components:
success evaluation, and structured-output generation.
SubscriptionLimits:
description: >-
Organization concurrency limits and remaining concurrent call capacity.
Subscription concurrency limits and remaining concurrent call capacity.
properties:
concurrencyLimit:
description: The total concurrent call limit for the subscription.
TransportCost:
title: TransportCost
description: >-
Expand Down
2 changes: 1 addition & 1 deletion fern/assistants/call-recording.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -549,7 +549,7 @@ Use artifact data for comprehensive insights:
</Accordion>

<Accordion title="How long are artifacts stored?">
Retention periods vary by your plan. See [Pricing and Success Packages](/billing/pricing-and-success-packages#whats-included) for what each plan includes. To check your current plan, open **Billing & Payment** in the [Vapi Dashboard](https://dashboard.vapi.ai).
Retention periods vary by billing option. See [Pricing and Success Packages](/billing/pricing-and-success-packages#whats-included) for what Usage only and each Success Package include. To check your current Success Package, or confirm that you use Usage only, open **Billing & Payment** in the [Vapi Dashboard](https://dashboard.vapi.ai).
</Accordion>

<Accordion title="How do artifacts work with squad transfers?">
Expand Down
10 changes: 5 additions & 5 deletions fern/billing/manage-billing-and-credits.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ slug: billing/manage-billing-and-credits
If your Dashboard shows **Settings → Billing & Add-Ons** instead of **Billing & Payment**, see [Manage pay-as-you-go billing and credits](/billing/manage-pay-as-you-go-billing).
</Note>

Vapi credits are prepaid funds in US dollars that cover usage-based charges. This guide shows you how to add a payment method, fund your usage, keep your balance funded automatically, and download billing records.
Vapi credits are prepaid funds in US dollars held by a subscription and used to cover its usage-based charges. This guide shows you how to add a payment method, fund the subscription, keep its balance funded automatically, and download billing records.

## Prerequisites

Expand All @@ -22,11 +22,11 @@ Credits cover usage-based costs:
- The per-minute Vapi hosting fee draws down your balance as calls run.
- Model, voice, transcriber, and telephony costs also draw down your balance.

The Dashboard shows how Success Package and add-on fees are charged before you confirm a purchase. If your credit balance reaches $0 and auto-reload is off, Vapi freezes the subscription. You cannot start new calls or other billable usage until you purchase more credits.
The Dashboard shows how Success Package and add-on fees are charged before you confirm a purchase. If the subscription's credit balance reaches $0 and auto-reload is off, Vapi freezes the subscription. You cannot start new calls or other billable usage until you purchase more credits.

## Add or update a payment method

Your default card is used for credit purchases, auto-reload, and any recurring charges shown in the Dashboard. Add a card before you buy credits or turn on auto-reload.
The subscription's default card is used for credit purchases, auto-reload, and any recurring charges shown in the Dashboard. Add a card before you buy credits or turn on auto-reload.

<Steps>
<Step title="Open the Billing page">
Expand All @@ -50,7 +50,7 @@ Your default card is used for credit purchases, auto-reload, and any recurring c

## Buy credits

Buy credits to fund your organization's usage. Credits are added to the organization you have selected, so confirm you are on the [right organization](/billing/manage-organizations-and-capacity#switch-organizations) first.
Buy credits to fund the subscription associated with your selected organization. Credits are added to that subscription, so confirm you are on the [right organization](/billing/manage-organizations-and-capacity#switch-organizations) first.

<Steps>
<Step title="Open Buy credits">
Expand All @@ -69,7 +69,7 @@ Buy credits to fund your organization's usage. Credits are added to the organiza

## Set up auto-reload

Auto-reload keeps your organization funded so usage is not interrupted. When the credit balance reaches a threshold you set, Vapi automatically purchases the top-up amount you choose.
Auto-reload keeps your subscription funded so usage is not interrupted. When the subscription's credit balance reaches a threshold you set, Vapi automatically purchases the top-up amount you choose.

<Steps>
<Step title="Open auto-reload settings">
Expand Down
14 changes: 9 additions & 5 deletions fern/billing/manage-organizations-and-capacity.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@ description: Learn how subscriptions provide organization capacity, how to creat
slug: billing/manage-organizations-and-capacity
---

A subscription groups usage-based billing, an optional Success Package, add-ons, and one or more organizations. Usage only and each Success Package determine how many organizations the subscription can contain.
Under the current pricing model, a subscription groups usage-based billing, an optional Success Package, add-ons, and one or more organizations. Usage only and each Success Package determine how many organizations the subscription can contain.

<Note>
Customers on the legacy pay-as-you-go model use the earlier structure. Each organization has its own subscription and a separate concurrency limit.
</Note>

## Prerequisites

Expand All @@ -28,7 +32,7 @@ Create an organization to separate workspaces, teams, or environments under the
<Step title="Enter the details">
Enter a name and admin email, and choose the subscription the organization belongs to.

<Frame caption="Account and subscription details blurred for privacy.">
<Frame caption="Admin email and subscription details blurred for privacy.">
<img src="../static/images/billing/billing-new-organization.png" alt="New organization dialog with name, admin email, and subscription fields" />
</Frame>
</Step>
Expand All @@ -41,7 +45,7 @@ If no capacity remains, purchase an organization add-on or upgrade your Success

## Switch organizations

Switch the active organization to work with its assistants, billing information, and settings.
Switch the active organization to work with its assistants and settings, and to access billing for its subscription.

<Steps>
<Step title="Open the organization switcher">
Expand Down Expand Up @@ -84,9 +88,9 @@ Reducing organization capacity does not remove organizations automatically. Dele

A Success Package downgrade can also reduce organization capacity and shared entitlements. Resolve any capacity conflict before confirming the downgrade. See [Downgrade or remove a Success Package](/billing/manage-packages-and-add-ons#downgrade-or-remove-a-success-package).

## Premier subscriptions
## Premier Success Package

Premier organization capacity and related entitlements depend on the customer agreement. Contact your account team to change custom limits.
Organization capacity and related entitlements for the Premier Success Package depend on the customer agreement. Contact your account team to change custom limits.

## Related

Expand Down
8 changes: 6 additions & 2 deletions fern/billing/manage-packages-and-add-ons.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@ description: Learn how to upgrade, downgrade, or remove a Success Package, and b
slug: billing/manage-packages-and-add-ons
---

Usage-based billing remains active when you add, change, or remove a Success Package. You can also purchase add-ons that increase specific capabilities without changing your Success Package.
<Note>
This page applies to subscriptions using the current pricing model whose Dashboard shows **Billing & Payment** with a **Packages & add-ons** tab. If your Dashboard shows **Settings → Billing & Add-Ons**, see [Manage pay-as-you-go billing and credits](/billing/manage-pay-as-you-go-billing) or [Purchase call concurrency](/billing/purchase-call-concurrency) instead.
</Note>

A Success Package applies to a subscription and every organization it contains. Usage-based billing remains active when you add, change, or remove a Success Package. You can also purchase add-ons that increase specific capabilities without changing your Success Package.

Available add-ons can be used with Usage only or any Success Package.

Expand All @@ -22,7 +26,7 @@ Check which Success Package you have, or confirm you are on Usage only, in the D

<Steps>
<Step title="Open Billing & Payment">
In the [Vapi Dashboard](https://dashboard.vapi.ai), open **Billing & Payment**. Your active plan appears in the **Success package** field.
In the [Vapi Dashboard](https://dashboard.vapi.ai), open **Billing & Payment**. Your current Success Package, or Usage only, appears in the **Success package** field.
</Step>
<Step title="Open Packages & add-ons">
Select the **Packages & add-ons** tab. Your current package is marked **Current package**, with its included limits, support, and compliance options listed.
Expand Down
4 changes: 2 additions & 2 deletions fern/billing/manage-pay-as-you-go-billing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ slug: billing/manage-pay-as-you-go-billing
---

<Note>
If your Dashboard shows **Billing & Payment** with a **Packages & add-ons** tab, see [Manage billing and credits](/billing/manage-billing-and-credits) instead.
This page applies to accounts on the legacy pay-as-you-go model whose Dashboard shows **Settings → Billing & Add-Ons**. Each organization in this model has its own subscription. If your Dashboard shows **Billing & Payment** with a **Packages & add-ons** tab, see [Manage billing and credits](/billing/manage-billing-and-credits) instead.
</Note>

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.
Expand Down Expand Up @@ -49,7 +49,7 @@ This guide shows you how to set up billing for a pay-as-you-go subscription. By
<Step title="Optional: Configure auto reload">
In **Payment method**, turn on **Enable auto reload**. Enter at least the minimum amount 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.
Select **Save changes**, review the confirmation, then select **Confirm**. If the current balance is at or below the threshold, saving the auto-reload settings charges the payment method immediately.

<Frame>
<img src="../static/images/billing/billing-auto-reload.jpg" alt="Auto reload controls on the live Billing page" />
Expand Down
18 changes: 9 additions & 9 deletions fern/billing/pricing-and-success-packages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ slug: billing/pricing-and-success-packages
---

<Note>
Success Packages are available to new Vapi customers. If you already have a Vapi account, nothing changes right now: your hosting fee, features, and agents stay the same, and no action is required.
Success Packages are currently available only to new Vapi customers. Customers on legacy pricing keep their existing billing structure and terms. Under the legacy pay-as-you-go model, each organization has its own subscription and concurrency limit.
</Note>

Every Vapi subscription starts with usage-based billing. Without an optional Success Package, you use Usage only. Usage-based charges remain active when you add a Success Package or add-ons.
A subscription is the billing and entitlement scope for one or more organizations. Every subscription starts with usage-based billing. Without an optional Success Package, you use Usage only. Usage-based charges remain active when you add a Success Package or add-ons.

A Success Package adds support, service commitments, and higher included limits. Add-ons increase individual capabilities without replacing usage-based billing or your Success Package.

Expand All @@ -23,28 +23,28 @@ To review costs for a completed call, open its [call log](/observability/logs/ca

With Usage only, you pay a per-minute hosting fee, plus the model, voice, transcriber, and telephony costs for each call.

Usage only includes the documentation, peer-to-peer help from the Vapi Discord community, and the base limits shown in [What's included](#whats-included).
Usage only includes the documentation, peer-to-peer help from the Vapi Discord community, email support without a response service-level agreement, and the base limits shown in [What's included](#whats-included).

Every minute your assistants run is billed. Usage only does not include a response or uptime service-level agreement. Vapi support starts with Core.
Every minute your assistants run is billed. Usage only does not include a response or uptime service-level agreement. A response service-level agreement starts with Core.

## Success Packages

A Success Package is an optional subscription that complements usage-based billing. It does not change how usage is billed. It adds higher support, service commitments, larger capacity, and compliance and governance options.
A Success Package is an optional package added to a subscription. It does not change how usage is billed. It adds higher support, service commitments, larger capacity, and compliance and governance options. The package applies to every organization in the subscription. Those organizations share the subscription's concurrent call lines.

Usage-based billing remains active when you add Core, Pro, or Premier.

| Plan or package | Support | Service commitments | How to get it |
| Billing option | Support | Service commitments | How to get it |
| --- | --- | --- | --- |
| **Usage only** | Documentation and peer-to-peer Discord community | No response or uptime service-level agreement | Included with every subscription |
| **Core** | Everything in Usage, plus email support | Two-business-day response service-level agreement | Buy in the Dashboard |
| **Usage only** | Documentation, peer-to-peer Discord community, and email support | No response or uptime service-level agreement | Included with every subscription |
| **Core** | Everything in Usage | Two-business-day response service-level agreement | Buy in the Dashboard |
| **Pro** | Everything in Core, plus a dedicated Slack channel | One-business-day response and 99% uptime service-level agreements | Buy in the Dashboard |
| **Premier** | Everything in Pro, plus a named support team | One-hour P0 response and 99.9% uptime service-level agreements | Contact Sales |

Core has a fixed monthly price. Pro pricing scales with Vapi hosting spend and has a monthly minimum. Premier pricing and terms depend on your agreement.

## What's included

Usage only and each Success Package include the limits and capabilities below. For current prices, see the [Vapi pricing page](https://vapi.ai/pricing).
Under the current pricing model, Usage only and each Success Package include the limits and capabilities below. For current prices, see the [Vapi pricing page](https://vapi.ai/pricing).

| Included | Usage only | Core | Pro | Premier |
| --- | --- | --- | --- | --- |
Expand Down
6 changes: 3 additions & 3 deletions fern/billing/purchase-call-concurrency.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ slug: billing/purchase-call-concurrency
---

<Note>
If your Dashboard shows **Packages & add-ons**, see [Manage Success Packages and add-ons](/billing/manage-packages-and-add-ons) instead.
This page applies to accounts on the legacy pay-as-you-go model whose Dashboard shows **Billing & Add-Ons**. Each organization in this model has its own subscription and concurrency limit. If your Dashboard shows **Packages & add-ons**, see [Manage Success Packages and add-ons](/billing/manage-packages-and-add-ons) instead.
</Note>

Purchase call concurrency when your organization needs to run more simultaneous calls than its plan includes.
Purchase call concurrency when your organization needs to run more simultaneous calls than its subscription includes.

## How call lines affect concurrency

Expand All @@ -32,7 +32,7 @@ All inbound and outbound calls share the organization's capacity. A campaign's *
<Step title="Enter the reserved concurrency">
In **Add-ons**, find **Reserved concurrency (call lines)**. Enter the total number of add-on call lines you want the organization to have.

This value represents purchased call lines, not the organization's total concurrency. For example, if the plan includes 10 calls and you enter `5`, the organization has 15 call lines after the purchase.
This value represents purchased call lines, not the organization's total concurrency. For example, if the subscription includes 10 calls and you enter `5`, the organization has 15 call lines after the purchase.

<Frame>
<img src="../static/images/billing/billing-purchase-call-concurrency.jpg" alt="Reserved concurrency call-line field used to purchase call concurrency in Billing and Add-Ons" />
Expand Down
Loading
Loading