> ## 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 and Usage API

> Manage subscriptions, payments, credits, budgets, and usage.

Manage subscriptions, payments, credits, budgets, and usage.

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

[Subscriptions](#subscriptions) · [Billing Details](#billing-details) · [Invoices](#invoices) · [Payment Methods](#payment-methods) · [Payments](#payments) · [Credits](#credits) · [Budgets](#budgets) · [Account usage](#account-usage) · [Project usage](#project-usage) · [API key usage](#api-key-usage) · [Feature gates](#feature-gates)

## Subscriptions

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

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

## Billing Details

Read or update account billing details.

| Endpoint | Methods | Description |
| - | - | - |
| `/account/billing-details` | [GET](/docs/cloud/rest/api-reference/billing-details/get-billing-details), [PATCH](/docs/cloud/rest/api-reference/billing-details/update-billing-details) | Get billing details; Update billing details |

## Invoices

List invoices and upcoming invoices.

| Endpoint | Methods | Description |
| - | - | - |
| `/account/invoices` | [GET](/docs/cloud/rest/api-reference/invoices/list-billing-invoices) | List billing invoices |
| `/account/upcoming-invoices` | [GET](/docs/cloud/rest/api-reference/invoices/list-upcoming-billing-invoices) | List upcoming billing invoices |

## Payment Methods

List, attach, detach, or select payment methods.

| Endpoint | Methods | Description |
| - | - | - |
| `/account/payment-methods` | [GET](/docs/cloud/rest/api-reference/payment-methods/list-payment-methods), [POST](/docs/cloud/rest/api-reference/payment-methods/attach-payment-method) | List payment methods; Attach payment method |
| `/account/payment-methods/{payment_method_id}` | [PATCH](/docs/cloud/rest/api-reference/payment-methods/set-default-payment-method), [DELETE](/docs/cloud/rest/api-reference/payment-methods/detach-payment-method) | Set default payment method; Detach payment method |

## Payments

List account payments.

| Endpoint | Methods | Description |
| - | - | - |
| `/account/payments` | [GET](/docs/cloud/rest/api-reference/payments/list-billing-payments) | List billing payments |

## Credits

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

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

## 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/budgets/update-budget) to change an existing cap.

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

## Account usage

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

| Endpoint | Methods | Description |
| - | - | - |
| `/account/usage` | [GET](/docs/cloud/rest/api-reference/account-usage/get-account-usage-overview) | Get account usage overview |
| `/account/usage/credits` | [GET](/docs/cloud/rest/api-reference/account-usage/get-account-ai-credits-usage) | Get account AI credits usage |
| `/account/usage/limits` | [GET](/docs/cloud/rest/api-reference/account-usage/get-account-usage-limits) | Get account usage limits |
| `/account/usage/series` | [GET](/docs/cloud/rest/api-reference/account-usage/get-account-usage-series) | Get account usage series |
| `/account/usage/warnings` | [GET](/docs/cloud/rest/api-reference/account-usage/get-account-usage-warnings) | Get account usage warnings |

## Project usage

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

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/members/usage` | [GET](/docs/cloud/rest/api-reference/project-usage/get-project-member-usage) | Get project member usage |
| `/projects/{project_reference}/usage` | [GET](/docs/cloud/rest/api-reference/project-usage/get-project-usage) | Get project usage |

## API key usage

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

| Endpoint | Methods | Description |
| - | - | - |
| `/api-keys/usage` | [GET](/docs/cloud/rest/api-reference/api-key-usage/list-api-key-usage) | List API key usage |
| `/api-keys/{id}/usage` | [GET](/docs/cloud/rest/api-reference/api-key-usage/get-api-key-usage) | Get API key usage |
| `/api-keys/{id}/limits` | [GET](/docs/cloud/rest/api-reference/api-key-usage/get-api-key-inference-limits), [PUT](/docs/cloud/rest/api-reference/api-key-usage/replace-api-key-inference-limits), [DELETE](/docs/cloud/rest/api-reference/api-key-usage/clear-api-key-inference-limits) | Get API key inference limits; Replace API key inference limits; Clear API key inference limits |

## Feature gates

Check access to a named plan or feature gate. Individual endpoints still enforce their resource permissions.

| Endpoint | Methods | Description |
| - | - | - |
| `/gates/{gate}` | [GET](/docs/cloud/rest/api-reference/feature-gates/check-gate-access) | Check gate access |

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


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