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.
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.
Request
Call it with a POST to https://api.modulify.ai/v1/cancel_domain_checkout, sending the inputs below as a JSON object. The token needs the domains:buy scope.
It makes changes, so send an Idempotency-Key header whenever you might retry it. A retry with the same key gets the first answer back instead of running again.
curl -X POST https://api.modulify.ai/v1/cancel_domain_checkout \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"workspaceId":"WORKSPACE_ID","orderId":"ORDER_ID"}'Over MCP, the same method is the cancel_domain_checkout tool.
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. |
Response
Every call answers with the JSON envelope of success, message, data, code and version. data holds the result described above, and on a method that returns a total, count carries it. The response headers carry the call's X-Request-Id and what is left of your per-minute budget in X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. Errors explains every status code a call can answer with.