Skip to main content
DELETE
Delete Adjustment

Authorizations

Authorization
string
header
required

API key authentication

Path Parameters

id
string
required

The subscription ID

adjustmentId
string
required

The adjustment ID

Response

The adjustment was retracted to the end of the last period it was billed on. It still exists, with a shortened window.

object
enum<string>
required
Available options:
subscriptionAdjustment
id
string
required

The adjustment ID

subscriptionId
string
required

Unique identifier for a subscription

Pattern: ^sub_[a-zA-Z0-9]+$
type
enum<string>
required
Available options:
percentageDiscount,
usageDiscount,
minimumQuantity,
maximumQuantity
percentageDiscount
string | null
required

The discount rate as a decimal fraction between 0 and 1. "0.35" means 35 percent. Null on every other type.

usageDiscount
string | null
required

The number of usage units taken off the targeted line's billable quantity. Null on every other type.

minimumQuantity
string | null
required

The contracted minimum quantity billed for one period of the targeted price. Null on every other type.

maximumQuantity
string | null
required

The contracted maximum quantity billed for one period of the targeted price. Null on every other type.

targetPriceIds
string[]
required

The prices this adjustment applies to. Exactly one price on a usageDiscount; empty on a percentageDiscount, which reduces every discountable charge. A minimumQuantity or maximumQuantity is created against exactly one price, and later lists more than one only where that charge moved to a new price — a floating subscription moving to a new plan version, or a price edit freezing the subscription's version. Every id listed is the same charge, and the bound applies to whichever one a period bills under.

effectiveFrom
string<date-time>
required

Opens the window. Read per type: INCLUSIVE on a percentageDiscount, whose window is prorated by day overlap; EXCLUSIVE on a usageDiscount and on both quantity bounds, which apply to a line whose period END falls strictly after this instant.

effectiveTo
string<date-time> | null
required

Closes the window, or null for never. Read per type: EXCLUSIVE on a percentageDiscount; INCLUSIVE on a usageDiscount and on both quantity bounds, which apply to a line whose period END falls on or before this instant. A delete shortens this to the end of the last period the adjustment has already been billed on.

description
string | null
required

The deal's own name. Shown on each discount line a percentageDiscount emits; every other type emits no line, so its description is carried here only.

createdAt
string<date-time>
required