Close a domain checkout link
cancel_domain_checkout
Closes a checkout link that buy_domain or renew_domain opened, so it can no longer be paid.
Scopedomains:buyMakes changes
Nothing was charged, so nothing is refunded. An order that was already paid is refused with paid set to true, and the order goes ahead. A link that was already closed, replaced or expired answers The checkout was closed., and an order that already ended another way answers This order already ended, so there was no checkout to close.
When Stripe cannot be reached, the link stays open and the call is refused with The checkout could not be closed right now. Please try again! Only the workspace owner can close a checkout.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
workspaceId |
string | Yes | The workspace the order belongs to. |
orderId |
string | Yes | The orderId that buy_domain or renew_domain returned. |