HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Partner discount change / Create

⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v2.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.

Create a future scheduled discount change for a partner with corporate billing enabled. Invalid fields or conditional revert combinations return 422 with API field names. Overlapping periods return 409 with message Another scheduled discount change already covers this period. Disabled corporate billing returns 409. The schedule does not change discounts captured for existing sessions.

Required permission: Partners.update on the visible parent partner. Missing, out-of-scope or wrong-parent identifiers return 404; a visible partner without edit permission returns 403.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Partner ID.

Body Params

Create a scheduled change with a future start. For a limited change, endsAt must be after startsAt and revertDiscount is required. For a permanent change, omit both endsAt and revertDiscount. Optional properties cannot be null. Periods must not overlap; adjacent periods are allowed. A permanent change represents a point in the schedule, not an indefinite occupied period.

number
required
0 to 100

Discount percentage, with at most two decimal places. Must be a JSON number, not a string.

date-time
required

Start timestamp. Requests must use a valid ISO 8601 timestamp with an explicit timezone or offset and minute precision (zero seconds and zero fractional seconds). Values are converted to UTC; responses use UTC.

date-time

End timestamp for a limited change. Requests require an explicit timezone or offset and minute precision (zero seconds and zero fractional seconds). Responses use UTC and may include seconds when ended early. Omitted for permanent changes.

number
0 to 100

Discount percentage to apply when the limited change ends, with at most two decimal places. Must be a JSON number, not a string. Required when creating a limited change; omitted for permanent changes. May be omitted in incomplete historical records.

string
length ≤ 16000

Optional note. Omitted in responses when empty.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json