> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Billing & Usage

> Manage billing and usage.

Manage billing and usage.

Find every run operation under [Runs](/docs/cloud/rest/apis/orchestration): lifecycle, events, input requests, children, the runs that triggers start, and the runtime callbacks workers use. Configure [schedules](/docs/cloud/rest/apis/orchestration#triggers) and [webhooks](/docs/cloud/rest/apis/orchestration#triggers) to trigger runs automatically.

Use project queries for individual applications. Use [account analytics](/docs/cloud/rest/apis/billing-usage#analytics) to inspect conversation activity across the account, and [Runs](/docs/cloud/rest/apis/orchestration) for account run analytics.

Assign access through account and project roles. Private resources may require additional permissions.

Inspect usage by account, project, member, or API key. Use [budgets](/docs/cloud/rest/apis/billing-usage#budgets) to cap monthly AI spend.

[Subscriptions](#subscriptions) · [Billing](#billing) · [Credits](#credits) · [Budgets](#budgets) · [Usage](#usage) · [Analytics](#analytics)

## Subscriptions

Read owner-wide collaboration entitlements and seat usage. The project reference selects its owner; can\_invite does not grant requester invitation permission.

Read, upgrade, or cancel the account subscription. Create [a checkout session](/docs/cloud/rest/api-reference/billing-usage-subscriptions-subscriptions/create-checkout-session) or open [the billing portal](/docs/cloud/rest/api-reference/billing-usage-subscriptions-subscriptions/get-billing-portal-url).

| Endpoint | Methods | Description |
| - | - | - |
| `/account/subscription/checkout` | [POST](/docs/cloud/rest/api-reference/billing-usage-subscriptions-subscriptions/create-checkout-session) | Create checkout session |
| `/account/subscription/manage` | [GET](/docs/cloud/rest/api-reference/billing-usage-subscriptions-subscriptions/get-billing-portal-url) | Get billing portal URL |
| `/account/subscription` | [GET](/docs/cloud/rest/api-reference/billing-usage-subscriptions-subscriptions/get-subscription) | Get subscription |
| `/account/subscription/cancel` | [POST](/docs/cloud/rest/api-reference/billing-usage-subscriptions-subscriptions/cancel-subscription) | Cancel subscription |
| `/account/subscription/upgrade` | [POST](/docs/cloud/rest/api-reference/billing-usage-subscriptions-subscriptions/upgrade-subscription) | Upgrade subscription |
| `/projects/{project_reference}/collaboration` | [GET](/docs/cloud/rest/api-reference/billing-usage-subscriptions-seats/get-available-seats) | Get available seats |

## Billing

Read financial records owned by the selected account.

Read or update account billing details.

List invoices and upcoming invoices.

List, attach, detach, or select payment methods.

List account payments.

| Endpoint | Methods | Description |
| - | - | - |
| `/account/invoices` | [GET](/docs/cloud/rest/api-reference/billing-usage-billing-invoices/list-billing-invoices) | List billing invoices |
| `/account/upcoming-invoices` | [GET](/docs/cloud/rest/api-reference/billing-usage-billing-invoices/list-upcoming-billing-invoices) | List upcoming billing invoices |
| `/account/payments` | [GET](/docs/cloud/rest/api-reference/billing-usage-billing-payments/list-billing-payments) | List billing payments |
| `/account/payment-methods` | [GET](/docs/cloud/rest/api-reference/billing-usage-billing-payment-methods/list-payment-methods), [POST](/docs/cloud/rest/api-reference/billing-usage-billing-payment-methods/add-payment-method) | List payment methods; Add payment method |
| `/account/payment-methods/{payment_method_id}` | [PATCH](/docs/cloud/rest/api-reference/billing-usage-billing-payment-methods/set-default-payment-method), [DELETE](/docs/cloud/rest/api-reference/billing-usage-billing-payment-methods/remove-payment-method) | Set default payment method; Remove payment method |
| `/account/billing-details` | [GET](/docs/cloud/rest/api-reference/billing-usage-billing-billing-details/get-billing-details), [PATCH](/docs/cloud/rest/api-reference/billing-usage-billing-billing-details/update-billing-details) | Get billing details; Update billing details |
| `/accounts/{account_id}/subscription/checkout` | [POST](/docs/cloud/rest/api-reference/billing-usage-billing-account-billing/create-account-checkout-session) | Create account checkout session |
| `/accounts/{account_id}/credits/topup` | [POST](/docs/cloud/rest/api-reference/billing-usage-billing-account-billing/create-account-credit-checkout) | Create account credit checkout |
| `/accounts/{account_id}/invoices` | [GET](/docs/cloud/rest/api-reference/billing-usage-billing-account-billing/list-account-billing-invoices) | List account billing invoices |
| `/accounts/{account_id}/payments` | [GET](/docs/cloud/rest/api-reference/billing-usage-billing-account-billing/list-account-billing-payments) | List account billing payments |
| `/accounts/{account_id}/credits/packages` | [GET](/docs/cloud/rest/api-reference/billing-usage-billing-account-billing/list-account-credit-packages) | List account credit packages |
| `/accounts/{account_id}/credits/transactions` | [GET](/docs/cloud/rest/api-reference/billing-usage-billing-account-billing/list-account-credit-transactions) | List account credit transactions |
| `/accounts/{account_id}/payment-methods` | [GET](/docs/cloud/rest/api-reference/billing-usage-billing-account-billing/list-account-payment-methods), [POST](/docs/cloud/rest/api-reference/billing-usage-billing-account-billing/add-account-payment-method) | List account payment methods; Add account payment method |
| `/accounts/{account_id}/upcoming-invoices` | [GET](/docs/cloud/rest/api-reference/billing-usage-billing-account-billing/list-account-upcoming-billing-invoices) | List account upcoming billing invoices |
| `/accounts/{account_id}/subscription/manage` | [GET](/docs/cloud/rest/api-reference/billing-usage-billing-account-billing/get-account-billing-portal-url) | Get account billing portal URL |
| `/accounts/{account_id}/billing-details` | [GET](/docs/cloud/rest/api-reference/billing-usage-billing-account-billing/read-account-billing-details), [PATCH](/docs/cloud/rest/api-reference/billing-usage-billing-account-billing/update-account-billing-details) | Read account billing details; Update account billing details |
| `/accounts/{account_id}/credits/balance` | [GET](/docs/cloud/rest/api-reference/billing-usage-billing-account-billing/read-account-credit-balance) | Read account credit balance |
| `/accounts/{account_id}/subscription` | [GET](/docs/cloud/rest/api-reference/billing-usage-billing-account-billing/read-account-subscriptions) | Read account subscriptions |
| `/accounts/{account_id}/usage` | [GET](/docs/cloud/rest/api-reference/billing-usage-billing-account-billing/read-account-usage) | Read account usage |
| `/accounts/{account_id}/payment-methods/{payment_method_id}` | [PATCH](/docs/cloud/rest/api-reference/billing-usage-billing-account-billing/set-account-default-payment-method), [DELETE](/docs/cloud/rest/api-reference/billing-usage-billing-account-billing/delete-account-payment-method) | Set account default payment method; Delete account payment method |
| `/accounts/{account_id}/subscription/cancel` | [POST](/docs/cloud/rest/api-reference/billing-usage-billing-account-billing/cancel-account-subscription) | Cancel account subscription |
| `/accounts/{account_id}/credits/coupons/redeem` | [POST](/docs/cloud/rest/api-reference/billing-usage-billing-account-billing/redeem-account-credit-coupon) | Redeem account credit coupon |
| `/accounts/{account_id}/subscription/upgrade` | [POST](/docs/cloud/rest/api-reference/billing-usage-billing-account-billing/upgrade-account-subscription) | Upgrade account subscription |

## Credits

Check the credit balance, review transactions, buy credits, or redeem a coupon.

| Endpoint | Methods | Description |
| - | - | - |
| `/credits/topup` | [POST](/docs/cloud/rest/api-reference/billing-usage-credits-credits/create-credit-checkout) | Create credit checkout |
| `/credits/packages` | [GET](/docs/cloud/rest/api-reference/billing-usage-credits-credits/list-credit-packages) | List credit packages |
| `/credits/transactions` | [GET](/docs/cloud/rest/api-reference/billing-usage-credits-credits/list-credit-transactions) | List credit transactions |
| `/credits/balance` | [GET](/docs/cloud/rest/api-reference/billing-usage-credits-credits/get-credit-balance) | Get credit balance |
| `/credits/coupons/redeem` | [POST](/docs/cloud/rest/api-reference/billing-usage-credits-credits/redeem-credit-coupon) | Redeem credit coupon |

## Budgets

Set monthly AI spending caps by project, person, API key, or a combination of these fields. New budgets count spending already incurred that month; use [`PATCH /budgets/{budget_id}`](/docs/cloud/rest/api-reference/billing-usage-budgets-budgets/update-budget) to change an existing cap.

| Endpoint | Methods | Description |
| - | - | - |
| `/budgets` | [GET](/docs/cloud/rest/api-reference/billing-usage-budgets-budgets/list-budgets), [POST](/docs/cloud/rest/api-reference/billing-usage-budgets-budgets/create-budget) | List budgets; Create budget |
| `/budgets/{budget_id}` | [GET](/docs/cloud/rest/api-reference/billing-usage-budgets-budgets/get-budget), [PATCH](/docs/cloud/rest/api-reference/billing-usage-budgets-budgets/update-budget), [DELETE](/docs/cloud/rest/api-reference/billing-usage-budgets-budgets/delete-budget) | Get budget; Update budget; Delete budget |

## Usage

Read account consumption, credit usage, limits, trends, and warnings.

Use [member usage](/docs/cloud/rest/api-reference/billing-usage-usage-project-usage/get-member-usage) for project AI spend by person and automation. [AI usage analytics](/docs/cloud/rest/api-reference/billing-usage-usage-project-usage/get-ai-usage-analytics) adds daily project or member consumption and customer charges. The [project usage endpoint](/docs/cloud/rest/api-reference/billing-usage-usage-project-usage/get-usage) returns the project owner’s account-wide totals, not project-attributed usage.

List usage across API keys or inspect one key. Manage the keys themselves through [API key endpoints](/docs/cloud/rest/apis/identity-access#api-keys). Manage [inference limits](/docs/cloud/rest/api-reference/billing-usage-usage-api-key-usage/get-api-key-inference-limits) for project-bound keys.

| Endpoint | Methods | Description |
| - | - | - |
| `/api-keys/usage` | [GET](/docs/cloud/rest/api-reference/billing-usage-usage-api-key-usage/list-api-key-usage) | List API key usage |
| `/api-keys/{id}/limits` | [GET](/docs/cloud/rest/api-reference/billing-usage-usage-api-key-usage/get-api-key-inference-limits), [PUT](/docs/cloud/rest/api-reference/billing-usage-usage-api-key-usage/replace-api-key-inference-limits), [DELETE](/docs/cloud/rest/api-reference/billing-usage-usage-api-key-usage/clear-api-key-inference-limits) | Get API key inference limits; Replace API key inference limits; Clear API key inference limits |
| `/api-keys/{id}/usage` | [GET](/docs/cloud/rest/api-reference/billing-usage-usage-api-key-usage/get-api-key-usage) | Get API key usage |
| `/account/usage/credits` | [GET](/docs/cloud/rest/api-reference/billing-usage-usage-account-usage/get-account-ai-credits-usage) | Get account AI credits usage |
| `/account/usage/limits` | [GET](/docs/cloud/rest/api-reference/billing-usage-usage-account-usage/get-account-usage-limits) | Get account usage limits |
| `/account/usage` | [GET](/docs/cloud/rest/api-reference/billing-usage-usage-account-usage/get-account-usage-overview) | Get account usage overview |
| `/account/usage/series` | [GET](/docs/cloud/rest/api-reference/billing-usage-usage-account-usage/get-account-usage-series) | Get account usage series |
| `/account/usage/warnings` | [GET](/docs/cloud/rest/api-reference/billing-usage-usage-account-usage/get-account-usage-warnings) | Get account usage warnings |
| `/projects/{project_reference}/analytics/ai-usage` | [GET](/docs/cloud/rest/api-reference/billing-usage-usage-project-usage/get-ai-usage-analytics) | Get AI usage analytics |
| `/projects/{project_reference}/members/usage` | [GET](/docs/cloud/rest/api-reference/billing-usage-usage-project-usage/get-member-usage) | Get member usage |
| `/projects/{project_reference}/usage` | [GET](/docs/cloud/rest/api-reference/billing-usage-usage-project-usage/get-usage) | Get usage |

## Analytics

Start, list, inspect, cancel, and resume agent, task, and workflow runs, follow their events, answer their input requests, and find the runs that schedules, webhooks, and evaluations start.

Read account-level conversation analytics. Find account run analytics under [Runs](/docs/cloud/rest/apis/orchestration). Use the Billing and Usage API for consumption and spending data.

| Endpoint | Methods | Description |
| - | - | - |
| `/account/analytics/conversations` | [GET](/docs/cloud/rest/api-reference/billing-usage-analytics-conversation-analytics/get-account-conversation-analytics) | Get account conversation analytics |
| `/account/analytics/runs` | [GET](/docs/cloud/rest/api-reference/billing-usage-analytics-run-analytics/get-run-analytics) | Get run analytics |

[Back to REST API reference](/docs/cloud/rest)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.