close_frame_order
Close an Open frame order so no new invoices may link to it. Returns a preview unless confirm=true is set. Closing is not directly reversible; the order remains in the Closed state.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | No | Set true to perform the action. Omit or false returns a preview only — nothing is written. | |
| frame_order_id | Yes | Id of the frame order to close. | |
| idempotency_key | No | Optional caller-supplied key; retrying with the same key returns the original result instead of acting twice. |