Skip to main content

​
Create a product

  1. Go to Pricebook in the left nav, which lands you in the Products tab.
  2. Click Add a Product button in the top right.
  3. Enter a Product name (eg. “API Requests,” “Storage GB”).
  4. If you want to set up external mappings before saving the product, continue to “Configure external mappings” below. Otherwise, continue to Step 5.
  5. Click Save.
If you did not configure external mappings in Step 4, the Product appears in the catalog with a Needs setup status until integrations are configured.

​
Configure external mappings (optional, depending on setup)

Refer to Integrations and exports for detailed documentation on implementing integrations. Products are the bridge between Orb and your external systems. The same product object that anchors your pricing carries the mappings that tell Orb how to handle each line item when it flows into a downstream system. There are three types of external mapping that you may need to configure, depending on your specific setup:
  • Invoicing (Stripe Invoicing, Netsuite, QuickBooks, Bill.com): Orb attaches the correct item in your invoicing system to each invoice line.
  • Accounting / ERP (NetSuite, QuickBooks): Orb syncs invoice and billing data to your accounting or ERP system for reporting and reconciliation.
  • Tax (Anrok, Avalara AvaTax, Numeral, Sphere, Stripe Tax, TaxJar): Orb uses the tax code on the product to apply the correct tax treatment per line item
You configure these mappings once per product from the product details page. After that, Orb automatically applies the correct treatment for the product across every plan and subscription whenever an invoice is generated, synced, or taxed.
Each product displays a status based on how completely it has been configured for the account’s connected external systems.Status is always relative to connected integrations. If a new integration is added, previously configured products may drop to Needs setup until they are mapped to the new provider.Products can be filtered by status and searched by name.
  • Configured (green): All required mappings to connected third parties are in place for the account’s current integrations. If there are no invoicing or tax integrations connected, the product is also treated as Configured.
  • Needs setup (red): At least one required mapping to a connected provider is missing. This can happen when a poduct is first created, or when a new integration is connected and existing products haven’t been mapped to it yet. In this state, invoices involving the product may fail to sync or be taxed incorrectly.
  • Optional setup available (yellow): All required mappings are configured, but there are additional optional mappings available for connected providers that haven’t been set up. Today, this specifically means Bill.com item mappings: tax and all other invoicing providers are mapped, but Bill.com is not.
  • Archived (gray): The product has been marked inactive. It won’t appear in selection menus or be used for new configurations, but is preserved in historical invoices, exports, and audit trails. Archived products can be unarchived if needed.
Note: If a Product is missing its external mappings, invoices that include it will fail to sync or be taxed incorrectly. You don’t need mappings before you start building, but you do need them before you go live with any integration.

​
Add a price to a plan

​
1. From the pricebook: new price

Start here when you’re building out your product catalog and the price doesn’t exist yet. If you know the price will be on more than one plan, starting here saves you steps, since you can create the price and attach it to multiple plans in a single flow.
  1. Go to Pricebook in the left nav and make sure you’re on the Products tab.
  2. Open the product you want to price, or create a new product first.
  3. Click Add a price.
  4. Choose a Price type (Usage-based or Fixed fee). More detail on price types and price models here.
  5. Enter a Price name, this becomes the line item label on customer invoices.
  6. Fill in the pricing configuration.
  7. Click Create.
  8. Click Add to plans
  9. Select the price(s) you want to add to a plan, click Next.
  10. Select the plan(s) to create a new plan version with the selected price(s), decide whether to make new versions the default version
  11. Review changes through the product interface on the right.
  12. Click Add to plan versions on the top right.
You will land in the Plan page. A new version has been created for each plan selected in Step 10. For each plan, you’ll need to migrate existing subscriptions. Refer to “Migrating subscriptions to a new version” for more detail.

​
2. From the pricebook: existing price

Start here when the price already exists. If you want to add it to more than one plan at once, starting here saves you steps. Otherwise, you can also do this from within each Plan directly.
  1. Go to Pricebook, click on the product that is connected to the price you want to add to plan(s).
  2. Find the price within the list of prices for that product (you can use the filters and/or search).
  3. Select the Price.
  4. Click on the menu on the upper right and select Add to plans.
  5. Select the plan(s) to create a new plan version with the selected price(s), decide whether to make new versions the default version
  6. Review changes through the product interface on the right.
  7. Click Add to plan versions on the top right.
You will land in the Plan page. A new Plan version has been created for each Plan that was selected in Step 5. For each Plan, existing subscriptions will need to be migrated to the new version to receive the change. Refer to “Migrating subscriptions to a new version” in this doc for more detail.

​
3. From a plan

Start here when you’re already configuring a plan, creating a plan, or versioning an existing plan. If the price would apply just to this plan, this is the most natural starting point.
  1. Go to Plans.
    • To create a new Plan to add a Price to, click the New Plan button in the top right and proceed to step 2.
    • To add a price to an existing Plan, open the Plan and click Add version.
  2. Click Add price.
  3. Choose one of the three options below and complete the flow:
    1. Select an existing price from pricebook — attaches a price that is centrally managed. Rate changes in the pricebook automatically applies to this price.
    2. Create a new price — creates a new price and adds it to pricebook. Initially references only by this plan, but other plans can point to it later.
    3. Copy a price from a plan — creates a new price with unique price ID that has the same configuration of the duplicated price.
If the price was added to an existing Plan, existing subscriptions will need to be migrated to the new version to receive the change. Refer to “Migrating subscriptions to a new version” in this doc for more detail.

​
Add a price to a subscription

Use this when you’re setting up a custom deal for a specific customer, a negotiated rate, a one-off add-on, or an exception that shouldn’t affect anyone else on the same plan.
  1. Go to Customers in the left nav.
    1. To create a new Subscription to add a price to, click Create a subscription in the center (only shows up for new customers) or Add subscription in the top right. See this “Creating subscriptions” for a detailed explanation of this flow.
    2. To add a price to an existing Subscription, select the customer’s subscription and open Edit subscription.
  2. Click Add price.
  3. Choose one of the three one of the three options below and complete the flow:
    1. Select an existing price from pricebook — attaches a price that is centrally managed. Rate changes in the pricebook automatically applies to this price.
    2. Create a new price — creates a new price and adds it to pricebook. Initially references only by this plan, but other plans can point to it later.
    3. Copy a price from a plan — creates a new price with unique price ID that has the same configuration of the duplicated price.