Discounts
Get a Discount by ID
Get a Discount by ID
GET
/
discounts
/
{id}
Headers
Authorization
string
requiredYour 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
requiredDiscount ID
Response
200 - application/json
id
string
requiredDiscount ID
sequenceAccountId
string
requiredThe Sequence Account to which this Discount belongs
billingScheduleId
string
requiredBilling Schedule ID
phaseId
string
Phase ID
priceIds
string[]
requiredPrice IDs this discount applies to. If not populated, the discount applies to all prices on the billing schedule
separateLineItem
boolean
requiredIndicates whether the discount should appear as a separate line item in the invoice
amount
number
requiredAmount to be reduced
discountCalculationType
enum<string>
requiredIndicates whether the discount amount is percentage or nominal
Available options:
PERCENTAGE
, NOMINAL
message
string
requiredMessage to appear on the Invoice
validFrom
string
First Day Discount is Valid
validTo
string
Last Day Discount is Valid
createdAt
string
requiredCreated at
updatedAt
string
requiredUpdated At