Cancel
cancel_itemCancel an item you created. After the business's cancellation window, a confirmed booking is cancelled late where the business records late cancellations (it may count against the customer), and refused where it does not. A confirmed stay answers first with the fee under its policy and what is owed back (confirm): send its fee_sha once your person said yes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | No | The person's key (sdkey1_…), if that is all you have: it is exchanged once for a pass, which comes back in identity.passes — keep the pass and send it next time instead. Never stored. | |
| pass | No | The person's passes (sdpass1_…), space-separated, at most 8: presented to the network that issued each, so the business recognises the customer. Or send them in the Sdi-Pass header. Never stored. | |
| reason | No | ||
| fee_sha | No | A confirmed stay: the fingerprint of the cancellation fee your person saw (details.fee_sha of the 409 confirm_terms a cancel without it gets). | |
| item_id | Yes | ||
| access_token | No | Capability secret returned when the item was created without an account. | |
| idempotency_key | No | Same key + same request = same answer. Required for agents. Make it a fresh random UUID per request: a retry of a create with a random key gets its access token again. |