# Salesbricks

- [Introduction](https://docs.salesbricks.com/quickstart-guide/introduction.md): Close more deals faster with the simplest way to buy and sell software.
- [Getting Started](https://docs.salesbricks.com/quickstart-guide/getting-started.md)
- [Navigating Salesbricks](https://docs.salesbricks.com/quickstart-guide/navigating-salesbricks.md)
- [Overview](https://docs.salesbricks.com/quickstart-guide/products-plans-bricks/overview.md)
- [Creating a Product](https://docs.salesbricks.com/quickstart-guide/products-plans-bricks/creating-a-product.md)
- [Creating a Plan](https://docs.salesbricks.com/quickstart-guide/products-plans-bricks/creating-a-plan.md)
- [Creating a Brick](https://docs.salesbricks.com/quickstart-guide/products-plans-bricks/creating-a-brick.md)
- [Building an Order](https://docs.salesbricks.com/quickstart-guide/building-an-order.md)
- [Order Types](https://docs.salesbricks.com/orders/order-types.md): Understanding upgrades, renewals, recasts, and terminations
- [Order Phases](https://docs.salesbricks.com/orders/order-phases.md): Split one contract into sequential phases, each with its own plan, pricing, billing frequency, and payment terms
- [Order Stages](https://docs.salesbricks.com/orders/order-stages.md)
- [Deal Shaping](https://docs.salesbricks.com/orders/deal-shaping.md): Best practices to help you and your customer benefit from a partnership and close the deal
- [Ramping Structures](https://docs.salesbricks.com/orders/ramping-structures.md)
- [Duration Discounts](https://docs.salesbricks.com/orders/duration-discounts.md)
- [Custom Billing](https://docs.salesbricks.com/orders/custom-billing.md)
- [Countersigning](https://docs.salesbricks.com/orders/countersigning.md)
- [Managing Your Customer](https://docs.salesbricks.com/customers/managing-your-customer.md): A primer on Upgrades, Renewals, Recasts, and Terminations
- [One-Off Invoices](https://docs.salesbricks.com/billing/one-off-invoices.md): Bill customers for charges outside of a subscription
- [Credit Pools](https://docs.salesbricks.com/billing/credit-pools.md): Grant and apply customer credits to invoices
- [Payment Communications](https://docs.salesbricks.com/billing/payment-communications.md): How to tell your customers that they owe you money
- [Dunning](https://docs.salesbricks.com/billing/dunning.md): Handling failed payments in Salesbricks
- [Renewals Management](https://docs.salesbricks.com/renewals/renewals-management.md)
- [Usage Alerts](https://docs.salesbricks.com/catalog/products/usage-alerts.md)
- [Monetary Usage Pricing](https://docs.salesbricks.com/catalog/products/monetary-usage-pricing.md)
- [Reports & Charts](https://docs.salesbricks.com/reports/reports-and-charts.md): A primer for Salesbricks' reporting and charting features
- [BrIQ AI Assistant](https://docs.salesbricks.com/agents/briq.md): Ask questions about your revenue data in plain language
- [Company Details & Branding](https://docs.salesbricks.com/settings/company/details-and-branding.md): Tailor your Salesbricks site to your organization
- [Legal Entities](https://docs.salesbricks.com/settings/company/legal-entities.md): Issue orders and invoices under multiple contracting entities
- [Pricing Display](https://docs.salesbricks.com/settings/finance/pricing-display.md)
- [Checkout & Invoice Payment Options](https://docs.salesbricks.com/settings/finance/checkout-invoice-payment-options.md)
- [Taxed States](https://docs.salesbricks.com/settings/finance/taxed-states.md)
- [Adding Team Members](https://docs.salesbricks.com/settings/team/adding-team-members.md)
- [Role-based access control (RBAC)](https://docs.salesbricks.com/settings/team/rbac.md)
- [Custom email domain](https://docs.salesbricks.com/settings/notifications/custom-email-domain.md): Send customer email notifications from your own domain
- [Customer email notifications](https://docs.salesbricks.com/settings/notifications/customer-email-notifications.md): What emails will Salesbricks send to your customers
- [Your email notifications](https://docs.salesbricks.com/settings/notifications/your-email-notifications.md): What emails will Salesbricks send to your team
- [Overview](https://docs.salesbricks.com/integrations/salesforce/overview.md)
- [Managed Package](https://docs.salesbricks.com/integrations/salesforce/managed-package.md)
- [HubSpot](https://docs.salesbricks.com/integrations/hubspot.md)
- [Attio](https://docs.salesbricks.com/integrations/attio.md)
- [CRM Field Mapping](https://docs.salesbricks.com/integrations/crm-field-mapping.md)
- [Overview](https://docs.salesbricks.com/integrations/stripe/overview.md)
- [Setup](https://docs.salesbricks.com/integrations/stripe/setup.md): Connect your Stripe account to collect credit card and ACH payments. Skip this guide if you're not using credit card or ACH payments in Salesbricks, or not using Salesbricks for billing.
- [Overview](https://docs.salesbricks.com/integrations/quickbooks/overview.md): Connect Salesbricks to QuickBooks Online to sync customers, invoices, payments, credit memos, and refunds into your accounting ledger.
- [Setup & Troubleshooting](https://docs.salesbricks.com/integrations/quickbooks/setup.md): Connect your QuickBooks Online company to Salesbricks, manage the connection, and resolve syncs that were skipped.
- [Manual Payment Matching](https://docs.salesbricks.com/integrations/quickbooks/payment-matching.md): Link a wire, check, or other payment recorded in QuickBooks to the Salesbricks invoice it belongs to. Or, undo a match that landed on the wrong invoice.
- [Overview](https://docs.salesbricks.com/integrations/xero/overview.md): Connect Salesbricks to Xero to sync contacts, invoices, payments, and credit notes into your accounting ledger.
- [Setup & Troubleshooting](https://docs.salesbricks.com/integrations/xero/setup.md): Connect your Xero organization to Salesbricks, manage the connection, and resolve syncs that were skipped.
- [Sphere](https://docs.salesbricks.com/integrations/sphere.md)
- [Kintsugi](https://docs.salesbricks.com/integrations/kintsugi/index.md)
- [ChartMogul](https://docs.salesbricks.com/integrations/chartmogul.md)
- [Slack](https://docs.salesbricks.com/integrations/slack.md)
- [MCP](https://docs.salesbricks.com/integrations/mcp.md): Connect your AI assistant to Salesbricks
- [OIN Configuration Setup](https://docs.salesbricks.com/integrations/okta/oin-configuration.md): How to set up Okta Single Sign-On integration
- [Private Integration Setup](https://docs.salesbricks.com/integrations/okta/private-integration.md): How to set up a private Okta integration with Salesbricks
- [REST API Overview](https://docs.salesbricks.com/api-reference/getting-started/overview.md)
- [Authentication](https://docs.salesbricks.com/api-reference/getting-started/authentication.md)
- [Starting a Subscription](https://docs.salesbricks.com/api-reference/getting-started/starting-a-subscription.md)
- [Idempotent Requests](https://docs.salesbricks.com/api-reference/getting-started/idempotent-requests.md)
- [GraphQL API (Legacy)](https://docs.salesbricks.com/api-reference/getting-started/graphql.md)
- [Manage My Subscription](https://docs.salesbricks.com/api-reference/manage-my-subscription.md)
- [List all customers](https://docs.salesbricks.com/api-reference/customers/list-all-customers.md): Returns a paginated list of all customers for the authenticated seller. Each customer includes their associated subscriptions with key fields: subscription ID, status, name, start date, and end date. Pagination is handled via query params (limit, offset).
- [Create a customer](https://docs.salesbricks.com/api-reference/customers/create-a-customer.md): Creates a new customer.
- [Retrieve a customer](https://docs.salesbricks.com/api-reference/customers/retrieve-a-customer.md): Retrieves a customer by ID.
- [Update a customer](https://docs.salesbricks.com/api-reference/customers/update-a-customer.md): Updates a customer.
- [Search customers](https://docs.salesbricks.com/api-reference/customers/search-customers.md): Search for customers using various criteria. Supports searching by `name` (case-insensitive substring match), `external_id` (exact match), or `stripe_customer_id` (exact match). At least one search parameter must be provided. Pagination is handled via query params (limit, offset).
- [List all customer invoices](https://docs.salesbricks.com/api-reference/invoices/list-all-customer-invoices.md): Returns a paginated list of a customer's invoices, subscription and standalone alike, newest first.
- [Create standalone invoice](https://docs.salesbricks.com/api-reference/invoices/create-standalone-invoice.md): Create a one-off invoice for a customer without a subscription.
- [Retrieve an invoice](https://docs.salesbricks.com/api-reference/invoices/retrieve-an-invoice.md): Retrieves the invoice details by ID.
- [Update an invoice](https://docs.salesbricks.com/api-reference/invoices/update-an-invoice.md): Update an invoice with override fields, line item descriptions, and/or PDF attachments.
- [Pay an invoice](https://docs.salesbricks.com/api-reference/invoices/pay-an-invoice.md): Processes a payment for a specific invoice using a Stripe payment method.
- [Create a payment](https://docs.salesbricks.com/api-reference/invoices/create-a-payment.md): Creates a payment against an invoice. Use this for payments collected outside of Salesbricks, such as wire transfers or checks. Works for both subscription and standalone invoices.
- [Retrieve an invoice PDF](https://docs.salesbricks.com/api-reference/invoices/retrieve-an-invoice-pdf.md): Returns the URL to the PDF file for the invoice. The URL expires in 1 hour. The download parameter can be used to force download with a Content-Disposition header.
- [Regenerate an invoice](https://docs.salesbricks.com/api-reference/invoices/regenerate-an-invoice.md): Recalculates the invoice from the current order and subscription data, regenerates the stored PDF, and creates a new invoice version. Use this after upstream changes (for example order or billing updates) that should be reflected on an already-generated invoice. The existing stored PDF is replaced,…
- [Search invoices](https://docs.salesbricks.com/api-reference/invoices/search-invoices.md): Search your invoices, both subscription and standalone. Filters combine with AND, and at least one must be provided (`ordering` alone is not enough). Empty arrays are treated as omitted.
- [List all subscription invoices](https://docs.salesbricks.com/api-reference/invoices/list-all-subscription-invoices.md): Returns a paginated list of invoices associated with the given subscription. Use this to show invoice history and billing status per subscription, display a timeline of past/current invoices, and let users download or inspect previous and current charges.
- [Retrieve next subscription invoice](https://docs.salesbricks.com/api-reference/invoices/retrieve-next-subscription-invoice.md): Returns the next invoice that will have a non-zero amount for the given subscription.
- [List all payment methods](https://docs.salesbricks.com/api-reference/payment-methods/list-all-payment-methods.md): Retrieves all payment methods associated with the subscription's customer. Returns formatted payment method details including cards and bank accounts.
- [Setup a payment method](https://docs.salesbricks.com/api-reference/payment-methods/setup-a-payment-method.md): Creates a Stripe SetupIntent for adding payment methods to a subscription. Returns the necessary Stripe credentials to initialize the payment form. Supports card, bank account, and SEPA direct debit payment methods.
- [Retrieve default payment method](https://docs.salesbricks.com/api-reference/payment-methods/retrieve-default-payment-method.md): Retrieves the default payment method for the subscription's customer.
- [Set default payment method](https://docs.salesbricks.com/api-reference/payment-methods/set-default-payment-method.md): Sets the default payment method for the subscription's customer. The payment method must be a valid Stripe payment method ID attached to the customer.
- [Delete a payment method](https://docs.salesbricks.com/api-reference/payment-methods/delete-a-payment-method.md): Removes a payment method from the subscription's customer.
- [List all payment methods](https://docs.salesbricks.com/api-reference/payment-methods/list-all-payment-methods-1.md): Retrieves all payment methods associated with the subscription's customer. Returns formatted payment method details including cards and bank accounts.
- [Setup a payment method](https://docs.salesbricks.com/api-reference/payment-methods/setup-a-payment-method-1.md): Creates a Stripe SetupIntent for adding payment methods to a subscription. Returns the necessary Stripe credentials to initialize the payment form. Supports card, bank account, and SEPA direct debit payment methods.
- [Retrieve default payment method](https://docs.salesbricks.com/api-reference/payment-methods/retrieve-default-payment-method-1.md): Retrieves the default payment method for the subscription's customer.
- [Set default payment method](https://docs.salesbricks.com/api-reference/payment-methods/set-default-payment-method-1.md): Sets the default payment method for the subscription's customer. The payment method must be a valid Stripe payment method ID attached to the customer.
- [Delete a payment method](https://docs.salesbricks.com/api-reference/payment-methods/delete-a-payment-method-1.md): Removes a payment method from the subscription's customer.
- [Create a customer contact](https://docs.salesbricks.com/api-reference/customer-contacts/create-a-customer-contact.md): Creates a new contact for a customer.
- [Update a customer contact](https://docs.salesbricks.com/api-reference/customer-contacts/update-a-customer-contact.md): Updates a contact for a customer.
- [Search customer contacts](https://docs.salesbricks.com/api-reference/customer-contacts/search-customer-contacts.md): Search for customer contacts using various criteria. Supports searching by `email`, `first_name`, `last_name` (case-insensitive substring match), or `customer_id` (exact match to filter by associated customer). At least one search parameter must be provided. Pagination is handled via query params (l…
- [List all discount coupons](https://docs.salesbricks.com/api-reference/discount-coupons/list-all-discount-coupons.md): Returns a paginated list of discount coupons for the authenticated seller. Supports filtering by active status and validity. Use this endpoint to display available coupons or validate coupon availability during checkout.
- [Retrieve a discount coupon](https://docs.salesbricks.com/api-reference/discount-coupons/retrieve-a-discount-coupon.md): Returns the details of a specific discount coupon by its code. The code lookup is case-insensitive. The response includes the coupon's current status (`active`, `is_valid`, `is_expired`) so the caller can determine how to handle it. Use this endpoint to validate and display coupon details during che…
- [List all invoice versions](https://docs.salesbricks.com/api-reference/invoice-versions/list-all-invoice-versions.md): Returns an array of past invoice versions for the specified invoice.
- [List all legal entities](https://docs.salesbricks.com/api-reference/legal-entities/list-all-legal-entities.md): Returns a paginated list of the seller's legal entities. Use a legal entity's id as `legal_entity_id` when creating a subscription to specify which entity issues it.
- [List all plans](https://docs.salesbricks.com/api-reference/plans/list-all-plans.md): Returns a paginated list of published plans. This will fetch the plan and the associated bricks for that plan.
- [Retrieve a plan](https://docs.salesbricks.com/api-reference/plans/retrieve-a-plan.md): Returns the details of a plan, including its name and bricks.
- [Get per-subscription revenue by month](https://docs.salesbricks.com/api-reference/revenue/get-per-subscription-revenue-by-month.md): Returns one row per (subscription, currency) with a sparse `entries` list of {month, revenue_type, amount} records. Revenue types are: recurring, overage, pay_as_you_go, one_time, and milestone. Continuation logic is applied server-side for recurring revenue — active subscriptions are forward-filled…
- [Create a subscription](https://docs.salesbricks.com/api-reference/subscriptions/create-a-subscription.md): Creates a new subscription for a customer.
- [Retrieve a subscription](https://docs.salesbricks.com/api-reference/subscriptions/retrieve-a-subscription.md): Returns the current subscription details for the specified ID, including plan name, lifecycle dates, billing information, point of contact, and line items. Use this endpoint to show subscription lifecycle info in user dashboards (e.g., start/end dates, contract renewal dates) and track active plan d…
- [Update a subscription](https://docs.salesbricks.com/api-reference/subscriptions/update-a-subscription.md): Updates a subscription for a customer.
- [Retrieve subscription checkout URL](https://docs.salesbricks.com/api-reference/subscriptions/retrieve-subscription-checkout-url.md): Retrieves the checkout URL for a subscription's open order.
- [Update a subscription pause](https://docs.salesbricks.com/api-reference/subscriptions/update-a-subscription-pause.md): Update a subscription pause (upcoming or active).
- [Pause a subscription](https://docs.salesbricks.com/api-reference/subscriptions/pause-a-subscription.md): Pause an active subscription. Creates a SubscriptionPause record and optionally extends the subscription end date if a scheduled resume date is provided.
- [Cancel an upcoming subscription pause](https://docs.salesbricks.com/api-reference/subscriptions/cancel-an-upcoming-subscription-pause.md): Cancel an upcoming (not yet started) subscription pause.
- [Resume a paused subscription](https://docs.salesbricks.com/api-reference/subscriptions/resume-a-paused-subscription.md): Resume a paused subscription. The resume date is automatically set to today in the subscription's timezone. This will adjust the subscription end date based on actual pause duration.
- [Retrieve subscription sign URL](https://docs.salesbricks.com/api-reference/subscriptions/retrieve-subscription-sign-url.md): Retrieves a URL for signing a subscription's open order.
- [Start a subscription](https://docs.salesbricks.com/api-reference/subscriptions/start-a-subscription.md): Starts a subscription for the specified ID. This endpoint is used to initiate a subscription and trigger the subscription lifecycle. It returns the subscription details after the start process.
- [Terminate a subscription](https://docs.salesbricks.com/api-reference/subscriptions/terminate-a-subscription.md): Terminates a subscription either immediately or at a specified future date. This endpoint allows for scheduling termination, adding termination notes, and specifying notification emails for termination alerts.
- [Estimate a subscription](https://docs.salesbricks.com/api-reference/subscriptions/estimate-a-subscription.md): Gets a pricing estimate for a subscription including the billing schedule and grand total.
- [Retrieve subscription management URL](https://docs.salesbricks.com/api-reference/subscription-management/retrieve-subscription-management-url.md): Retrieves a URL for managing a subscription's billing portal.
- [List all subscription bricks](https://docs.salesbricks.com/api-reference/subscription-state/list-all-subscription-bricks.md): Returns the bricks the customer is entitled to based on the current closed subscription agreements, along with their quantities.
- [Retrieve current subscription state](https://docs.salesbricks.com/api-reference/subscription-state/retrieve-current-subscription-state.md): Returns the current state of a subscription, including its active status, current billing period, and real-time subscription information. This endpoint is optimized for displaying current subscription state in dashboards and real-time status updates.
- [Update details for a closed subscription](https://docs.salesbricks.com/api-reference/subscription-state/update-details-for-a-closed-subscription.md): Updates details for a subscription that has already started. Only 'accounts_payable_emails' and 'accepted_payment_methods_config' can be modified for closed subscriptions.
- [Retrieve current subscription order form PDF](https://docs.salesbricks.com/api-reference/subscription-state/retrieve-current-subscription-order-form-pdf.md): Returns a URL to the signed order form PDF for the most recent won (closed) order.
- [Retrieve a subscription order form PDF](https://docs.salesbricks.com/api-reference/subscription-state/retrieve-a-subscription-order-form-pdf.md): Returns a signed URL to the order form PDF for the subscription.
- [Retrieve brick usage](https://docs.salesbricks.com/api-reference/usage/retrieve-brick-usage.md): Returns detailed usage metrics for a specific brick within a subscription, including pre-commitment amounts, used quantities, and remaining units. The remaining value can be negative if usage exceeds the pre-commitment amount. If no pre-commitment is set, `pre_commitment` and `remaining` will be 0.…
- [List individual usage entries](https://docs.salesbricks.com/api-reference/usage/list-individual-usage-entries.md): Returns the individual usage entries (single submitted events) for a brick, newest first, paginated via limit/offset in a {count, next, previous, results} envelope. Each entry carries the `transaction_id` accepted by PATCH /usage and DELETE /usage, enabling per-entry edit and delete.
- [Retrieve brick usage time series](https://docs.salesbricks.com/api-reference/usage/retrieve-brick-usage-time-series.md): Returns usage submitted against a brick, aggregated into fixed-size buckets (hour, day, week, or month). Decoupled from billing periods: the response contains only the raw sum of units per bucket and does NOT include pre-commitment, remaining, overages, or overage rate. For commitment-scoped fields,…
- [Create a usage entry](https://docs.salesbricks.com/api-reference/usage/create-a-usage-entry.md): Submits a usage entry for a subscription's metered brick. Each entry must have a unique `transaction_id` to prevent duplicates. The usage will be associated with the specified subscription and brick, and will be reflected in the next billing cycle.
- [Delete a usage entry](https://docs.salesbricks.com/api-reference/usage/delete-a-usage-entry.md): Deletes a usage entry by its unique `transaction_id`. Once deleted, the usage will no longer be counted in billing calculations. Returns a 404 error if the transaction_id is not found.
- [Update a usage entry](https://docs.salesbricks.com/api-reference/usage/update-a-usage-entry.md): Updates an existing usage entry by its unique `transaction_id`. You can update the `value` and/or `properties` fields. At least one field must be provided to update. Returns a 404 error if the transaction_id is not found.
- [Get usage transaction details](https://docs.salesbricks.com/api-reference/usage/get-usage-transaction-details.md): Retrieves the details of a usage transaction by its unique `transaction_id`. Returns the subscription, brick, value, timestamp, and any additional properties.
- [List all subscription milestones](https://docs.salesbricks.com/api-reference/subscription-milestones/list-all-subscription-milestones.md): Returns the milestones on a subscription's current agreement, with the quantity contracted and the quantity completed so far.
- [Complete a subscription milestone](https://docs.salesbricks.com/api-reference/subscription-milestones/complete-a-subscription-milestone.md): Marks some or all of a milestone complete so that it bills. `IMMEDIATELY` raises a standalone invoice and issues it now; `NEXT_INVOICE` adds it to the subscription's next scheduled invoice.
- [List all subscription orders](https://docs.salesbricks.com/api-reference/subscription-history/list-all-subscription-orders.md): Returns all closed orders for a subscription, including order dates, type, contract value, and PDF download links. Orders are returned in chronological order by start date (ascending by default). Supports pagination with limit/offset and ordering by `starts_at`, `ends_at`, or `created_at`.
- [List all subscription recast open orders](https://docs.salesbricks.com/api-reference/subscription-recasts/list-all-subscription-recast-open-orders.md): Returns a list of all open orders for subscription recast. These are recast orders that haven't started yet.
- [Create a subscription recast](https://docs.salesbricks.com/api-reference/subscription-recasts/create-a-subscription-recast.md): Creates a subscription recast which can be used to replace the terms, dates, and/or entitlements of a customer's current contract. It essentially scraps the existing agreement and creates a completely new one. Estimate the pricing for the newly created recast order using the `/subscriptions/{subscri…
- [Delete a subscription recast](https://docs.salesbricks.com/api-reference/subscription-recasts/delete-a-subscription-recast.md): DELETE /subscriptions/:subscription_id/recast/:order_idx
- [Update a subscription recast](https://docs.salesbricks.com/api-reference/subscription-recasts/update-a-subscription-recast.md): Updates a subscription recast order. This endpoint allows you to modify bricks, AP contacts, and other properties for an existing recast order.
- [Retrieve subscription recast checkout URL](https://docs.salesbricks.com/api-reference/subscription-recasts/retrieve-subscription-recast-checkout-url.md): Retrieves the checkout URL for a subscription's recast open order.
- [Retrieve subscription recast sign URL](https://docs.salesbricks.com/api-reference/subscription-recasts/retrieve-subscription-recast-sign-url.md): Retrieves a URL for signing a subscription's recast open order.
- [Start a subscription recast](https://docs.salesbricks.com/api-reference/subscription-recasts/start-a-subscription-recast.md): Starts a subscription recast order for the specified subscription and order IDs. This endpoint is used to initiate a recast order and trigger the recast lifecycle. It validates the order is ready to start and processes payment if required. A recast restarts an existing subscription with new terms, t…
- [Estimate a subscription recast](https://docs.salesbricks.com/api-reference/subscription-recasts/estimate-a-subscription-recast.md): Gets a pricing estimate for an open subscription recast including the billing schedule and grand total.
- [List all subscription upgrade open orders](https://docs.salesbricks.com/api-reference/subscription-upgrades/list-all-subscription-upgrade-open-orders.md): Returns a list of all open orders for subscription upgrade. These are upgrade orders that haven't started yet.
- [Create a subscription upgrade](https://docs.salesbricks.com/api-reference/subscription-upgrades/create-a-subscription-upgrade.md): Creates a subscription upgrade that can be used to add or remove add-ons from an existing contract term.
- [Delete a subscription upgrade](https://docs.salesbricks.com/api-reference/subscription-upgrades/delete-a-subscription-upgrade.md)
- [Update a subscription upgrade](https://docs.salesbricks.com/api-reference/subscription-upgrades/update-a-subscription-upgrade.md): Updates a subscription upgrade order. This endpoint allows you to modify bricks, AP contacts, and other properties for an existing upgrade order.
- [Retrieve subscription upgrade checkout URL](https://docs.salesbricks.com/api-reference/subscription-upgrades/retrieve-subscription-upgrade-checkout-url.md): Retrieves the checkout URL for a subscription's upgrade open order.
- [Retrieve subscription upgrade sign URL](https://docs.salesbricks.com/api-reference/subscription-upgrades/retrieve-subscription-upgrade-sign-url.md): Retrieves a URL for signing a subscription's upgrade open order.
- [Start a subscription upgrade](https://docs.salesbricks.com/api-reference/subscription-upgrades/start-a-subscription-upgrade.md): Starts a subscription upgrade order for the specified subscription and order IDs. This endpoint is used to initiate an upgrade order and trigger the upgrade lifecycle with the newly added/removed bricks. It validates the order is ready to start and processes payment if required.
- [Estimate a subscription upgrade](https://docs.salesbricks.com/api-reference/subscription-upgrades/estimate-a-subscription-upgrade.md): Gets a pricing estimate for an open subscription upgrade including the billing schedule and grand total.
- [Overview](https://docs.salesbricks.com/api-reference/usage/overview.md)
- [Submit a usage entry](https://docs.salesbricks.com/api-reference/usage/post.md): Use this API to increment a final value counter for a customer.
- [Update a usage entry](https://docs.salesbricks.com/api-reference/usage/patch.md): Use this API to update an existing usage entry.
- [Delete a usage entry](https://docs.salesbricks.com/api-reference/usage/delete.md): Use this API to delete an existing usage entry.
- [Overview](https://docs.salesbricks.com/api-reference/webhooks/overview.md)
- [Schemas](https://docs.salesbricks.com/api-reference/webhooks/schemas.md): In-depth look at webhook payload schemas
- [Order Webhook Payload](https://docs.salesbricks.com/api-reference/webhooks/order/payload.md)
- [order.stage.change](https://docs.salesbricks.com/api-reference/webhooks/order/stage-change.md)
- [order.complete](https://docs.salesbricks.com/api-reference/webhooks/order/complete.md)
- [order.closed.lost](https://docs.salesbricks.com/api-reference/webhooks/order/closed-lost.md)
- [order.closed.delete](https://docs.salesbricks.com/api-reference/webhooks/order/closed-delete.md)
- [order.end](https://docs.salesbricks.com/api-reference/webhooks/order/end.md)
- [order.new-ramping-period](https://docs.salesbricks.com/api-reference/webhooks/order/new-ramping-period.md)
- [order.terminated](https://docs.salesbricks.com/api-reference/webhooks/order/terminated.md)
- [Subscription Inactive Payload](https://docs.salesbricks.com/api-reference/webhooks/subscription/payload.md)
- [subscription.inactive](https://docs.salesbricks.com/api-reference/webhooks/subscription/inactive.md)
- [Invoice Webhook Payload](https://docs.salesbricks.com/api-reference/webhooks/invoice/payload.md)
- [invoice.start](https://docs.salesbricks.com/api-reference/webhooks/invoice/start.md)
- [invoice.past.due](https://docs.salesbricks.com/api-reference/webhooks/invoice/past-due.md)
- [invoice.payment.succeeded](https://docs.salesbricks.com/api-reference/webhooks/invoice/payment/succeeded.md)
- [invoice.payment.failed](https://docs.salesbricks.com/api-reference/webhooks/invoice/payment/failed.md)
- [Payment Webhook Payload](https://docs.salesbricks.com/api-reference/webhooks/payment/payload.md)
- [What's new in Salesbricks](https://docs.salesbricks.com/whats-new/index.md): Product features and updates (newest first)

## OpenAPI Specs

- [post](/api-reference/usage/post.yml)
- [usage](/api-reference/usage/usage.yml)
- [openapi](https://api.salesbricks.com/api/v2/openapi.yaml)

## Optional

- [Knowledge Base](https://support.salesbricks.com)