Catalog template reference
Columns, allowed values and rules for the three catalog templates.
Exact columns, allowed values and defaults for the three Configure Catalog templates. Values are case-sensitive and uppercase where shown.
Common rules (all templates)
- Download location: Settings → Onboarding → 2. Configure Catalog → section → download icon (Products and Offerings) or Microsoft Excel / Google Sheets and Others (Rates).
- Workbook layout: three sheets: Instructions, a data sheet (Products, Offerings or Rates), and Values.
- Values sheet: the source for every dropdown and ID lookup, generated from your tenant at download time. Don't edit it.
- Golden rules (printed in every template): don't edit or delete column headers, don't edit the Values sheet, and read the Instructions sheet.
- Upload: CSV or XLSX, maximum 10 MB. XLSX uploads are read from the sheet with the data-sheet name. Formulas are replaced by their calculated values, and dates become
YYYY-MM-DD. - Optional columns: add them as extra header cells using the exact names below. The Products and Offerings templates also include a column for each custom field on that object, headed by the custom field's API name.
- Uploads only create records. They never update existing ones.
Products
File: Onboarding - Products Template.xlsx · Sheet: Products · One row = one product
| Column | Required | Allowed values | Notes |
|---|---|---|---|
| Product Name | Yes | Any text | |
| Description | Yes | Any text, max 255 characters | |
| Product Type | Yes | SUBSCRIPTION, USAGE, ONETIME, MIN_COMMIT, ONETIME_PREPAID_CREDIT | Shown as "Subscription", "Usage", "Onetime" and so on in the app |
| Status | Yes | ACTIVE, INACTIVE | Only Active products appear in the Offerings template |
| SKU | No | Any text | |
| Recognition Method | No | IMMEDIATE, STRAIGHT_LINE_EXACT_DAYS, STRAIGHT_LINE_EVEN_PERIODS, STRAIGHT_LINE_PRORATED_FIRST_LAST, STRAIGHT_LINE_PRORATED_PERIOD_RATE | |
| Recognition Duration | No | Number | Used only for ONETIME and SUBSCRIPTION products that also have a Recognition Method |
Optional columns:
| Column | Values | Notes |
|---|---|---|
| Custom ID | Any | |
| Finance ID | Any | |
| Tax Item Code | Any | |
| Tax Exempt | Boolean | Defaults to false |
| Usage Type IDs | Comma-separated IDs, no spaces inside an ID | For USAGE products. If left blank, a usage type with the product's name is created automatically (unit "Unit", 0 decimals). |
| custom field API name | Must match the field's type |
Offerings
File: Onboarding - Offerings Template.xlsx · Sheet: Offerings · One row = one product inside an offering
| Column | Required | Allowed values | Notes |
|---|---|---|---|
| Offering Name | Yes | Any text | Rows with the same name are grouped into one offering, so names must be unique per offering |
| Status | Yes | ACTIVE, INACTIVE | Status and optional fields are taken from the first row of each offering |
| Product Name | Yes | Dropdown of Active products | |
| Product ID | Yes | Fills in automatically | Looked up from Product Name on the Values sheet |
| Required | Yes | Y, N | Y = mandatory in the offering, N = optional add-on |
Products are added to the offering in row order.
Optional columns:
| Column | Values | Default / notes |
|---|---|---|
| Description | Any | |
| Custom ID | Any | |
| Start Date / End Date | Date | Limits when the offering is available |
| Type | SUBSCRIPTION, ONETIME, MIN_COMMIT, CUSTOM_PERCENT_OF_TOTAL | If blank: ONETIME when every product is Onetime or Onetime Prepaid Credit; MIN_COMMIT when the only product is a Min Commit product; otherwise SUBSCRIPTION |
| custom field API name | Must match the field's type |
Rates
File: Onboarding - Rate Template.xlsx (both buttons) · Sheet: Rates · One row = one price line for one product
| Template button | Dropdown behavior |
|---|---|
| Microsoft Excel | Product Name dropdown is filtered to the selected offering's products (Excel only). For tenants with a very large number of offerings, use the other template. |
| Google Sheets and Others | Plain dropdowns of all offerings and all their products |
| Column | Required | Allowed values | Notes |
|---|---|---|---|
| Offering Name | Yes | Dropdown of Active offerings that have products | |
| Offering ID | Yes | Fills in automatically | |
| Rate Name | Yes | Any text | |
| Billing Frequency | Yes | DAILY, MONTHLY, QUARTERLY, SEMIANNUALLY, ANNUALLY, CUSTOM, ONETIME | |
| Subscription Timing | Yes | ADVANCE, ARREARS | |
| Product Name | Yes | Dropdown | |
| Product ID | Yes | Fills in automatically | |
| Type | Yes | FLAT, VOLUME, TIERED, CUSTOM, PERCENT_OF_TOTAL, BLOCK | The pricing model for this line |
| From | Yes | Integer ≥ 0 | Start of the quantity band |
| To | No | Integer ≥ 0 | Leave blank for "and above" |
| Price | Yes | Number ≥ 0 | |
| Currency | No | ISO code from the dropdown (for example USD, EUR, GBP) | Defaults to USD |
Grouping: rows sharing Offering ID + Rate Name + Billing Frequency + Subscription Timing form one rate. Within a rate, an identical repeated line (same product, type, From and To) is ignored.
Pricing models, per product within one rate:
| Combination | Allowed? |
|---|---|
| A single type (any) | ✅ |
FLAT + TIERED | ✅ |
FLAT + VOLUME | ✅ |
CUSTOM + anything else | ❌ |
VOLUME or TIERED mixed with any type other than FLAT | ❌ |
| Three or more types | ❌ |
Different products in the same rate can use different models. In the tutorial, Analyst Seat uses VOLUME while API Calls uses TIERED.
Optional columns:
| Column | Values | Default / notes |
|---|---|---|
| Custom ID | Any | |
| Description | Any | Defaults to the Rate Name |
| Status | ACTIVE, INACTIVE (and other rate statuses) | Defaults to ACTIVE |
| Billing Frequency in Months | Integer 1–60 | A value other than 1, 3, 6 or 12 makes the rate CUSTOM with that many months |
| Usage Billing Frequency | MONTHLY, QUARTERLY, SEMIANNUALLY, ANNUALLY | |
| Start Date / End Date | Date | |
| Parent Rate ID | Rate ID | |
| Account ID | Account ID | Makes the rate account-specific; otherwise it's a catalog rate |
| Quotable | Boolean | Defaults to true |
| Internal Description | Any | |
| Price Display | PRODUCT, OFFERING | |
| Min Commit Configuration | USAGE_PRODUCTS, SPECIFIC_USAGE_PRODUCTS, EXCLUDE_SPECIFIC_USAGE_PRODUCTS | |
| Min Commit Configuration - Product IDs | Comma-separated Product IDs | |
| Percent of Total Configuration | ALL_ELIGIBLE, SPECIFIED_PRODUCTS | |
| Percent of Total Configuration - Product IDs | Comma-separated Product IDs | |
| Revenue Channels | SALES, SELF_SERVICE (comma-separated) | Defaults to SALES |
Updated about 2 hours ago