Docs

Log in to read the version of docs relevant to your site, or use the dropdown versions

Products

The available fields in Products and their corresponding descriptions are listed below.

FieldDescription
Plan NameThe display name of the plan.
Plan PeriodDisplays the period of the plan.
SKUDisplays the Product name/code used in your third party accounting application.
PriceThe price of the plan.
Account CodeDisplays the Account code of the plan used for integration purposes.
Invoice NameDisplays the invoice name.
Plan CurrencyThe currency code (ISO 4217 format) of the plan.
Free QuantityDisplays the number of free units.
Pricing ModelDisplays the pricing model.
Tax CodeDisplays the tax code in case of Avalara integration.
Trial Period UnitDisplays the unit for the trial period. Possible values are day and month.
Enabled in Self-Serve PortalDisplays ‘Yes' if the customers can change their subscription using the self serve portal. Displays ‘No', if otherwise.
TaxableDisplays ‘Yes' if the plan is taxable, ‘No', if otherwise.
StatusDisplays the status of the plan. Possible values are active, archived.
Charge TypeDisplays if the charges are recurring, or non-recurring.
Plan Setup FeeDisplays the one time set up free.
Trial PeriodDisplays the trial period for the plan/add-on.
Product TypeDisplays if the product type is a plan or add-on.
Accounting Category 1Displays the name of the category of your product in Xero. If you've integrated with QuickBooks, this will be the "Class". Uses the format "<Category>:<Name>". E.g. "Region: North".
Accounting Category 2Displays the name of the category of your product in Xero. Uses the format<Category>:<Name>". E.g. "Region: North".
Billing CyclesThe number of billing cycles the subscription is active.
Billing Frequency UnitDefines billing frequency in association with billing period. Possible values are week, month, year.
Enabled in Hosted PagesDisplays True if checkout through plan specific URL is enabled. Displays False if otherwise.

Was this article helpful?