Showing the first 18000 characters. Load the complete file to read the remainder.
# 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)
- [Approval Workflows](https://docs.salesbricks.com/orders/approval-workflows.md): Review non-standard deals before an order can be shared with your customer or closed
- [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
- [Overview](https://docs.salesbricks.com/partners/overview.md): Sell through resellers, distributors, and other third parties that receive and pay the invoice on behalf of your customer.
- [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
- [Overview](https://docs.salesbricks.com/renewals/overview.md): The Renewals page gives sellers centralized visibility into every customer subscription approaching renewal. Use it to monitor upcoming renewals, track renewal status, flag growth opportunities, schedule price uplifts, and take action before a contract lapses.
- [Usage Alerts](https://docs.salesbricks.com/catalog/usage-alerts.md)
- [Usage Pools](https://docs.salesbricks.com/catalog/usage-pools.md): Let several usage bricks draw from one shared bucket of units
- [Monetary Usage Pricing](https://docs.salesbricks.com/catalog/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.
- [Finalize an invoice](https://docs.salesbricks.com/api-reference/invoices/finalize-an-invoice.md): Issues a draft invoice. Final tax is committed, the date of issue and due date are stamped, the invoice leaves draft for its terminal status, and it is sent to the customer's invoice recipients. Only drafts can be issued.
- [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,…
- [Void an invoice](https://docs.salesbricks.com/api-reference/invoices/void-an-invoice.md): Voids an invoice so it is no longer collectible, exactly as voiding it in the app does. The invoice's PDF is regenerated to show it as void, the customer's invoice recipients are emailed, the `invoice.voided` webhook fires, and the invoice is voided in your connected accounting system.
- [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 the payment methods for an invoice](https://docs.salesbricks.com/api-reference/payment-methods/list-the-payment-methods-for-an-invoice.md): Retrieves the saved payment methods of the company billed for this invoice, each answered for the invoice itself. A method the invoice cannot be paid with is returned with a `restricted` object naming the reason, rather than omitted, so a payer can be told why their stored card is unavailable. `rest…
- [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: re
Measured from the saved file
Linked document
UTF-8 text size
32.8 KB33620 bytes
Token count
7211o200k_base encoding
Markdown links
179179 distinct URLs
Fenced code blocks
0189 lines in the file
Size measures the captured UTF-8 text, not compressed transfer size. Tokens are counted with a named tokenizer; other models can count differently. Neither measure establishes context compatibility or answer quality.
Project H1
Salesbricks
Context architecture
How the content is divided
2 H2 sections organize 179 parsed Markdown links. 174 links point to .md or .markdown paths; 3 link occurrences use another hostname. Linked destinations have not been recursively validated.
H2 section
Links
UTF-8 bytes
Tokens
OpenAPI SpecsLine 178
3
145
45
OptionalLine 184 · Optional
2
166
36
Link counts exclude parsed fenced and inline code and resolve relative destinations against the final endpoint. Section sizes cover the text below each H2 until the next H2.
Embedded material
Code, installation and API examples
Fenced blocks
0 closed
Declared languages
No fenced blocks detected
Package-install commands
0 detected in fenced or inline code
Authentication examples
0 fenced lines match API-key, Authorization, Bearer, OAuth or access-token patterns
HTTP request examples
0 fenced lines match request-method patterns
Authentication links
0 links have authentication-related labels
Embedded example text and links to further documentation are counted separately. A code block does not establish that a sample runs or that an authentication flow succeeds.
Publisher prioritization
The Optional section
1 H2 section named “Optional” contain 2 parsed links. 177 links sit outside those sections. That puts 1.1% of the file’s parsed links under Optional.
The community proposal uses Optional by convention for secondary links that can be skipped for a shorter context. This label does not establish that everything outside it is critical, or that the material inside it is deprecated.
Machine-readable routes
MCP references and configuration text
MCP-related text was detected in the captured file. 1 links have MCP-related labels or paths. 0 fenced lines match mcpServers, mcp_servers or an mcp add command.
A verified text response establishes a companion at the checked URL. It does not prove the bundle contains all product documentation, that generation is automated, or that it fits an assistant’s context window.
Change evidence
What can be said about freshness
This capture establishes a baseline. Update frequency cannot be determined from one observation.
File changes can reveal documentation edits or navigation changes. They do not by themselves measure product release velocity, accuracy, agent adoption or AI visibility.
Counts use a deterministic parser, not a spec-compliance grade. Unusual Markdown and indented code can fall outside its recognized patterns. See the llms.txt proposal and tokenizer implementation.