PUT
/
discounts
/
{id}
curl --request PUT \
  --url https://eu.sequencehq.com/api/discounts/{id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "billingScheduleId": "08a76ddb-230e-4700-a5e2-70f6edaf7d50",
  "priceIds": [
    "e007e884-5100-4183-8355-4771865cb4d7"
  ],
  "separateLineItem": false,
  "amount": 25,
  "discountCalculationType": "PERCENTAGE",
  "message": "Loyalty Discount",
  "validFrom": "2023-01-01",
  "validTo": "2023-01-31"
}'
{
  "id": "d58bf2e3-7a5d-4900-8457-2521c6880f7d",
  "sequenceAccountId": "1986c663-9ee9-4811-bfbf-57d2ad666096",
  "billingScheduleId": "08a76ddb-230e-4700-a5e2-70f6edaf7d50",
  "phaseId": "220e1878-b70a-4dfd-9c55-7651424b12d6",
  "priceIds": [
    "e007e884-5100-4183-8355-4771865cb4d7"
  ],
  "separateLineItem": false,
  "amount": 25,
  "discountCalculationType": "PERCENTAGE",
  "message": "Loyalty Discount",
  "validFrom": "2023-01-01",
  "validTo": "2023-01-31",
  "createdAt": "2022-06-28T16:47:00Z",
  "updatedAt": "2022-06-28T16:47:00Z"
}

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

Path Parameters

id
string
required

Discount ID

Body

application/json
billingScheduleId
string
required

Billing Schedule ID

priceIds
string[]
required

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

separateLineItem
boolean
required

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

amount
number
required

Amount to be reduced

discountCalculationType
enum<string>
required

Indicates whether the discount amount is percentage or nominal

Available options:
PERCENTAGE,
NOMINAL
message
string
required

Message to appear on the Invoice

validFrom
string

First Day Discount is Valid

validTo
string

Last Day Discount is Valid

Response

200 - application/json
id
string
required

Discount ID

sequenceAccountId
string
required

The Sequence Account to which this Discount belongs

billingScheduleId
string
required

Billing Schedule ID

phaseId
string

Phase ID

priceIds
string[]
required

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

separateLineItem
boolean
required

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

amount
number
required

Amount to be reduced

discountCalculationType
enum<string>
required

Indicates whether the discount amount is percentage or nominal

Available options:
PERCENTAGE,
NOMINAL
message
string
required

Message to appear on the Invoice

validFrom
string

First Day Discount is Valid

validTo
string

Last Day Discount is Valid

createdAt
string
required

Created at

updatedAt
string
required

Updated At