← All resources

Resource

price_bracket

A quantity-band pricing rule for a specific scope

GraphQL reference →

Configuration

nameStringOptional

Optional label

scopeTypePriceBracketScopeType!Required

Scope type (required)

Allowed values

COST_CATEGORY — Bracket applies to a cost category

OPERATION_KIND — Bracket applies to an operation kind

PRODUCT — Bracket applies to a product

scopeReferenceString!Required

ID or kind code of the scoped entity (required)

customerIdCustomerIDOptional

Customer-specific bracket (omit for all customers)

minQuantityInt!Required

Inclusive lower quantity bound (required)

maxQuantityIntOptional

Inclusive upper quantity bound (nil = unlimited)

rateFloat!Required

Rate value (required)

rateTypePriceBracketRateType!Required

How the rate is applied (required)

Allowed values

PER_UNIT — Rate × quantity

FLAT — Flat rate regardless of quantity within the bracket

currencyCurrencyISO!Required

ISO 4217 currency code (required)

isActiveBoolean!Optional

Whether active (default: true)

validFromISO8601Optional

Valid-from date (ISO8601)

validUntilISO8601Optional

Valid-until date (ISO8601)

Read-only values

Show values
idPriceBracketID!Read only

Unique identifier

computed by the platform

createdAtString!Read only

Creation timestamp (ISO8601)

computed by the platform

updatedAtString!Read only

Last update timestamp (ISO8601)

computed by the platform

Lifecycle

The CLI can create this resource. The platform assigns its id.

When replacement is needed, the existing resource is removed before its replacement is created.