Skip to main content
POST
Edit Price Intervals

Authorizations

Authorization
string
header
required

API key authentication

Path Parameters

id
string
required

The subscription ID

Body

application/json

The operations to apply. At least one of add, edit or remove is required.

add
object[]
required

New override segments to add.

Maximum array length: 25
edit
object[]

Changes to existing intervals.

Maximum array length: 25
remove
object[]

Intervals to remove outright.

Maximum array length: 25
changeReason
enum<string>

Why a change was made. correction fixes data to match what was agreed; migration moves a contract from another system; commercial is a real change to the deal. Defaults to unspecified.

Available options:
commercial,
correction,
migration,
unspecified
description
string

A free-text note on why these intervals are changing.

Maximum string length: 1000
metadata
object

Your own key-value data about the change, such as a CRM deal ID.

Response

The price intervals after the changes. If the request changed nothing, unchanged is true.

intervals
object[]
required

The timeline's effective price intervals after applying the op set, ordered by start date.

unchanged
boolean
required

True when the op set resolved to no change and nothing was written.

lineItems
object
required
intervalChange
object | null
required

The record this edit wrote. Null when the edit changed nothing.