Restricted — requires a sponsorship program. See the
Sponsorship API overview for access and auth.
Request
Safety guards
Because this endpoint cancels seats, two guards protect against a bad payload:- Empty roster →
400 invalid_request. - Mass-cancel threshold. If a run would cancel more than
max_cancel, or (by default) more than 20% of your active seats and more than 10 seats, DSS refuses to apply and returns the diff withthreshold_exceeded: true. Sendoverride_threshold: trueonly once you’ve confirmed the drop is intended.
Response
200 OK.
Each applied cancellation behaves exactly like removing a seat:
the member is downgraded to Free, you receive a prorated credit, and tracking is
paused best-effort.
Recommended usage
Run a nightly reconcile: first withapply: false to review the diff, then with
apply: true once your export looks right. Keep sending your complete active
list every time — the endpoint only ever cancels seats that are missing from it.
