Get Bundle Option

GET https://api.secure.quotivity.com/v1/bundles/{bundleId}/options/{optionId}

Retrieves a bundle option with its priced products.

Send your API key in the x-api-key header. See Generating API keys.

Path parameters

Name	Type	Required	Description
`bundleId`	string	Yes	—
`optionId`	string	Yes	—

Query parameters

Name	Type	Required	Description
`startKey`	string	No	Cursor for pagination of products
`limit`	string	No	—

Responses

Status	Body	Description
`200`	GetBundleOptionResponse	Successfully retrieved bundle option
`400`	—	Bundle option does not belong to this bundle
`401`	—	Unauthorized
`500`	—	Internal Server Error

Schemas

BundleOption

Field	Type	Required	Description
`id`	string	Yes	—
`accountId`	string	Yes	—
`bundleId`	string	Yes	—
`name`	string	Yes	—
`description`	string	No	—
`priceBookId`	string	Yes	—
`displayOrder`	number	Yes	—
`configuration`	BundleOptionConfiguration	Yes	—

BundleOptionConfiguration

Field	Type	Required	Description
`minCount`	number	No	—
`maxCount`	number	No	—
`defaultOptionProductId`	string	No	—

BundleOptionProduct

Field	Type	Required	Description
`id`	string	Yes	—
`accountId`	string	Yes	—
`bundleId`	string	Yes	—
`optionId`	string	Yes	—
`productId`	string	Yes	—
`properties`	map of string to string	Yes	—
`configuration`	BundleProductConfiguration	No	—
`displayOrder`	number	Yes	—

BundleProductConfiguration

Field	Type	Required	Description
`minQuantity`	number	No	—
`maxQuantity`	number	No	—
`readonlyQuantity`	boolean	No	—

CostPlusAdjustment

Derives the list price from the product’s hs_cost_of_goods_sold: basis amount adds value to cost; basis percent applies value as a fraction of cost (0.3 = 30%) as a markup (cost × (1 + value)) or a margin (cost ÷ (1 − value)). Non-primary currencies convert the cost with the account’s cached HubSpot exchange rate. value must not be negative and a margin must be below 1. Requires the Cost Plus feature (Enterprise).

Extends PriceAdjustmentBase.

Field	Type	Required	Description
`type`	`costplus`	Yes	—
`basis`	`amount` \| `percent`	Yes	—
`mode`	`markup` \| `margin`	No	Read only when `basis` is `percent`; defaults to `markup`.
`value`	number	Yes	Currency amount above cost for `amount`; fraction of cost for `percent`.
`round`	boolean	No	Round the derived price to 2 decimals (default true); `false` keeps 5 decimals.