> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.paid.ai/v-2/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.paid.ai/_mcp/server. # v2 ## Docs - [Quickstart](https://docs.paid.ai/documentation/getting-started/quickstart.md): Build a complete credit-based billing integration for an AI chatbot with Paid. - [Create a product](https://docs.paid.ai/documentation/getting-started/create-a-product.md): Set up product details, currencies, and pricing in the dashboard, and save unfinished work as a draft. - [First signals](https://docs.paid.ai/documentation/getting-started/first-signals.md): Send first signals and cost traces - [Cost traces](https://docs.paid.ai/documentation/getting-started/cost-traces.md): Use telemetry to capture AI costs - [Cost attributed signals](https://docs.paid.ai/documentation/getting-started/cost-attributed-signals.md): Track the AI cost behind each signal - [Delivered value](https://docs.paid.ai/documentation/getting-started/delivered-value.md): Track the measurable value your AI agent delivers to customers alongside billing - [Credits](https://docs.paid.ai/documentation/credits/credits.md): Set up prepaid credit systems and query customer credit balances via the API. - [How credit balances work](https://docs.paid.ai/documentation/credits/how-credit-balances-work.md): Learn how credits are granted, spent, rolled over, and topped up in Paid. - [Understanding the credit ledger](https://docs.paid.ai/documentation/credits/understanding-the-credit-ledger.md): Understand the running history of credit additions, spending, pending grants, and balance changes in Paid. - [Examples of plans with included credits](https://docs.paid.ai/documentation/credits/examples-of-plans-with-included-credits.md): Examples of how to include credits alongside one-time, recurring, and seat-based pricing in Paid. - [Customer units and credit caps](https://docs.paid.ai/documentation/credits/customer-units-and-credit-caps.md): Model a customer's own hierarchy of teams, tenants or departments, attribute credit spend to it, and cap spend per unit and period. - [Checkout](https://docs.paid.ai/documentation/customers-users/checkout.md): Create checkout sessions programmatically to collect payments from your customers. - [User management](https://docs.paid.ai/documentation/customers-users/user-management.md): Create users explicitly, bill for seats through orders, and manage seat assignments through the public API. - [Multi-entity customers](https://docs.paid.ai/documentation/customers-users/multi-entity-customers.md): Consolidate billing across multiple customer accounts using parent-child hierarchies. - [Meters](https://docs.paid.ai/documentation/billing/meters.md): Create product-scoped meters from signal events and signal data. - [Webhooks](https://docs.paid.ai/documentation/billing/webhooks.md): Receive real-time HTTP notifications when billing events happen in Paid. - [Bank transfers](https://docs.paid.ai/documentation/billing/bank-transfers.md): Let a customer pay invoices by ACH or wire into a bank account that is theirs alone - [Product lifecycle and archival semantics](https://docs.paid.ai/documentation/billing/product-lifecycle-and-archival-semantics.md): Understand how product archival affects listings, checkout flows, billing, usage attribution, and existing customer relationships. - [Amending orders](https://docs.paid.ai/documentation/billing/amending-orders.md): Change quantities, prices, attributes, and end dates on a live order, with a billing preview before anything is applied. - [Backdated order activation](https://docs.paid.ai/documentation/billing/backdated-order-activation.md): Understand how Paid backfills credits, invoices, and historical usage when activating orders that started in the past. - [Value receipts](https://docs.paid.ai/documentation/value-receipts/overview.md): Customer-facing documents that showcase the measurable value your AI agent delivers - [Integration guide](https://docs.paid.ai/documentation/value-receipts/integration-guide.md): Create, manage, and embed value receipts using the Paid API and embed SDK - [Authentication and embedding](https://docs.paid.ai/documentation/value-receipts/authentication-and-embedding.md): Set up JWT-based authentication, embed value receipts, and configure login redirects - [Create a custom view with Claude](https://docs.paid.ai/documentation/custom-views/create-a-custom-view-with-claude.md): Generate a per-customer or organization-level dashboard conversationally with Claude over the Paid MCP server, then preview and publish it - [Embed a custom view](https://docs.paid.ai/documentation/custom-views/embed-a-custom-view.md): Embed a published per-customer dashboard in your app with a short-lived, Paid-minted token scoped to one customer - [Chart signal volume](https://docs.paid.ai/documentation/signals/chart-signal-volume.md): Count signals into period buckets, grouped by signal name or by a field in your signal payload - [Send signals with a customer API key](https://docs.paid.ai/documentation/signals/send-signals-with-a-customer-api-key.md): Give a customer's own runtime a key that reports usage for that customer and nothing else - [Analytics API overview](https://docs.paid.ai/documentation/analytics-api/overview.md): Query your Paid data with SQL to power dashboards and reports - [Analytics schema reference](https://docs.paid.ai/documentation/analytics-api/schema-reference.md): Every table and column you can query with the Analytics API - [Analytics query cookbook](https://docs.paid.ai/documentation/analytics-api/query-cookbook.md): Ready-to-use SQL recipes for the Analytics API - [Datadog Integration](https://docs.paid.ai/documentation/integrations/datadog.md): Import OpenTelemetry spans from Datadog for usage-based billing. - [SalesBricks Integration](https://docs.paid.ai/documentation/integrations/sales-bricks.md): Provision usage-based deals in Paid automatically when orders close in SalesBricks. - [Provisioning from a CRM](https://docs.paid.ai/documentation/integrations/provisioning-from-a-crm.md): Create or update a customer and their order in Paid from a closed deal in your CRM, in one API call. - [Xero Integration](https://docs.paid.ai/documentation/integrations/xero.md): Send Paid invoices into Xero so your finance team can reconcile in one place. - [Overview](https://docs.paid.ai/api-reference/introduction/overview.md): Start using the Paid API and SDKs to manage pricing, subscriptions, billing, and renewals. - [Rate limits](https://docs.paid.ai/api-reference/introduction/rate-limits.md): How Paid rate limits API requests, how to recognize a 429, and how clients should back off. - [Quickstart](https://docs.paid.ai/cli/cli/quickstart.md): Authenticate and make your first Paid API call from the command line. - [Command reference](https://docs.paid.ai/cli/cli/command-reference.md): Reference for Paid CLI commands, options, profiles, and request body formats. - [Quickstart](https://docs.paid.ai/mcp/mcp/quickstart.md): Connect Paid to MCP-compatible AI tools with single sign-on or a Paid API key. ## API Docs - API Reference > amendments [Amend an order](https://docs.paid.ai/api-reference/api-reference/amendments/execute-order-amendment.md) - API Reference > amendments [Get amendment options for an order](https://docs.paid.ai/api-reference/api-reference/amendments/get-order-amendment-options.md) - API Reference > amendments [Preview an order amendment](https://docs.paid.ai/api-reference/api-reference/amendments/preview-order-amendment.md) - API Reference > analytics [Discover metadata keys present in your signals](https://docs.paid.ai/api-reference/api-reference/analytics/get-signals-metadata.md) - API Reference > analytics [Execute a SQL query against your analytics data](https://docs.paid.ai/api-reference/api-reference/analytics/execute-analytics-query.md) - API Reference > analytics [List queryable analytics views, columns, and types](https://docs.paid.ai/api-reference/api-reference/analytics/get-analytics-schema.md) - API Reference > analytics-experimental [Discover metadata keys present in your signals (deprecated)](https://docs.paid.ai/api-reference/api-reference/analytics-experimental/get-experimental-signals-metadata.md) - API Reference > analytics-experimental [Execute a SQL query against your analytics data (deprecated)](https://docs.paid.ai/api-reference/api-reference/analytics-experimental/execute-experimental-analytics-query.md) - API Reference > analytics-experimental [List queryable analytics views, columns, and types (deprecated)](https://docs.paid.ai/api-reference/api-reference/analytics-experimental/get-experimental-analytics-schema.md) - API Reference > checkouts [Archive checkout](https://docs.paid.ai/api-reference/api-reference/checkouts/archive-checkout.md) - API Reference > checkouts [Create a checkout](https://docs.paid.ai/api-reference/api-reference/checkouts/create-checkout.md) - API Reference > checkouts [Get checkout](https://docs.paid.ai/api-reference/api-reference/checkouts/get-checkout.md) - API Reference > checkouts [List checkouts](https://docs.paid.ai/api-reference/api-reference/checkouts/list-checkouts.md) - API Reference > contacts [Create a new contact](https://docs.paid.ai/api-reference/api-reference/contacts/create-contact.md) - API Reference > contacts [Delete contact](https://docs.paid.ai/api-reference/api-reference/contacts/delete-contact-by-id.md) - API Reference > contacts [Delete contact by external ID](https://docs.paid.ai/api-reference/api-reference/contacts/delete-contact-by-external-id.md) - API Reference > contacts [Get contact](https://docs.paid.ai/api-reference/api-reference/contacts/get-contact-by-id.md) - API Reference > contacts [Get contact by external ID](https://docs.paid.ai/api-reference/api-reference/contacts/get-contact-by-external-id.md) - API Reference > contacts [List contacts](https://docs.paid.ai/api-reference/api-reference/contacts/list-contacts.md) - API Reference > contacts [Update contact](https://docs.paid.ai/api-reference/api-reference/contacts/update-contact-by-id.md) - API Reference > contacts [Update contact by external ID](https://docs.paid.ai/api-reference/api-reference/contacts/update-contact-by-external-id.md) - API Reference > costs [Submit cost and/or usage data](https://docs.paid.ai/api-reference/api-reference/costs/create-costs.md) - API Reference > credits [Create credit currency](https://docs.paid.ai/api-reference/api-reference/credits/create-credit-currency.md) - API Reference > credits [List credit currencies](https://docs.paid.ai/api-reference/api-reference/credits/list-credit-currencies.md) - API Reference > credits [List credit transactions](https://docs.paid.ai/api-reference/api-reference/credits/list-credit-transactions.md) - API Reference > credits [Summarize credit transactions](https://docs.paid.ai/api-reference/api-reference/credits/get-credit-transaction-summary.md) - API Reference > credits [Update credit currency](https://docs.paid.ai/api-reference/api-reference/credits/update-credit-currency-by-id.md) - API Reference > custom-views-experimental [Change a custom view's date range (experimental)](https://docs.paid.ai/api-reference/api-reference/custom-views-experimental/update-custom-view-period.md) - API Reference > custom-views-experimental [Create a custom view (experimental)](https://docs.paid.ai/api-reference/api-reference/custom-views-experimental/create-custom-view.md) - API Reference > custom-views-experimental [Fetch a custom view's data, scoped to a customer or the organization (experimental)](https://docs.paid.ai/api-reference/api-reference/custom-views-experimental/get-custom-view-data.md) - API Reference > custom-views-experimental [Get a custom view's metadata + render bundle (experimental)](https://docs.paid.ai/api-reference/api-reference/custom-views-experimental/get-custom-view.md) - API Reference > custom-views-experimental [Get an embed token for a custom view](https://docs.paid.ai/api-reference/api-reference/custom-views-experimental/get-custom-view-embed-token.md) - API Reference > custom-views-experimental [List a customer's units for a custom view (experimental)](https://docs.paid.ai/api-reference/api-reference/custom-views-experimental/get-custom-view-customer-units.md) - API Reference > custom-views-experimental [List custom views (experimental)](https://docs.paid.ai/api-reference/api-reference/custom-views-experimental/list-custom-views.md) - API Reference > custom-views-experimental [Publish a custom view (experimental)](https://docs.paid.ai/api-reference/api-reference/custom-views-experimental/publish-custom-view.md) - API Reference > custom-views-experimental [Update a custom view (experimental)](https://docs.paid.ai/api-reference/api-reference/custom-views-experimental/update-custom-view.md) - API Reference > customer-groups [Add members to group](https://docs.paid.ai/api-reference/api-reference/customer-groups/create-customer-group-members.md) - API Reference > customer-groups [Create customer group](https://docs.paid.ai/api-reference/api-reference/customer-groups/create-customer-group.md) - API Reference > customer-groups [Delete customer group](https://docs.paid.ai/api-reference/api-reference/customer-groups/delete-customer-group.md) - API Reference > customer-groups [Get customer group](https://docs.paid.ai/api-reference/api-reference/customer-groups/get-customer-group.md) - API Reference > customer-groups [List customer groups](https://docs.paid.ai/api-reference/api-reference/customer-groups/list-customer-groups.md) - API Reference > customer-groups [Remove members from group](https://docs.paid.ai/api-reference/api-reference/customer-groups/delete-customer-group-members.md) - API Reference > customer-groups [Set group members](https://docs.paid.ai/api-reference/api-reference/customer-groups/update-customer-group-members.md) - API Reference > customer-groups [Update customer group](https://docs.paid.ai/api-reference/api-reference/customer-groups/update-customer-group.md) - API Reference > customer-portals [Create a customer portal session](https://docs.paid.ai/api-reference/api-reference/customer-portals/create-customer-portal.md) - API Reference > customers [Create a customer API key](https://docs.paid.ai/api-reference/api-reference/customers/create-customer-api-key.md) - API Reference > customers [Create a customer API key (by external customer id)](https://docs.paid.ai/api-reference/api-reference/customers/create-customer-api-key-by-external-id.md) - API Reference > customers [Create a customer unit](https://docs.paid.ai/api-reference/api-reference/customers/create-customer-unit.md) - API Reference > customers [Create a customer unit (by external customer id)](https://docs.paid.ai/api-reference/api-reference/customers/create-customer-unit-by-external-id.md) - API Reference > customers [Create a customer unit alias](https://docs.paid.ai/api-reference/api-reference/customers/create-customer-unit-alias.md) - API Reference > customers [Create a customer unit alias by customer external ID](https://docs.paid.ai/api-reference/api-reference/customers/create-customer-unit-alias-by-external-id.md) - API Reference > customers [Create a customer unit alias by the unit's key](https://docs.paid.ai/api-reference/api-reference/customers/create-customer-unit-alias-by-key.md) - API Reference > customers [Create a customer unit under a parent](https://docs.paid.ai/api-reference/api-reference/customers/create-customer-unit-under-parent.md) - API Reference > customers [Create a new customer](https://docs.paid.ai/api-reference/api-reference/customers/create-customer.md) - API Reference > customers [Create customer alias](https://docs.paid.ai/api-reference/api-reference/customers/create-customer-alias.md) - API Reference > customers [Create customer alias by external ID](https://docs.paid.ai/api-reference/api-reference/customers/create-customer-alias-by-external-id.md) - API Reference > customers [Create customer virtual bank account](https://docs.paid.ai/api-reference/api-reference/customers/create-customer-funding-instructions.md) - API Reference > customers [Delete a customer unit](https://docs.paid.ai/api-reference/api-reference/customers/delete-customer-unit.md) - API Reference > customers [Delete a customer unit (by external customer id)](https://docs.paid.ai/api-reference/api-reference/customers/delete-customer-unit-by-external-id.md) - API Reference > customers [Delete a customer unit alias](https://docs.paid.ai/api-reference/api-reference/customers/delete-customer-unit-alias.md) - API Reference > customers [Delete a customer unit alias by customer external ID](https://docs.paid.ai/api-reference/api-reference/customers/delete-customer-unit-alias-by-external-id.md) - API Reference > customers [Delete a customer unit alias by the unit's key](https://docs.paid.ai/api-reference/api-reference/customers/delete-customer-unit-alias-by-key.md) - API Reference > customers [Delete customer](https://docs.paid.ai/api-reference/api-reference/customers/delete-customer-by-id.md) - API Reference > customers [Delete customer alias](https://docs.paid.ai/api-reference/api-reference/customers/delete-customer-alias.md) - API Reference > customers [Delete customer alias by external ID](https://docs.paid.ai/api-reference/api-reference/customers/delete-customer-alias-by-external-id.md) - API Reference > customers [Delete customer by external ID](https://docs.paid.ai/api-reference/api-reference/customers/delete-customer-by-external-id.md) - API Reference > customers [End customer-unit cap](https://docs.paid.ai/api-reference/api-reference/customers/end-customer-unit-cap.md) - API Reference > customers [End customer-unit cap (by external customer id)](https://docs.paid.ai/api-reference/api-reference/customers/end-customer-unit-cap-by-external-id.md) - API Reference > customers [Get a customer unit](https://docs.paid.ai/api-reference/api-reference/customers/get-customer-unit.md) - API Reference > customers [Get a customer unit (by external customer id)](https://docs.paid.ai/api-reference/api-reference/customers/get-customer-unit-by-external-id.md) - API Reference > customers [Get a customer unit by its key](https://docs.paid.ai/api-reference/api-reference/customers/get-customer-unit-by-key.md) - API Reference > customers [Get customer](https://docs.paid.ai/api-reference/api-reference/customers/get-customer-by-id.md) - API Reference > customers [Get customer by external ID](https://docs.paid.ai/api-reference/api-reference/customers/get-customer-by-external-id.md) - API Reference > customers [Get customer credit balances](https://docs.paid.ai/api-reference/api-reference/customers/get-customer-credit-balances.md) - API Reference > customers [Get customer credit balances by external ID](https://docs.paid.ai/api-reference/api-reference/customers/get-customer-credit-balances-by-external-id.md) - API Reference > customers [Get customer state](https://docs.paid.ai/api-reference/api-reference/customers/get-customer-state-by-id.md) - API Reference > customers [Get customer state by external ID](https://docs.paid.ai/api-reference/api-reference/customers/get-customer-state-by-external-id.md) - API Reference > customers [Get customer virtual bank account](https://docs.paid.ai/api-reference/api-reference/customers/get-customer-funding-instructions.md) - API Reference > customers [Get customer-unit cap](https://docs.paid.ai/api-reference/api-reference/customers/get-customer-unit-cap.md) - API Reference > customers [Get customer-unit cap (by external customer id)](https://docs.paid.ai/api-reference/api-reference/customers/get-customer-unit-cap-by-external-id.md) - API Reference > customers [Get customer-unit spend](https://docs.paid.ai/api-reference/api-reference/customers/get-customer-unit-spend.md) - API Reference > customers [Get customer-unit spend (by external customer id)](https://docs.paid.ai/api-reference/api-reference/customers/get-customer-unit-spend-by-external-id.md) - API Reference > customers [Grant customer credits](https://docs.paid.ai/api-reference/api-reference/customers/grant-customer-credits.md) - API Reference > customers [Grant customer credits by external ID](https://docs.paid.ai/api-reference/api-reference/customers/grant-customer-credits-by-external-id.md) - API Reference > customers [List a customer unit's aliases](https://docs.paid.ai/api-reference/api-reference/customers/list-customer-unit-aliases.md) - API Reference > customers [List a customer unit's aliases by customer external ID](https://docs.paid.ai/api-reference/api-reference/customers/list-customer-unit-aliases-by-external-id.md) - API Reference > customers [List a customer unit's aliases by its key](https://docs.paid.ai/api-reference/api-reference/customers/list-customer-unit-aliases-by-key.md) - API Reference > customers [List customer aliases](https://docs.paid.ai/api-reference/api-reference/customers/list-customer-aliases.md) - API Reference > customers [List customer aliases by external ID](https://docs.paid.ai/api-reference/api-reference/customers/list-customer-aliases-by-external-id.md) - API Reference > customers [List customer API keys](https://docs.paid.ai/api-reference/api-reference/customers/list-customer-api-keys.md) - API Reference > customers [List customer API keys (by external customer id)](https://docs.paid.ai/api-reference/api-reference/customers/list-customer-api-keys-by-external-id.md) - API Reference > customers [List customer units](https://docs.paid.ai/api-reference/api-reference/customers/list-customer-units.md) - API Reference > customers [List customer units (by external customer id)](https://docs.paid.ai/api-reference/api-reference/customers/list-customer-units-by-external-id.md) - API Reference > customers [List customers](https://docs.paid.ai/api-reference/api-reference/customers/list-customers.md) - API Reference > customers [List pending credit consumption](https://docs.paid.ai/api-reference/api-reference/customers/list-customer-pending-credit-consumption.md) - API Reference > customers [List pending credit consumption by external ID](https://docs.paid.ai/api-reference/api-reference/customers/list-customer-pending-credit-consumption-by-external-id.md) - API Reference > customers [Revoke a customer API key](https://docs.paid.ai/api-reference/api-reference/customers/revoke-customer-api-key.md) - API Reference > customers [Revoke a customer API key (by external customer id)](https://docs.paid.ai/api-reference/api-reference/customers/revoke-customer-api-key-by-external-id.md) - API Reference > customers [Set customer-unit cap](https://docs.paid.ai/api-reference/api-reference/customers/set-customer-unit-cap.md) - API Reference > customers [Set customer-unit cap (by external customer id)](https://docs.paid.ai/api-reference/api-reference/customers/set-customer-unit-cap-by-external-id.md) - API Reference > customers [Update a customer unit](https://docs.paid.ai/api-reference/api-reference/customers/update-customer-unit.md) - API Reference > customers [Update a customer unit (by external customer id)](https://docs.paid.ai/api-reference/api-reference/customers/update-customer-unit-by-external-id.md) - API Reference > customers [Update customer](https://docs.paid.ai/api-reference/api-reference/customers/update-customer-by-id.md) - API Reference > customers [Update customer by external ID](https://docs.paid.ai/api-reference/api-reference/customers/update-customer-by-external-id.md) - API Reference > customers [Upsert customer user by external IDs](https://docs.paid.ai/api-reference/api-reference/customers/upsert-customer-user-by-external-id.md) - API Reference > delivered-value [Get delivered value](https://docs.paid.ai/api-reference/api-reference/delivered-value/get-delivered-value.md) - API Reference > delivered-value [Summarize delivered value](https://docs.paid.ai/api-reference/api-reference/delivered-value/get-delivered-value-summary.md) - API Reference > invoices [Get invoice](https://docs.paid.ai/api-reference/api-reference/invoices/get-invoice-by-id.md) - API Reference > invoices [Get invoice lines](https://docs.paid.ai/api-reference/api-reference/invoices/get-invoice-lines.md) - API Reference > invoices [List invoices](https://docs.paid.ai/api-reference/api-reference/invoices/list-invoices.md) - API Reference > invoices [Update invoice](https://docs.paid.ai/api-reference/api-reference/invoices/update-invoice-by-id.md) - API Reference > orders [Activate order](https://docs.paid.ai/api-reference/api-reference/orders/activate-order-by-id.md) - API Reference > orders [Assign or unassign seat](https://docs.paid.ai/api-reference/api-reference/orders/update-order-seat-assignment.md) - API Reference > orders [Batch assign seats](https://docs.paid.ai/api-reference/api-reference/orders/batch-order-seat-assignments.md) - API Reference > orders [Create a new order](https://docs.paid.ai/api-reference/api-reference/orders/create-order.md) - API Reference > orders [Delete order](https://docs.paid.ai/api-reference/api-reference/orders/delete-order-by-id.md) - API Reference > orders [Get order](https://docs.paid.ai/api-reference/api-reference/orders/get-order-by-id.md) - API Reference > orders [Get order lines](https://docs.paid.ai/api-reference/api-reference/orders/get-order-lines.md) - API Reference > orders [List orders](https://docs.paid.ai/api-reference/api-reference/orders/list-orders.md) - API Reference > orders [List seats](https://docs.paid.ai/api-reference/api-reference/orders/list-order-seats.md) - API Reference > orders [Update order](https://docs.paid.ai/api-reference/api-reference/orders/update-order-by-id.md) - API Reference > orders [Upsert an order with its customer and products](https://docs.paid.ai/api-reference/api-reference/orders/upsert-order-by-external-id.md) - API Reference > payment-allocations [Create payment allocations](https://docs.paid.ai/api-reference/api-reference/payment-allocations/create-payment-allocation.md) - API Reference > payment-allocations [List payment allocations](https://docs.paid.ai/api-reference/api-reference/payment-allocations/list-payment-allocations.md) - API Reference > payment-methods [Create a payment method](https://docs.paid.ai/api-reference/api-reference/payment-methods/create-payment-method.md) - API Reference > payment-methods [Delete payment method](https://docs.paid.ai/api-reference/api-reference/payment-methods/delete-payment-method.md) - API Reference > payment-methods [Get payment method](https://docs.paid.ai/api-reference/api-reference/payment-methods/get-payment-method.md) - API Reference > payment-methods [List payment methods](https://docs.paid.ai/api-reference/api-reference/payment-methods/list-payment-methods.md) - API Reference > payment-methods [Set default payment method](https://docs.paid.ai/api-reference/api-reference/payment-methods/update-default-payment-method.md) - API Reference > payments [Create a payment](https://docs.paid.ai/api-reference/api-reference/payments/create-payment.md) - API Reference > payments [Get payment](https://docs.paid.ai/api-reference/api-reference/payments/get-payment.md) - API Reference > payments [List payments](https://docs.paid.ai/api-reference/api-reference/payments/list-payments.md) - API Reference > plans [Create a new plan](https://docs.paid.ai/api-reference/api-reference/plans/create-plan.md) - API Reference > plans [Get plan](https://docs.paid.ai/api-reference/api-reference/plans/get-plan-by-id.md) - API Reference > plans [Get plan by external ID](https://docs.paid.ai/api-reference/api-reference/plans/get-plan-by-external-id.md) - API Reference > plans [List plans](https://docs.paid.ai/api-reference/api-reference/plans/list-plans.md) - API Reference > plans [Update plan](https://docs.paid.ai/api-reference/api-reference/plans/update-plan-by-id.md) - API Reference > plans [Update plan by external ID](https://docs.paid.ai/api-reference/api-reference/plans/update-plan-by-external-id.md) - API Reference > plans [Update plan upgrade path](https://docs.paid.ai/api-reference/api-reference/plans/update-plan-upgrade-path.md) - API Reference > pricing [Get pricing for a product attribute](https://docs.paid.ai/api-reference/api-reference/pricing/get-pricing.md) - API Reference > pricing [List pricing for a product](https://docs.paid.ai/api-reference/api-reference/pricing/list-pricing.md) - API Reference > pricing [Update pricing for a product attribute](https://docs.paid.ai/api-reference/api-reference/pricing/update-pricing.md) - API Reference > products [Create a new product](https://docs.paid.ai/api-reference/api-reference/products/create-product.md) - API Reference > products [Get product](https://docs.paid.ai/api-reference/api-reference/products/get-product-by-id.md) - API Reference > products [Get product by external ID](https://docs.paid.ai/api-reference/api-reference/products/get-product-by-external-id.md) - API Reference > products [List products](https://docs.paid.ai/api-reference/api-reference/products/list-products.md) - API Reference > products [Update product](https://docs.paid.ai/api-reference/api-reference/products/update-product-by-id.md) - API Reference > products [Update product by external ID](https://docs.paid.ai/api-reference/api-reference/products/update-product-by-external-id.md) - API Reference > signals [Create signals in bulk](https://docs.paid.ai/api-reference/api-reference/signals/create-signals.md) - API Reference > signals [Get a signal summary export](https://docs.paid.ai/api-reference/api-reference/signals/get-signal-summary-export.md) - API Reference > signals [Get signal](https://docs.paid.ai/api-reference/api-reference/signals/get-signal-by-id.md) - API Reference > signals [List signals](https://docs.paid.ai/api-reference/api-reference/signals/list-signals.md) - API Reference > signals [Start a signal summary export](https://docs.paid.ai/api-reference/api-reference/signals/create-signal-summary-export.md) - API Reference > signals [Summarize signals over time](https://docs.paid.ai/api-reference/api-reference/signals/get-signal-summary.md) - API Reference > value-metrics [Archive a value metric](https://docs.paid.ai/api-reference/api-reference/value-metrics/archive-value-metric.md) - API Reference > value-metrics [Create a value metric](https://docs.paid.ai/api-reference/api-reference/value-metrics/create-value-metric.md) - API Reference > value-metrics [Get a value metric](https://docs.paid.ai/api-reference/api-reference/value-metrics/get-value-metric.md) - API Reference > value-metrics [List value metrics](https://docs.paid.ai/api-reference/api-reference/value-metrics/list-value-metrics.md) - API Reference > value-metrics [Update a value metric](https://docs.paid.ai/api-reference/api-reference/value-metrics/update-value-metric.md) - API Reference > value-models [Get current value model](https://docs.paid.ai/api-reference/api-reference/value-models/get-current-value-model.md) - API Reference > value-models [Get specific version](https://docs.paid.ai/api-reference/api-reference/value-models/get-value-model-version.md) - API Reference > value-models [List version history](https://docs.paid.ai/api-reference/api-reference/value-models/list-value-model-versions.md) - API Reference > value-models [Trigger backfill](https://docs.paid.ai/api-reference/api-reference/value-models/refresh-value-model-backfill.md) - API Reference > value-models [Upload value model](https://docs.paid.ai/api-reference/api-reference/value-models/update-value-model.md) - API Reference > value-receipts [Archive a value receipt](https://docs.paid.ai/api-reference/api-reference/value-receipts/archive-value-receipt.md) - API Reference > value-receipts [Create a value receipt](https://docs.paid.ai/api-reference/api-reference/value-receipts/create-value-receipt.md) - API Reference > value-receipts [Get value receipt](https://docs.paid.ai/api-reference/api-reference/value-receipts/get-value-receipt-by-id.md) - API Reference > value-receipts [List value receipts](https://docs.paid.ai/api-reference/api-reference/value-receipts/list-value-receipts.md) - API Reference > value-receipts [Publish a value receipt](https://docs.paid.ai/api-reference/api-reference/value-receipts/publish-value-receipt.md) - API Reference > value-receipts [Refresh a value receipt (deprecated)](https://docs.paid.ai/api-reference/api-reference/value-receipts/refresh-value-receipt.md) - API Reference > value-receipts [Seal a value receipt (deprecated)](https://docs.paid.ai/api-reference/api-reference/value-receipts/seal-value-receipt.md) - API Reference > value-receipts [Sync a value receipt (deprecated)](https://docs.paid.ai/api-reference/api-reference/value-receipts/sync-value-receipt.md) - API Reference > value-receipts [Unarchive a value receipt](https://docs.paid.ai/api-reference/api-reference/value-receipts/unarchive-value-receipt.md) - API Reference > value-receipts [Unpublish a value receipt](https://docs.paid.ai/api-reference/api-reference/value-receipts/unpublish-value-receipt.md) - API Reference > webhooks [List webhooks](https://docs.paid.ai/api-reference/api-reference/webhooks/list-webhooks.md) - API Reference > webhooks [Rotate the organization's webhook signing secret](https://docs.paid.ai/api-reference/api-reference/webhooks/rotate-webhook-secret.md) - API Reference > webhooks [Send a test webhook](https://docs.paid.ai/api-reference/api-reference/webhooks/test-webhook.md) - API Reference > webhooks [Update a webhook](https://docs.paid.ai/api-reference/api-reference/webhooks/update-webhook.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://docs.paid.ai/v-2/openapi.json) - [OpenAPI YAML](https://docs.paid.ai/v-2/openapi.yaml)