shops.close

Close the shop for good (owner, on a hosted page, typing the shop name). Everyone loses access, agent connections and webhooks stop, every customer link stops working, and the payments account only settles what is in flight. Records are kept. The owner can reopen it with shops.reopen for 90 days; after that photos, notes, templates, the price book and saved cards are deleted, and money, tax, signature and job records stay. Offer shops.export before closing. Refused with the blockers from shops.closeCheck while any remain.

When to use it

Close the shop for good (owner, on a hosted page, typing the shop name). Everyone loses access, agent connections and webhooks stop, every customer link stops working, and the payments account only settles what is in flight.

What to tell the owner

Send the person the link. They finish this step themselves on the page; you never do it for them.

Input

Example

POST https://doingwork.work/v1/shops/close
content-type: application/json
Idempotency-Key: 3f1c...

{
  "shop_id": "00000000-0000-4000-8000-000000000000",
  "confirm_name": "..."
}

Output

{
  "shop_id": "00000000-0000-4000-8000-000000000000",
  "status": "...",
  "memberships_ended": 1,
  "links_ended": 1,
  "warnings": [
    {
      "code": "...",
      "count": 1,
      "message": "..."
    }
  ],
  "reopen_until": "..."
}

Errors