githubEdit

Product

Attributes of the Product type

Name
Type
Description

code

String

Unique code

createdAt

ISO8601DateTime

Timestamp the product was created

customFieldDefinitions

Custom field definitions for this object type

customFieldsData

JSON

All custom field values for this object as a JSON object

description

String

Product description

everythingInPlus

Boolean

Lays out plan features in typical everything-in-X-plus style

features

List (Feature)

The features available on the product

hasCustomFields

Boolean

Whether this object type has any custom fields defined

id

ID

Unique identifier for the product

internalNotes

String

Internal notes

name

String

Unique product name

planDefaults

Default values for a new plan

plans

List (Plan)

The plan available on the product

plansToDisplay

Int

Number of plans to display at once on the product page

platform

Platform object

platformId

ID

ID of the platform this plan is provisioned to

productCategory

Product category object

productCategoryId

ID

ID of the product category

showProductNameOnLineItem

Boolean

Prefix quote and invoice line items with product name

updatedAt

ISO8601DateTime

Timestamp the product was last updated

Last updated

Was this helpful?