v356

OpenAPI 3.0.3raw.githubusercontent.com2026-08-031733562.1 MB

Discounts

Update a discount

put/discounts/{id}

Path parameters

idstring required

Discount ID

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Request body

billingScheduleIdstring required

Billing Schedule ID

priceIdsstring[] required

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

separateLineItemboolean required

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

amountnumber required

Amount to be reduced

discountCalculationType'PERCENTAGE' | 'NOMINAL' required

messagestring required

Message to appear on the Invoice

validFromstring

First Day Discount is Valid

validTostring

Last Day Discount is Valid

Example request

{
  "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"
}

Response

idstring required

Discount ID

sequenceAccountIdstring required

The Sequence Account to which this Discount belongs

billingScheduleIdstring required

Billing Schedule ID

phaseIdstring

Phase ID

priceIdsstring[] required

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

separateLineItemboolean required

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

amountnumber required

Amount to be reduced

discountCalculationType'PERCENTAGE' | 'NOMINAL' required

messagestring required

Message to appear on the Invoice

validFromstring

First Day Discount is Valid

validTostring

Last Day Discount is Valid

createdAtstring required

Created at

updatedAtstring required

Updated At

seatDiscountType'INCLUDED_SEATS_ONLY' | 'OVERAGE_SEATS_ONLY' | 'ALL_SEATS' required

Example response

{
  "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",
  "seatDiscountType": "ALL_SEATS"
}