Skip to main content
DELETE
Delete a discount

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

sequence-version
enum<string>

Use this header to select an API version

Available options:
2024-07-30

Path Parameters

id
string
required

Discount ID

Response

OK

id
string
required

Discount ID

Example:

"d58bf2e3-7a5d-4900-8457-2521c6880f7d"

sequenceAccountId
string
required

The Sequence Account to which this Discount belongs

Example:

"1986c663-9ee9-4811-bfbf-57d2ad666096"

billingScheduleId
string
required

Billing Schedule ID

Example:

"08a76ddb-230e-4700-a5e2-70f6edaf7d50"

priceIds
string[]
required

Price IDs this discount applies to. If not populated, the discount applies to all prices on the billing schedule

Example:
separateLineItem
boolean
required

Indicates whether the discount should appear as a separate line item in the invoice

Example:

false

amount
number
required

Amount to be reduced

Example:

25

discountCalculationType
enum<string>
required

Indicates whether the discount amount is percentage or nominal

Available options:
PERCENTAGE,
NOMINAL
Example:

"PERCENTAGE"

message
string
required

Message to appear on the Invoice

Example:

"Loyalty Discount"

createdAt
string
required

Created at

Example:

"2022-06-28T16:47:00Z"

updatedAt
string
required

Updated At

Example:

"2022-06-28T16:47:00Z"

seatDiscountType
enum<string>
required

Determines how the discount is applied to any seat-based prices

Available options:
INCLUDED_SEATS_ONLY,
OVERAGE_SEATS_ONLY,
ALL_SEATS
Example:

"ALL_SEATS"

phaseId
string

Phase ID

Example:

"220e1878-b70a-4dfd-9c55-7651424b12d6"

validFrom
string

First Day Discount is Valid

Example:

"2023-01-01"

validTo
string

Last Day Discount is Valid

Example:

"2023-01-31"