Skip to main content
GET
List price modifiers

Authorizations

Authorization
string
header
required

Organization API key using Authorization: Bearer sk_....

Query Parameters

filter
object

Fields encoded with qs bracket notation.

orderBy
object

Fields encoded with qs bracket notation.

skip
number
default:0

Pagination offset.

Required range: x >= 0
Example:

0

take
number
default:20

Pagination limit.

Required range: 1 <= x <= 100
Example:

20

Response

Price modifiers list

id
string
required

Unique identifier of the price modifier.

Example:

"prm_1234567890abcdefghij"

createdAt
required

When the modifier was created.

Example:

"2025-01-01T00:00:00.000Z"

updatedAt
required

When the modifier was last updated.

Example:

"2025-01-01T00:00:00.000Z"

name
string
required

Display name of the modifier.

Example:

"Descuento por pago anticipado 10%"

type
enum<string>
required

Whether this is an early payment discount or a late payment interest charge.

Available options:
EARLY_PAYMENT_DISCOUNT,
LATE_PAYMENT_INTEREST
Example:

"EARLY_PAYMENT_DISCOUNT"

adjustmentType
enum<string>
required

Whether the adjustment is a fixed amount, a percentage, or a resulting set price.

Available options:
FIXED,
PERCENTAGE,
SET_PRICE
Example:

"PERCENTAGE"

value
number
required

Adjustment value: cents for FIXED and SET_PRICE, percentage points for PERCENTAGE.

Example:

10

timeUnit
enum<string>
required

Time unit for offset and frequency calculations.

Available options:
MINUTES,
HOURS,
DAYS,
WEEKS,
MONTHS,
YEARS,
BUSINESS_DAYS
Example:

"DAYS"

anchorOffsetStart
number
required

Start of the eligibility window (in time units) relative to the anchor date.

Example:

1

anchorOffsetEnd
number | null
required

End of the eligibility window (in time units) relative to the anchor date, if bounded.

maxAdjustmentAmount
number | null
required

Maximum total adjustment in minor currency units.

Example:

null

isRecurring
boolean
required

Whether the modifier is applied repeatedly over time.

Example:

false

organizationId
string
required

Identifier of the owning organization.

Example:

"org_1234567890abcdefghij"

compoundInterest
boolean
required

Whether interest compounds on accumulated interest (late payment only).

Example:

false

recurringFrequency
number | null
required

How often the modifier is applied (in time units) when recurring.

Example:

null

maxApplications
number | null
required

Maximum number of times this modifier can be applied.

Example:

null

priority
number
required

Application order when multiple modifiers are active. Lower values run first.

Example:

0

oneOff
boolean
required

Whether this modifier is single-use.

Example:

false

description
string | null

Optional description of the modifier.

Example:

null