Pricebooks

The pricebook object represents a collection of products and list prices to be repeatedly used across the business. The pricebook is stored in the source and is primarily used for packaging and provisioning.

Diagram

../_images/pricebooks_erd.svg

Table description

Column name

Data type

Description

id

BIGINT

An identifier for looking up or referencing this specific object.

org_id

INTEGER

An identifier referencing the organization related to this object.

env_id

INTEGER

An identifier referencing the environment related to this object.

branch_id

INTEGER

An identifier referencing the branch related to this object.

created_at

TIMESTAMP

A timestamp for when this row was first created.

durable_id

VARCHAR

An identifier for looking up or referencing this specific object. It will not change over time.

prorate

BOOLEAN

A boolean that determines whether or not proration is applied to the object.

name

VARCHAR

A string that respresents what this object is called.

invoice_delivery

VARCHAR

A string that represents if the invoice will be delivered at the beginning of the month, “ADVANCED”, or at the end of the month, “ARREARS”

invoice_schedule

INTEGER

An integer for the number of months in a billing or service period.

billing_target

VARCHAR

A string that defines what billing provider an invoice is sent to.

effective_at

TIMESTAMP

A timestamp that represents the beginning of the objects active period. This timestamp is inclusive.

ineffective_at

TIMESTAMP

A timestamp that represents the completion of the objects active period. This timestamp is exclusive.

archived_at

TIMESTAMP

A timestamp for when this object was archived.

version

INTEGER

An incrementing integer which denotes the most up to date object associated with an ID.