Skip to content

Get Price Point By Id

GET
/v1/sandbox/{sandbox_id}/price-point/{price_point_id}

Get Price Point by ID. Requires any of permissions: sandbox:config:view, sandbox:config:edit

Authorizations

Parameters

Path Parameters

price_point_id
required

Price Point ID

string format: uuid

Price Point ID

sandbox_id
required

Sandbox ID

string format: uuid

Sandbox ID

Responses

200

Successful Response

A collection of Price Breakpoints (volume pricing).

object
custom_data

Custom data associated with the resource

object
key
additional properties
string
name

Name of the resource

string
>= 1 characters <= 125 characters
description

Description of the resource

string
>= 1 characters <= 250 characters
strict_flag

Forces the quantity to be equal to a quantity on a Price Breakpoint.

boolean
cap_flag

Only allows quantity to be fulfilled up the highest quantity on the Price Breakpoints

boolean
current_breakpoints

Current Price Breakpoints.

Array<object>
default:

Price based on quantity and the Item ID of the currency used.

object
custom_data

Custom data associated with the resource

object
key
additional properties
string
price_item_id
required

Item ID of the currency used to price.

string format: uuid
quantity
required

Quantity for the price break point.

integer
> 0
price
required

Price for the quantity.

integer
> 0
price_item_name

Name corresponding Item ID

string
pre_sale_breakpoints

Previous Price Breakpoints.

Array<object>
default:

Price based on quantity and the Item ID of the currency used.

object
custom_data

Custom data associated with the resource

object
key
additional properties
string
price_item_id
required

Item ID of the currency used to price.

string format: uuid
quantity
required

Quantity for the price break point.

integer
> 0
price
required

Price for the quantity.

integer
> 0
price_item_name

Name corresponding Item ID

string
sandbox_id

ID of the Sandbox

string format: uuid
last_modified_account_id

Account ID of the user who last modified the resource

string format: uuid
last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time
created_timestamp

Timestamp of when the resource was created

string format: date-time
price_point_id

The Price Point ID.

string format: uuid

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string