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

ColumnRequiredAllowed valuesNotes
Product NameYesAny text
DescriptionYesAny text, max 255 characters
Product TypeYesSUBSCRIPTION, USAGE, ONETIME, MIN_COMMIT, ONETIME_PREPAID_CREDITShown as "Subscription", "Usage", "Onetime" and so on in the app
StatusYesACTIVE, INACTIVEOnly Active products appear in the Offerings template
SKUNoAny text
Recognition MethodNoIMMEDIATE, STRAIGHT_LINE_EXACT_DAYS, STRAIGHT_LINE_EVEN_PERIODS, STRAIGHT_LINE_PRORATED_FIRST_LAST, STRAIGHT_LINE_PRORATED_PERIOD_RATE
Recognition DurationNoNumberUsed only for ONETIME and SUBSCRIPTION products that also have a Recognition Method

Optional columns:

ColumnValuesNotes
Custom IDAny
Finance IDAny
Tax Item CodeAny
Tax ExemptBooleanDefaults to false
Usage Type IDsComma-separated IDs, no spaces inside an IDFor USAGE products. If left blank, a usage type with the product's name is created automatically (unit "Unit", 0 decimals).
custom field API nameMust match the field's type

Offerings

File: Onboarding - Offerings Template.xlsx · Sheet: Offerings · One row = one product inside an offering

ColumnRequiredAllowed valuesNotes
Offering NameYesAny textRows with the same name are grouped into one offering, so names must be unique per offering
StatusYesACTIVE, INACTIVEStatus and optional fields are taken from the first row of each offering
Product NameYesDropdown of Active products
Product IDYesFills in automaticallyLooked up from Product Name on the Values sheet
RequiredYesY, NY = mandatory in the offering, N = optional add-on

Products are added to the offering in row order.

Optional columns:

ColumnValuesDefault / notes
DescriptionAny
Custom IDAny
Start Date / End DateDateLimits when the offering is available
TypeSUBSCRIPTION, ONETIME, MIN_COMMIT, CUSTOM_PERCENT_OF_TOTALIf 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 nameMust match the field's type

Rates

File: Onboarding - Rate Template.xlsx (both buttons) · Sheet: Rates · One row = one price line for one product

Template buttonDropdown behavior
Microsoft ExcelProduct 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 OthersPlain dropdowns of all offerings and all their products
ColumnRequiredAllowed valuesNotes
Offering NameYesDropdown of Active offerings that have products
Offering IDYesFills in automatically
Rate NameYesAny text
Billing FrequencyYesDAILY, MONTHLY, QUARTERLY, SEMIANNUALLY, ANNUALLY, CUSTOM, ONETIME
Subscription TimingYesADVANCE, ARREARS
Product NameYesDropdown
Product IDYesFills in automatically
TypeYesFLAT, VOLUME, TIERED, CUSTOM, PERCENT_OF_TOTAL, BLOCKThe pricing model for this line
FromYesInteger ≥ 0Start of the quantity band
ToNoInteger ≥ 0Leave blank for "and above"
PriceYesNumber ≥ 0
CurrencyNoISO 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:

CombinationAllowed?
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:

ColumnValuesDefault / notes
Custom IDAny
DescriptionAnyDefaults to the Rate Name
StatusACTIVE, INACTIVE (and other rate statuses)Defaults to ACTIVE
Billing Frequency in MonthsInteger 1–60A value other than 1, 3, 6 or 12 makes the rate CUSTOM with that many months
Usage Billing FrequencyMONTHLY, QUARTERLY, SEMIANNUALLY, ANNUALLY
Start Date / End DateDate
Parent Rate IDRate ID
Account IDAccount IDMakes the rate account-specific; otherwise it's a catalog rate
QuotableBooleanDefaults to true
Internal DescriptionAny
Price DisplayPRODUCT, OFFERING
Min Commit ConfigurationUSAGE_PRODUCTS, SPECIFIC_USAGE_PRODUCTS, EXCLUDE_SPECIFIC_USAGE_PRODUCTS
Min Commit Configuration - Product IDsComma-separated Product IDs
Percent of Total ConfigurationALL_ELIGIBLE, SPECIFIED_PRODUCTS
Percent of Total Configuration - Product IDsComma-separated Product IDs
Revenue ChannelsSALES, SELF_SERVICE (comma-separated)Defaults to SALES

Did this page help you?