• Pricing
  • >
  • Objects
  • >
  • PriceBook

PriceBook

Represents the details for price book

This page contains

Fields

id: ID!

Unique identifier for price book

name: String

Name of price book

description: String

Description of price book

createdOn: DateTime

Creation date of price book

modifiedOn: DateTime

Updation date of price book

createdBy: String

User who created the price book

modifiedBy: String

User who modified the price book

priceBookEntries: [PriceBookEntry!]

List of custom price entries for different plans

priceBookConditions: [PriceBookCondition!]

List of conditions associated with price book

precedence: Long

precedence of price book

status: PriceBookStatus

Status of price book

effectiveStartDate: DateTime

Price will be applicable base on mentioned date

effectiveEndDate: DateTime

Price will not be applicable after end date

externalSource: PriceBookExternalSource PREVIEW

External source to which price book prices are associated

markupType: PriceBookMarkupType

Markup type for a price book

isDeleted: Boolean

Boolean value represents respective price book is deleted or not

Parent objects of PriceBook

PriceBookConnection

A connection type used to page through a list of price books

Mutations for PriceBook

activatePriceBook

Activate a price book

clonePriceBook

Clone price book

createOrUpdatePriceBook

Creates new price book or updates existing price book

createPriceBook

Create a price book

deactivatePriceBook

Deactivate a price book

updatePriceBook

Update name and description for a price book

Queries for PriceBook

priceBook

Returns price book by it's id

priceBookByName

Returns price book by its name

priceBooks

Returns all price books for partner

priceBooksByPricingPlanId

Returns all the price books for a given pricing plan