{
  "openapi": "3.0.1",
  "info": {
    "version": "v1",
    "title": "Tuppence API",
    "description": "Payments for developers and AI agents.\n\n**Versioning.** Send `Tuppence-Version: YYYY-MM-DD` to choose the API version a request is answered in; without it you get the version your account was pinned to when it was created (`GET /v1/account` → `api_version`). Every response echoes the version it used in a `Tuppence-Version` header. An unknown version is `400 invalid_api_version`. Additive changes never need a new version; breaking ones always do.",
    "contact": {
      "name": "Tuppence",
      "email": "support@tuppence.ai",
      "url": "https://docs.tuppence.ai"
    }
  },
  "servers": [
    {
      "url": "https://api.tuppence.ai",
      "description": "Test and live mode alike: the key you send decides which."
    }
  ],
  "tags": [
    {
      "name": "Payments",
      "description": "Take a payment: create it, then confirm it with a card."
    },
    {
      "name": "Refunds",
      "description": "Give money back — all of a payment or part of it."
    },
    {
      "name": "Customers",
      "description": "Who pays you, and what each has paid."
    },
    {
      "name": "Saved cards",
      "description": "Cards customers saved for later, off-session charges."
    },
    {
      "name": "Payment links",
      "description": "A URL that takes a payment. No code on the payer's side."
    },
    {
      "name": "Balance",
      "description": "What is held for you, and exactly what it is made of."
    },
    {
      "name": "Payouts",
      "description": "Money to your bank: on a schedule, or when you ask."
    },
    {
      "name": "Disputes",
      "description": "A cardholder's bank takes a payment back; you answer."
    },
    {
      "name": "Credits",
      "description": "Prepaid credit, usage metering and credit tokens."
    },
    {
      "name": "Agents",
      "description": "The AI agents a business runs — each can have cards and rules of its own."
    },
    {
      "name": "Cardholders",
      "description": "Who a business's cards are issued to. Once cards are switched on."
    },
    {
      "name": "Locations",
      "description": "Where your services happen: premises, a mobile service area, or online."
    },
    {
      "name": "Services",
      "description": "What you sell: services with their options, add-ons, resource needs and eligible staff — and a quote for any choice of them."
    },
    {
      "name": "Staff",
      "description": "Who works for you, where and when: staff members, their schedules and exceptions, and their working hours day by day."
    },
    {
      "name": "Resources",
      "description": "The rooms, chairs, baths and vans your services need, with how many units each location has — and whether a span can have them."
    },
    {
      "name": "Packages",
      "description": "Session packages: N visits of a service sold up front — defined, sold, used on bookings, refunded pro rata."
    },
    {
      "name": "Vouchers",
      "description": "Gift vouchers: credit held with you for whoever holds the code — sold, listed, voided."
    },
    {
      "name": "Booking policy",
      "description": "The terms a client accepts when they book — deposit, card on file, cancellation window and fees, notice, approval — versioned, with the words rendered for them."
    },
    {
      "name": "Availability",
      "description": "When a client could book: every start for a service or a visit of several, with whom, at a location."
    },
    {
      "name": "Bookings",
      "description": "Appointments: made from what availability offered, held while a client finishes, confirmed, listed. The slot is protected by the database, whatever two callers do at once."
    },
    {
      "name": "Forms",
      "description": "Consultation, consent and intake forms, and patch tests: their questions, versioned, and the services each is for — before booking, on the day, or optional. And what clients answered, against the version they answered: a clinical form's answers sealed, a signature an image only the business fetches."
    },
    {
      "name": "Imports",
      "description": "Bring a business in from a spreadsheet — services, clients, upcoming bookings, staff, time off: the columns matched, a dry run that says what would happen to every row, the run, and an undo for 24 hours."
    },
    {
      "name": "Reviews",
      "description": "Clients' reviews of their visits: asked for only after a completed booking, written through the link the client is sent — stripped of their details and of swearing — replied to once, and hidden only for abuse (a hidden review's stars still count)."
    },
    {
      "name": "Booking page",
      "description": "The business's public face: its address on the booking origin, look, content, gallery, flow and SEO fields — published when the business says so."
    },
    {
      "name": "Sites",
      "description": "The business site behind the booking page and the store: its address, brand kit, navigation and store settings."
    },
    {
      "name": "Shipping",
      "description": "How the store delivers: shipping profiles of zones and rates, the packages parcels go in, and the delivery services a rate can name."
    },
    {
      "name": "Booking setup",
      "description": "Where a business starts: business-type templates — services at their starting prices, hours, policy, forms, reminders and the page's words — and applying one through the ordinary APIs."
    },
    {
      "name": "Registers",
      "description": "Till points: where a device is paired, what a till there prints, prompts and defaults to — and the tile layouts the tills show."
    },
    {
      "name": "POS devices",
      "description": "The phones, tablets and browsers paired to your registers — listed and revoked here; paired from the device itself with a code."
    },
    {
      "name": "Change sets",
      "description": "Every change to your store, by a person, the assistant, a key or an agent: what each changed, before and after, and its undo — refused when something newer has changed the same thing."
    },
    {
      "name": "Assistant jobs",
      "description": "The assistant's standing jobs for your store (restock, listing quality, the morning brief and the rest): each one's brief, levels and ceilings, schedule, budget as a share of the allowance, runs and what the owner taught it, and the morning briefs they write. Read only: a person changes a job in the dashboard."
    },
    {
      "name": "Products",
      "description": "What the till sells: products with their variants, barcodes, SKUs, options and modifier groups, in categories — sold each, by weight in a unit your locations allow, or at an open price; looked up by a scan, searched by name, repriced in bulk — and the named discounts a till offers."
    },
    {
      "name": "Orders",
      "description": "Sales at the till or through the API: an order made whole, then changed by events in sequence — lines added, changed and voided, its type switched, held, resumed, voided — and priced by the server with the same engine every till runs; a till's figures that disagree are refused with the server's."
    },
    {
      "name": "Shifts",
      "description": "A register's cash session: opened with a float, moved by cash sales and refunds and by hand — pay-ins, pay-outs, drops, tip-outs and no-sales — and closed with a count by denomination: expected against counted, the variance reported and never corrected, and the Z written once. Cash is recorded, never held."
    },
    {
      "name": "Stock",
      "description": "A tracked variant's quantity at each location, moved by every sale (and its void), every return taken back into stock and every adjustment by hand — a level is the sum of its movements, may go below zero (flagged, never blocking a sale), and raises `stock.low` as it crosses its reorder point."
    },
    {
      "name": "Fiscal",
      "description": "The fiscal receipt journal: every receipt a location issues — sales, returns, voids and reprints — numbered with no gaps and chained by SHA-256, closed by day, month and year with grand totals that never decrease, exported as an archive (JSON or CSV) and re-verified from scratch."
    },
    {
      "name": "Printers",
      "description": "A location's receipt and kitchen printers, wired to registers with the cash drawer, and the print queue: a job for a printer that polls Tuppence (Star CloudPRNT, Epson Server Direct Print) waits here, is fetched by the printer, and is printed — or failed after three tries. A till beside a LAN printer prints to it directly."
    },
    {
      "name": "Tax",
      "description": "Tax as your country and region levy it: components (rates in parts per million) and classes (rules by order type) seeded from the country pack and yours to edit, a class's preview for a price, and each location's settings — inclusive or exclusive prices, rounding, cash rounding, registration numbers and its province or state."
    },
    {
      "name": "Cards",
      "description": "Cards with limits you set: virtual cards for your business or your agents, physical cards for people."
    },
    {
      "name": "Card balance",
      "description": "What the cards can spend now, and top-ups: money on its way to it, by bank transfer or from your balance. Each top-up says what it waits on (`delay`) and when it will be spendable (`expected_available_at`)."
    },
    {
      "name": "Card disputes",
      "description": "A purchase on one of YOUR cards you say was wrong — never delivered, not as described, not yours — put to the card network: a draft, its evidence and files, submitted once, then won, lost or expired. (A customer disputing a payment you took is Disputes.)"
    },
    {
      "name": "Approvals",
      "description": "A person's say over a purchase at or over the threshold: asked for, then decided."
    },
    {
      "name": "Spend policies",
      "description": "The rules cards spend under — set on a card, or as an agent's default: limits, merchants, approvals."
    },
    {
      "name": "Subscriptions",
      "description": "Plans a business sells on repeat, and the customers paying for them."
    },
    {
      "name": "Pricing",
      "description": "What we charge — one rate per territory, and whether your traffic is the wrong shape for cards."
    },
    {
      "name": "Cashback",
      "description": "Cashback on all eligible card spend — 0.89% in the UK, 1% in the US — paid monthly."
    },
    {
      "name": "Payment method domains",
      "description": "The domains your own checkout runs on, registered so Apple Pay and Google Pay show in the card fields there."
    },
    {
      "name": "Webhooks",
      "description": "Endpoints we deliver events to, signed."
    },
    {
      "name": "Events",
      "description": "Everything that happened, as it happened."
    },
    {
      "name": "Ticketed events",
      "description": "Tuppence Events: an event with its dates, put on sale with a page of its own. No booking fee: buyers pay the price on the page."
    },
    {
      "name": "Ticket types",
      "description": "What buyers pick on an event's page, with early-bird price phases by date or by number sold."
    },
    {
      "name": "Check-ins",
      "description": "Guests checked in at the door, online or offline at several gates: the guest list a device downloads, and the scans it sends. The first scan of a ticket wins."
    },
    {
      "name": "Ticket orders",
      "description": "What buyers ordered on an event's page: the seats held at the price shown, then paid for in one payment (or free)."
    },
    {
      "name": "Tickets",
      "description": "One admission each, issued once its order is paid."
    },
    {
      "name": "Ticket promo codes",
      "description": "Money off tickets, or a code that opens hidden tickets, typed by the buyer at checkout."
    },
    {
      "name": "Reporting",
      "description": "Reports and monthly statements from the ledger."
    },
    {
      "name": "Account",
      "description": "Your business: settings, onboarding and branding."
    },
    {
      "name": "Sandboxes",
      "description": "A test account with no sign-up, for an agent: solve a small proof of work, get test keys at once, and hand your person a link to claim the business. Test mode only; gone after 30 days unless claimed."
    },
    {
      "name": "Connect",
      "description": "Tuppence Connect: the businesses your platform onboards and runs — each a Tuppence account of its own, which any call acts as with the `Tuppence-Account` header — their onboarding links, bank accounts and capabilities."
    },
    {
      "name": "Persons",
      "description": "Tuppence Connect: the people behind a connected account — names and roles back, never the details given."
    },
    {
      "name": "Files",
      "description": "Tuppence Connect: documents for a connected account's verification, uploaded as the account."
    },
    {
      "name": "Application fees",
      "description": "Tuppence Connect: your fees on your connected accounts' payments, the Connect balance they build, and any you give back."
    },
    {
      "name": "Transfers",
      "description": "Tuppence Connect: money from your Connect balance to your connected accounts, and its reversals."
    },
    {
      "name": "Request logs",
      "description": "Every API request made with your keys."
    },
    {
      "name": "Receipts",
      "description": "Keys that verify receipt tokens (HTTP 402)."
    },
    {
      "name": "Country packs",
      "description": "What differs between countries at the till — tax rates and classes, receipt rules, rounding, conventions — as data, per country and per Canadian province or US state."
    },
    {
      "name": "Test helpers",
      "description": "TEST MODE only: what time, a bank or a cardholder would do."
    }
  ],
  "x-tagGroups": [
    {
      "name": "Payments",
      "tags": [
        "Payments",
        "Refunds",
        "Customers",
        "Saved cards",
        "Payment links",
        "Subscriptions",
        "Credits",
        "Cashback",
        "Payment method domains",
        "Balance",
        "Payouts",
        "Disputes",
        "Pricing"
      ]
    },
    {
      "name": "Store",
      "tags": [
        "Sites",
        "Products",
        "Orders",
        "Shipping",
        "Reviews",
        "Imports",
        "Change sets",
        "Assistant jobs"
      ]
    },
    {
      "name": "Point of sale",
      "tags": [
        "Registers",
        "POS devices",
        "Shifts",
        "Stock",
        "Printers",
        "Fiscal",
        "Tax"
      ]
    },
    {
      "name": "Bookings",
      "tags": [
        "Bookings",
        "Availability",
        "Services",
        "Staff",
        "Locations",
        "Resources",
        "Packages",
        "Vouchers",
        "Forms",
        "Booking policy",
        "Booking page",
        "Booking setup"
      ]
    },
    {
      "name": "Cards and agents",
      "tags": [
        "Cards",
        "Cardholders",
        "Card balance",
        "Card disputes",
        "Spend policies",
        "Approvals",
        "Agents"
      ]
    },
    {
      "name": "Events and tickets",
      "tags": [
        "Ticketed events",
        "Ticket types",
        "Check-ins",
        "Ticket orders",
        "Tickets",
        "Ticket promo codes"
      ]
    },
    {
      "name": "Connect",
      "tags": [
        "Connect",
        "Persons",
        "Application fees",
        "Transfers"
      ]
    },
    {
      "name": "Account and developers",
      "tags": [
        "Account",
        "Sandboxes",
        "Webhooks",
        "Events",
        "Files",
        "Reporting",
        "Request logs",
        "Receipts",
        "Country packs",
        "Test helpers"
      ]
    }
  ],
  "security": [
    {
      "apiKey": []
    }
  ],
  "paths": {
    "/v1/accounting/statement.csv": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "text/csv": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BadRequest"
                }
              }
            },
            "description": "Bad Request"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "description": "Columns: Date (UK `DD/MM/YYYY`, US `MM/DD/YYYY`), Description, Reference, Amount (signed decimal, money in positive), Balance, FITID. One line per day's sales, per day's fees and refunds, and per payout on its arrival date. FITIDs are stable: the same days asked for again give the same ones. `from` and `to` are business dates (`YYYY-MM-DD`, inclusive) in the business's time zone. The default is last month; at most 92 days.",
        "summary": "The Tuppence account as a bank statement, CSV, for any accounting tool to import",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "First business date, `YYYY-MM-DD`, in the business's time zone. Defaults to the first day of last month.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "Last business date, `YYYY-MM-DD`, inclusive; at most 92 days after `from`. Defaults to the last day of last month.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Reporting"
        ],
        "operationId": "downloadAccountingStatementCsv"
      }
    },
    "/v1/accounting/statement.ofx": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/x-ofx": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BadRequest"
                }
              }
            },
            "description": "Bad Request"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "description": "OFX 1.0.2 (SGML). The account is `TUPPENCE-…`; each line is a `STMTTRN` (CREDIT or DEBIT) with a stable FITID, and `LEDGERBAL` is the closing balance. `from` and `to` are business dates (`YYYY-MM-DD`, inclusive) in the business's time zone. The default is last month; at most 92 days.",
        "summary": "The Tuppence account as a bank statement, OFX 1.0.2, for any accounting tool to import",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "First business date, `YYYY-MM-DD`, in the business's time zone. Defaults to the first day of last month.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "Last business date, `YYYY-MM-DD`, inclusive; at most 92 days after `from`. Defaults to the last day of last month.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Reporting"
        ],
        "operationId": "downloadAccountingStatementOfx"
      }
    },
    "/v1/test_helpers/accounting/post": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountingRunModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotFound"
                }
              }
            },
            "description": "Not Found"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE, fake books: plan and post the account's connection now, inline",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersAccountingPost"
      }
    },
    "/v1/locations": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LocationList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List locations, newest first. Every account has at least one: the first is made from your business details. `?status=active|archived`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only locations in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Locations"
        ],
        "operationId": "listLocations"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LocationModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a location — premises, a mobile service area, or an online meeting link",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LocationBody"
              }
            }
          }
        },
        "tags": [
          "Locations"
        ],
        "operationId": "createLocation"
      }
    },
    "/v1/locations/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LocationModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a location",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Locations"
        ],
        "operationId": "retrieveLocation"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LocationModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a location",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LocationBody"
              }
            }
          }
        },
        "tags": [
          "Locations"
        ],
        "operationId": "updateLocation"
      }
    },
    "/v1/locations/{id}/archive": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LocationModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Archive a location: nothing new happens there; what already did keeps it",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Locations"
        ],
        "operationId": "archiveLocation"
      }
    },
    "/v1/locations/{id}/coverage": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CoverageModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Does a mobile location serve an address? `?postcode=` for an outcode area, `?lat=&lng=` for a radius.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "postcode",
            "in": "query",
            "required": false,
            "description": "The client's postcode, for an outcode area.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "lat",
            "in": "query",
            "required": false,
            "description": "The client's latitude, for a radius area.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "lng",
            "in": "query",
            "required": false,
            "description": "The client's longitude, for a radius area.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Locations"
        ],
        "operationId": "checkLocationCoverage"
      }
    },
    "/v1/service_categories": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceCategoryList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List categories, newest first. `?status=active|archived`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only categories in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Services"
        ],
        "operationId": "listServiceCategories"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceCategoryModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a category — a heading your services are grouped under",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ServiceCategoryBody"
              }
            }
          }
        },
        "tags": [
          "Services"
        ],
        "operationId": "createServiceCategory"
      }
    },
    "/v1/service_categories/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceCategoryModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a category",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Services"
        ],
        "operationId": "retrieveServiceCategory"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceCategoryModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a category",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ServiceCategoryBody"
              }
            }
          }
        },
        "tags": [
          "Services"
        ],
        "operationId": "updateServiceCategory"
      }
    },
    "/v1/service_categories/{id}/archive": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceCategoryModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Archive a category: its services keep their `category`; the heading is no longer offered",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Services"
        ],
        "operationId": "archiveServiceCategory"
      }
    },
    "/v1/services": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List services, newest first, each with its options, add-ons, resource needs and staff. `?status=`, `?category=`, `?online_bookable=`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only services in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "category",
            "in": "query",
            "required": false,
            "description": "Only services in this category (`scat_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "online_bookable",
            "in": "query",
            "required": false,
            "description": "`true` or `false`: only services clients can (or cannot) book online.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Services"
        ],
        "operationId": "listServices"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a service — with its options, add-ons, resource needs and eligible staff in one call",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ServiceBody"
              }
            }
          }
        },
        "tags": [
          "Services"
        ],
        "operationId": "createService"
      }
    },
    "/v1/services/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a service",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Services"
        ],
        "operationId": "retrieveService"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a service. Options, add-ons, resources and staff have their own routes.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ServiceBody"
              }
            }
          }
        },
        "tags": [
          "Services"
        ],
        "operationId": "updateService"
      }
    },
    "/v1/services/{id}/archive": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Archive a service: no longer offered; kept, with everything under it, for the bookings that exist",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Services"
        ],
        "operationId": "archiveService"
      }
    },
    "/v1/services/{id}/variants": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceVariantModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Add an option — short / medium / long hair, small / large dog. A service with options requires one to be chosen.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ServiceOptionBody"
              }
            }
          }
        },
        "tags": [
          "Services"
        ],
        "operationId": "createServiceVariant"
      }
    },
    "/v1/services/{id}/variants/{variant}": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceVariantModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update an option, or retire it with `status: archived`",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "variant",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ServiceOptionBody"
              }
            }
          }
        },
        "tags": [
          "Services"
        ],
        "operationId": "updateServiceVariant"
      }
    },
    "/v1/services/{id}/addons": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceAddonModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Add an add-on — an extra a client can tick, with its own minutes and price",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ServiceOptionBody"
              }
            }
          }
        },
        "tags": [
          "Services"
        ],
        "operationId": "createServiceAddon"
      }
    },
    "/v1/services/{id}/addons/{addon}": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceAddonModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update an add-on, or retire it with `status: archived`",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "addon",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ServiceOptionBody"
              }
            }
          }
        },
        "tags": [
          "Services"
        ],
        "operationId": "updateServiceAddon"
      }
    },
    "/v1/services/{id}/resources": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Set what the service needs — `[{kind, count}]` — replacing the previous list",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ServiceResourcesBody"
              }
            }
          }
        },
        "tags": [
          "Services"
        ],
        "operationId": "setServiceResources"
      }
    },
    "/v1/services/{id}/staff": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Set who may perform the service, with their own duration or price — replacing the previous list",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ServiceStaffListBody"
              }
            }
          }
        },
        "tags": [
          "Services"
        ],
        "operationId": "setServiceStaff"
      }
    },
    "/v1/services/{id}/image": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Give the service a picture: PNG or JPEG, re-encoded by Tuppence, served publicly",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ServiceImageBody"
              }
            }
          }
        },
        "tags": [
          "Services"
        ],
        "operationId": "setServiceImage"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Remove the service's picture",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Services"
        ],
        "operationId": "removeServiceImage"
      }
    },
    "/v1/services/{id}/quote": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceQuoteModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Price and time a choice of this service — option, add-ons, staff member, group size — or learn why it cannot be booked so (`variant_required`, `staff_not_eligible`, `service_unavailable`, `client_not_eligible`).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ServiceQuoteBody"
              }
            }
          }
        },
        "tags": [
          "Services"
        ],
        "operationId": "quoteService"
      }
    },
    "/v1/staff": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StaffMemberList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List staff, newest first. `?status=`, `?location=`, `?service=`, `?bookable_online=`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only staff in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Only staff who work at this location (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "service",
            "in": "query",
            "required": false,
            "description": "Only staff who offer this service (`svc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "bookable_online",
            "in": "query",
            "required": false,
            "description": "`true` or `false`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Staff"
        ],
        "operationId": "listStaffMembers"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StaffMemberModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Add a staff member — with where they work and what they do, in one call",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StaffMemberBody"
              }
            }
          }
        },
        "tags": [
          "Staff"
        ],
        "operationId": "createStaffMember"
      }
    },
    "/v1/staff/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StaffMemberModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a staff member",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Staff"
        ],
        "operationId": "retrieveStaffMember"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StaffMemberModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a staff member. Locations and services have their own routes.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StaffMemberBody"
              }
            }
          }
        },
        "tags": [
          "Staff"
        ],
        "operationId": "updateStaffMember"
      }
    },
    "/v1/staff/{id}/archive": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StaffMemberModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A staff member leaves: no more hours, nothing new. Refused while confirmed bookings still need them (`bookings_affected`).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Staff"
        ],
        "operationId": "archiveStaffMember"
      }
    },
    "/v1/staff/{id}/locations": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StaffMemberModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Set where a staff member works — the whole list",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StaffLocationsBody"
              }
            }
          }
        },
        "tags": [
          "Staff"
        ],
        "operationId": "setStaffLocations"
      }
    },
    "/v1/staff/{id}/services": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StaffMemberModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Set what a staff member does, with their own duration or price — the whole list",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StaffServicesBody"
              }
            }
          }
        },
        "tags": [
          "Staff"
        ],
        "operationId": "setStaffServices"
      }
    },
    "/v1/staff/{id}/image": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StaffMemberModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Give a staff member a photo: PNG or JPEG, re-encoded by Tuppence, served publicly",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StaffImageBody"
              }
            }
          }
        },
        "tags": [
          "Staff"
        ],
        "operationId": "setStaffImage"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StaffMemberModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Remove a staff member's photo",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Staff"
        ],
        "operationId": "removeStaffImage"
      }
    },
    "/v1/staff/{id}/schedules": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScheduleList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A staff member's schedules, newest first — every one, ended or not",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Staff"
        ],
        "operationId": "listSchedules"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScheduleModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Give a staff member hours: a weekly pattern or a two-week rotation at a location, from a date. Never overlaps another schedule at that location; refused if a confirmed booking would fall outside (`bookings_affected`).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ScheduleBody"
              }
            }
          }
        },
        "tags": [
          "Staff"
        ],
        "operationId": "createSchedule"
      }
    },
    "/v1/staff/{id}/schedules/{schedule}": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScheduleModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change a schedule's pattern or range — to end it, set `effective_to`. Same refusals as creating one.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "schedule",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ScheduleBody"
              }
            }
          }
        },
        "tags": [
          "Staff"
        ],
        "operationId": "updateSchedule"
      }
    },
    "/v1/staff/{id}/working_hours": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkingHoursModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "When a staff member works, day by day: their schedule less their exceptions, in each location's zone. `?from=&to=` (`YYYY-MM-DD`, up to 62 days).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "`YYYY-MM-DD`, the first day.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "`YYYY-MM-DD`, the last day — at most 62 days after `from`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Staff"
        ],
        "operationId": "getWorkingHours"
      }
    },
    "/v1/schedule_exceptions": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScheduleExceptionList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List exceptions, newest first. `?staff_member=`, `?location=`, `?from=&to=` (`YYYY-MM-DD`).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "staff_member",
            "in": "query",
            "required": false,
            "description": "Only this staff member's (`stf_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Only this location's (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "`YYYY-MM-DD`: only exceptions touching this day or later.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "`YYYY-MM-DD`: only exceptions touching this day or earlier.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Staff"
        ],
        "operationId": "listScheduleExceptions"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScheduleExceptionModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Time off, a break, a block or extra hours for a staff member — or a closure at a location for everyone there. Refused if a confirmed booking would fall inside (`bookings_affected`).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ScheduleExceptionBody"
              }
            }
          }
        },
        "tags": [
          "Staff"
        ],
        "operationId": "createScheduleException"
      }
    },
    "/v1/schedule_exceptions/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScheduleExceptionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve an exception",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Staff"
        ],
        "operationId": "retrieveScheduleException"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScheduleExceptionDeleted"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Remove an exception: the hours come back",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Staff"
        ],
        "operationId": "deleteScheduleException"
      }
    },
    "/v1/time_off_requests": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TimeOffRequestList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List time-off requests, newest first. `?status=` (`pending`, `approved`, `declined`), `?staff_member=`. A staff login sees its own.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "`pending`, `approved` or `declined`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "staff_member",
            "in": "query",
            "required": false,
            "description": "Only this staff member's (`stf_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Staff"
        ],
        "operationId": "listTimeOffRequests"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TimeOffRequestModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Ask for time off — whole days, or from one time to another. A staff login asks for its own. It is on the rota once approved.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TimeOffRequestBody"
              }
            }
          }
        },
        "tags": [
          "Staff"
        ],
        "operationId": "createTimeOffRequest"
      }
    },
    "/v1/time_off_requests/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TimeOffRequestModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a time-off request",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Staff"
        ],
        "operationId": "retrieveTimeOffRequest"
      }
    },
    "/v1/time_off_requests/{id}/approve": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TimeOffRequestModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Approve a pending request: the time goes on the rota as a `time_off` exception. Refused while it would strand bookings (`409 bookings_affected` lists them) — move them, or keep them with `keep_bookings`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApproveTimeOffBody"
              }
            }
          }
        },
        "tags": [
          "Staff"
        ],
        "operationId": "approveTimeOffRequest"
      }
    },
    "/v1/time_off_requests/{id}/decline": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TimeOffRequestModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Decline a pending request, with a note for the person who asked: nothing changes.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DeclineTimeOffBody"
              }
            }
          }
        },
        "tags": [
          "Staff"
        ],
        "operationId": "declineTimeOffRequest"
      }
    },
    "/v1/commission_rules": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CommissionRuleList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List commission rules, newest first — each staff member's history. `?staff_member=`. A staff login sees its own.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "staff_member",
            "in": "query",
            "required": false,
            "description": "Only this staff member's (`stf_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Staff"
        ],
        "operationId": "listCommissionRules"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CommissionRuleModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Set a staff member's commission from a month on: a rate on their service revenue, tiers on the month's revenue, and rates of their own for some services. It takes over from `effective_from` (this month by default); a month that is over keeps its rules.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CommissionRuleBody"
              }
            }
          }
        },
        "tags": [
          "Staff"
        ],
        "operationId": "createCommissionRule"
      }
    },
    "/v1/commission_rules/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CommissionRuleModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a commission rule",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Staff"
        ],
        "operationId": "retrieveCommissionRule"
      }
    },
    "/v1/commission_reports": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CommissionReportModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Commission and tips for a period, by staff member and service: `?period=` a month (`2026-11`, this month by default) or one day (`2026-11-05`). Revenue is the price of the services completed on the period's days, before tips. A staff login's report is its own line.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "period",
            "in": "query",
            "required": false,
            "description": "A month (`2026-11`, this month by default) or one day (`2026-11-05`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Staff"
        ],
        "operationId": "retrieveCommissionReport"
      }
    },
    "/v1/commission_reports/{period}.csv": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "text/csv": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The report as CSV: a line per staff member and service, each one's total, and everyone's (money in the currency's units, `145.00`)",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "period",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Staff"
        ],
        "operationId": "downloadCommissionReportCsv"
      }
    },
    "/v1/commission_reports/{period}.pdf": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The report as a PDF to print",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "period",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Staff"
        ],
        "operationId": "downloadCommissionReportPdf"
      }
    },
    "/v1/resources": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResourceList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List resources, newest first. `?status=`, `?location=`, `?kind=`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only resources in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Only resources at this location (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "kind",
            "in": "query",
            "required": false,
            "description": "Only resources of this kind (`room`, `chair`, …).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Resources"
        ],
        "operationId": "listResources"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResourceModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Add a resource — a room, a chair, a bath, a van — with how many units it has",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ResourceBody"
              }
            }
          }
        },
        "tags": [
          "Resources"
        ],
        "operationId": "createResource"
      }
    },
    "/v1/resources/check": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResourceCheckModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Can a location meet a service's resource needs (or a list of `{kind, count}`) for a span — and with which units? The same allocator the engine uses, against what is still held.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ResourceCheckBody"
              }
            }
          }
        },
        "tags": [
          "Resources"
        ],
        "operationId": "checkResources"
      }
    },
    "/v1/resources/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResourceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a resource",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Resources"
        ],
        "operationId": "retrieveResource"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResourceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a resource",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ResourceBody"
              }
            }
          }
        },
        "tags": [
          "Resources"
        ],
        "operationId": "updateResource"
      }
    },
    "/v1/resources/{id}/archive": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResourceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Archive a resource: no longer bookable. Refused while a future booking still holds a unit of it (`bookings_affected`).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Resources"
        ],
        "operationId": "archiveResource"
      }
    },
    "/v1/booking_policy": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingPolicyModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The booking policy in force: deposit, card on file, cancellation window and fees, notice, approval",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Booking policy"
        ],
        "operationId": "retrieveBookingPolicy"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingPolicyModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change the policy: a new version with these fields over the current one. Bookings already made keep the version they were made under.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BookingPolicyBody"
              }
            }
          }
        },
        "tags": [
          "Booking policy"
        ],
        "operationId": "updateBookingPolicy"
      }
    },
    "/v1/booking_policy/versions": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingPolicyList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Every version of the policy, newest first",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Booking policy"
        ],
        "operationId": "listBookingPolicyVersions"
      }
    },
    "/v1/booking_policy/render": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PolicyRenderModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The policy as a client would read it — for a service (its override merged, its price), a price, or bare — with the mandate a saved card is charged under and the snapshot a booking would keep. `draft` previews unsaved changes.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PolicyRenderBody"
              }
            }
          }
        },
        "tags": [
          "Booking policy"
        ],
        "operationId": "renderBookingPolicy"
      }
    },
    "/v1/booking_setup/checklist": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingChecklistModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What is left of setting bookings up, the checklist Home shows: going live, a first booking of the business's own (not an example or an import), reminders on, someone invited to the team, a calendar that syncs, and clients booking through a second channel — each done or not, in that order, read from what the business already has",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Booking setup"
        ],
        "operationId": "retrieveBookingChecklist"
      }
    },
    "/v1/booking_setup/templates": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingTemplateList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The business-type templates a business can start from — each with its services (at their starting prices), resources, typical hours, policy, forms, reminders and page words, and the MCC, subject kind, JSON-LD type and share channels it suggests",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Booking setup"
        ],
        "operationId": "listBookingTemplates"
      }
    },
    "/v1/booking_setup/apply_template": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingSetupModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Start from a business-type template: its categories, resources, services (priced `from`), forms, hours, policy, page words and reminders, written through their own APIs. It fills in and never overwrites — what the business already has or has changed is kept — so applying twice is applying once. `preview: true` writes nothing and says what would happen; `sections` applies only some parts.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApplyTemplateBody"
              }
            }
          }
        },
        "tags": [
          "Booking setup"
        ],
        "operationId": "applyBookingTemplate"
      }
    },
    "/v1/booking_setup/draft": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingSetupDraftModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Where the business has got to in the setup wizard: the step to resume at and the business type it started from. A business that hasn't started is at step 1.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Booking setup"
        ],
        "operationId": "retrieveBookingSetupDraft"
      },
      "put": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingSetupDraftModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Save where the business has got to in the setup wizard — the step, the business type, or both; what is left out is kept. The wizard's answers themselves go through the ordinary APIs.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SetupDraftBody"
              }
            }
          }
        },
        "tags": [
          "Booking setup"
        ],
        "operationId": "updateBookingSetupDraft"
      }
    },
    "/v1/booking_page": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingPageModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The booking page: its address, look, content, gallery, flow and SEO fields, and whether it is published. Made from the business's name the first time anyone asks.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Booking page"
        ],
        "operationId": "retrieveBookingPage"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingPageModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change the page: a new slug (the old one redirects for 90 days; another business's is 409 slug_taken), the theme, content, gallery order, flow or SEO fields — each a patch over what is there.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BookingPageBody"
              }
            }
          }
        },
        "tags": [
          "Booking page"
        ],
        "operationId": "updateBookingPage"
      }
    },
    "/v1/booking_page/publish": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingPageModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Publish: from now the page answers to everyone at its address. Already published: unchanged.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Booking page"
        ],
        "operationId": "publishBookingPage"
      }
    },
    "/v1/booking_page/unpublish": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingPageModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Unpublish: the public gets 404 from now; the business still sees it with a preview token.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Booking page"
        ],
        "operationId": "unpublishBookingPage"
      }
    },
    "/v1/booking_page/preview_token": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingPagePreviewTokenModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Mint a preview token — shown once, here — that opens the page before it is published (`?preview=`). Minting another retires the last.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Booking page"
        ],
        "operationId": "createBookingPagePreviewToken"
      }
    },
    "/v1/booking_page/gallery": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingPageModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Add a picture to the gallery: re-encoded (nothing but pixels is kept), stored, shown last. At most 20 — reorder or drop with `gallery` on POST /v1/booking_page.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PageImageBody"
              }
            }
          }
        },
        "tags": [
          "Booking page"
        ],
        "operationId": "addBookingPageGalleryImage"
      }
    },
    "/v1/booking_page/cover": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingPageModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Set the cover picture: re-encoded and stored. Remove it with `theme: {cover_image: null}`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PageImageBody"
              }
            }
          }
        },
        "tags": [
          "Booking page"
        ],
        "operationId": "setBookingPageCover"
      }
    },
    "/v1/booking_page/custom_domain": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingPageModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Use the business's own domain (24-09) — a subdomain such as `book.yoursalon.co.uk`. The page answers with the records to add (a CNAME to us, a TXT that proves it is theirs); once both are seen and the certificate is out, the domain is the page's address and the old one redirects to it. `409 domain_taken` when another page has it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CustomDomainBody"
              }
            }
          }
        },
        "tags": [
          "Booking page"
        ],
        "operationId": "setBookingPageCustomDomain"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingPageModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Stop using the business's own domain: the booking origin's address is the page again, at once.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Booking page"
        ],
        "operationId": "removeBookingPageCustomDomain"
      }
    },
    "/v1/booking_page/custom_domain/check": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingPageModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Look for the domain's records now rather than at the next check (every ten minutes): `pending` → `verified` once the TXT record is seen, → `active` once the certificate is out.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Booking page"
        ],
        "operationId": "checkBookingPageCustomDomain"
      }
    },
    "/v1/booking_page/short_links": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingShortLinkList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The page's short links, newest first, with how often each has been visited.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Booking page"
        ],
        "operationId": "listBookingPageShortLinks"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingShortLinkModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The short link to the page — or to its flow with a service or a person chosen — carrying `ch` (`qr` by default). The same target always gives the same code, so a printed one never goes stale.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShortLinkBody"
              }
            }
          }
        },
        "tags": [
          "Booking page"
        ],
        "operationId": "createBookingPageShortLink"
      }
    },
    "/v1/sites": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The business's site, as a list of one. Made from the booking page the first time anyone asks.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "listSites"
      }
    },
    "/v1/sites/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The site: its address, brand kit, navigation, SEO fields, home and store settings.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "retrieveSite"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change the site's name, brand kit, navigation, SEO fields, store settings, home or headless origins — each a patch over what is there. Sends `store.site_updated`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SiteBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "updateSite"
      }
    },
    "/v1/sites/{id}/resume_checkouts": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Resume the store's checkouts after we paused them (85-12): shoppers can check out and pay again. Look at the declined payments first. Some pauses only Tuppence can lift: those answer `403 permission_denied` and say to contact us.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "resumeSiteCheckouts"
      }
    },
    "/v1/sites/{id}/slug": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A new address for the site and its booking page: the old one redirects for 90 days, and nobody else may take it meanwhile. Another business's slug is `409 slug_taken`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SiteSlugBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "changeSiteSlug"
      }
    },
    "/v1/sites/{id}/domains": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteDomainList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The site's own domains, newest first, each with its status and the DNS records it still needs.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "listSiteDomains"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteDomainModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "description": "This call's own: `domain_taken` (the hostname is already another site's or booking page's). Any other code is one every call can answer (`Conflict`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Use the business's own domain — a subdomain such as `shop.yoursalon.co.uk`, or the domain itself where its DNS host flattens a CNAME to us — replacing the one there was. The answer has the records to add (a CNAME to us, a TXT that proves it is yours); once both are seen and the certificate is out it is `active` and the site's address. The domain itself comes with `www.` as a `redirect` domain (its own records), and a `www.` domain with the domain itself where it flattens, else with `forwarding` instructions for the registrar. `400` for a domain itself that doesn't flatten, with the instructions. `409 domain_taken` when another business has it. Sends `store.domain_requested`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SiteDomainBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "addSiteDomain"
      }
    },
    "/v1/sites/{id}/domains/{domain}/check": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteDomainModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Look for the domain's records now rather than at the next check (every ten minutes): `pending` → `verified` once the TXT record is seen, → `active` once the certificate is out.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "domain",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "checkSiteDomain"
      }
    },
    "/v1/sites/{id}/domains/{domain}": {
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteDomainModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Stop using the domain: the booking origin's address is the site's again, at once. Sends `store.domain_removed`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "domain",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "removeSiteDomain"
      }
    },
    "/v1/sites/{id}/translations": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteTranslationList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List a site's translations in one language, each draft, approved or stale, beside its English now. Without `locale`, only the languages.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "locale",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "listSiteTranslations"
      }
    },
    "/v1/sites/{id}/translations/draft": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteTranslationResult"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Draft the site's products in a language, in the brand voice: every text with no translation of its current English. Approved ones that still match are kept.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SiteTranslationLanguageBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "draftSiteTranslations"
      }
    },
    "/v1/test_helpers/sites/{id}/domains/{domain}/simulate/{step}": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteDomainModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE, local and test suites only: the world outside moves a site's own domain on: `add_records` (its CNAME and TXT appear at the fake DNS) or `issue_certificate` (the fake edge issues its certificate). The domain moves on at its next check.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "domain",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "step",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Test helpers"
        ],
        "operationId": "simulateSiteDomainStep"
      }
    },
    "/v1/sites/{id}/fonts": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteFontsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The site's own fonts, and the families its headings and body text render in.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "listSiteFonts"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteFontsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Adds a font: a Google Font, downloaded once and served from your store (no request to Google from your shoppers), or a WOFF2 you upload after confirming your web licence. At most two families and four styles.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SiteFontBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "addSiteFont"
      }
    },
    "/v1/sites/{id}/fonts/{family}": {
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteFontsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Takes a font off the site; the brand kit's pair renders in its place.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "family",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "removeSiteFont"
      }
    },
    "/v1/sites/{id}/design_runs": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DesignRunModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Ask the design agent for a change to how the store looks. It writes the change in the least powerful layer that does it, checks it, and proposes it for approval; nothing changes until a person approves. With `Accept: text/event-stream`, the editor watches a section being written (`preview` events), then gets the run (`run`).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DesignRunBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "createDesignRun"
      }
    },
    "/v1/sites/{id}/design_runs/{run}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DesignRunModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A design run: what it made, its checks, its cost and its change set.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "run",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "retrieveDesignRun"
      }
    },
    "/v1/sites/{id}/sections": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteSectionList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The site's custom sections, newest first, each with its current version and the draft pages that use it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "listSiteSections"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteSectionWriteModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A new custom section from TSF source written by hand, through the same checks as the agent's.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SourceBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "createSiteSection"
      }
    },
    "/v1/sites/{id}/sections/{section}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteSectionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A custom section with every version, newest first, and the draft pages that use it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "section",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "retrieveSiteSection"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteSectionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Rename a custom section. Its versions and the pages using it are unchanged.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "section",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RenameSectionBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "renameSiteSection"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteSectionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Take a custom section out of the library and off every draft page that uses it (`used_on`). The live site keeps it until the next publish.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "section",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "deleteSiteSection"
      }
    },
    "/v1/sites/{id}/section_versions/{version}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteSectionVersionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "One version of a custom section: its source, for comparing or restoring.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "version",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "retrieveSiteSectionVersion"
      }
    },
    "/v1/sites/{id}/sections/{section}/duplicate": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteSectionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A new custom section from this one's current source, named as a copy.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "section",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "duplicateSiteSection"
      }
    },
    "/v1/sites/{id}/sections/{section}/restore": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteSectionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Bring back an earlier version: its source becomes the section's next version. Pages keep the version they place until it is placed again.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "section",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RestoreSectionBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "restoreSiteSection"
      }
    },
    "/v1/sites/{id}/code_sections": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteCodeSectionList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The site's code sections, newest first (at most 100).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "listSiteCodeSections"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteCodeSectionModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A new code section: a document run in a sealed frame below the fold, with a fallback section in its place. Only with code sections on for the site (S25); the code is at most 60,000 bytes compressed.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateCodeSectionBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "createSiteCodeSection"
      }
    },
    "/v1/sites/{id}/code_sections/{code}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteCodeSectionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "One code section, with its code and its fallback.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "code",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "retrieveSiteCodeSection"
      }
    },
    "/v1/sites/{id}/section_checks": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SectionCheckModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Run a custom section's checks on TSF source without keeping it: what the code tab shows.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SourceBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "checkSiteSection"
      }
    },
    "/v1/sites/{id}/sections/{section}/versions": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteSectionWriteModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A custom section's next version from TSF source edited by hand; it becomes the current one. Pages keep the version they place until it is placed again.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "section",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SourceBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "editSiteSection"
      }
    },
    "/v1/sites/{id}/design": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteDesignFileModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The site's design as a file: the look, its custom and code sections' source, and its draft pages' layouts.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "exportSiteDesign"
      }
    },
    "/v1/sites/{id}/design/import": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteDesignImportModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A design file into this site's draft, every section through the same checks. Nothing is published; what can't come in is listed with why.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ImportBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "importSiteDesign"
      }
    },
    "/v1/store/changes": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreChangeModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Propose a change to the store from a sentence. Answers the proposed change set, with a card for every change, or an error card for an operation that can't be done (and then no change set). Nothing changes until a person approves it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreChangeBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "proposeStoreChange"
      }
    },
    "/v1/sites/{id}/pages": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SitePageList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The site's draft pages, newest first. What the public sees is the live version.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "listSitePages"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SitePageModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "description": "This call's own: `slug_taken` (another page on the site already has this address). Any other code is one every call can answer (`Conflict`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Add a draft page: home, a template, or a `page` with a slug. An address the store uses (`/cart`) is refused. Nothing changes for the public until a publish.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SitePageBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "createSitePage"
      }
    },
    "/v1/sites/{id}/pages/{page}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SitePageModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A draft page, with its blocks.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "page",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "retrieveSitePage"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SitePageModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "description": "This call's own: `slug_taken` (another page on the site already has this address). Any other code is one every call can answer (`Conflict`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change a draft page's slug, path, title, blocks or SEO fields. The live site is unchanged until the next publish.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "page",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SitePageBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "updateSitePage"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SitePageModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Take a page off the draft (archived): the next publish leaves it out and its address is free. Earlier versions keep it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "page",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "archiveSitePage"
      }
    },
    "/v1/sites/{id}/publish": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteVersionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "description": "This call's own: `invalid_state` (that version is already published, or the draft changed since the preview it names). Any other code is one every call can answer (`Conflict`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Publish the draft: every block checked, every sentence checked against your facts, then frozen as the next version and live. A page that can't publish is named, with its block. Sends `store.site_published`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SitePublishBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "publishSite"
      }
    },
    "/v1/sites/{id}/schedule": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteVersionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "description": "This call's own: `invalid_state` (that version is already published, or the draft changed since the preview it names). Any other code is one every call can answer (`Conflict`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Publish the draft as it is now at a later time (`at`, unix seconds). Checked and frozen now; replaces any earlier schedule. Sends `store.site_scheduled`, then `store.site_published` at the time.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SiteScheduleBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "scheduleSitePublish"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Cancel the scheduled publish. The version it froze stays in the list, never live.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "cancelSiteSchedule"
      }
    },
    "/v1/sites/{id}/versions": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteVersionList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The site's versions, newest first, with which is live and which is scheduled.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "listSiteVersions"
      }
    },
    "/v1/sites/{id}/versions/{version}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteVersionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A version by id or number, with its snapshot: brand, navigation, every page and the route table.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "version",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "retrieveSiteVersion"
      }
    },
    "/v1/sites/{id}/versions/{version}/revert": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteVersionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "description": "This call's own: `invalid_state` (that version was never published, or it is the live one already). Any other code is one every call can answer (`Conflict`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Make an earlier version live again, exactly as it was (by id or number). The draft pages are not changed. Sends `store.site_reverted`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "version",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "revertSiteVersion"
      }
    },
    "/v1/sites/{id}/preview_token": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SitePreviewTokenModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Mint a preview token, shown once, here, that opens the draft before it is published (`?preview=`). Minting another retires the last.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "createSitePreviewToken"
      }
    },
    "/v1/sites/{id}/not_found": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteNotFoundList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Paths the store had no page for, asked for three or more times in a day in the last 30 days, most asked first, each with a suggested target. Only the path and counts: nothing about who asked.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "listSiteNotFound"
      }
    },
    "/v1/sites/{id}/redirects": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteRedirectList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The site's redirects, newest first, each with how often the storefront answered it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "listSiteRedirects"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteRedirectModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Redirect an old path (301). A path that already redirects is moved; a chain is flattened to one hop; a loop is refused.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SiteRedirectBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "createSiteRedirect"
      }
    },
    "/v1/sites/{id}/redirects/{redirect}": {
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteRedirectModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Remove a redirect: the old path answers 404 again.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "redirect",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "deleteSiteRedirect"
      }
    },
    "/v1/sites/{id}/domain_switch": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DomainSwitchModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotFound"
                }
              }
            },
            "description": "Not Found"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The site's newest domain switch: its plan, the TXT records to add, its state and probes.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "retrieveDomainSwitch"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DomainSwitchModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Start moving the old store's domain here: read its records on two public resolvers, plan the one record to change (the email records are always kept) and ask for its certificate by TXT pre-validation, while the old store keeps serving. A switch already on its way for the same host is returned as it is. Refused in test mode, because it moves your real domain.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DomainSwitchBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "startDomainSwitch"
      }
    },
    "/v1/sites/{id}/domain_switch/check": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DomainSwitchModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Check the switch now rather than at the next minute: the certificate, both resolvers and the probes of the old addresses.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "checkDomainSwitch"
      }
    },
    "/v1/sites/{id}/domain_switch/switch": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DomainSwitchModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Say you are changing the record: the site serves the domain from now, so the change lands on a store that already works. `409` until the certificate is active, and for a store on the domain itself whose DNS host can't point it here.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "beginDomainSwitch"
      }
    },
    "/v1/sites/{id}/domain_switch/roll_back": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DomainSwitchModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Put it back: the switch ends, and `records` has the values to restore at your DNS host.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "rollBackDomainSwitch"
      }
    },
    "/v1/sites/{id}/render_context": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteRenderContextModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What these blocks render with on the store: the brand kit, the site's details, and the online products, pictures and pages they name, as the storefront shows them. Changes nothing.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SiteRenderContextBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "retrieveSiteRenderContext"
      }
    },
    "/v1/availability": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AvailabilityModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "When a client could book: `?service=` (`&variant=`, `&addons[]=`) or `?items[]=svc_a,svc_b:svar_x` for a visit of several — each with its own add-ons after another colon, `svc_c:svar_y:sadd_z` or `svc_c::sadd_z` — at `?location=`, from `?from=` to `?to=` (`YYYY-MM-DD`, up to 62 days), for `?staff_member=` or anyone.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "service",
            "in": "query",
            "required": false,
            "description": "The service (`svc_…`); with `variant` when it has options.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "variant",
            "in": "query",
            "required": false,
            "description": "The option (`svar_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "addons[]",
            "in": "query",
            "required": false,
            "description": "Add-ons (`sadd_…`), for a single service.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "items[]",
            "in": "query",
            "required": false,
            "description": "A visit of several: `svc_a,svc_b:svar_x`, in order — up to five.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "staff_member",
            "in": "query",
            "required": false,
            "description": "Only this person (`stf_…`); omit for anyone.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Where (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "`YYYY-MM-DD`, the first day.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "`YYYY-MM-DD`, the last day — at most 62 days after `from`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "group_size",
            "in": "query",
            "required": false,
            "description": "People or seats. Default 1.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Availability"
        ],
        "operationId": "getAvailability"
      }
    },
    "/v1/availability/next": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AvailabilitySlotModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotFound"
                }
              }
            },
            "description": "Not Found"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The first start a client could book, on or after `?from=` (today by default), within the policy's advance window",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "service",
            "in": "query",
            "required": false,
            "description": "The service (`svc_…`); with `variant` when it has options.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "variant",
            "in": "query",
            "required": false,
            "description": "The option (`svar_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "items[]",
            "in": "query",
            "required": false,
            "description": "A visit of several: `svc_a,svc_b:svar_x`, in order.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "staff_member",
            "in": "query",
            "required": false,
            "description": "Only this person (`stf_…`); omit for anyone.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Where (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "`YYYY-MM-DD`; today by default.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Availability"
        ],
        "operationId": "getNextAvailability"
      }
    },
    "/v1/bookings": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List bookings, newest first. `?from=&to=` (the location's calendar days), `?status=`, `?staff_member=`, `?service=`, `?customer=`, `?source=`, `?channel=` (where the client came from: `instagram`, `qr`…, `other`; `none` for the bookings from no channel), `?payment_status=`, `?fee_status=` (a late-cancellation or no-show fee's state: `due`, `pending_authentication`, `charged`, `failed`, `waived`, `refunded`), `?location=`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "`YYYY-MM-DD`, the first calendar day at the location.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "`YYYY-MM-DD`, the last.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "held · pending_approval · confirmed · arrived · in_progress · completed · cancelled · no_show · declined · expired",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "staff_member",
            "in": "query",
            "required": false,
            "description": "Visits with an item for this person (`stf_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "service",
            "in": "query",
            "required": false,
            "description": "Visits with this service (`svc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "customer",
            "in": "query",
            "required": false,
            "description": "This client's (`cus_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "source",
            "in": "query",
            "required": false,
            "description": "online · widget · dashboard · app · api · agent · walk_in · import · google · instagram · facebook · apple",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "channel",
            "in": "query",
            "required": false,
            "description": "Where the client came from: a channel's code (`instagram`, `qr`, `link`…) or `other`; `none` for the bookings from no channel.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "payment_status",
            "in": "query",
            "required": false,
            "description": "unpaid · deposit_paid · paid · partially_refunded · refunded · fee_charged",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fee_status",
            "in": "query",
            "required": false,
            "description": "A late-cancellation or no-show fee's state: due · pending_authentication · charged · failed · waived · refunded",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "At this location (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "listBookings"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Book a visit: the services, who (or anyone), when, and who for. Confirmed at once, or a request when the policy says approval first. `409 slot_unavailable` names other starts.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateBookingBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "createBooking"
      }
    },
    "/v1/bookings/holds": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Hold a slot for the policy's `hold_minutes` (ten by default) while the client finishes — no client needed yet. Confirm it, extend it, or release it; a lapsed hold gives the slot back on its own.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BookingHoldBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "createBookingHold"
      }
    },
    "/v1/bookings/holds/{id}/extend": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Keep a hold for another `hold_minutes` from now.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "extendBookingHold"
      }
    },
    "/v1/bookings/holds/{id}/release": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Give a held slot back now.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "releaseBookingHold"
      }
    },
    "/v1/bookings/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotFound"
                }
              }
            },
            "description": "Not Found"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a booking.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "getBooking"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotFound"
                }
              }
            },
            "description": "Not Found"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change a booking's notes or metadata. When, and with whom, are `reschedule`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateBookingBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "updateBooking"
      }
    },
    "/v1/bookings/{id}/reschedule": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Move a confirmed booking (or a pending request) to another start: checked against availability and taken in one transaction, the snapshot and prices kept. `409 slot_unavailable` names other starts; `409 policy_window_closed` when a client is inside the policy's window.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RescheduleBookingBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "rescheduleBooking"
      }
    },
    "/v1/bookings/{id}/cancellation": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CancellationPreviewModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What cancelling the booking now would come to, before anyone confirms it: `?by=client` (the policy's outcome) or `business` (the default — everything back). What comes back, what is kept, and the late fee left to charge once what was paid counts towards it. Nothing changes.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "by",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "previewBookingCancellation"
      }
    },
    "/v1/bookings/{id}/cancel": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Cancel a confirmed or arrived booking. `by: client` computes the policy's outcome (a late fee inside the window, what was paid counting towards it; the deposit kept or returned); the business owes nothing and returns everything. What comes back is refunded once the cancellation is made — `cancellation.refunded` says when.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CancelBookingBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "cancelBooking"
      }
    },
    "/v1/bookings/{id}/check_in": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The client is here: confirmed → arrived.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "checkInBooking"
      }
    },
    "/v1/bookings/{id}/start": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The service has begun: arrived → in_progress.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "startBooking"
      }
    },
    "/v1/bookings/{id}/complete": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Done: in_progress → completed. A booking marked a no-show within the last day can be completed too — they did turn up — and no fee is due.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "completeBooking"
      }
    },
    "/v1/bookings/{id}/no_show": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The client did not come (after the start): confirmed or arrived → no_show. The slot is freed and the policy's no-show fee is due (M25 charges it).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "noShowBooking"
      }
    },
    "/v1/bookings/{id}/approve": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Say yes to a request: pending_approval → confirmed.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "approveBooking"
      }
    },
    "/v1/bookings/{id}/decline": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Say no to a request: pending_approval → declined; the slot is free again.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DeclineBookingBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "declineBooking"
      }
    },
    "/v1/bookings/{id}/confirm": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Turn a live hold into the booking: who it is for (a customer id, or their details), their notes. `409 hold_expired` once the hold has lapsed.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ConfirmBookingBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "confirmBooking"
      }
    },
    "/v1/bookings/{id}/timeline": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingTimelineModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A booking's history, oldest first: how it was made, every message it sent or will send with its state, each move and step of the visit, and the money — payments, refunds and money recorded at the desk. Messages still planned come last, at when they will go.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "getBookingTimeline"
      }
    },
    "/v1/bookings/{id}/payments": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Take money for a booking: a payment for its deposit, its balance (with a tip), the whole price, a tip alone, or the late-cancellation or no-show fee that is due. Nothing is charged until a card is presented (confirm).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateBookingPaymentBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "createBookingPayment"
      }
    },
    "/v1/bookings/{id}/charge_fee": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Charge the booking's late-cancellation or no-show fee to the card the client kept under its policy, with nobody there — once, within 14 days of the appointment, never more than the policy's. Always returns the payment: check `status`. `authentication_required` means the client was emailed a link to confirm it; a refusal leaves the fee `failed`, with the bank's reason.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ChargeFeeBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "chargeBookingFee"
      }
    },
    "/v1/bookings/{id}/waive_fee": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Let the booking's fee go: who and why are kept, and `booking.fee_waived` is sent. A waived fee can still be charged within 14 days of the appointment; one the client is being asked to confirm is canceled first.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WaiveFeeBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "waiveBookingFee"
      }
    },
    "/v1/bookings/{id}/money": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingMoneyModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The booking's money, as its rail shows it: what is paid towards the price — through Tuppence or recorded at the desk — what is left, the tips, what was given back, and the card the client kept on file under its policy.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "retrieveBookingMoney"
      }
    },
    "/v1/bookings/{id}/payment_link": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingPaymentLinkModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A link the client pays what is left of the booking with — or `amount` of it: a `balance` payment, its secret in the link's fragment (shown once). Once money moves, a link that would take more than is left is canceled. `409 nothing_due` when the booking is paid.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PaymentLinkBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "createBookingPaymentLink"
      }
    },
    "/v1/bookings/{id}/payment_records": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingPaymentRecordList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The money recorded against the booking, newest first — voided records too, marked.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "listBookingPaymentRecords"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingPaymentRecordModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Record money taken for the booking outside Tuppence — cash, another terminal, a bank transfer — so its money adds up: it counts towards `amount_due` like a payment, with no money through us. Never more than is left to pay, a tip aside.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PaymentRecordBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "recordBookingPayment"
      }
    },
    "/v1/bookings/{id}/payment_records/{record}/void": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingPaymentRecordModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Take back a record made by mistake: it is kept, voided — who, when, why — and the booking's money is worked out without it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "record",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VoidRecordBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "voidBookingPaymentRecord"
      }
    },
    "/v1/packages": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PackageList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Packages, newest first",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "active",
                "archived"
              ]
            }
          },
          {
            "in": "query",
            "name": "service",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Packages"
        ],
        "operationId": "listPackages"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PackageModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Define a session package: N visits of a service for one price, good for a year unless you say otherwise.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreatePackageBody"
              }
            }
          }
        },
        "tags": [
          "Packages"
        ],
        "operationId": "createPackage"
      }
    },
    "/v1/packages/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PackageModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A package",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Packages"
        ],
        "operationId": "retrievePackage"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PackageModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Rename a package, or offer it on the booking page (or take it off).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdatePackageBody"
              }
            }
          }
        },
        "tags": [
          "Packages"
        ],
        "operationId": "updatePackage"
      }
    },
    "/v1/packages/{id}/archive": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PackageModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Stop selling a package. What clients bought still serves them.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Packages"
        ],
        "operationId": "archivePackage"
      }
    },
    "/v1/package_balances": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PackageBalanceList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Clients' packages, newest first",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "query",
            "name": "customer",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "package",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "pending",
                "active",
                "used_up",
                "refunded",
                "expired"
              ]
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Packages"
        ],
        "operationId": "listPackageBalances"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PackageBalanceModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Sell a package to a customer: creates the payment that buys it (its `approval_url`). The sessions are theirs when it succeeds.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SellPackageBody"
              }
            }
          }
        },
        "tags": [
          "Packages"
        ],
        "operationId": "sellPackage"
      }
    },
    "/v1/package_balances/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PackageBalanceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A client's package: what is left, what is held for visits not yet final",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Packages"
        ],
        "operationId": "retrievePackageBalance"
      }
    },
    "/v1/package_balances/{id}/refund": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PackageBalanceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Refund the unused sessions, pro rata, to the payment that bought the package. Sessions held for visits not yet final settle first.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Packages"
        ],
        "operationId": "refundPackageBalance"
      }
    },
    "/v1/bookings/{id}/package": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingMoneyModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Give a session of the client's package for this booking: held for the visit, counted as paid now, used once the visit is final. Answers the booking's money.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApplyPackageBody"
              }
            }
          }
        },
        "tags": [
          "Packages"
        ],
        "operationId": "applyBookingPackage"
      }
    },
    "/v1/bookings/{id}/membership": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingMoneyModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Give a visit of the client's membership for this booking: held for the visit, counted as paid now, used once the visit is final. Answers the booking's money.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApplyMembershipBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "applyBookingMembership"
      }
    },
    "/v1/messaging_settings": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MessagingSettingsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "How the business messages its clients: reminders, the sender, what is off, quiet hours, caps.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "retrieveMessagingSettings"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MessagingSettingsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change the messaging settings. Bookings made from now on are planned with them.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateMessagingSettingsBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "updateMessagingSettings"
      }
    },
    "/v1/bookings/{id}/messages": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingMessageList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A booking's messages, oldest first: planned, sent, cancelled or skipped, each with its channel and moment.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "listBookingMessages"
      }
    },
    "/v1/messaging_messages": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingMessageList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Every booking's messages, newest first, with the channel, the state and the cost. `?month=YYYY-MM` narrows to a month (the moment a message went, or is for); `?channel=`, `?status=`, `?booking=`, `?customer=` (a client's, across their bookings) and `?template=` narrow further.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "month",
            "in": "query",
            "required": false,
            "description": "Only this month's (`YYYY-MM`): the moment a message went, or is for.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "channel",
            "in": "query",
            "required": false,
            "description": "Only this channel's: `email`, `sms` or `whatsapp`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only messages in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "booking",
            "in": "query",
            "required": false,
            "description": "Only this booking's (`bk_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "customer",
            "in": "query",
            "required": false,
            "description": "Only this client's, across their bookings (`cus_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "template",
            "in": "query",
            "required": false,
            "description": "Only this message, e.g. `booking.reminder`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "listMessagingMessages"
      }
    },
    "/v1/messaging_usage": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MessagingUsageModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What the month's messages cost, per channel: the sum of every sent message's `cost_minor`, which the monthly statement's messaging line repeats. `?month=YYYY-MM`; this month by default.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "query",
            "name": "month",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "retrieveMessagingUsage"
      }
    },
    "/v1/marketing_settings": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MarketingSettingsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "How the business markets to its clients: the month's cap, and whether texts go too.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "retrieveMarketingSettings"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MarketingSettingsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change the marketing settings. Messages not yet sent are held to them.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateMarketingSettingsBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "updateMarketingSettings"
      }
    },
    "/v1/marketing_campaigns": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MarketingCampaignList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The business's campaigns, newest first: drafts, and those sent, with how many they reached.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "listMarketingCampaigns"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MarketingCampaignModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Write a campaign, or a last-minute slot: its words, who it is for and its cap. A draft until it is sent.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateMarketingCampaignBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "createMarketingCampaign"
      }
    },
    "/v1/marketing_campaigns/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MarketingCampaignModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotFound"
                }
              }
            },
            "description": "Not Found"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "One campaign.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "retrieveMarketingCampaign"
      }
    },
    "/v1/marketing_campaigns/{id}/preview": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MarketingCampaignPreviewModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotFound"
                }
              }
            },
            "description": "Not Found"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Who it would reach now — clients who said yes and match, how many under its cap, a few first names — and what it says.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "previewMarketingCampaign"
      }
    },
    "/v1/marketing_campaigns/{id}/send": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MarketingCampaignModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotFound"
                }
              }
            },
            "description": "Not Found"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Send it: one message to each client it reaches, under its cap. Once — `409 invalid_state` after.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "sendMarketingCampaign"
      }
    },
    "/v1/vouchers": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VoucherList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Vouchers, newest first",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "pending",
                "active",
                "void",
                "expired"
              ]
            }
          },
          {
            "in": "query",
            "name": "customer",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Vouchers"
        ],
        "operationId": "listVouchers"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VoucherModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Sell a gift voucher: creates the payment that buys it (its `approval_url`). The voucher is live — its code emailed to the recipient — when that payment succeeds.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateVoucherBody"
              }
            }
          }
        },
        "tags": [
          "Vouchers"
        ],
        "operationId": "createVoucher"
      }
    },
    "/v1/vouchers/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VoucherModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A voucher: its state and what is left on it (never its code)",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Vouchers"
        ],
        "operationId": "retrieveVoucher"
      }
    },
    "/v1/vouchers/{id}/code": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VoucherCodeModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: a voucher's code, as emailed to its recipient",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Vouchers"
        ],
        "operationId": "revealVoucherCode"
      }
    },
    "/v1/vouchers/{id}/void": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VoucherModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Cancel a voucher: what is unused is refunded to the payment that bought it, and the code stops working. Only an active one.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Vouchers"
        ],
        "operationId": "voidVoucher"
      }
    },
    "/v1/bookings/{id}/voucher": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingMoneyModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Give a gift voucher for what is left of a booking (or `amount` of it): a hold on the voucher, counted as paid now, used once the visit is final. Answers the booking's money.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DeskVoucherBody"
              }
            }
          }
        },
        "tags": [
          "Vouchers"
        ],
        "operationId": "applyBookingVoucher"
      }
    },
    "/v1/calendar": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CalendarModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Everything the calendar grid needs for a window, in one answer: the bookings and holds with their items and client, each staff member's working spans per day, blocked time and time off, class sessions, the location's hours. `?location=` (required), `?from=&to=` (the location's days, at most 31; this week by default), `?staff=` (one or more `stf_…`, comma-separated or repeated) for a column. Carries an `ETag`; `If-None-Match` gets `304`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "retrieveCalendar"
      }
    },
    "/v1/class_sessions": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClassSessionList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List class sessions, newest first. `?from=&to=` (`YYYY-MM-DD`, in the location's zone when `?location=` is given), `?service=`, `?staff_member=`, `?status=`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "`YYYY-MM-DD`, the first day (in the location's zone with `location`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "`YYYY-MM-DD`, the last.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "service",
            "in": "query",
            "required": false,
            "description": "This class (`svc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "staff_member",
            "in": "query",
            "required": false,
            "description": "This teacher (`stf_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "At this location (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "scheduled · cancelled · completed",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "listClassSessions"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClassSessionModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Schedule a class: the service, the teacher, where and when, the seats. The teacher's time is taken; `409 slot_unavailable` when they are not free.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ClassSessionBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "createClassSession"
      }
    },
    "/v1/class_sessions/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClassSessionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotFound"
                }
              }
            },
            "description": "Not Found"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a class session.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "getClassSession"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClassSessionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change a session's capacity — never below what is booked.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ClassSessionUpdateBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "updateClassSession"
      }
    },
    "/v1/class_sessions/{id}/cancel": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClassSessionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Cancel a class: every booking still on it is cancelled by the business, and the teacher's time is freed.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ClassSessionCancelBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "cancelClassSession"
      }
    },
    "/v1/booking_series": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingSeriesList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List series, newest first. `?status=` active or ended.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "active · ended",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "listBookingSeries"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingSeriesModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Start a series: the visit (or class), who, the first occurrence, the rule. The first occurrence is booked now or the series is refused (`409 slot_unavailable`); the rest follow eight weeks ahead, a date that is taken becoming an alert.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BookingSeriesBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "createBookingSeries"
      }
    },
    "/v1/booking_series/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingSeriesModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotFound"
                }
              }
            },
            "description": "Not Found"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a series.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "getBookingSeries"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingSeriesModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "This and following: from a date on, a new time and/or person — the occurrences already made are moved (a taken slot becomes an alert). A class series changes its capacity.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BookingSeriesEditBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "updateBookingSeries"
      }
    },
    "/v1/booking_series/{id}/skip": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingSeriesModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Leave one occurrence out: its booking is cancelled by the business and never remade.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BookingSeriesSkipBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "skipBookingSeries"
      }
    },
    "/v1/booking_series/{id}/end": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingSeriesModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "End the series: nothing after the given day (today by default), and nothing new.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BookingSeriesEndBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "endBookingSeries"
      }
    },
    "/v1/waitlist": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingWaitlistEntryList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List the waitlist, newest first — `position` says who is ahead. `?status=`, `?customer=`, `?service=`, `?staff_member=`, `?location=`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "waiting · offered · converted · expired · cancelled",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "customer",
            "in": "query",
            "required": false,
            "description": "This client's wishes (`cus_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "service",
            "in": "query",
            "required": false,
            "description": "Wishes for this service (`svc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "staff_member",
            "in": "query",
            "required": false,
            "description": "Wishes for this person (`stf_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "At this location (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "listWaitlist"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingWaitlistEntryModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Join the waitlist: the service, who (or anyone), the days and the times that would do, and who for. Matched at once when something already suits; otherwise the moment a slot frees up. An offer holds the slot for 30 minutes.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WaitlistEntryBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "createWaitlistEntry"
      }
    },
    "/v1/waitlist/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingWaitlistEntryModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotFound"
                }
              }
            },
            "description": "Not Found"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a waitlist entry: where it is in the line, or the open offer.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "getWaitlistEntry"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingWaitlistEntryModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change a waiting wish — its person, days, windows or notes — and match it again.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WaitlistEntryEditBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "updateWaitlistEntry"
      }
    },
    "/v1/waitlist/{id}/cancel": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingWaitlistEntryModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Withdraw a wish. An open offer's slot goes back on sale.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "cancelWaitlistEntry"
      }
    },
    "/v1/waitlist/{id}/accept": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingWaitlistEntryModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Take up the open offer: the held slot becomes the client's booking in one step. `409 offer_expired` once the window has passed; `409 invalid_status` when there is no open offer.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "acceptWaitlistOffer"
      }
    },
    "/v1/ics_feeds": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IcsFeedList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The account's calendar feeds, newest first — whose each is, never their links.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "listIcsFeeds"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IcsFeedModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A calendar feed for one staff member or one location (name one), with its link — shown this once. Asked again, the same feed gets a new link and the old one stops working: the way to take a feed back from a calendar it should no longer reach.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/IcsFeedBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "createIcsFeed"
      }
    },
    "/v1/booking_reports/summary": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingReportModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "How your bookings did over a range of days: utilisation, sources, no-show and late-cancellation rates (with and without a card on file, with and without a reminder), the money taken on them, new and returning clients, rebooking, lead time and the busiest hours. `?from=&to=` (`YYYY-MM-DD`, each location's own days; the last 30 days by default, at most 366) and `?location=`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "First day, `YYYY-MM-DD`, on each location's own calendar. Defaults to 29 days before `to`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "Last day, `YYYY-MM-DD`, inclusive. Defaults to today (UTC).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Only this location's bookings and working time (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "retrieveBookingReport"
      }
    },
    "/v1/booking_reports/summary.csv": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "text/csv": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The report's headline figures as CSV: one `metric,value` row each",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "First day, `YYYY-MM-DD`, on each location's own calendar. Defaults to 29 days before `to`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "Last day, `YYYY-MM-DD`, inclusive. Defaults to today (UTC).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Only this location's bookings and working time (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "downloadBookingReportSummaryCsv"
      }
    },
    "/v1/booking_reports/utilisation.csv": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "text/csv": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Utilisation as CSV: each staff member's working and booked minutes",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "First day, `YYYY-MM-DD`, on each location's own calendar. Defaults to 29 days before `to`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "Last day, `YYYY-MM-DD`, inclusive. Defaults to today (UTC).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Only this location's bookings and working time (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "downloadBookingReportUtilisationCsv"
      }
    },
    "/v1/booking_reports/revenue.csv": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "text/csv": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Revenue as CSV: by staff member, service and category (amounts in minor units)",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "First day, `YYYY-MM-DD`, on each location's own calendar. Defaults to 29 days before `to`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "Last day, `YYYY-MM-DD`, inclusive. Defaults to today (UTC).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Only this location's bookings and working time (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "downloadBookingReportRevenueCsv"
      }
    },
    "/v1/booking_reports/sources.csv": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "text/csv": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Bookings by source and channel as CSV",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "First day, `YYYY-MM-DD`, on each location's own calendar. Defaults to 29 days before `to`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "Last day, `YYYY-MM-DD`, inclusive. Defaults to today (UTC).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Only this location's bookings and working time (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "downloadBookingReportSourcesCsv"
      }
    },
    "/v1/booking_reports/staff.csv": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "text/csv": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "How each person did as CSV (28-04): their bookings, takings (minor units), utilisation, rebooking and no-shows",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "First day, `YYYY-MM-DD`, on each location's own calendar. Defaults to 29 days before `to`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "Last day, `YYYY-MM-DD`, inclusive. Defaults to today (UTC).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Only this location's bookings and working time (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "downloadBookingReportStaffCsv"
      }
    },
    "/v1/booking_reports/hours.csv": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "text/csv": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The busiest hours as CSV: bookings by weekday and hour at the location",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "First day, `YYYY-MM-DD`, on each location's own calendar. Defaults to 29 days before `to`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "Last day, `YYYY-MM-DD`, inclusive. Defaults to today (UTC).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Only this location's bookings and working time (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "downloadBookingReportHoursCsv"
      }
    },
    "/v1/booking_setup/ai_proposal": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AiProposalModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Draft the business's services, hours and about text from its website, Instagram profile or a photo of its price list (AI-assisted setup, the `ai_setup` flag). Nothing is saved: accept each line through the ordinary APIs.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AiProposalBody"
              }
            }
          }
        },
        "tags": [
          "Booking setup"
        ],
        "operationId": "createAiProposal"
      }
    },
    "/v1/booking_setup/google_business": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GoogleBusinessModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Whether Google can fill the setup in here, the connection, and the listing chosen",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Booking setup"
        ],
        "operationId": "retrieveGoogleBusiness"
      },
      "delete": {
        "responses": {
          "204": {
            "description": "No Content"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Disconnect: forget the listing, and give the Business Profile grant back to Google",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Booking setup"
        ],
        "operationId": "disconnectGoogleBusiness"
      }
    },
    "/v1/booking_setup/google_business/locations": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GoogleListingList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The connected Business Profile's locations, each read into a listing",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Booking setup"
        ],
        "operationId": "listGoogleBusinessLocations"
      }
    },
    "/v1/booking_setup/google_business/listing": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GoogleListingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotFound"
                }
              }
            },
            "description": "Not Found"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "description": "Nothing is put on the location: its address, phone and hours come back for the person to check and save through `POST /v1/locations/{id}`. The listing is remembered as the business's, so the share step can say which profile the booking link goes on.",
        "summary": "Read one listing in — a location of the connected profile, or the place a Google Maps link names",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ListingBody"
              }
            }
          }
        },
        "tags": [
          "Booking setup"
        ],
        "operationId": "readGoogleBusinessListing"
      }
    },
    "/v1/booking_setup/google_business/photos": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GooglePhotoImportModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "description": "The listing's cover becomes the page's cover when the page has none; the rest are added to the gallery while there is room (20). Each is re-encoded like an upload, and a photo already on the page is not added again.",
        "summary": "Bring a listing's photos onto the booking page — its cover, and the rest to the gallery",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ListingBody"
              }
            }
          }
        },
        "tags": [
          "Booking setup"
        ],
        "operationId": "importGoogleBusinessPhotos"
      }
    },
    "/v1/booking_channels": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingChannelSummaryModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Where your bookings came from: every channel — yours, and the places you could put your link and have not — with the bookings made through it for a range of days, what came of them, the money taken on them and the no-show rate, and the bookings made from no channel. `?from=&to=` (`YYYY-MM-DD`, each location's own days; the last 30 days by default, at most 366) and `?location=`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "First day, `YYYY-MM-DD`, on each location's own calendar. Defaults to 29 days before `to`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "Last day, `YYYY-MM-DD`, inclusive. Defaults to today (UTC).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Only this location's bookings and working time (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Bookings"
        ],
        "operationId": "retrieveBookingChannels"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingChannelModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Set a channel up: one of Tuppence's by its `code` (`instagram`, `qr`, `google_link`…), or one of your own with a `kind` and a `label`. The same code again is the same channel — its label changed if you give one; a channel never moves back from `live`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SetUpChannelBody"
              }
            }
          }
        },
        "tags": [
          "Bookings"
        ],
        "operationId": "setUpBookingChannel"
      }
    },
    "/v1/reviews": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReviewList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Reviews clients have written, newest first. `?status=` (`published`, `hidden`), `?staff_member=`, `?customer=`, `?booking=`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "`published` or `hidden`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "staff_member",
            "in": "query",
            "required": false,
            "description": "Only those naming this staff member (`stf_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "customer",
            "in": "query",
            "required": false,
            "description": "Only this client's (`cus_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "booking",
            "in": "query",
            "required": false,
            "description": "Only this booking's (`bk_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Reviews"
        ],
        "operationId": "listReviews"
      }
    },
    "/v1/reviews/summary": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReviewSummaryModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The rating: every review written — published or hidden — its average to one decimal place, and how many of each star.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Reviews"
        ],
        "operationId": "retrieveReviewSummary"
      }
    },
    "/v1/reviews/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReviewModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a review",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Reviews"
        ],
        "operationId": "retrieveReview"
      }
    },
    "/v1/reviews/{id}/reply": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReviewModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Reply to a review — one reply, shown beneath it on the page as the business's. Sent again, it replaces the last.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReviewReplyBody"
              }
            }
          }
        },
        "tags": [
          "Reviews"
        ],
        "operationId": "replyToReview"
      }
    },
    "/v1/reviews/{id}/hide": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReviewModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Keep a review off the page — for abuse. Its stars still count in the rating, on the page and here.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Reviews"
        ],
        "operationId": "hideReview"
      }
    },
    "/v1/reviews/{id}/publish": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReviewModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Show a hidden review on the page again.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Reviews"
        ],
        "operationId": "publishReview"
      }
    },
    "/v1/test_helpers/bookings/seed_week": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SeedWeekModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: fill a week with plausible bookings for a cast of example clients, using the account's own services, staff and hours — the same week for the same account every time, and never twice.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SeedWeekBody"
              }
            }
          }
        },
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersSeedBookingWeek"
      }
    },
    "/v1/test_helpers/bookings/remove_seeded": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SeedRemovalModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: take the example bookings away — every seeded week's bookings, and the example clients nothing else names now. What the business has used since (money recorded, a note, a form) stays, and is listed in `kept`. No messages and no events.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersRemoveSeededBookings"
      }
    },
    "/v1/test_helpers/bookings/expire_holds": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExpiredHoldsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: give every open hold back now, as if its time were up.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersExpireBookingHolds"
      }
    },
    "/v1/test_helpers/bookings/{id}/confirm_link": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentConfirmationLinkModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: mint a fresh confirmation link for a booking a client's agent made, waiting for the client — the one the client was sent is theirs alone. The old link stops working.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersAgentConfirmationLink"
      }
    },
    "/v1/test_helpers/bookings/{id}/review_link": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReviewLinkModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: mint a fresh link to review a completed booking whose review has been asked for — the one the client was sent is theirs alone. The old link stops working.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersReviewLink"
      }
    },
    "/v1/test_helpers/bookings/{id}/force_no_show": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: mark a confirmed or arrived booking a no-show without waiting for it to start — the slot is freed and the policy's fee is due, as the real thing.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersForceBookingNoShow"
      }
    },
    "/v1/test_helpers/calendar/events": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExternalEventsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Their calendar as they see it (`?staff_member=`)",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "staff_member",
            "in": "query",
            "required": false,
            "description": "Whose fake calendar (`stf_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersListCalendarEvents"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MadeModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Someone adds an event in their calendar — and the provider notifies us",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ExternalEventBody"
              }
            }
          }
        },
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersAddCalendarEvent"
      }
    },
    "/v1/test_helpers/calendar/events/{id}": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MadeModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Someone edits an event out there — ours included — and the provider notifies us",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ExternalEventPatchBody"
              }
            }
          }
        },
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersEditCalendarEvent"
      }
    },
    "/v1/test_helpers/calendar/gone": {
      "post": {
        "responses": {
          "204": {
            "description": "No Content"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The next sync answers 410: the cursor is gone (`provider`, google by default)",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          }
        },
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersCalendarGone"
      }
    },
    "/v1/test_helpers/calendar/sync": {
      "post": {
        "responses": {
          "204": {
            "description": "No Content"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Run the connection's sync now, inline (`staff_member`)",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          }
        },
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersCalendarSync"
      }
    },
    "/v1/test_helpers/calendar/push": {
      "post": {
        "responses": {
          "204": {
            "description": "No Content"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Push a booking's copy now, inline (`booking`, `action`)",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          }
        },
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersCalendarPush"
      }
    },
    "/v1/test_helpers/waitlist/{id}/offer_link": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WaitlistOfferLinkModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: mint a fresh link for an open waitlist offer — the one the client was sent is theirs alone. The old link stops working.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersWaitlistOfferLink"
      }
    },
    "/.well-known/jwks.json": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/JwksModel"
                }
              }
            },
            "description": "Success"
          }
        },
        "summary": "The public keys that sign receipt tokens (EdDSA / Ed25519). Cache for five minutes.",
        "parameters": [],
        "tags": [
          "Receipts"
        ],
        "operationId": "retrieveReceiptKeys",
        "security": []
      }
    },
    "/v1/statements": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StatementMonths"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The months there are statements for, newest first",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Reporting"
        ],
        "operationId": "listStatements"
      }
    },
    "/v1/statements/{month}.csv": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "text/csv": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A month's statement as CSV (amounts in minor units, money out negative)",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "month",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Reporting"
        ],
        "operationId": "downloadStatementCsv"
      }
    },
    "/v1/statements/{month}.pdf": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A month's statement as a PDF",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "month",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Reporting"
        ],
        "operationId": "downloadStatementPdf"
      }
    },
    "/v1/statements/{month}/fee_invoice.pdf": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A month's fee invoice as a PDF: Tuppence's fees, in the reader's language",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "month",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Reporting"
        ],
        "operationId": "downloadFeeInvoicePdf"
      }
    },
    "/v1/statements/{month}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StatementModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A month's statement: opening balance, sales, fees, refunds, disputes, payouts, closing balance",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "month",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Reporting"
        ],
        "operationId": "retrieveStatement"
      }
    },
    "/v1/plans": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PlanList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List plans, newest first. Filter with `?status=active`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Subscriptions"
        ],
        "operationId": "listPlans"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PlanModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a plan. Its price never changes — a new price is a new plan.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreatePlanBody"
              }
            }
          }
        },
        "tags": [
          "Subscriptions"
        ],
        "operationId": "createPlan"
      }
    },
    "/v1/plans/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PlanModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a plan",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Subscriptions"
        ],
        "operationId": "retrievePlan"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PlanModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Rename a plan, or change its metadata. Never its price.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdatePlanBody"
              }
            }
          }
        },
        "tags": [
          "Subscriptions"
        ],
        "operationId": "updatePlan"
      }
    },
    "/v1/plans/{id}/archive": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PlanModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Stop new subscriptions on this plan. The ones already on it carry on.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Subscriptions"
        ],
        "operationId": "archivePlan"
      }
    },
    "/v1/subscriptions": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List subscriptions, newest first. Filter with `?customer=`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Subscriptions"
        ],
        "operationId": "listSubscriptions"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Start a subscription. The first period is charged now, unless the plan has a trial.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateSubscriptionBody"
              }
            }
          }
        },
        "tags": [
          "Subscriptions"
        ],
        "operationId": "createSubscription"
      }
    },
    "/v1/subscriptions/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a subscription",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Subscriptions"
        ],
        "operationId": "retrieveSubscription"
      }
    },
    "/v1/subscriptions/{id}/cancel": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "End it — now, or when the period they have paid for ends",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CancelSubscriptionBody"
              }
            }
          }
        },
        "tags": [
          "Subscriptions"
        ],
        "operationId": "cancelSubscription"
      }
    },
    "/v1/subscriptions/{id}/pause": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Pause it — nothing is charged until it resumes, on a date or when asked",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PauseSubscriptionBody"
              }
            }
          }
        },
        "tags": [
          "Subscriptions"
        ],
        "operationId": "pauseSubscription"
      }
    },
    "/v1/subscriptions/{id}/resume": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Resume a paused subscription now — charged now if the period it had paid for is over",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Subscriptions"
        ],
        "operationId": "resumeSubscription"
      }
    },
    "/v1/subscriptions/{id}/reactivate": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Take back a cancellation set for the end of the period, before it lands",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Subscriptions"
        ],
        "operationId": "reactivateSubscription"
      }
    },
    "/v1/subscriptions/{id}/preview": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProrationPreviewModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What changing to another plan would cost, without doing it",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ChangeSubscriptionBody"
              }
            }
          }
        },
        "tags": [
          "Subscriptions"
        ],
        "operationId": "previewSubscriptionChange"
      }
    },
    "/v1/subscriptions/{id}/change": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Move it to another plan — charged for the time remaining, or waiting for the period",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ChangeSubscriptionBody"
              }
            }
          }
        },
        "tags": [
          "Subscriptions"
        ],
        "operationId": "changeSubscription"
      }
    },
    "/v1/coupons": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CouponList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List coupons, newest first",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Subscriptions"
        ],
        "operationId": "listCoupons"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CouponModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a coupon: a percentage or an amount off, once, for some charges, or for ever",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateCouponBody"
              }
            }
          }
        },
        "tags": [
          "Subscriptions"
        ],
        "operationId": "createCoupon"
      }
    },
    "/v1/coupons/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CouponModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a coupon",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Subscriptions"
        ],
        "operationId": "retrieveCoupon"
      }
    },
    "/v1/coupons/{id}/archive": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CouponModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Stop new redemptions. Subscriptions already carrying it keep it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Subscriptions"
        ],
        "operationId": "archiveCoupon"
      }
    },
    "/v1/promo_codes": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PromoCodeList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List promo codes, newest first",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Subscriptions"
        ],
        "operationId": "listPromoCodes"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PromoCodeModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a promo code for a coupon",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreatePromoCodeBody"
              }
            }
          }
        },
        "tags": [
          "Subscriptions"
        ],
        "operationId": "createPromoCode"
      }
    },
    "/v1/promo_codes/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PromoCodeModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a promo code",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Subscriptions"
        ],
        "operationId": "retrievePromoCode"
      }
    },
    "/v1/promo_codes/{id}/deactivate": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PromoCodeModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Stop a promo code from being redeemed",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Subscriptions"
        ],
        "operationId": "deactivatePromoCode"
      }
    },
    "/v1/invoices": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvoiceList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List invoices, newest first. Filter with `?status=` (`draft`, `open`, `paid`, `void`, `overdue`…), `?kind=` (`one_off` for the invoices written by the business), `?customer=` or `?subscription=`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only invoices in this status: `draft`, `open`, `processing`, `paid`, `uncollectible`, `void`, or `overdue` (open and past its due day).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "customer",
            "in": "query",
            "required": false,
            "description": "Only this customer's (`cus_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "subscription",
            "in": "query",
            "required": false,
            "description": "Only this subscription's invoices (`sub_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Subscriptions"
        ],
        "operationId": "listInvoices"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvoiceModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a one-off invoice, as a draft: a customer (an id, or `{ name, email }`), lines and when it is due. Send it to number it and email the customer",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InvoiceBody"
              }
            }
          }
        },
        "tags": [
          "Subscriptions"
        ],
        "operationId": "createInvoice"
      }
    },
    "/v1/invoices/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvoiceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve an invoice",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Subscriptions"
        ],
        "operationId": "retrieveInvoice"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvoiceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a draft invoice. Once sent, an invoice no longer changes",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InvoiceBody"
              }
            }
          }
        },
        "tags": [
          "Subscriptions"
        ],
        "operationId": "updateInvoice"
      }
    },
    "/v1/invoices/{id}/send": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvoiceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Send a draft invoice: it takes the next number, opens, and the customer is emailed a link to pay it and its PDF",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Subscriptions"
        ],
        "operationId": "sendInvoice"
      }
    },
    "/v1/invoices/{id}/void": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvoiceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Void an open invoice: it keeps its number and can no longer be paid",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Subscriptions"
        ],
        "operationId": "voidInvoice"
      }
    },
    "/v1/invoices/{id}/pdf": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "An invoice as a PDF",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Subscriptions"
        ],
        "operationId": "retrieveInvoicePdf"
      }
    },
    "/v1/portal_sessions": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PortalSessionModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A one-hour link to the customer portal, for one customer",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreatePortalSessionBody"
              }
            }
          }
        },
        "tags": [
          "Subscriptions"
        ],
        "operationId": "createPortalSession"
      }
    },
    "/v1/issuing/limits": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IssuingLimitsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Your card limits — cards, cardholders, card spend — with what is used and when each resets",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Cards"
        ],
        "operationId": "retrieveIssuingLimits"
      }
    },
    "/v1/agents": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List agents, newest first. `?status=` is `active` or `disabled`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only agents in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Agents"
        ],
        "operationId": "listAgents"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create an agent",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AgentBody"
              }
            }
          }
        },
        "tags": [
          "Agents"
        ],
        "operationId": "createAgent"
      }
    },
    "/v1/agents/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve an agent",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Agents"
        ],
        "operationId": "retrieveAgent"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update an agent — its name, description, status or metadata",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AgentBody"
              }
            }
          }
        },
        "tags": [
          "Agents"
        ],
        "operationId": "updateAgent"
      }
    },
    "/v1/agents/{id}/credentials": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentCredentialList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The keys an agent signs with — newest first, revoked ones included",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Agents"
        ],
        "operationId": "listAgentCredentials"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentCredentialModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Give an agent a key: register your own public key, or let us generate the pair and show the private half once",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateCredentialBody"
              }
            }
          }
        },
        "tags": [
          "Agents"
        ],
        "operationId": "createAgentCredential"
      }
    },
    "/v1/agents/{id}/credentials/{kid}": {
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentCredentialModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Revoke a key: proofs signed with it stop verifying at once",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "kid",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Agents"
        ],
        "operationId": "revokeAgentCredential"
      }
    },
    "/v1/agent_mandates": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentMandateList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List mandates, newest first. Filter with `?agent=`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Agents"
        ],
        "operationId": "listAgentMandates"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentMandateModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Ask a person to let an agent buy something, within limits",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateMandateBody"
              }
            }
          }
        },
        "tags": [
          "Agents"
        ],
        "operationId": "createAgentMandate"
      }
    },
    "/v1/agent_mandates/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentMandateModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a mandate",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Agents"
        ],
        "operationId": "retrieveAgentMandate"
      }
    },
    "/v1/agent_mandates/{id}/revoke": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentMandateModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Take a mandate back: nothing more can be bought under it",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Agents"
        ],
        "operationId": "revokeAgentMandate"
      }
    },
    "/v1/agent_mandates/{id}/carts": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentCartList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What the agent came back with under this mandate — refused carts included",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Agents"
        ],
        "operationId": "listAgentCarts"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentCartModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The agent comes back with a cart, signed with its own key — checked against what the person agreed",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddCartBody"
              }
            }
          }
        },
        "tags": [
          "Agents"
        ],
        "operationId": "createAgentCart"
      }
    },
    "/v1/cardholders": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardholderList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List cardholders, newest first",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Cardholders"
        ],
        "operationId": "listCardholders"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardholderModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a cardholder — once cards are switched on",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CardholderBody"
              }
            }
          }
        },
        "tags": [
          "Cardholders"
        ],
        "operationId": "createCardholder"
      }
    },
    "/v1/cardholders/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardholderModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a cardholder",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Cardholders"
        ],
        "operationId": "retrieveCardholder"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardholderModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a cardholder — email, phone, billing address, status or metadata",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CardholderBody"
              }
            }
          }
        },
        "tags": [
          "Cardholders"
        ],
        "operationId": "updateCardholder"
      }
    },
    "/v1/cards": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List cards, newest first. `?agent=` and `?status=` narrow it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only cards in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agent",
            "in": "query",
            "required": false,
            "description": "Only this agent's (`agt_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Cards"
        ],
        "operationId": "listCards"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Issue a card — virtual (yours, or an agent's) or physical (a person's) — standing, or single-use up to an amount",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateCardBody"
              }
            }
          }
        },
        "tags": [
          "Cards"
        ],
        "operationId": "createCard"
      }
    },
    "/v1/cards/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a card",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Cards"
        ],
        "operationId": "retrieveCard"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a card's metadata",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateCardBody"
              }
            }
          }
        },
        "tags": [
          "Cards"
        ],
        "operationId": "updateCard"
      }
    },
    "/v1/cards/{id}/limits": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change a card's spending limits — `null` removes one; at least one always remains",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LimitsBody"
              }
            }
          }
        },
        "tags": [
          "Cards"
        ],
        "operationId": "setCardLimits"
      }
    },
    "/v1/cards/{id}/activate": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Activate a card issued inactive",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Cards"
        ],
        "operationId": "activateCard"
      }
    },
    "/v1/cards/{id}/freeze": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Freeze a card: every purchase is declined until it is unfrozen",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Cards"
        ],
        "operationId": "freezeCard"
      }
    },
    "/v1/cards/{id}/unfreeze": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Unfreeze a frozen card",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Cards"
        ],
        "operationId": "unfreezeCard"
      }
    },
    "/v1/cards/{id}/cancel": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Cancel a card, for good",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Cards"
        ],
        "operationId": "cancelCard"
      }
    },
    "/v1/cards/{id}/replace": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Replace a card: a physical one lost, stolen, damaged or expired, or a virtual one lost or stolen",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReplaceCardBody"
              }
            }
          }
        },
        "tags": [
          "Cards"
        ],
        "operationId": "replaceCard"
      }
    },
    "/v1/test_helpers/cards/{id}/shipping/{step}": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: the post moves a physical card — `ship`, `deliver`, `fail` or `return`",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "step",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Test helpers"
        ],
        "operationId": "simulateCardShipping"
      }
    },
    "/v1/cards/{id}/details": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardDetailsModel"
                }
              },
              "*/*": {
                "schema": {}
              }
            },
            "description": "Success",
            "headers": {
              "Pragma": {
                "example": "no-cache",
                "schema": {
                  "type": "string"
                }
              },
              "Cache-Control": {
                "example": "no-store",
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Read a virtual card's number, CVC and expiry — your business's own card or an agent's — to fill in a merchant's checkout. A restricted key with `card_details:read` only, on an account whose owner has allowed it; every read is audited and sent as `card.details_retrieved`. Never store, print or log the answer.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Cards"
        ],
        "operationId": "retrieveCardDetails"
      }
    },
    "/v1/spend_policies": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SpendPolicyList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List spend policies, newest first",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Spend policies"
        ],
        "operationId": "listSpendPolicies"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SpendPolicyModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a spend policy",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PolicyBody"
              }
            }
          }
        },
        "tags": [
          "Spend policies"
        ],
        "operationId": "createSpendPolicy"
      }
    },
    "/v1/spend_policies/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SpendPolicyModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a spend policy",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Spend policies"
        ],
        "operationId": "retrieveSpendPolicy"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SpendPolicyModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Edit a spend policy — pass `version` to be told if someone else edited it first",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PolicyBody"
              }
            }
          }
        },
        "tags": [
          "Spend policies"
        ],
        "operationId": "updateSpendPolicy"
      }
    },
    "/v1/agents/{id}/profile": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentProfileModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What's normal for an agent's spending, and its latest unusual purchases",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Agents"
        ],
        "operationId": "retrieveAgentProfile"
      }
    },
    "/v1/card_authorizations": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardAuthorizationList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List card authorisations, newest first. `?card=` narrows it to one card.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "card",
            "in": "query",
            "required": false,
            "description": "Only this card's (`card_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Cards"
        ],
        "operationId": "listCardAuthorizations"
      }
    },
    "/v1/card_authorizations/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardAuthorizationModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a card authorisation",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Cards"
        ],
        "operationId": "retrieveCardAuthorization"
      }
    },
    "/v1/test_helpers/issuing/authorizations": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardAuthorizationModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: a simulated purchase on a card — decided exactly as a real one would be",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SimulatedPurchaseBody"
              }
            }
          }
        },
        "tags": [
          "Test helpers"
        ],
        "operationId": "simulateCardPurchase"
      }
    },
    "/v1/approvals": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApprovalList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List approvals, newest first. `?status=` and `?card=` narrow it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only approvals in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "card",
            "in": "query",
            "required": false,
            "description": "Only this card's (`card_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Approvals"
        ],
        "operationId": "listApprovals"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApprovalModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Ask a person to approve a purchase before making it (a pre-approval)",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RequestApprovalBody"
              }
            }
          }
        },
        "tags": [
          "Approvals"
        ],
        "operationId": "requestApproval"
      }
    },
    "/v1/approvals/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApprovalModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve an approval — poll it after asking",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Approvals"
        ],
        "operationId": "retrieveApproval"
      }
    },
    "/v1/issuing/balance": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IssuingBalanceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Spendable (what the cards can spend: the UK's Issuing balance; in the US, what could be paid out of earnings now) and earned — read before buying",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Card balance"
        ],
        "operationId": "retrieveIssuingBalance"
      }
    },
    "/v1/issuing/funding_instructions": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FundingInstructionsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The bank details to send money to, to top up what the cards can spend",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Card balance"
        ],
        "operationId": "retrieveFundingInstructions"
      }
    },
    "/v1/issuing/balance_transfers": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IssuingFundingModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Move cleared earnings onto the cards' Issuing balance (UK, free, spendable on Stripe's date) — the same as POST /v1/issuing/topups {method: balance}; refused in the US, whose cards spend earnings directly",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BalanceTransferBody"
              }
            }
          }
        },
        "tags": [
          "Card balance"
        ],
        "operationId": "createIssuingBalanceTransfer"
      }
    },
    "/v1/issuing/topups": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IssuingTopupList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Top-ups of your cards' balance, newest first — by `status` or `method` if you like",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only top-ups in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "method",
            "in": "query",
            "required": false,
            "description": "Only top-ups by this method: `bank_transfer`, `card`, `balance` or `platform` (`instant_from_balance`: instant moves of your balance).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Card balance"
        ],
        "operationId": "listIssuingTopups"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IssuingTopupModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "description": "`{method: bank_transfer, amount}` (UK): answers `requires_action` with `next_action.bank_transfer` — your card balance's own sort code and account number, and a reference — and `expected_available_at` (about two hours while banks are open, else the next banking day's opening). No money moves and it's free. When your transfer arrives (`issuing_topup.available`) the top-up is `available` and the amount is spendable; nothing arriving within 7 days and it's `canceled` (money sent later still lands, as an `incoming` top-up). `{method: bank_transfer, amount}` (US): the same, with your card balance's own virtual account — `next_action.bank_transfer` has its `routing_number` and `account_number` (ACH and domestic wire, `networks`), `swift` for international wires, and the `reference` to put on it — and `expected_available_at` (ACH: by 5pm New York time the next business day; wires usually the same day). Send `total`: `amount` arrives on your card balance and the fee (Stripe's bank-transfer fee, 0.5%, at most $5) is on top; `amount_type: pay` takes it out of `amount` instead. Spendable on your cards as soon as it arrives; it can be paid out to your bank only once it has cleared. Money you send with no top-up asked for is recorded too, as an `incoming` top-up, the fee taken from it. `{method: balance, speed: instant}` (or M57's `method: instant_from_balance`): `amount` (default: the most possible) leaves your payments balance — pending card money included — and, less our 0.99% fee, is spendable on your cards at once. The same rules and allowance as an instant payout; refused with `topup_unavailable` and the `reason`, `message` and `fix_url` of `GET /v1/payout_settings`'s `instant_payouts.destinations.card_balance` when it can't be used. `{method: card, amount, business_funds: true, confirmation_token | payment_method}` (both regions): `amount` arrives on your card balance and the card is charged `total` — the card rate on top, by the card's kind (`amount_type: pay` takes it out instead). The bank checks it's the cardholder (3-D Secure): until they have, `requires_action` with `next_action.confirm_payment.client_secret` for Stripe.js's `handleNextAction`. Paid, it is `processing` (`delay.code: clearing`) until the payment clears, and `expected_available_at` says when it's spendable (in the UK, within a day more: it moves onto your card balance). Refused before any charge (`topup_unavailable`, with `reason` and `fix_url`): prepaid cards, your own Tuppence cards, an amount that can't be topped up by card on the account right now (`amount_unavailable`, with *Contact us* as `fix_url`), card top-ups not open on the account yet, card top-ups paused on your account (`reason: paused`: after a chargeback, or while we review recent activity; bank transfers stay open). Any method can also be refused while Tuppence has top-ups paused for a moment (`reason: topups_paused`, or `card_topups_paused` for cards only, when a bank transfer still works) or has switched top-ups off for your account (`topups_off`): `message` says what to do and `fix_url` where. `save_payment_method: true` keeps the card for later top-ups (`GET /v1/issuing/topup_payment_methods`); `{method: card, amount, payment_method: tpm_…}` then charges it with nobody there — if the bank wants the cardholder, it answers `requires_action` with `next_action.confirm_payment` (the *confirm your payment* link). An agent signing its requests (`Tuppence-Agent-Proof`) tops up by card or from its balance only inside a funding mandate a person gave it (`POST /v1/agents/:id/funding_mandates`), and only with a saved top-up card; otherwise `403 approval_required`, and nothing moves. `{method: card, speed: instant, …}` (both regions, where the account can use it): the card rate plus 0.99% on top (`fee.instant_bps`, `fee.instant_amount`), and `available` within a minute of the payment instead of `processing` — in the US at once (it can't be paid out to your bank until it clears), in the UK moved onto your card balance as soon as it's paid. Refused before any charge with `reason: not_available_yet` and *Contact us* as `fix_url` where it can't. `{method: balance, amount}` (UK, standard): cleared earnings moved onto your card balance, free — decided as a payout is (what has cleared, holds, limits) — `in_transit` with `delay.code: moving_to_card_balance` until Stripe's date (`expected_available_at`, usually the next day), then `available`. Refused with `topup_unavailable` (`not_enabled`) where it isn't switched on in live mode yet, with `fix_url` to top up by bank transfer; in the US with `already_spendable` (the cards spend your earnings directly). Platforms arrive with M54.",
        "summary": "Top up your cards' balance — by bank transfer (UK free; US 0.5%, at most $5), by card (the card rate, spendable once it clears; instant for 0.99% more), or from your earnings (UK: cleared money free, pending money now for 0.99%)",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/IssuingTopupBody"
              }
            }
          }
        },
        "tags": [
          "Card balance"
        ],
        "operationId": "createIssuingTopup"
      }
    },
    "/v1/issuing/topups/options": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IssuingTopupOptionsList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "description": "One answer to *how can I top up, and what will it cost and take?* For each method and speed: `available`; when not, `reason`, `message` and a `fix_url`; the `fee` (and, with `amount`, the `total` you pay for `amount` to arrive); `expected_available_at` if you made it now; the `delay` it would wait on; and, for `bank_transfer`, your card balance's bank details. `amount` (optional) is what should arrive, in minor units; without it you get rates and timings without totals. `currency`, if given, must be your card balance's. Only methods that can be made are listed: platform top-ups join when they open.",
        "summary": "Every way to top up your cards' balance — open or not, why and where to fix it, the fee, the total and when it would be spendable",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "amount",
            "in": "query",
            "required": false,
            "description": "What should arrive on your card balance, in minor units (10000 is £100.00). Leave it out for rates and timings without totals.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "description": "Your card balance's currency, if you'd like to say it (`gbp` or `usd`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Card balance"
        ],
        "operationId": "listIssuingTopupOptions"
      }
    },
    "/v1/issuing/topups/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IssuingTopupModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A top-up of your cards' balance",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Card balance"
        ],
        "operationId": "retrieveIssuingTopup"
      }
    },
    "/v1/issuing/topups/{id}/cancel": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IssuingTopupModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Call off a top-up still waiting on you (`requires_action`) — before any money moves",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Card balance"
        ],
        "operationId": "cancelIssuingTopup"
      }
    },
    "/v1/issuing/funding": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IssuingFundingList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Money that has come into the cards' balance, newest first — replaced by GET /v1/issuing/topups, which lists every top-up",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Card balance"
        ],
        "operationId": "listIssuingFunding"
      }
    },
    "/v1/test_helpers/issuing/topups/{id}/arrive": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IssuingTopupModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "description": "UK: Stripe sends a test bank transfer of the top-up's amount to your card balance's details (`fund_balance`), and it is recorded as any transfer is — matched to your oldest open bank-transfer top-up of that amount, which becomes `available` with `issuing_topup.available`. US: Stripe sends a test transfer of the top-up's `total` to your card balance's virtual account with its reference (`fund_cash_balance`); Stripe applies it to the top-up's payment, which succeeds, and the top-up becomes `available`. Usually at once; on the sandbox it can take a few seconds more, so the answer may still say `requires_action`: the webhook or the next check records it.",
        "summary": "TEST MODE: the bank transfer for a `requires_action` top-up arrives — Stripe's test transfer, through the real arrival path",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Test helpers"
        ],
        "operationId": "arriveIssuingTopup"
      }
    },
    "/v1/test_helpers/issuing/fund": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IssuingFundingModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: money arrives in the cards' balance, as if you had sent a bank transfer — a bank-transfer top-up made and arrived in one call",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TestFundBody"
              }
            }
          }
        },
        "tags": [
          "Test helpers"
        ],
        "operationId": "simulateIssuingFunding"
      }
    },
    "/v1/test_helpers/issuing/topups/{id}/clear": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IssuingTopupModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "description": "For a `processing` card top-up: the payment clears now, whatever its date. US: `available` at once — the amount is spendable. UK: it moves onto your card balance by Stripe's balance transfer (`in_transit`), `available` when Stripe lands it — at once on the simulated gateway; on a sandbox on Stripe's date, which is often at once. On a sandbox the money must be released at Stripe first: top up with `pm_card_bypassPending`.",
        "summary": "TEST MODE: a card top-up's payment clears now — and the top-up carries on as it would",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Test helpers"
        ],
        "operationId": "clearIssuingTopup"
      }
    },
    "/v1/test_helpers/issuing/topups/{id}/authenticate": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IssuingTopupModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "description": "For a card top-up waiting on 3-D Secure (`requires_action`, `next_action.confirm_payment`): `outcome: pass` and the payment is made, as Stripe's webhook would say (`processing`, or `available`/`in_transit` at `speed: instant`); `fail` and it isn't (`failed`). A saved card's charge the bank stopped is confirmed again with the same card first, as the cardholder does on the *confirm your payment* page. Simulated gateway only: on a Stripe sandbox, Stripe.js's `handleNextAction` shows the bank's own test page.",
        "summary": "TEST MODE, simulated gateway: the cardholder passes (or fails) their bank's check on a card top-up",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TopupAuthenticationBody"
              }
            }
          }
        },
        "tags": [
          "Test helpers"
        ],
        "operationId": "authenticateIssuingTopup"
      }
    },
    "/v1/test_helpers/issuing/topups/{id}/fail": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IssuingTopupModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "description": "Waiting on the bank's check (`requires_action`): its payment is canceled and the top-up `failed`. Paid and not yet moving (`processing`): `failed`, and the money stays in your payments balance.",
        "summary": "TEST MODE: a card top-up fails — before its payment is made, or after, before it lands",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Test helpers"
        ],
        "operationId": "failIssuingTopup"
      }
    },
    "/v1/test_helpers/issuing/topups/{id}/chargeback": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IssuingTopupModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "description": "Through the real dispute path: the dispute is recorded, the top-up is `reversed`, and card top-ups pause for the account. Money not yet on your cards goes to the dispute; money already spent leaves your payments balance short. On a Stripe sandbox, top up with `pm_card_createDispute` instead.",
        "summary": "TEST MODE: the cardholder's bank takes a card top-up's payment back (simulated gateway)",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Test helpers"
        ],
        "operationId": "chargebackIssuingTopup"
      }
    },
    "/v1/issuing/topup_links": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IssuingTopupLinkModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "description": "Answers with the page's `url` (shown only now): send it to whoever tops up — or, in a browser, `tuppence.topups.redirect({ url })` from `@tuppence/js`. On it they pay by card (the card rate on top, 3-D Secure, the same rules and limits as `POST /v1/issuing/topups {method: card}`) or see your card balance's own bank details to send a transfer. `amount` fixes what arrives; left out, they choose. Once they have paid they go to `return_url` (left out, the page tells them they can close it). The first card top-up made on it uses it up (`status: used`, `topup`); after 24 hours it is `expired`. A connected account's page shows its Connect platform's name and logo, and its platform's fee on card top-ups, if it sets one.",
        "summary": "A hosted page for a person to top up your cards' balance — by card or by bank transfer; single use, good for 24 hours",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TopupLinkBody"
              }
            }
          }
        },
        "tags": [
          "Card balance"
        ],
        "operationId": "createIssuingTopupLink"
      }
    },
    "/v1/issuing/topup_links/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IssuingTopupLinkModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A hosted top-up link: whether it is still open, and the top-up made on it",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Card balance"
        ],
        "operationId": "retrieveIssuingTopupLink"
      }
    },
    "/v1/issuing/auto_topup": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IssuingAutoTopupModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The auto top-up rule: on or off, its threshold and amount, and whether it is paused",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Card balance"
        ],
        "operationId": "retrieveIssuingAutoTopup"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IssuingAutoTopupModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "description": "When what your cards can spend, plus every top-up already on its way, falls below `threshold`, Tuppence tops up by `amount`: `method: card` charges your saved top-up card with nobody there (the card rate on top; spendable once it clears), `method: balance` (UK) moves pending money onto the cards now for 0.99%. It looks after every card capture and top-up, and every 15 minutes. At most `max_per_day` (3) a day and `max_per_month` (30) in 30 days. A declined card, or a bank that wants the cardholder, pauses it — an hour, then a day — with `issuing_auto_topup.failed` and a `fix_url`; `issuing_balance.low` says Spendable fell below `threshold`, whether or not the rule is on. A person signed in needs a fresh second factor; an agent can't set it (`approval_required`). Switching it on with no saved card, or `balance` where it isn't open (US: `already_spendable`), is refused with `topup_unavailable` and the reason.",
        "summary": "Set the auto top-up rule — what you send changes, the rest stays",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/IssuingAutoTopupBody"
              }
            }
          }
        },
        "tags": [
          "Card balance"
        ],
        "operationId": "updateIssuingAutoTopup"
      }
    },
    "/v1/issuing/topup_payment_methods": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IssuingTopupPaymentMethodList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Your saved top-up cards, newest first (`?include_removed=true` for removed ones too)",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "include_removed",
            "in": "query",
            "required": false,
            "description": "`true`: removed cards too (they can't be charged).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Card balance"
        ],
        "operationId": "listIssuingTopupPaymentMethods"
      }
    },
    "/v1/issuing/topup_payment_methods/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IssuingTopupPaymentMethodModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A saved top-up card",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Card balance"
        ],
        "operationId": "retrieveIssuingTopupPaymentMethod"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IssuingTopupPaymentMethodModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Remove a saved top-up card — at Stripe too: it can't be charged again, an auto top-up charging it switches off, and funding mandates lose it",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Card balance"
        ],
        "operationId": "removeIssuingTopupPaymentMethod"
      }
    },
    "/v1/agents/{id}/funding_mandates": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentFundingMandateList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The funding mandates given to an agent, newest first — revoked ones too",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Agents"
        ],
        "operationId": "listAgentFundingMandates"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentFundingMandateModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "description": "Only a person — the account's owner or an admin, signed in to the dashboard, with a fresh second factor — can give one; an API key or an agent can't. Inside it, the agent's `create_topup` (MCP) or signed `POST /v1/issuing/topups` with `method: card` (a saved top-up card it names) or `balance` is made at once; outside it, `approval_required`. Revoke it with DELETE — at once.",
        "summary": "Let an agent top up the cards within limits, without asking each time",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AgentCreateFundingMandateBody"
              }
            }
          }
        },
        "tags": [
          "Agents"
        ],
        "operationId": "createAgentFundingMandate"
      }
    },
    "/v1/agents/{id}/funding_mandates/{mandate}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentFundingMandateModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A funding mandate",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "mandate",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Agents"
        ],
        "operationId": "retrieveAgentFundingMandate"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentFundingMandateModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Revoke a funding mandate — at once: the agent's next top-up asks a person",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "mandate",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Agents"
        ],
        "operationId": "revokeAgentFundingMandate"
      }
    },
    "/v1/card_transactions": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardTransactionList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List card transactions — captures and refunds — newest first. `?card=` narrows it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "card",
            "in": "query",
            "required": false,
            "description": "Only this card's (`card_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Cards"
        ],
        "operationId": "listCardTransactions"
      }
    },
    "/v1/card_transactions/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardTransactionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a card transaction — with its timeline: asked, approved, authorised, settled",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Cards"
        ],
        "operationId": "retrieveCardTransaction"
      }
    },
    "/v1/test_helpers/issuing/authorizations/{id}/capture": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardAuthorizationModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: the merchant takes the money for a purchase — all of it, or `amount`",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AmountBody"
              }
            }
          }
        },
        "tags": [
          "Test helpers"
        ],
        "operationId": "simulateCardCapture"
      }
    },
    "/v1/test_helpers/issuing/authorizations/{id}/reverse": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardAuthorizationModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: the merchant lets a purchase's hold go",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Test helpers"
        ],
        "operationId": "simulateCardReversal"
      }
    },
    "/v1/test_helpers/issuing/transactions/{id}/refund": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardTransactionModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: the merchant refunds a capture — all of it, or `amount`",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AmountBody"
              }
            }
          }
        },
        "tags": [
          "Test helpers"
        ],
        "operationId": "simulateCardRefund"
      }
    },
    "/v1/cashback/statements": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CashbackStatementList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List cashback statements, one per month, newest first",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Cashback"
        ],
        "operationId": "listCashbackStatements"
      }
    },
    "/v1/cashback/statements/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CashbackStatementModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a cashback statement — the month's spend, cashback, reversals and fees",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Cashback"
        ],
        "operationId": "retrieveCashbackStatement"
      }
    },
    "/v1/cashback/effective_rate": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EffectiveRateModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What payments really cost in a month once cashback is back: (fees − cashback) ÷ volume. `?period=2026-09` (this month by default).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "period",
            "in": "query",
            "required": false,
            "description": "The UTC month: `2026-09`. This month by default.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Cashback"
        ],
        "operationId": "retrieveEffectiveRate"
      }
    },
    "/v1/cashback/connected_accounts": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConnectedAccountCashbackList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A platform's connected accounts' cashback for a month: their card spend, what you earn on it, what you pass on and what you keep. `?period=2026-10` (this month by default), `?account=acct_…`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "period",
            "in": "query",
            "required": false,
            "description": "The UTC month: `2026-10`. This month by default.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "account",
            "in": "query",
            "required": false,
            "description": "Only this connected account's (`acct_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Cashback"
        ],
        "operationId": "listConnectedAccountCashback"
      }
    },
    "/v1/test_helpers/cashback/run_statement": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CashbackStatementModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: make (or remake, while a draft) a month's cashback statement now",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RunStatementBody"
              }
            }
          }
        },
        "tags": [
          "Test helpers"
        ],
        "operationId": "simulateCashbackStatement"
      }
    },
    "/v1/test_helpers/cashback/statements/{id}/pay": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CashbackStatementModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: approve and pay a cashback statement — the transfer, the ledger credit, the email — as staff do in live mode",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Test helpers"
        ],
        "operationId": "simulateCashbackPayment"
      }
    },
    "/v1/cashback/accruals": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CashbackAccrualList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List cashback accruals — each card capture and refund, eligible or not and why — newest first. `?period=2026-09`, `?card=`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "period",
            "in": "query",
            "required": false,
            "description": "Only this UTC month's: `2026-09`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "card",
            "in": "query",
            "required": false,
            "description": "Only this card's (`card_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Cashback"
        ],
        "operationId": "listCashbackAccruals"
      }
    },
    "/v1/payment_links/{id}/preview": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShareMetaModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "How the link looks when it is shared in a chat or a social post: its title, description and preview card image",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payment links"
        ],
        "operationId": "retrievePaymentLinkPreview"
      }
    },
    "/v1/direct_debit": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DirectDebitModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Direct Debit (Bacs or SEPA) for your business: its status, your application, limits and the price — and what to do next",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Account"
        ],
        "operationId": "retrieveDirectDebit"
      }
    },
    "/v1/direct_debit/application": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DirectDebitApplicationModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Apply for Direct Debit (Bacs or SEPA), saying why — we review it within one working day and tell you",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApplyForDirectDebitBody"
              }
            }
          }
        },
        "tags": [
          "Account"
        ],
        "operationId": "applyForDirectDebit"
      }
    },
    "/v1/direct_debit/application/respond": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DirectDebitApplicationModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Answer what we asked about your Direct Debit application — it goes back for review",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RespondToDirectDebitBody"
              }
            }
          }
        },
        "tags": [
          "Account"
        ],
        "operationId": "respondToDirectDebitApplication"
      }
    },
    "/v1/direct_debit/application/withdraw": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DirectDebitApplicationModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Withdraw your open Direct Debit application — you can apply again at any time",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Account"
        ],
        "operationId": "withdrawDirectDebitApplication"
      }
    },
    "/v1/direct_debit/limit_increase": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DirectDebitApplicationModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Ask for higher Direct Debit limits once you're approved — we review it and tell you",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DirectDebitLimitIncreaseBody"
              }
            }
          }
        },
        "tags": [
          "Account"
        ],
        "operationId": "requestDirectDebitLimitIncrease"
      }
    },
    "/v1/payment_method_settings": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentMethodSettingsListModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The payment methods your business can switch on, each with its price and status",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Account"
        ],
        "operationId": "listPaymentMethodSettings"
      }
    },
    "/v1/payment_method_settings/{type}": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentMethodSettingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Switch a payment method on or off for your payers",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "type",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SetPaymentMethodBody"
              }
            }
          }
        },
        "tags": [
          "Account"
        ],
        "operationId": "setPaymentMethodSetting"
      }
    },
    "/v1/account/small_tickets": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SmallTicketsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Small payments (20-04): what the smallest payments cost, and what the same money would have cost as prepaid credit",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Pricing"
        ],
        "operationId": "retrieveSmallTickets"
      }
    },
    "/v1/account/fee_tier": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FeeTierModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Deprecated — the price no longer depends on holding a card: always `standard` and the one rate",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Cashback"
        ],
        "operationId": "retrieveFeeTier"
      }
    },
    "/v1/account/pricing": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountPricingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Every price this business pays now — the list's, or one agreed with Tuppence, with its dates",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "description": "Prices in this currency, e.g. `usd`. Left out: the account's own currency.",
            "in": "query",
            "name": "currency",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Pricing"
        ],
        "operationId": "retrieveAccountPricing"
      }
    },
    "/v1/pricing": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PricingModel"
                }
              }
            },
            "description": "Success"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "description": "The card rate, surcharges, other payment methods, cashback, payouts, the smallest payment and the dispute fee, from the price list in force today. Cached for five minutes.",
        "summary": "Tuppence's price list in each region. No key needed",
        "parameters": [],
        "tags": [
          "Pricing"
        ],
        "operationId": "retrievePricing",
        "security": []
      }
    },
    "/v1/pricing/estimate": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PricingEstimateModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "description": "Quoted by the same fee engine that prices real payments, from the price list in force today: the fee and what is left, for one payment and for `count` of them.",
        "summary": "What Tuppence's fee on a card payment would be. No key needed",
        "parameters": [
          {
            "description": "One payment, in minor units (2000 is £20.00). Required.",
            "in": "query",
            "name": "amount",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Whose price list: `gb`, `us` or `eu`. Required.",
            "in": "query",
            "name": "region",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "The kind of card, when it costs more: `amex`, `commercial` or `foreign`, or several separated by commas. Left out: a domestic consumer card.",
            "in": "query",
            "name": "card",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "How many such payments, from 1 (the default) to 1,000,000.",
            "in": "query",
            "name": "count",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "tags": [
          "Pricing"
        ],
        "operationId": "estimatePricing",
        "security": []
      }
    },
    "/v1/card_transactions/{id}/disputes": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardDisputeFiledModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Dispute a card purchase — a draft to add evidence to, or (`submit: true`) sent to the card network at once. Disputing as fraud cancels the card and issues a replacement.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DisputeBody"
              }
            }
          }
        },
        "tags": [
          "Card disputes"
        ],
        "operationId": "createCardDispute"
      }
    },
    "/v1/card_disputes": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardDisputeList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List card disputes, newest first. `?card=` and `?status=` narrow it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "card",
            "in": "query",
            "required": false,
            "description": "Only this card's (`card_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only disputes in this state.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Card disputes"
        ],
        "operationId": "listCardDisputes"
      }
    },
    "/v1/card_disputes/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardDisputeModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a card dispute",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Card disputes"
        ],
        "operationId": "retrieveCardDispute"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardDisputeModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a draft dispute's evidence, reason or amount — only until it is submitted",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateCardDisputeBody"
              }
            }
          }
        },
        "tags": [
          "Card disputes"
        ],
        "operationId": "updateCardDispute"
      }
    },
    "/v1/card_disputes/{id}/files": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardDisputeModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Attach a PDF or JPEG (up to 5 MB) to a draft dispute's evidence — multipart/form-data: `file`, and optionally `field`",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "name": "content-type",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          }
        },
        "tags": [
          "Card disputes"
        ],
        "operationId": "attachCardDisputeFile"
      }
    },
    "/v1/card_disputes/{id}/submit": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardDisputeFiledModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Submit a draft dispute to the card network — once; nothing can be added after. A person only: an agent's key is refused.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Card disputes"
        ],
        "operationId": "submitCardDispute"
      }
    },
    "/v1/test_helpers/card_disputes/{id}/close": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardDisputeModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: the card network decides a submitted dispute — `won` or `lost` — or a draft runs out of time (`expired`)",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CloseBody"
              }
            }
          }
        },
        "tags": [
          "Test helpers"
        ],
        "operationId": "simulateCardDisputeOutcome"
      }
    },
    "/v1/account": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve the account this key belongs to",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Account"
        ],
        "operationId": "retrieveAccount"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update the account: its name, the smallest payment it will take, and (a platform) whether Tuppence emails its connected accounts",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateAccountBody"
              }
            }
          }
        },
        "tags": [
          "Account"
        ],
        "operationId": "updateAccount"
      }
    },
    "/v1/test_helpers/clock": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TestClockModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: what time it is for this account, and how far ahead of real time",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersRetrieveClock"
      }
    },
    "/v1/test_helpers/clock/advance": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TestClockModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: move this account's clock forward by `days`, `hours`, `minutes` and `seconds` — every later test-mode request sees the new time",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AdvanceBody"
              }
            }
          }
        },
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersAdvanceClock"
      }
    },
    "/v1/test_helpers/clock/reset": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TestClockModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: put this account's clock back to real time",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersResetClock"
      }
    },
    "/v1/payment_method_domains": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentMethodDomainList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List the domains you registered, and whether each wallet shows on each",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payment method domains"
        ],
        "operationId": "listPaymentMethodDomains"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentMethodDomainModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Register a domain your checkout runs on, so Apple Pay and Google Pay show in the card fields there",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PaymentMethodDomainBody"
              }
            }
          }
        },
        "tags": [
          "Payment method domains"
        ],
        "operationId": "createPaymentMethodDomain"
      }
    },
    "/v1/payment_method_domains/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentMethodDomainModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a payment method domain",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payment method domains"
        ],
        "operationId": "retrievePaymentMethodDomain"
      },
      "delete": {
        "responses": {
          "204": {
            "description": "No Content"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Remove a domain: Apple Pay and Google Pay stop showing there",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payment method domains"
        ],
        "operationId": "deletePaymentMethodDomain"
      }
    },
    "/v1/payment_method_domains/{id}/validate": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentMethodDomainModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Check the domain's wallets again now",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payment method domains"
        ],
        "operationId": "validatePaymentMethodDomain"
      }
    },
    "/v1/webhook_endpoints": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpointList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List webhook endpoints",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Webhooks"
        ],
        "operationId": "listWebhookEndpoints"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpointModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a webhook endpoint — the signing secret is returned once",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WebhookEndpointBody"
              }
            }
          }
        },
        "tags": [
          "Webhooks"
        ],
        "operationId": "createWebhookEndpoint"
      }
    },
    "/v1/webhook_endpoints/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpointModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a webhook endpoint",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Webhooks"
        ],
        "operationId": "retrieveWebhookEndpoint"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpointModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a webhook endpoint, or switch it on or off",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WebhookEndpointBody"
              }
            }
          }
        },
        "tags": [
          "Webhooks"
        ],
        "operationId": "updateWebhookEndpoint"
      },
      "delete": {
        "responses": {
          "204": {
            "description": "No Content"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Delete a webhook endpoint",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Webhooks"
        ],
        "operationId": "deleteWebhookEndpoint"
      }
    },
    "/v1/webhook_endpoints/{id}/rotate_secret": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpointModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Issue a new signing secret; the old one keeps signing for 24 hours",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Webhooks"
        ],
        "operationId": "rotateWebhookEndpointSecret"
      }
    },
    "/v1/webhook_endpoints/{id}/test": {
      "post": {
        "responses": {
          "202": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TestEventModel"
                }
              }
            },
            "description": "Accepted"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Send a `webhook_endpoint.test` event to this endpoint",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Webhooks"
        ],
        "operationId": "sendTestWebhookEvent"
      }
    },
    "/v1/webhook_endpoints/{id}/deliveries": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookDeliveryList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Deliveries to this endpoint, newest first, with every attempt",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Webhooks"
        ],
        "operationId": "listWebhookEndpointDeliveries"
      }
    },
    "/v1/test_helpers/webhook_inboxes": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookInboxModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: an inbox to point a webhook endpoint at — see real, signed deliveries arrive without a server. Keeps the newest 20 for a day.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersCreateWebhookInbox"
      }
    },
    "/v1/test_helpers/webhook_inboxes/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookInboxModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: an inbox and the deliveries it has received, newest first",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersRetrieveWebhookInbox"
      }
    },
    "/v1/events": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EventList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List events, newest first. Filter with `?type=`, and with `?object=` for one object's own events — those whose `data` is that object (a booking's, `bk_…`). A platform reads a connected account's with `Tuppence-Account` or `?account=`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "type",
            "in": "query",
            "required": false,
            "description": "Only events of this type, e.g. `payment.succeeded`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "account",
            "in": "query",
            "required": false,
            "description": "A connected account of yours (`acct_…`): read ITS events, each with `account` — the same as sending `Tuppence-Account`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Events"
        ],
        "operationId": "listEvents"
      }
    },
    "/v1/events/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EventModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve an event",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "account",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Events"
        ],
        "operationId": "retrieveEvent"
      }
    },
    "/v1/events/{id}/deliveries": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookDeliveryList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Where this event was sent, and how each delivery went",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "account",
            "in": "query",
            "required": false,
            "description": "A connected account of yours (`acct_…`): read ITS events, each with `account` — the same as sending `Tuppence-Account`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Events"
        ],
        "operationId": "listEventDeliveries"
      }
    },
    "/v1/events/{id}/resend": {
      "post": {
        "responses": {
          "202": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookDeliveryList"
                }
              }
            },
            "description": "Accepted"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Deliver an event again — to one endpoint, or to every subscriber",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ResendBody"
              }
            }
          }
        },
        "tags": [
          "Events"
        ],
        "operationId": "resendEvent"
      }
    },
    "/v1/event_types": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EventTypeList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Every event type a webhook endpoint can subscribe to, grouped by product and section",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Events"
        ],
        "operationId": "listEventTypes"
      }
    },
    "/v1/account/onboarding": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OnboardingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Onboarding status, what is due, and whether payments and payouts are enabled",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Account"
        ],
        "operationId": "retrieveOnboarding"
      }
    },
    "/v1/test_helpers/onboarding/complete": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OnboardingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: make this account's test connected account able to take payments",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersCompleteOnboarding"
      }
    },
    "/v1/customers": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List customers, newest first. `?query=` finds an id, or the start of a name, an email or a phone number; `?email=` is an exact email; `?phone=` a phone number, however it is typed; `?tag=` those with the tag; `?blocked=true|false`; `?opted_out=true` is the clients who said no to reminders, texts or WhatsApp.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "email",
            "in": "query",
            "required": false,
            "description": "Exactly this email address.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "phone",
            "in": "query",
            "required": false,
            "description": "Exactly this phone number, however it is typed (`07700 900123`, `+44 7700 900123`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "tag",
            "in": "query",
            "required": false,
            "description": "Only those with this tag (case-insensitive).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "blocked",
            "in": "query",
            "required": false,
            "description": "`true`: only those you blocked; `false`: only the rest.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "opted_out",
            "in": "query",
            "required": false,
            "description": "`true`: only those who said no to reminders, texts or WhatsApp.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "description": "A customer's id, or the START of their name, email or phone number (case-insensitive; prefix, not substring).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "listCustomers"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a customer. A paired till adds someone at the counter with a `name` and `phone` only — and the customer already holding that number is answered instead, never duplicated.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CustomerBody"
              }
            }
          }
        },
        "tags": [
          "Customers"
        ],
        "operationId": "createCustomer"
      }
    },
    "/v1/customers/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a customer",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "retrieveCustomer"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a customer",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CustomerBody"
              }
            }
          }
        },
        "tags": [
          "Customers"
        ],
        "operationId": "updateCustomer"
      }
    },
    "/v1/customers/{id}/summary": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerSummaryModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What a customer has paid you — lifetime value, refunds, fees, disputes — per currency",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "retrieveCustomerSummary"
      }
    },
    "/v1/customers/{id}/block": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Block a client, with your reason: their online bookings are refused in your policy's words (`online: refuse`, the default) or come as requests you approve (`online: request`). Blocking again changes the reason and `online`, not when the block began. Their confirmed bookings stay; cancel those yourself.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BlockCustomerBody"
              }
            }
          }
        },
        "tags": [
          "Customers"
        ],
        "operationId": "blockCustomer"
      }
    },
    "/v1/customers/{id}/unblock": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Lift a client's block, and its reason with it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "unblockCustomer"
      }
    },
    "/v1/accounts": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConnectAccountList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List your connected accounts in this mode, newest first. Filter with `status` (active, rejected, closed), `email` or `charges_enabled`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only accounts in this status: `active`, `rejected` or `closed`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "email",
            "in": "query",
            "required": false,
            "description": "Exactly this email address.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "charges_enabled",
            "in": "query",
            "required": false,
            "description": "`true`: only accounts that can take payments; `false`: only those that cannot yet.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Connect"
        ],
        "operationId": "listConnectedAccounts"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConnectAccountModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a connected account: a business your platform onboards and runs, with verification requirements to collect — on Tuppence's hosted onboarding, or given here and through `POST /v1/accounts/{id}`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateConnectAccountBody"
              }
            }
          }
        },
        "tags": [
          "Connect"
        ],
        "operationId": "createConnectedAccount"
      }
    },
    "/v1/accounts/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConnectAccountModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a connected account, with what verification still needs from it",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Connect"
        ],
        "operationId": "retrieveConnectedAccount"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConnectAccountModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a connected account: `email`, `business_profile`, `settings` and `metadata`. What identifies its people and bank account is given through onboarding. `external_account` needs `external_accounts:write` and `individual` or `company` need `persons:write`, as their own endpoints do: a restricted key can send neither.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateConnectAccountBody"
              }
            }
          }
        },
        "tags": [
          "Connect"
        ],
        "operationId": "updateConnectedAccount"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConnectAccountDeletedModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Close a connected account: in test mode at any time, in live mode once its balance is zero and nothing is in dispute. Nothing is deleted: the account stays retrievable, with `status: closed`, and disputes on its earlier payments are still recorded — but it can no longer be acted as, and nothing is paid out of it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Connect"
        ],
        "operationId": "deleteConnectedAccount"
      }
    },
    "/v1/accounts/{id}/store": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConnectStoreModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a connected account's store as your platform sees it: its address and status, and this month's store orders, revenue and your application fees on them.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Connect"
        ],
        "operationId": "retrieveConnectedAccountStore"
      }
    },
    "/v1/accounts/{id}/reject": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConnectAccountModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Reject a connected account — for `fraud`, `terms_of_service` or `other`. Its charges and payouts stop for good; reads and refunds of what it already took keep working.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RejectConnectAccountBody"
              }
            }
          }
        },
        "tags": [
          "Connect"
        ],
        "operationId": "rejectConnectedAccount"
      }
    },
    "/v1/account_links": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountLinkModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create an account link: a URL, good once and for five minutes, that opens Tuppence's hosted onboarding for one of your connected accounts, in your branding",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateAccountLinkBody"
              }
            }
          }
        },
        "tags": [
          "Connect"
        ],
        "operationId": "createAccountLink"
      }
    },
    "/v1/accounts/{id}/persons": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PersonList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The account's people, newest first — filtered by `relationship[owner]=true` and the like",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "relationship[representative]",
            "in": "query",
            "required": false,
            "description": "`true`: only the representative; `false`: everyone else.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "relationship[owner]",
            "in": "query",
            "required": false,
            "description": "`true`: only owners (25% or more).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "relationship[director]",
            "in": "query",
            "required": false,
            "description": "`true`: only directors.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "relationship[executive]",
            "in": "query",
            "required": false,
            "description": "`true`: only executives.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Persons"
        ],
        "operationId": "listPersons"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PersonModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Add a person to a company's account — its representative, an owner, a director or an executive",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PersonBody"
              }
            }
          }
        },
        "tags": [
          "Persons"
        ],
        "operationId": "createPerson"
      }
    },
    "/v1/accounts/{id}/persons/{person}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PersonModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a person",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "person",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Persons"
        ],
        "operationId": "retrievePerson"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PersonModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a person — what is sent goes on for verification",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "person",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PersonBody"
              }
            }
          }
        },
        "tags": [
          "Persons"
        ],
        "operationId": "updatePerson"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PersonDeletedModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Remove a person from the account",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "person",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Persons"
        ],
        "operationId": "deletePerson"
      }
    },
    "/v1/accounts/{id}/persons/{person}/identity_sessions": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PersonIdentityCheckModel"
                }
              },
              "*/*": {
                "schema": {}
              }
            },
            "description": "Success",
            "headers": {
              "Cache-Control": {
                "example": "no-store",
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Open an identity check (Stripe Identity) for a person, on your own page: an ID document, a selfie and a liveness check",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "person",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Persons"
        ],
        "operationId": "createPersonIdentitySession"
      }
    },
    "/v1/accounts/{id}/external_accounts": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExternalAccountList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The account's bank accounts, newest first",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Connect"
        ],
        "operationId": "listExternalAccounts"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExternalAccountModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Add a bank account for payouts — its details, which Tuppence keeps; a bank token is refused",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateExternalAccountBody"
              }
            }
          }
        },
        "tags": [
          "Connect"
        ],
        "operationId": "createExternalAccount"
      }
    },
    "/v1/accounts/{id}/external_accounts/{bank}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExternalAccountModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a bank account",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "bank",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Connect"
        ],
        "operationId": "retrieveExternalAccount"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExternalAccountModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Make a bank account the default for its currency",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "bank",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateExternalAccountBody"
              }
            }
          }
        },
        "tags": [
          "Connect"
        ],
        "operationId": "updateExternalAccount"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExternalAccountDeletedModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Remove a bank account — never the default for its currency",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "bank",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Connect"
        ],
        "operationId": "deleteExternalAccount"
      }
    },
    "/v1/files": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FileModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Upload a file for a connected account's verification — an ID document, proof of address or a company document, up to 10 MB",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "header",
            "name": "content-type",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          }
        },
        "tags": [
          "Files"
        ],
        "operationId": "createFile"
      }
    },
    "/v1/files/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FileModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a file: what it is for, its size and type",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Files"
        ],
        "operationId": "retrieveFile"
      }
    },
    "/v1/country_specs": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CountrySpecList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The countries a connected account can be in, and what each needs to be verified",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Connect"
        ],
        "operationId": "listCountrySpecs"
      }
    },
    "/v1/country_specs/{country}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CountrySpecModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "One country's spec",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "country",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Connect"
        ],
        "operationId": "retrieveCountrySpec"
      }
    },
    "/v1/application_fees": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationFeeList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List your application fees, newest first. Filter with `?account=acct_…`, `?payment=pay_…` and `?status=pending|available|swept`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Application fees"
        ],
        "operationId": "listApplicationFees"
      }
    },
    "/v1/application_fees/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationFeeModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve an application fee",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Application fees"
        ],
        "operationId": "retrieveApplicationFee"
      }
    },
    "/v1/application_fees/{id}/refunds": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FeeRefundList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List an application fee's refunds, newest first",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Application fees"
        ],
        "operationId": "listFeeRefunds"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FeeRefundModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Give some or all of an application fee back to the connected account it was taken from — the rest, by default.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FeeRefundBody"
              }
            }
          }
        },
        "tags": [
          "Application fees"
        ],
        "operationId": "createFeeRefund"
      }
    },
    "/v1/application_fees/{id}/refunds/{refund}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FeeRefundModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve one of an application fee's refunds",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "refund",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Application fees"
        ],
        "operationId": "retrieveFeeRefund"
      }
    },
    "/v1/transfers": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TransferList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List your transfers, newest first. Filter with `?destination=acct_…` and `?transfer_group=`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Transfers"
        ],
        "operationId": "listTransfers"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TransferModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Send money from your Connect balance's available part to one of your connected accounts. More than is available is 402 balance_insufficient, with `available`. Decided as a payout is, sharing the payout limits: 403 payouts_not_approved, new_account_floor (with `available_from`), payouts_on_hold or payout_limit (with `fix_url`) say why it can't go. The account can pay it out 7 days after it arrives.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateTransferBody"
              }
            }
          }
        },
        "tags": [
          "Transfers"
        ],
        "operationId": "createTransfer"
      }
    },
    "/v1/transfers/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TransferModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a transfer",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Transfers"
        ],
        "operationId": "retrieveTransfer"
      }
    },
    "/v1/transfers/{id}/reversals": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TransferReversalList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List a transfer's reversals, newest first",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Transfers"
        ],
        "operationId": "listTransferReversals"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TransferReversalModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Take some or all of a transfer back — the rest, by default — while the account still holds it (402 balance_insufficient, naming the account, when it does not).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReverseTransferBody"
              }
            }
          }
        },
        "tags": [
          "Transfers"
        ],
        "operationId": "createTransferReversal"
      }
    },
    "/v1/transfers/{id}/reversals/{reversal}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TransferReversalModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve one of a transfer's reversals",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "reversal",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Transfers"
        ],
        "operationId": "retrieveTransferReversal"
      }
    },
    "/v1/account/live_connect": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LiveConnectModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "description": "Live connected accounts need three things (60-13): payouts approved after our review, the platform live for 30 days, and the current Platform Agreement accepted. Each condition says whether it is met, why not, when it will be (`available_from`) and where to fix it (`fix_url`).",
        "summary": "Whether this platform's live connected accounts are on, and what they still need",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Connect"
        ],
        "operationId": "retrieveLiveConnect"
      }
    },
    "/v1/accounts/{id}/capabilities": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CapabilityList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A connected account's capabilities: `card_payments`, `transfers` and `card_issuing`",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Connect"
        ],
        "operationId": "listConnectedAccountCapabilities"
      }
    },
    "/v1/accounts/{id}/capabilities/{capability}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CapabilityModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve one of a connected account's capabilities",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "capability",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Connect"
        ],
        "operationId": "retrieveConnectedAccountCapability"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CapabilityModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Request a capability. `card_payments` and `transfers` are always on, together; `card_issuing` takes `tos_acceptance` — Stripe's Issuing terms, as the account's representative accepted them.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "capability",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateCapabilityBody"
              }
            }
          }
        },
        "tags": [
          "Connect"
        ],
        "operationId": "updateConnectedAccountCapability"
      }
    },
    "/v1/test_helpers/accounts/{id}/verify": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConnectAccountModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: a connected account passes verification with the test values — it can take payments at once",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersVerifyConnectedAccount"
      }
    },
    "/v1/test_helpers/accounts/{id}/requirements": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConnectAccountModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: set what verification asks of a connected account — `currently_due`, `past_due`, `pending_verification`, `disabled_reason`, `current_deadline` — and see what follows (simulated Stripe only)",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TestRequirementsBody"
              }
            }
          }
        },
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersSetConnectedAccountRequirements"
      }
    },
    "/v1/customers/{id}/notes": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerNoteList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A client's notes you may read, pinned first, then the newest. Private notes are for owners, admins, managers and keys; clinical ones for owners, admins and managers in the dashboard.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "listCustomerNotes"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerNoteModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Write a note on a client: `shared` (everyone who works with them), `private` (owners, admins and managers) or `clinical` (health information: encrypted, the dashboard's alone).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateNoteBody"
              }
            }
          }
        },
        "tags": [
          "Customers"
        ],
        "operationId": "createCustomerNote"
      }
    },
    "/v1/customers/{id}/notes/{note}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerNoteModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a note on a client — one you may read",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "note",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "retrieveCustomerNote"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerNoteModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change a note's words or pin it. Its kind stays what it was.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "note",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateNoteBody"
              }
            }
          }
        },
        "tags": [
          "Customers"
        ],
        "operationId": "updateCustomerNote"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerNoteDeleted"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Delete a note on a client",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "note",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "deleteCustomerNote"
      }
    },
    "/v1/customers/{id}/export": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerExportModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Everything you keep about a client, in one document — for a subject-access request: the record, their pets and children, notes, forms (the signatures as files), bookings, messages, payments, cards and credit, and what the online store keeps (`store`). Read with your own rights: `withheld` names what you may not read. Logged without its body.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "exportCustomer"
      }
    },
    "/v1/customers/{id}/delete": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Delete a client, for an erasure request: their details, notes, pets and children, form answers and signatures, what they typed when booking and the addresses their messages went to — and every copy in events and logs. From the online store: their contact and street address on baskets, checkouts and orders, delivery notes, gift messages, the words and photos of their returns, and their alerts. Their payments, refunds, the ledger, order lines and tax records (with the postcode) stay exactly as they were, with no one's name on them. Refused while they have a booking to come, a subscription running, an order on its way or a return open. Cannot be undone.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "deleteCustomer"
      }
    },
    "/v1/customers/{id}/consents": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConsentList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A client's consent log, newest first: each time they gave or withdrew consent — on your booking page, from their booking's link, at your desk, through the API or by the link in your marketing — with the version and words they were shown.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "listCustomerConsents"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConsentModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Record what a client told you: consent to marketing with your booking page's words now (you must have written some), or its withdrawal. It goes on their record and in the log.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ConsentBody"
              }
            }
          }
        },
        "tags": [
          "Customers"
        ],
        "operationId": "createCustomerConsent"
      }
    },
    "/v1/store_privacy_requests": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StorePrivacyRequestList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Shoppers' requests about their data, newest first: a copy (`export`) or deletion (`erasure`), asked from their order's page, each due 30 days after it arrived. Filter by `customer` or `status` (`open`, `done`).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "customer",
            "in": "query",
            "required": false,
            "description": "Only this customer's requests (`cus_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only requests in this status: `open` or `done`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "listStorePrivacyRequests"
      }
    },
    "/v1/store_privacy_requests/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StorePrivacyRequestModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a shopper's request about their data",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "getStorePrivacyRequest"
      }
    },
    "/v1/store_privacy_requests/{id}/complete": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StorePrivacyRequestModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Answer a shopper's request. An export: their data goes on their order's page to download for 30 days. An erasure: the customer is deleted as `POST /v1/customers/{id}/delete` does, refused while an order of theirs is on its way or a return is open. Answering again returns the same.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "completeStorePrivacyRequest"
      }
    },
    "/v1/privacy_settings": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PrivacySettingsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "How long you keep client records: clinical notes and clinical forms' answers (7 years unless you say), and every other note and form answer (3). Older ones are deleted each night.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "retrievePrivacySettings"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PrivacySettingsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Set how many years you keep client records — each a whole number from 1 to 30; what you leave out stays as it was. Shortening one deletes what is older at the next nightly purge.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PrivacySettingsBody"
              }
            }
          }
        },
        "tags": [
          "Customers"
        ],
        "operationId": "updatePrivacySettings"
      }
    },
    "/v1/customers/{id}/subjects": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClientSubjectList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Who or what a client's visits are for — their pets, children or vehicles, newest first",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "listClientSubjects"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClientSubjectModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Add a pet, a child, a vehicle or something else to a client's record — its kind's fields, and only those",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateSubjectBody"
              }
            }
          }
        },
        "tags": [
          "Customers"
        ],
        "operationId": "createClientSubject"
      }
    },
    "/v1/customers/{id}/subjects/{subject}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClientSubjectModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve one of a client's subjects",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "subject",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "retrieveClientSubject"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClientSubjectModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change a subject's name or fields, or archive it. Its kind stays what it was.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "subject",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateSubjectBody"
              }
            }
          }
        },
        "tags": [
          "Customers"
        ],
        "operationId": "updateClientSubject"
      }
    },
    "/v1/forms": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FormList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The account's forms, newest first — `?status=archived` for the archived ones",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "`active` (the default) or `archived`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Forms"
        ],
        "operationId": "listForms"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FormModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Make a form — from a template, or from its questions",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateFormBody"
              }
            }
          }
        },
        "tags": [
          "Forms"
        ],
        "operationId": "createForm"
      }
    },
    "/v1/forms/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FormModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a form — `?version=` for an earlier version's questions",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "version",
            "in": "query",
            "required": false,
            "description": "An earlier version's questions, by its number.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Forms"
        ],
        "operationId": "retrieveForm"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FormModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change a form: its name, its questions (a new version — the old one's are kept), the services it is for, a patch test's days, or archive it",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateFormBody"
              }
            }
          }
        },
        "tags": [
          "Forms"
        ],
        "operationId": "updateForm"
      }
    },
    "/v1/form_templates": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FormTemplateList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The templates a form can start from: a consultation, three consents, two intakes, a pet's intake and a patch test",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Forms"
        ],
        "operationId": "listFormTemplates"
      }
    },
    "/v1/form_responses": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FormResponseList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Responses, newest first — a client's (`?customer=`, which a staff login always names), a booking's (`?booking=`) or a form's (`?form=`)",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "customer",
            "in": "query",
            "required": false,
            "description": "Only this client's (`cus_…`). A staff login always names one.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "booking",
            "in": "query",
            "required": false,
            "description": "Only this booking's (`bk_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "form",
            "in": "query",
            "required": false,
            "description": "Only this form's (`form_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Forms"
        ],
        "operationId": "listFormResponses"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FormResponseModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Record a client's answers to a form — its version in use — with the drawn signature where it asks for one, and a patch test's result",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateFormResponseBody"
              }
            }
          }
        },
        "tags": [
          "Forms"
        ],
        "operationId": "createFormResponse"
      }
    },
    "/v1/form_responses/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FormResponseModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a response, against the questions of the version it answered",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Forms"
        ],
        "operationId": "retrieveFormResponse"
      }
    },
    "/v1/form_responses/{id}/signature": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "image/png": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A response's drawn signature, as re-encoded by Tuppence — never at a public URL",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Forms"
        ],
        "operationId": "retrieveFormResponseSignature"
      }
    },
    "/v1/payments": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List payments, newest first. Filter with `?status=`, `?customer=` and `?booking=` (a booking's payments).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only payments in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "customer",
            "in": "query",
            "required": false,
            "description": "Only this customer's (`cus_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "booking",
            "in": "query",
            "required": false,
            "description": "Only those towards this booking (`bk_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payments"
        ],
        "operationId": "listPayments"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a payment. Nothing is charged until a card is presented (confirm).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreatePaymentBody"
              }
            }
          }
        },
        "tags": [
          "Payments"
        ],
        "operationId": "createPayment"
      }
    },
    "/v1/payments/charge_saved": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "402": {
            "$ref": "#/components/responses/PaymentFailed"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Charge a card a customer saved, with nobody there. Always returns the payment: check `status`. `authentication_required` means bring the payer back via `approval_url`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ChargeSavedBody"
              }
            }
          }
        },
        "tags": [
          "Payments"
        ],
        "operationId": "chargeSavedCard"
      }
    },
    "/v1/payments/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a payment. With a publishable key, send its client secret in `Tuppence-Client-Secret`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payments"
        ],
        "operationId": "retrievePayment"
      }
    },
    "/v1/payments/{id}/confirm": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "402": {
            "$ref": "#/components/responses/PaymentFailed"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Present a card. The fee is computed from the card and fixed at this moment.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ConfirmPaymentBody"
              }
            }
          }
        },
        "tags": [
          "Payments"
        ],
        "operationId": "confirmPayment"
      }
    },
    "/v1/payments/{id}/capture": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Capture a manually-captured payment, in full or in part",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CapturePaymentBody"
              }
            }
          }
        },
        "tags": [
          "Payments"
        ],
        "operationId": "capturePayment"
      }
    },
    "/v1/payments/{id}/cancel": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Cancel a payment that has not succeeded",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payments"
        ],
        "operationId": "cancelPayment"
      }
    },
    "/v1/refunds": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RefundList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List refunds, newest first. Filter with `?payment=`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "payment",
            "in": "query",
            "required": false,
            "description": "Only those for this payment (`pay_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Refunds"
        ],
        "operationId": "listRefunds"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RefundModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Refund a payment, in full or in part. The payer gets the whole amount back; our fee is not returned.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateRefundBody"
              }
            }
          }
        },
        "tags": [
          "Refunds"
        ],
        "operationId": "createRefund"
      }
    },
    "/v1/refunds/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RefundModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a refund",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Refunds"
        ],
        "operationId": "retrieveRefund"
      }
    },
    "/v1/balance": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BalanceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The account's balance, and what it is made of",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Balance"
        ],
        "operationId": "retrieveBalance"
      }
    },
    "/v1/balance/transactions": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BalanceTransactionList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Everything that moved the balance, newest first. Filter with `?type=` (one or more, comma-separated) and `?payout=po_…` (what that payout covered: everything since the payout before it). A platform reads its Connect balance's with `?balance=connect`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "type",
            "in": "query",
            "required": false,
            "description": "One or more types, comma-separated: `payment_succeeded`, `refund`, `refund_failed`, `dispute_opened`, `dispute_won`, `dispute_fee`, `credit_topup`, `credit_refund`, `payout`, `payout_failed`, `instant_payout_fee`, `negative_balance_debit`, `negative_balance_debit_failed`, `loss_written_off`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "payout",
            "in": "query",
            "required": false,
            "description": "What this payout (`po_…`) covered: everything since the payout before it, up to it.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Balance"
        ],
        "operationId": "listBalanceTransactions"
      }
    },
    "/v1/reports/summary": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReportModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Volume, fees, refunds and net per UTC day. Defaults to the last 30 days.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "First day, `YYYY-MM-DD` (UTC). Defaults to 30 days ago.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "Last day, `YYYY-MM-DD` (UTC), inclusive. Defaults to today.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Reporting"
        ],
        "operationId": "retrieveReportSummary"
      }
    },
    "/v1/reports/summary.csv": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "text/csv": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The same report as CSV (amounts in minor units)",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "First day, `YYYY-MM-DD` (UTC). Defaults to 30 days ago.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "Last day, `YYYY-MM-DD` (UTC), inclusive. Defaults to today.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Reporting"
        ],
        "operationId": "downloadReportSummaryCsv"
      }
    },
    "/v1/reports/payments.csv": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "text/csv": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Every payment made in the range as CSV, one row each with how it was paid (amounts in minor units; at most 10,000 rows). Defaults to the last 30 days.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "First day, `YYYY-MM-DD` (UTC). Defaults to 30 days ago.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "Last day, `YYYY-MM-DD` (UTC), inclusive. Defaults to today.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Reporting"
        ],
        "operationId": "downloadPaymentsCsv"
      }
    },
    "/v1/payment_links": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentLinkList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List payment links, newest first. Filter with `?status=`; `?query=` finds a link by its id or the start of its name.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only links in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "description": "A link's id, or the START of its name (case-insensitive; prefix, not substring).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payment links"
        ],
        "operationId": "listPaymentLinks"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentLinkModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a payment link — share its `url` and get paid",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PaymentLinkBody"
              }
            }
          }
        },
        "tags": [
          "Payment links"
        ],
        "operationId": "createPaymentLink"
      }
    },
    "/v1/payment_links/{id}/qr": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "image/svg+xml": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A QR code of the link's URL — SVG by default, or `?format=png`; `?size=` 64–1024 px",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "required": false,
            "name": "format",
            "schema": {
              "type": "string",
              "enum": [
                "svg",
                "png"
              ]
            }
          },
          {
            "in": "query",
            "required": false,
            "name": "size",
            "schema": {
              "type": "integer",
              "maximum": 1024,
              "minimum": 64,
              "multipleOf": 1
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payment links"
        ],
        "operationId": "retrievePaymentLinkQr"
      }
    },
    "/v1/payment_links/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentLinkModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a payment link",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payment links"
        ],
        "operationId": "retrievePaymentLink"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentLinkModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a link's name, description, completion message, redirect or metadata",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PaymentLinkBody"
              }
            }
          }
        },
        "tags": [
          "Payment links"
        ],
        "operationId": "updatePaymentLink"
      }
    },
    "/v1/payment_links/{id}/image": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentLinkModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Give the link a photo of what it sells (PNG or JPEG, ≤ 512 KB): shown above its name on the pay page and on its preview card. Re-encoded by Tuppence.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PaymentLinkImageBody"
              }
            }
          }
        },
        "tags": [
          "Payment links"
        ],
        "operationId": "setPaymentLinkImage"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentLinkModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Remove the link's photo",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payment links"
        ],
        "operationId": "removePaymentLinkImage"
      }
    },
    "/v1/payment_links/{id}/share_image": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentLinkModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Give the link its own preview image for chats and social posts (PNG or JPEG, ≤ 700 KB): cropped to 1200×630, re-encoded, and shown in place of the drawn card.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PaymentLinkImageBody"
              }
            }
          }
        },
        "tags": [
          "Payment links"
        ],
        "operationId": "setPaymentLinkShareImage"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentLinkModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Remove the link's own preview image: it uses the account's, or the drawn card",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payment links"
        ],
        "operationId": "removePaymentLinkShareImage"
      }
    },
    "/v1/payment_links/{id}/unpause": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentLinkModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Take payments again on a link we paused, once you have looked. Some pauses only Tuppence can lift: those answer `403 permission_denied` and say to contact us.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payment links"
        ],
        "operationId": "unpausePaymentLink"
      }
    },
    "/v1/payment_links/{id}/expire": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentLinkModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Stop a link taking payments. Payments already made are untouched.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payment links"
        ],
        "operationId": "expirePaymentLink"
      }
    },
    "/v1/ticketing/events": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketedEventList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List events, newest first. Filter with `?status=` (draft, on_sale, ended, cancelled).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only events in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticketed events"
        ],
        "operationId": "listTicketedEvents"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketedEventModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create an event, as a draft: a title and `starts_at` are enough. Refunds until a day before, a reminder 24 hours before, no capacity limit, the account's timezone and currency, and a public page are the defaults.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TicketedEventBody"
              }
            }
          }
        },
        "tags": [
          "Ticketed events"
        ],
        "operationId": "createTicketedEvent"
      }
    },
    "/v1/ticketing/events/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketedEventModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve an event, with its dates",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticketed events"
        ],
        "operationId": "retrieveTicketedEvent"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketedEventModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update an event. `starts_at`, `ends_at`, `doors_at` and `capacity` change a one-date event's date; moving the start keeps its length.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TicketedEventBody"
              }
            }
          }
        },
        "tags": [
          "Ticketed events"
        ],
        "operationId": "updateTicketedEvent"
      }
    },
    "/v1/ticketing/events/{id}/dates": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketedEventModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Add dates to an event: one (`starts_at`), a list (`dates`), or a weekly or monthly series from a first date (`starts_at` with `repeat`). Dates that start when one of the event's already does are skipped.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EventDatesBody"
              }
            }
          }
        },
        "tags": [
          "Ticketed events"
        ],
        "operationId": "addTicketedEventDates"
      }
    },
    "/v1/ticketing/events/{id}/dates/{date}": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketedEventModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Move one date or change its capacity. Moving the start keeps its length. Ticket money for the date stays held until the new end has passed.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "date",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EventDateUpdateBody"
              }
            }
          }
        },
        "tags": [
          "Ticketed events"
        ],
        "operationId": "updateTicketedEventDate"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketedEventModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Remove a date that has no orders and that no ticket type is for. An event keeps at least one date.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "date",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticketed events"
        ],
        "operationId": "removeTicketedEventDate"
      }
    },
    "/v1/ticketing/events/{id}/publish": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketedEventModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Put a draft event on sale: its page opens and `event.published` is sent",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticketed events"
        ],
        "operationId": "publishTicketedEvent"
      }
    },
    "/v1/ticketing/events/{id}/cancel": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketedEventModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Cancel an event: it comes off sale for good, every ticket is voided, and every buyer gets their money back in full, once. `event.cancelled` is sent now; the refunds follow within minutes.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticketed events"
        ],
        "operationId": "cancelTicketedEvent"
      }
    },
    "/v1/ticketing/events/{id}/unpublish": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketedEventModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Take an event off sale, back to a draft. Tickets already sold stay valid.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticketed events"
        ],
        "operationId": "unpublishTicketedEvent"
      }
    },
    "/v1/ticket_types": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketTypeList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List ticket types, newest first. `?event=` for one event's.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "event",
            "in": "query",
            "required": false,
            "description": "Only this event's (`tev_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticket types"
        ],
        "operationId": "listTicketTypes"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketTypeModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Add a ticket type to an event: a name, and a `price` for a paid one (none makes it free). Up to five `price_phases` (early bird until a time or a number sold) come before the base price.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TicketTypeBody"
              }
            }
          }
        },
        "tags": [
          "Ticket types"
        ],
        "operationId": "createTicketType"
      }
    },
    "/v1/ticket_types/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketTypeModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a ticket type, with the price a buyer is offered now",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticket types"
        ],
        "operationId": "retrieveTicketType"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketTypeModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a ticket type. Sending `price_phases` replaces them all.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TicketTypeBody"
              }
            }
          }
        },
        "tags": [
          "Ticket types"
        ],
        "operationId": "updateTicketType"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketTypeModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Take a ticket type off sale for good (`status: archived`). Tickets already sold stay valid.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticket types"
        ],
        "operationId": "archiveTicketType"
      }
    },
    "/v1/pos/door_stock": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DoorStockList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The tickets a till sells at the door: each ticket type linked to a product, for its next date, with how many are left and how many the till may sell while offline.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticket types"
        ],
        "operationId": "listDoorStock"
      }
    },
    "/v1/ticketing/check_in_events": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CheckInEventList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The events a device can check guests in for: not cancelled, with a date still to come or under way, soonest first. What a till offers before it downloads a guest list.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Check-ins"
        ],
        "operationId": "listCheckInEvents"
      }
    },
    "/v1/ticketing/events/{id}/check_in_manifest": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CheckInManifestModel"
                }
              },
              "*/*": {
                "schema": {}
              }
            },
            "description": "Success",
            "headers": {
              "Cache-Control": {
                "example": "no-store",
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The guest list a device checks guests in from: every ticket with its holder's name, type, date and status, and the event's verification key for checking codes offline. Ask again every `refresh_after` seconds while online.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Check-ins"
        ],
        "operationId": "retrieveCheckInManifest"
      }
    },
    "/v1/ticketing/events/{id}/check_in_counts": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CheckInCountsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "How the door is going: tickets issued and checked in, by gate and by ticket type, and when the last scan was. The dashboard's check-in panel polls it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Check-ins"
        ],
        "operationId": "retrieveCheckInCounts"
      }
    },
    "/v1/ticketing/check_ins": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CheckInList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List scans at the door, newest first. `?event=` for one event's, `?ticket=` for one ticket's.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "event",
            "in": "query",
            "required": false,
            "description": "Only this event's (`tev_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "ticket",
            "in": "query",
            "required": false,
            "description": "Only this ticket's (`tkt_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Check-ins"
        ],
        "operationId": "listCheckIns"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CheckInModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Check a guest in: a scanned `code`, a `short_code` read out, or a `ticket` found by name. The first scan of a ticket is `admitted`; a later one is `duplicate`, with the gate that admitted it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CheckInScanBody"
              }
            }
          }
        },
        "tags": [
          "Check-ins"
        ],
        "operationId": "checkInTicket"
      }
    },
    "/v1/ticketing/check_ins/sync": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CheckInSyncModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Send the scans a device made offline. They are applied in the order they were made, so the first scan of each ticket wins whichever device sent it; the answer is one result per scan, in the order sent.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CheckInSyncBody"
              }
            }
          }
        },
        "tags": [
          "Check-ins"
        ],
        "operationId": "syncCheckIns"
      }
    },
    "/v1/ticket_orders": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketOrderList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List ticket orders, newest first. `?event=` for one event's, `?status=` (pending, requested, paid, declined, expired, failed) for those in one state: `requested` for the requests waiting for approval.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "event",
            "in": "query",
            "required": false,
            "description": "Only this event's (`tev_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only orders in this status: `pending`, `requested` (waiting for approval), `paid`, `declined`, `expired` or `failed`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticket orders"
        ],
        "operationId": "listTicketOrders"
      }
    },
    "/v1/ticket_orders/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketOrderModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a ticket order: the buyer, its lines at the prices held, its payment",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticket orders"
        ],
        "operationId": "retrieveTicketOrder"
      }
    },
    "/v1/ticket_orders/{id}/approve": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketOrderModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Approve a request for an approval-only event: the card's authorisation is captured and the tickets are issued (`ticket_order.paid`). A free request is issued at once.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticket orders"
        ],
        "operationId": "approveTicketOrder"
      }
    },
    "/v1/ticket_orders/{id}/decline": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketOrderModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Decline a request for an approval-only event: the authorisation is cancelled, so the hold on the buyer's card is released, and the seats go back on sale (`ticket_order.declined`).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticket orders"
        ],
        "operationId": "declineTicketOrder"
      }
    },
    "/v1/ticket_orders/{id}/refund": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketOrderRefundModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Refund a paid order, in full or by tickets: the tickets are voided, their seats go back on sale if the date hasn't started, and their share of the order goes back to the buyer. Sends `ticket.refunded` per ticket and `ticket_order.refunded`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TicketOrderRefundBody"
              }
            }
          }
        },
        "tags": [
          "Ticket orders"
        ],
        "operationId": "refundTicketOrder"
      }
    },
    "/v1/tickets": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List tickets, newest first. `?order=` for one order's, `?event=` for one event's, `?status=` (valid, checked_in, void) for those in one state.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "order",
            "in": "query",
            "required": false,
            "description": "Only this order's (`tord_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "event",
            "in": "query",
            "required": false,
            "description": "Only this event's (`tev_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only tickets in this status: `valid`, `checked_in` or `void`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Tickets"
        ],
        "operationId": "listTickets"
      }
    },
    "/v1/tickets/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a ticket: its holder, status and short code (never its signing secret)",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Tickets"
        ],
        "operationId": "retrieveTicket"
      }
    },
    "/v1/tickets/{id}/transfer": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketTransferResultModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Give a valid ticket to someone else: it is voided and a new ticket (a new code) is issued in their name and emailed to them, in one step. The old holder is told. Sends `ticket.transferred` and `ticket.issued`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TicketTransferBody"
              }
            }
          }
        },
        "tags": [
          "Tickets"
        ],
        "operationId": "transferTicket"
      }
    },
    "/v1/tickets/{id}/return": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Give a ticket back to its sold-out event's waitlist, to sell at face value (no fee). It stays valid until it sells; then it is voided and its holder refunded what they paid. A free ticket is cancelled at once. Sends `ticket.transferred` when it sells.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Tickets"
        ],
        "operationId": "returnTicket"
      }
    },
    "/v1/ticketing/funds_holds": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketFundsHoldList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List ticket money held until after each event, newest first: per date, how much and when it is released. `?event=` for one event's.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "event",
            "in": "query",
            "required": false,
            "description": "Only this event's (`tev_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticketed events"
        ],
        "operationId": "listTicketFundsHolds"
      }
    },
    "/v1/ticketing/reports/sales": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketSalesReportModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Ticket sales over a range of UTC days, by the day each order was paid: totals, by event, by ticket type and by where buyers came from (`utm_*`). `?from=&to=` (`YYYY-MM-DD`, the last 30 days by default) and `?event=`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "First day, `YYYY-MM-DD` (UTC). Defaults to 30 days ago.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "Last day, `YYYY-MM-DD` (UTC), inclusive. Defaults to today.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "event",
            "in": "query",
            "required": false,
            "description": "Only this event's orders (`tev_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticketed events"
        ],
        "operationId": "retrieveTicketSalesReport"
      }
    },
    "/v1/ticketing/reports/sales.csv": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "text/csv": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Ticket sales by event as CSV (amounts in minor units)",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "First day, `YYYY-MM-DD` (UTC). Defaults to 30 days ago.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "Last day, `YYYY-MM-DD` (UTC), inclusive. Defaults to today.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "event",
            "in": "query",
            "required": false,
            "description": "Only this event's orders (`tev_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticketed events"
        ],
        "operationId": "downloadTicketSalesReportCsv"
      }
    },
    "/v1/ticketing/events/{id}/settlement": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketSettlementModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "An event's settlement statement: gross, discounts, refunds, fees and net over all its orders, and how much of its money is held until after the event, released, or used for refunds.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticketed events"
        ],
        "operationId": "retrieveTicketedEventSettlement"
      }
    },
    "/v1/ticketing/events/{id}/settlement.csv": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "text/csv": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The settlement statement as CSV: one `line,value` row each, amounts in minor units",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticketed events"
        ],
        "operationId": "downloadTicketedEventSettlementCsv"
      }
    },
    "/v1/ticketing/promo_codes": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketPromoCodeList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List promo and access codes, newest first. `?event=` for one event's own codes.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "event",
            "in": "query",
            "required": false,
            "description": "Only this event's own codes (`tev_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticket promo codes"
        ],
        "operationId": "listTicketPromoCodes"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketPromoCodeModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a promo or access code: `percent_off` or `amount_off` off each ticket, `unlocks` for hidden and code-only tickets, or both. For every event unless `event` is set.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TicketPromoCodeBody"
              }
            }
          }
        },
        "tags": [
          "Ticket promo codes"
        ],
        "operationId": "createTicketPromoCode"
      }
    },
    "/v1/ticketing/promo_codes/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketPromoCodeModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a promo or access code, with how often it has been used",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticket promo codes"
        ],
        "operationId": "retrieveTicketPromoCode"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketPromoCodeModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a promo or access code. `active: false` switches it off.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TicketPromoCodeBody"
              }
            }
          }
        },
        "tags": [
          "Ticket promo codes"
        ],
        "operationId": "updateTicketPromoCode"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketPromoCodeModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Delete a code nobody has used. A used code is switched off instead, with `active: false`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticket promo codes"
        ],
        "operationId": "deleteTicketPromoCode"
      }
    },
    "/v1/ticketing/waitlist": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EventWaitlistList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List an event's waitlist, newest first: who is waiting, offered a ticket, or got one. `?event=` for one event's.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "event",
            "in": "query",
            "required": false,
            "description": "Only this event's (`tev_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticketed events"
        ],
        "operationId": "listEventWaitlist"
      }
    },
    "/v1/ticketing/commissions": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketCommissionList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List affiliate commission on your ticket sales, newest first. `?event=` for one event's.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "event",
            "in": "query",
            "required": false,
            "description": "Only this event's (`tev_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticket promo codes"
        ],
        "operationId": "listTicketCommissions"
      }
    },
    "/v1/ticketing/events/{id}/messages": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EventMessageList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List an event's messages to attendees, newest first",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticketed events"
        ],
        "operationId": "listEventMessages"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EventMessageModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Message an event's attendees, now or at `send_at`: email to every paid buyer in the segment, and a text or WhatsApp message to those who agreed at checkout. Each buyer gets it once per channel.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EventMessageBody"
              }
            }
          }
        },
        "tags": [
          "Ticketed events"
        ],
        "operationId": "createEventMessage"
      }
    },
    "/v1/ticketing/messages/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EventMessageModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a message to attendees, with who it reaches and what was sent",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticketed events"
        ],
        "operationId": "retrieveEventMessage"
      }
    },
    "/v1/ticketing/messages/{id}/cancel": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EventMessageModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Call off a scheduled message before it is sent",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticketed events"
        ],
        "operationId": "cancelEventMessage"
      }
    },
    "/v1/ticketing/settings": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketingSettingsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve the settings every event uses: the ad pixels its page loads",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Ticketed events"
        ],
        "operationId": "retrieveTicketingSettings"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TicketingSettingsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Set the ad pixels (Meta, TikTok, Google Analytics 4) every event page loads unless the event has its own. They load only after the buyer agrees to marketing cookies.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TicketingSettingsBody"
              }
            }
          }
        },
        "tags": [
          "Ticketed events"
        ],
        "operationId": "updateTicketingSettings"
      }
    },
    "/v1/payouts": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayoutList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List payouts, newest first",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payouts"
        ],
        "operationId": "listPayouts"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayoutModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Pay out to the bank account on file: everything cleared, or the amount you name — or instantly (`method: instant`, 0.99% taken out of the amount)",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreatePayoutBody"
              }
            }
          }
        },
        "tags": [
          "Payouts"
        ],
        "operationId": "createPayout"
      }
    },
    "/v1/payouts/instant/quote": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InstantPayoutQuoteModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What an instant move of `amount` would cost (0.99%, taken out of it) and what would arrive — at your bank, or (`destination=card_balance`) on your card balance — and when, whether you can make one now, and the most that could go",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "description": "What would leave your balance, in minor units — the fee comes out of it. Defaults to the most that could go now.",
            "in": "query",
            "name": "amount",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Where the money would go: `bank` (the default — an instant payout to your bank account) or `card_balance` (pending money onto your cards' balance, UK only). A destination you can't use yet still answers, with `available: false` and the reason.",
            "in": "query",
            "name": "destination",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "bank",
                "card_balance"
              ]
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payouts"
        ],
        "operationId": "retrieveInstantPayoutQuote"
      }
    },
    "/v1/payouts/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayoutModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a payout",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payouts"
        ],
        "operationId": "retrievePayout"
      }
    },
    "/v1/payouts/{id}/reconciliation": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayoutReconciliationModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What a payout covered: the balance after the payout before it, everything since, this payout, and what was left",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payouts"
        ],
        "operationId": "retrievePayoutReconciliation"
      }
    },
    "/v1/payout_settings": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayoutSettingsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The automatic payout schedule, the next run, the bank account payouts go to — and next-day payouts (UK)",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payouts"
        ],
        "operationId": "retrievePayoutSettings"
      }
    },
    "/v1/payout_settings/next_day": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NextDayModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BadRequest"
                }
              }
            },
            "description": "Bad Request"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Forbidden"
                }
              }
            },
            "description": "Forbidden"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Switch next-day payouts on or off (UK): money from each payment paid out the day after it's taken, for 0.2% on each payment from then on. Available two weeks after your first payment, once `next_day.available` says so; refused with the reason otherwise",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SetNextDayBody"
              }
            }
          }
        },
        "tags": [
          "Payouts"
        ],
        "operationId": "setNextDayPayouts"
      }
    },
    "/v1/settlement_requests": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SettlementRequestList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Your next-day payouts history, newest first: each time they were switched on (by you or by us) and off, and why",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payouts"
        ],
        "operationId": "listSettlementRequests"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SettlementRequestModel"
                }
              }
            },
            "description": "Never returned since next-day payouts became a switch (61-06): every call answers 410."
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "410": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Gone"
                }
              }
            },
            "description": "Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "deprecated": true,
        "summary": "Gone: next-day payouts are no longer requested. Switch them on with `POST /v1/payout_settings/next_day` (`410 use_payout_settings`)",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payouts"
        ],
        "operationId": "createSettlementRequest"
      }
    },
    "/v1/test_helpers/balance/make_available": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BalanceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: on the simulated gateway, settle pending funds into the available balance. Elsewhere, pending money is released on the card's own schedule: pay with `pm_card_bypassPending` to have it available at once",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersMakeFundsAvailable"
      }
    },
    "/v1/test_helpers/payouts/{id}/settle": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayoutModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: the payout as the bank settled it (`paid` or `failed`). A test payout settles by itself, by its bank account's number: to see one fail, pay out to sort code 108800, account 11111116",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SettlePayoutBody"
              }
            }
          }
        },
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersSettlePayout"
      }
    },
    "/v1/bank_debits": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BankDebitList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List money taken from your bank account to bring a negative balance back to zero, newest first",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payouts"
        ],
        "operationId": "listBankDebits"
      }
    },
    "/v1/bank_debits/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BankDebitModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a debit of your bank account",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Payouts"
        ],
        "operationId": "retrieveBankDebit"
      }
    },
    "/v1/disputes": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DisputeList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List disputes, newest first. Filter with `payment` or `status`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "payment",
            "in": "query",
            "required": false,
            "description": "Only those for this payment (`pay_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only disputes in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Disputes"
        ],
        "operationId": "listDisputes"
      }
    },
    "/v1/disputes/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DisputeModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a dispute",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Disputes"
        ],
        "operationId": "retrieveDispute"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DisputeModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Save evidence for a dispute. Nothing is sent to the bank until you submit.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateDisputeBody"
              }
            }
          }
        },
        "tags": [
          "Disputes"
        ],
        "operationId": "updateDisputeEvidence"
      }
    },
    "/v1/disputes/{id}/submit": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DisputeModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Send the saved evidence to the cardholder's bank. This can be done ONCE.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Disputes"
        ],
        "operationId": "submitDispute"
      }
    },
    "/v1/test_helpers/payments/{id}/dispute": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DisputeModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: have the cardholder's bank dispute a succeeded payment — or, for a Direct Debit (Bacs or SEPA), the payer claim it back",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SimulateDisputeBody"
              }
            }
          }
        },
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersDisputePayment"
      }
    },
    "/v1/test_helpers/disputes/{id}/close": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DisputeModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: have the bank decide a dispute — `won` or `lost`",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CloseDisputeBody"
              }
            }
          }
        },
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersCloseDispute"
      }
    },
    "/v1/request_logs": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RequestLogList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Your API requests from the last 30 days, newest first. Filter with `status_class` (2xx, 4xx, 5xx), `method`, `path_prefix`, `api_key` or `account` (the connected account a request was made as). With `Tuppence-Account`, the requests made as that account.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status_class",
            "in": "query",
            "required": false,
            "description": "`2xx`, `4xx` or `5xx`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "method",
            "in": "query",
            "required": false,
            "description": "`GET`, `POST` or `DELETE`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "path_prefix",
            "in": "query",
            "required": false,
            "description": "Requests whose path starts with this.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "api_key",
            "in": "query",
            "required": false,
            "description": "Requests made with this key (`key_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Request logs"
        ],
        "operationId": "listRequestLogs"
      }
    },
    "/v1/request_logs/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RequestLogModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "One request: what was sent and what we answered, with secrets redacted",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Request logs"
        ],
        "operationId": "retrieveRequestLog"
      }
    },
    "/v1/account/branding": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BrandingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "How this business appears to its payers",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Account"
        ],
        "operationId": "retrieveBranding"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BrandingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Set the display name, accent colour, support contact, statement descriptor and link preview defaults",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BrandingBody"
              }
            }
          }
        },
        "tags": [
          "Account"
        ],
        "operationId": "updateBranding"
      }
    },
    "/v1/account/branding/logo": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BrandingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Upload a logo (PNG or JPEG, ≤ 512 KB, 32–1024 px a side). It is re-encoded before use.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LogoBody"
              }
            }
          }
        },
        "tags": [
          "Account"
        ],
        "operationId": "uploadBrandingLogo"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BrandingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Remove the logo",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Account"
        ],
        "operationId": "deleteBrandingLogo"
      }
    },
    "/v1/account/branding/share_image": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BrandingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Upload your own link preview image (PNG or JPEG, ≤ 700 KB). It is cropped to 1200×630 and re-encoded, and payment links show it in place of the drawn card.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShareImageBody"
              }
            }
          }
        },
        "tags": [
          "Account"
        ],
        "operationId": "uploadBrandingShareImage"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BrandingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Remove your own link preview image: links go back to the drawn card",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Account"
        ],
        "operationId": "deleteBrandingShareImage"
      }
    },
    "/v1/media": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MediaAssetList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List the media library, newest first. `?kind=image|video|document`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "kind",
            "in": "query",
            "required": false,
            "description": "`image`, `video` or `document`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "listMediaAssets"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MediaAssetModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Upload a photo (JPEG or PNG, re-encoded to at most 2048 px) or a video (MP4, H.264, at most 60 s, with a poster). The same bytes again answer the same asset.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MediaUploadBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "createMediaAsset"
      }
    },
    "/v1/media/uploads": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MediaUploadModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "description": "This call's own: `feature_not_enabled` (a video, where the store's media storage for videos is not set up). Any other code is one every call can answer (`BadRequest`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Open a resumable upload for a video (MP4, up to 50 MB): send its bytes to `upload_url`, then create the asset with `upload`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MediaUploadStartBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "createMediaUpload"
      }
    },
    "/v1/media/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MediaAssetModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a photo or video",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "retrieveMediaAsset"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MediaAssetModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Set a photo's or video's alt text and focal point. Only what is sent changes.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MediaUpdateBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "updateMediaAsset"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MediaAssetModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "description": "This call's own: `invalid_state` (the photo is in use: a video's poster, a fact's evidence, or on the live site's pages or brand). Any other code is one every call can answer (`Conflict`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Delete a photo, video or document. Refused while your live site, a video's poster or a product's fact uses it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "deleteMediaAsset"
      }
    },
    "/v1/media/{id}/file": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A document's file (a PDF a product's fact rests on), for the account only; photos and videos are served at their `path`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "downloadMediaDocument"
      }
    },
    "/v1/media/{id}/video_tags/propose": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MediaAssetModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Propose the products a video shows, from up to six frames of it: the proposals wait for you to confirm them.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VideoTagsProposeBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "proposeMediaVideoTags"
      }
    },
    "/v1/media/{id}/video_tags": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MediaAssetModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Confirm a video's product tags: exactly these, each a product at a moment. Only confirmed tags show on your store.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VideoTagsBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "setMediaVideoTags"
      }
    },
    "/v1/digital_assets": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DigitalAssetList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List a digital product's files, newest first: `?product=prod_…`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "product",
            "in": "query",
            "required": false,
            "description": "The digital product (`prod_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "listDigitalAssets"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DigitalAssetModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Add a file a digital product delivers (up to 10 MB, base64). The same bytes again answer the same file.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DigitalAssetBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "createDigitalAsset"
      }
    },
    "/v1/digital_assets/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DigitalAssetModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a digital product's file",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "retrieveDigitalAsset"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DigitalAssetModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Remove a file: links already sent no longer offer it",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "deleteDigitalAsset"
      }
    },
    "/v1/products/{id}/licence_keys": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LicenceKeyPoolModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A digital product's licence key pool: how many are left, sold and owed",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "retrieveLicenceKeyPool"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LicenceKeyPoolModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Add licence keys to a digital product's pool: each is sealed, and one already there is skipped. Answers the pool's counts, never a key.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LicenceKeysBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "addLicenceKeys"
      }
    },
    "/v1/store/proposals": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreProposalListModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The account's proposals in this mode, newest first, without their items: `?status=open` answers the one still open (at most one), which the review screens open. Paged with `limit`, `starting_after` and `ending_before`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "`open`: only the proposal still open (at most one).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "listStoreProposals"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreProposalModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Start the store builder from any mix of a sentence, the till's products, the website, an Instagram handle, photos and CSV, XLSX or PDF files. Answers at once with `status: building`; the build runs in the background (follow it at `…/events`). One open proposal per account and mode (`409` otherwise). Sends `store.proposal_started`, then `store.proposal_ready` or `store.proposal_failed`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProposalBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "createStoreProposal"
      }
    },
    "/v1/store/proposals/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreProposalModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The proposal: its stages, what it cost, and a page of its items in review order (`?group=product`, `?limit=` up to 200, `?starting_after=<item id>`).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "group",
            "in": "query",
            "required": false,
            "description": "Only this group's items: `brand`, `product`, `collection`, …",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "Items on the page, 1 to 200 (default 100).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "starting_after",
            "in": "query",
            "required": false,
            "description": "The last item (`spri_…`) of the page before.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "retrieveStoreProposal"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreProposalModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Discard the proposal. Nothing it proposed is kept, and a new one can start.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "discardStoreProposal"
      }
    },
    "/v1/store/proposals/{id}/events": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "text/event-stream": {
                "schema": {}
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Server-Sent Events while the proposal builds: `proposal` (its status and stages) whenever they change, `item` for each item written or changed, a `: ping` every 15 s, and `end` (`{reason}`: the status it reached, or `rotate` at 50 s: open it again). It starts with the proposal and every item so far.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "streamStoreProposalEvents"
      }
    },
    "/v1/store/proposals/{id}/items/{item}": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProposalItemModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Decide one item: `accept` (refused while a guess is open), `reject`, `edit` with `payload` (validated by the target's own schema; a product's text is claims-checked again), `confirm_guess` with `field`: each guess is confirmed one by one, or `rewrite`: a product whose copy the build ran out of time for (`context.copy: \"not_written\"`) has its copy drafted now.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "item",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ItemActionBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "decideStoreProposalItem"
      }
    },
    "/v1/store/proposals/{id}/items/{item}/redo": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProposalItemModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Ask the builder to redo one item on your words (≤ 300 characters), at most 3 times an item. The brand kit's redo moves its colours (and its type or voice only when asked).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "item",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RedoBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "redoStoreProposalItem"
      }
    },
    "/v1/store/proposals/{id}/preview": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProposalPreviewModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A link that opens the store as this proposal would make it (its brand kit and pages, edits included), never written and never cached, for an hour. The token is shown once; making another retires the last. For a phone, where the preview can't sit beside the decisions.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "previewStoreProposal"
      }
    },
    "/v1/store/proposals/{id}/accept_all": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AcceptAllModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Accept every proposed item with no guess left to confirm; the others stay, and the answer says how many.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "acceptAllStoreProposalItems"
      }
    },
    "/v1/store/proposals/{id}/publish": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PublishModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Publish the proposal: every accepted item with no guess left is applied (a product's web text, facts and photos, a new product as a draft, the brand kit), recorded as one change set, and the site is published as a version with `source: builder`. Each accepted till product then goes online where it can (`online`); one that can't says what it lacks (`not_online`). An accepted page whose words a fact on file can't back yet stays in the proposal (`pages_left`, with its fix) and the rest publish. `store` says whether the store is open, with its address, or what stops it. Items still to decide stay in the proposal, listed in `skipped`. In live mode, send `confirm: true`. Sends `store.proposal_published`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PublishBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "publishStoreProposal"
      }
    },
    "/v1/store/snaps": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreSnapModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Start a snap from 1 to 5 photos in the media library and an optional note, barcode and location. Answers at once with `status: working`; the draft product follows within a minute (follow it at `…/events`). Sends `store.snap_started`, then `store.snap_ready` or `store.snap_failed`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SnapBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "createStoreSnap"
      }
    },
    "/v1/store/snaps/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreSnapModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The snap: its steps, what it cost, and once `ready`, the draft product and its guesses.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "retrieveStoreSnap"
      }
    },
    "/v1/store/snaps/{id}/publish": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreSnapModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Publish a ready snap's draft (86-11b): sets its price, counts its stock in, makes it active on the chosen channels and puts it online through the product's own checklist. Refused with a link to the fix while a sentence fails the claims check, and then nothing changes. Sends `store.snap_published`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SnapPublishBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "publishStoreSnap"
      }
    },
    "/v1/store/snaps/{id}/photos": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreSnapModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Add a studio shot or a lifestyle shot of a ready snap's main photo to its draft (86-13), after the edited photos already there. Counted against this month's store AI and added to the snap's cost; refused once there isn't enough of it left. Asked again for the same kind: the snap as it is.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SnapPhotoBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "addStoreSnapPhoto"
      }
    },
    "/v1/store/snaps/{id}/events": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "text/event-stream": {
                "schema": {}
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Server-Sent Events while the snap works: `snap` (the snap as `GET` shows it) whenever it changes, a `: ping` every 15 s, and `end` (`{reason}`: the status it reached, or `rotate` at 50 s: open it again).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "streamStoreSnapEvents"
      }
    },
    "/v1/image_studio": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ImageStudioModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What each photo edit costs and whether it is set up here, the brand kit's studio backdrops, three scene presets (for `?product=`), and this month's store AI allowance.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "query",
            "name": "product",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "retrieveImageStudio"
      }
    },
    "/v1/image_studio/edits": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ImageEditModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Edit one photo: clean, studio, relight or scene. The edited photo is a new media asset marked AI-edited; the original is kept. An edit that would change the product is discarded.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ImageEditBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "createImageEdit"
      }
    },
    "/v1/collections": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List collections, newest first: `active` ones unless `?status=archived`; `?kind=manual|rule`, `?published=true|false`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "kind",
            "in": "query",
            "required": false,
            "description": "`manual` or `rule`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "`active` (the default) or `archived`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "published",
            "in": "query",
            "required": false,
            "description": "`true` or `false`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "listCollections"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "description": "This call's own: `resource_limit_reached` (the store has as many collections as it may keep; archive one first). Any other code is one every call can answer (`BadRequest`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a collection: products you pick (`manual`) or every product a rule matches (`rule`). Sends `store.collection_created`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CollectionBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "createCollection"
      }
    },
    "/v1/collections/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a collection",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "retrieveCollection"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change a collection. Only what is sent changes. Sends `store.collection_updated`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CollectionBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "updateCollection"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Delete a collection; its address is free again at once. Sends `store.collection_deleted`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "deleteCollection"
      }
    },
    "/v1/collections/{id}/products": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The collection's products as they are now, in its order: a rule evaluated against the catalogue. Every product not archived, or `?channel=online` for what shoppers see. Paged by `starting_after`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "channel",
            "in": "query",
            "required": false,
            "description": "`online`: only what shoppers see.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "listCollectionProducts"
      }
    },
    "/v1/store_imports/{id}/savings": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreImportSavingsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What a completed import's last 12 months of orders would have cost on Tuppence, priced on your own prices, beside the plan you paid: a confirmed plan by `plan`, or your own `monthly_fee`, `card_bps` and `card_fixed`. An estimate: every order as a domestic consumer card, before apps.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "plan",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "monthly_fee",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "card_bps",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "card_fixed",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Imports"
        ],
        "operationId": "retrieveStoreImportSavings"
      }
    },
    "/v1/store_imports": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreImportList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Your store imports, newest first.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Imports"
        ],
        "operationId": "listStoreImports"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreImportModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Start moving a store from Shopify, WooCommerce, Squarespace, Wix, Etsy, Big Cartel or Square Online. Nothing is read or written until `…/preview`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateStoreImportBody"
              }
            }
          }
        },
        "tags": [
          "Imports"
        ],
        "operationId": "createStoreImport"
      }
    },
    "/v1/store_imports/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreImportModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a store import: its preview, each phase's progress and, once undone, what was kept.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Imports"
        ],
        "operationId": "retrieveStoreImport"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreImportModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change what an import brings. Preview it again before it runs.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateStoreImportBody"
              }
            }
          }
        },
        "tags": [
          "Imports"
        ],
        "operationId": "updateStoreImport"
      }
    },
    "/v1/store_imports/{id}/files": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreImportModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "description": "This call's own: `invalid_state` (the import is not by files, or that file is complete, or the import is running or was undone). Any other code is one every call can answer (`Conflict`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Upload one of your store's export files, in parts of up to 800,000 characters. The first part's header row says which export it is; the wrong export is refused with the one to choose instead. A newer file of the same kind replaces the older one.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddStoreImportFileBody"
              }
            }
          }
        },
        "tags": [
          "Imports"
        ],
        "operationId": "addStoreImportFile"
      }
    },
    "/v1/store_imports/{id}/preview": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreImportModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Read the store and say what an import would do, writing nothing: counts per kind, what is already yours (matched by SKU, barcode, email or phone, never duplicated), what changed since the last run, conflicts, and what will not move with its reason.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Imports"
        ],
        "operationId": "previewStoreImport"
      }
    },
    "/v1/store_imports/{id}/run": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreImportModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "description": "This call's own: `invalid_state` (the import has not been previewed, or the import is running or was undone). Any other code is one every call can answer (`Conflict`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Import what the preview showed, in the background (`status: importing`, then `completed`). Products land as drafts; imported orders are history and send nothing. Run a completed import again to bring across what changed at the source: it creates nothing twice.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Imports"
        ],
        "operationId": "runStoreImport"
      }
    },
    "/v1/store_imports/{id}/stock_mirror": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StockMirrorModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The import's stock mirror: while it is `active`, a sale on your old Shopify or WooCommerce store moves your stock here once, and yours moves theirs. Live mode only.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Imports"
        ],
        "operationId": "retrieveStockMirror"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StockMirrorModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Turn the import's stock mirror on or off. Off removes its webhooks from the old store and wipes its connection; on again needs the store's access token in `credentials`. Refused in test mode, because it changes your real stock.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SetStockMirrorBody"
              }
            }
          }
        },
        "tags": [
          "Imports"
        ],
        "operationId": "setStockMirror"
      }
    },
    "/v1/recommendation_rules": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RecommendationRuleList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List recommendation rules, newest first: `?product=`, `?collection=` or `?kind=`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "product",
            "in": "query",
            "required": false,
            "description": "Only the rule for this product (`prod_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "collection",
            "in": "query",
            "required": false,
            "description": "Only the rules for this collection (`coll_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "kind",
            "in": "query",
            "required": false,
            "description": "`bought_together`, `similar` or `complete_the_look`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "listRecommendationRules"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RecommendationRuleModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a recommendation rule for a product or a collection: products always shown first (`pinned`) and never shown (`excluded`). One rule per product or collection and kind.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RecommendationRuleBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "createRecommendationRule"
      }
    },
    "/v1/recommendation_rules/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RecommendationRuleModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a recommendation rule",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "retrieveRecommendationRule"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RecommendationRuleModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change a rule's `pinned` or `excluded` products. Only what is sent changes.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RecommendationRuleBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "updateRecommendationRule"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RecommendationRuleModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Delete a recommendation rule: the product's related products are the store's own again.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "deleteRecommendationRule"
      }
    },
    "/v1/subscription_offers": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionOfferList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List subscribe and save offers, newest first: `?product=` or `?active=true`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "product",
            "in": "query",
            "required": false,
            "description": "Only the offer for this product (`prod_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "active",
            "in": "query",
            "required": false,
            "description": "`true`: only offers shown on the store; `false`: only those off.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "listSubscriptionOffers"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionOfferModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Offer a product on subscribe and save: how often shoppers may choose, and what comes off each order (10 % unless you say). One offer per product.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SubscriptionOfferBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "createSubscriptionOffer"
      }
    },
    "/v1/subscription_offers/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionOfferModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a subscribe and save offer",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "retrieveSubscriptionOffer"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionOfferModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change an offer: its variants, how often, the saving or whether it shows (`active`). Only what is sent changes; renewals already due use the new saving.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SubscriptionOfferBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "updateSubscriptionOffer"
      }
    },
    "/v1/store_campaigns": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreCampaignList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List store campaigns, newest first.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "listStoreCampaigns"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreCampaignModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Write a store campaign: its words, its button and who it's for (`segment`). A draft until it's scheduled.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreCampaignBody"
              }
            }
          }
        },
        "tags": [
          "Customers"
        ],
        "operationId": "createStoreCampaign"
      }
    },
    "/v1/store_campaigns/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreCampaignModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a store campaign",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "retrieveStoreCampaign"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreCampaignModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change a draft campaign. Only what is sent changes.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreCampaignBody"
              }
            }
          }
        },
        "tags": [
          "Customers"
        ],
        "operationId": "updateStoreCampaign"
      }
    },
    "/v1/store_campaigns/{id}/preview": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreCampaignPreviewModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Who it would reach now (a count and a few first names) and what it says.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "previewStoreCampaign"
      }
    },
    "/v1/store_campaigns/{id}/test": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreCampaignModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Send yourself a test: to the signed-in person's own email only, marked as a test. Not available to API keys.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "testStoreCampaign"
      }
    },
    "/v1/store_campaigns/{id}/schedule": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreCampaignModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Schedule it for a time on your clock (`send_at`, `YYYY-MM-DDTHH:MM` in your zone) or now. Who it goes to is worked out when it sends.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreCampaignScheduleBody"
              }
            }
          }
        },
        "tags": [
          "Customers"
        ],
        "operationId": "scheduleStoreCampaign"
      }
    },
    "/v1/store_campaigns/{id}/unschedule": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreCampaignModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Back to a draft before it sends.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "unscheduleStoreCampaign"
      }
    },
    "/v1/store_campaigns/{id}/results": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreCampaignResultsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "How it went: sent, skipped, waiting, clicked, and the orders it brought.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "retrieveStoreCampaignResults"
      }
    },
    "/v1/store_flows": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreFlowList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List the store's six flows, each with its words and its last 30 days",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "listStoreFlows"
      }
    },
    "/v1/store_flows/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreFlowModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a store flow",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "retrieveStoreFlow"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreFlowModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Turn a flow on or off, or change its words (one for each message). Only what is sent changes.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreFlowBody"
              }
            }
          }
        },
        "tags": [
          "Customers"
        ],
        "operationId": "updateStoreFlow"
      }
    },
    "/v1/store_flows/{id}/resume": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreFlowModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Turn a flow back on after the guardrail paused it. Review its email first: only sends from now count towards the next pause.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "resumeStoreFlow"
      }
    },
    "/v1/drops": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DropList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List drops, newest first.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "listDrops"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DropModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a drop: products on sale at `starts_at` through a fair queue, with limits per customer and per card. Sends `store.drop_created`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DropBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "createDrop"
      }
    },
    "/v1/drops/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DropModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a drop",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "retrieveDrop"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DropModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "description": "This call's own: `invalid_state` (the drop was cancelled, or its start moved once it had opened). Any other code is one every call can answer (`Conflict`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change a drop. Only what is sent changes; its start, products and lottery window only before it opens. `status: cancelled` stops it. Sends `store.drop_updated`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DropBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "updateDrop"
      }
    },
    "/v1/drops/{id}/queue": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DropQueueModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The drop's queue: baskets joined, drawing, waiting, checking out and done, units sold through it, and its waitlist. Counts only.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "retrieveDropQueue"
      }
    },
    "/v1/product_reviews": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductReviewList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Product reviews, newest first. `?status=` (`requested`, `pending`, `published`, `rejected`), `?product=`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "`requested`, `pending`, `published` or `rejected`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "product",
            "in": "query",
            "required": false,
            "description": "Only this product's (`prod_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Reviews"
        ],
        "operationId": "listProductReviews"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductReviewModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Add a review the business received another way. Verified only when `order_line` is this business's, for the product.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductReviewCreateBody"
              }
            }
          }
        },
        "tags": [
          "Reviews"
        ],
        "operationId": "createProductReview"
      }
    },
    "/v1/product_reviews/summary": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductReviewSummaryModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Counts by status, the share rejected and the published reviews' average rating.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Reviews"
        ],
        "operationId": "retrieveProductReviewSummary"
      }
    },
    "/v1/product_reviews/settings": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReviewSettingsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The review settings: requests, their delay, verified buyers only, and any incentive.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Reviews"
        ],
        "operationId": "retrieveReviewSettings"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReviewSettingsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change the review settings. An incentive makes the request marketing: only customers who agreed to marketing are asked.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductReviewSettingsBody"
              }
            }
          }
        },
        "tags": [
          "Reviews"
        ],
        "operationId": "updateReviewSettings"
      }
    },
    "/v1/product_reviews/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductReviewModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a product review",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Reviews"
        ],
        "operationId": "retrieveProductReview"
      }
    },
    "/v1/product_reviews/{id}/publish": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductReviewModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Publish a pending review now, or one rejected by mistake. Sends `product_review.published`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Reviews"
        ],
        "operationId": "publishProductReview"
      }
    },
    "/v1/product_reviews/{id}/reject": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductReviewModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Keep a review off the page for a rule of the published policy (`reason` is required); the writer is told which. Sends `product_review.rejected`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductReviewRejectBody"
              }
            }
          }
        },
        "tags": [
          "Reviews"
        ],
        "operationId": "rejectProductReview"
      }
    },
    "/v1/product_reviews/{id}/reply": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductReviewModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Reply to a review, once, shown beneath it as the business's. Sent again, it replaces the last.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductReviewReplyBody"
              }
            }
          }
        },
        "tags": [
          "Reviews"
        ],
        "operationId": "replyToProductReview"
      }
    },
    "/v1/store_threads": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreThreadList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List your store's conversations with shoppers, newest first. Filter by `status`, `site` or `assignee`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "`open`, `needs_you`, `waiting_customer` or `closed`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "site",
            "in": "query",
            "required": false,
            "description": "Only this store's (`site_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "assignee",
            "in": "query",
            "required": false,
            "description": "Only those this team member (`usr_…`) looks after.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "listStoreThreads"
      }
    },
    "/v1/store_threads/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreThreadModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a conversation with its messages",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "retrieveStoreThread"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreThreadModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change a conversation's status or who looks after it. Only what is sent changes.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreThreadUpdateBody"
              }
            }
          }
        },
        "tags": [
          "Customers"
        ],
        "operationId": "updateStoreThread"
      }
    },
    "/v1/store_threads/{id}/messages": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreThreadModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Reply to the shopper as your store. By email from your store's sender when they left an address; the conversation then waits for them.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreThreadReplyBody"
              }
            }
          }
        },
        "tags": [
          "Customers"
        ],
        "operationId": "replyToStoreThread"
      }
    },
    "/v1/store_threads/{id}/templates": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreThreadTemplates"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A WhatsApp conversation's approved templates: what can be sent after its 24 hours",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "listStoreThreadTemplates"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreThreadModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BadRequest"
                }
              }
            },
            "description": "Bad Request"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Send an approved WhatsApp template: the only reply WhatsApp takes after 24 hours",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreThreadTemplateBody"
              }
            }
          }
        },
        "tags": [
          "Customers"
        ],
        "operationId": "sendStoreThreadTemplate"
      }
    },
    "/v1/merchant_sending_domains": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MerchantSendingDomainList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List your store's sending domain: none, or the one.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "listMerchantSendingDomains"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MerchantSendingDomainModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Add a sending domain, the suggestion when `domain` is left out. Answers the records to add at your DNS host.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MerchantSendingDomainBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "createMerchantSendingDomain"
      }
    },
    "/v1/merchant_sending_domains/suggestion": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MerchantSendingDomainSuggestion"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The sending domain we suggest: `mail.` on your store's own domain",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "suggestMerchantSendingDomain"
      }
    },
    "/v1/merchant_sending_domains/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MerchantSendingDomainModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve your sending domain with what the last check found",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "retrieveMerchantSendingDomain"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MerchantSendingDomainModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Remove the sending domain: your store's emails go from Tuppence in your name again",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "removeMerchantSendingDomain"
      }
    },
    "/v1/merchant_sending_domains/{id}/check": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MerchantSendingDomainModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Check the records now, rather than at the next 10-minute check",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "checkMerchantSendingDomain"
      }
    },
    "/v1/test_helpers/merchant_sending_domains/{id}/add_records": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MerchantSendingDomainModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE, local and test suites only: the domain's records appear at the fake DNS (all of them, or all but `except`). It verifies at its next check.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddRecordsBody"
              }
            }
          }
        },
        "tags": [
          "Test helpers"
        ],
        "operationId": "addMerchantSendingDomainRecords"
      }
    },
    "/v1/suppliers": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SupplierList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List suppliers, newest first.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "listSuppliers"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SupplierModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a supplier. With no email its purchase orders can be drafted but not sent.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SupplierCreateBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "createSupplier"
      }
    },
    "/v1/suppliers/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SupplierModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a supplier",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "retrieveSupplier"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SupplierModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change a supplier: its name, the email orders go to, or its lead time.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SupplierUpdateBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "updateSupplier"
      }
    },
    "/v1/suppliers/{id}/products": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SupplierProductList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List the products a supplier sells, with its case size, cost and lead time.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "listSupplierProducts"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SupplierProductModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Link a product to a supplier, or change the link: its case size, what the supplier charges per unit and its own lead time. Only the fields sent change.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SupplierProductBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "linkSupplierProduct"
      }
    },
    "/v1/purchase_orders": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PurchaseOrderList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List purchase orders, newest first.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "`draft`, `sent` or `cancelled`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "supplier",
            "in": "query",
            "required": false,
            "description": "One supplier's orders: `supp_…`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "listPurchaseOrders"
      }
    },
    "/v1/purchase_orders/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PurchaseOrderModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a purchase order",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "retrievePurchaseOrder"
      }
    },
    "/v1/purchase_orders/{id}/cancel": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PurchaseOrderModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Cancel a draft purchase order. A sent one is the supplier's, so it is refused.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "cancelPurchaseOrder"
      }
    },
    "/v1/store/settings": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreSettingsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve the store's settings: the purchase order limit and its default.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "retrieveStoreSettings"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreSettingsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change the store's settings. `po_limit`: the most an order restock drafts on its own may come to; above it, restock asks first. `credit_limit`: the most store credit the customer-service job gives a shopper on its own; above it, it asks first. `referrals`, `referral_reward`, `referral_friend_reward`: customer referrals and each side's store credit on a friend's first order. `min_margin_bps`: the lowest margin, after the discount and the card fee, a promotion the assistant proposes may leave. null restores the default.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreSettingsBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "updateStoreSettings"
      }
    },
    "/v1/sales_channels": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SalesChannelList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List the business's sales channel connections, newest first",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "listSalesChannels"
      }
    },
    "/v1/sales_channels/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SalesChannelModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a sales channel connection",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "retrieveSalesChannel"
      }
    },
    "/v1/sales_channels/{id}/pause": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SalesChannelModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Pause a channel: nothing is sent to it until it resumes",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "pauseSalesChannel"
      }
    },
    "/v1/sales_channels/{id}/resume": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SalesChannelModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Resume a paused channel: what changed meanwhile is sent",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "resumeSalesChannel"
      }
    },
    "/v1/listings": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListingList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List listings, newest first, by channel, product or state",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "sales_channel",
            "in": "query",
            "required": false,
            "description": "One channel's listings: `slch_…`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "product",
            "in": "query",
            "required": false,
            "description": "One product's listings: `prod_…`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "state",
            "in": "query",
            "required": false,
            "description": "`pending`, `live`, `rejected`, `excluded` or `removed`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "listListings"
      }
    },
    "/v1/listings/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a listing",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "retrieveListing"
      }
    },
    "/v1/listings/{id}/exclude": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Keep this variant off the channel; it stays on the store",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "excludeListing"
      }
    },
    "/v1/listings/{id}/include": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListingModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List this variant on the channel again",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "includeListing"
      }
    },
    "/v1/reports/channels": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ChannelReportModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Sales per channel over `?from=`/`?to=` (business days, the last 30 by default): orders, units, gross, discounts, refunds, the channel's own fees (estimated and final apart, never Tuppence's) and net, with impressions and clicks where the channel reports them.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "First day, `YYYY-MM-DD` (UTC). Defaults to 30 days ago.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "Last day, `YYYY-MM-DD` (UTC), inclusive. Defaults to today.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Reporting"
        ],
        "operationId": "retrieveChannelReport"
      }
    },
    "/v1/tax_nexus": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NexusStateList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Every US state with a sales tax, nearest its economic-nexus threshold first: what you sold into it over the state's own period (your own sales and marketplace sales apart), the state's threshold with its source, `near` from 80 %, and whether you are registered there. Counted every night at 02:30 in your time zone. Tuppence never decides whether you must register.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Tax"
        ],
        "operationId": "listTaxNexusStates"
      }
    },
    "/v1/tax_registrations": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaxRegistrationList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The tax registrations you hold for your online sales, oldest first.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Tax"
        ],
        "operationId": "listTaxRegistrations"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaxRegistrationModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Record a US state sales tax registration you hold (the nexus tracker then shows the state as registered and sends no threshold notices for it), or, selling from the US, your UK VAT number: your store then charges UK VAT on parcels to the UK of £135 or less, and can deliver there.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TaxRegistrationBody"
              }
            }
          }
        },
        "tags": [
          "Tax"
        ],
        "operationId": "createTaxRegistration"
      }
    },
    "/v1/site_policies": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SitePolicyList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Your store's policies, one per kind, each with the version shoppers see and the draft waiting for your approval.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "site",
            "in": "query",
            "required": false,
            "description": "The site (`site_…`); the account's site when left out.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "listSitePolicies"
      }
    },
    "/v1/site_policies/generate": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SitePolicyList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Write your store's policies from your settings: a new draft of each policy whose words would change, nothing for the rest. Drafts go live when you approve them.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/GenerateBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "generateSitePolicies"
      }
    },
    "/v1/site_policies/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SitePolicyModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "One of your store's policies, with its live and draft versions.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "retrieveSitePolicy"
      }
    },
    "/v1/site_policies/{id}/versions": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SitePolicyVersionList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Every version of a policy, newest first.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "listSitePolicyVersions"
      }
    },
    "/v1/site_policies/{id}/own_words": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SitePolicyModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Add your own paragraphs under your terms, returns or delivery text. They can't take away a shopper's legal rights: words like `no refunds` are refused unless they are about goods the law excepts, such as personalised items. Makes a new draft.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OwnWordsBody"
              }
            }
          }
        },
        "tags": [
          "Sites"
        ],
        "operationId": "setSitePolicyOwnWords"
      }
    },
    "/v1/site_policy_versions/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SitePolicyVersionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "One version of a policy: its words, what they were made from, and whether it is live.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "retrieveSitePolicyVersion"
      }
    },
    "/v1/site_policy_versions/{id}/approve": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SitePolicyModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Approve a draft: it becomes what shoppers see, and the version before it is kept as it was.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "approveSitePolicyVersion"
      }
    },
    "/v1/sites/{id}/readiness": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteReadinessModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What your store still has to show shoppers before it can open, each with a link to fix it: your address and email, your approved policies, the model cancellation form and your pay button's words.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "retrieveSiteReadiness"
      }
    },
    "/v1/sites/{id}/selling_abroad": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SellingAbroadModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Where your store can sell abroad: the EU, the US from the UK, the UK from the US. Each destination opens once its checklist is complete (a delivery zone there, every product's customs details, your EORI number or UK VAT number), and each item links to its fix.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "retrieveSellingAbroad"
      }
    },
    "/v1/sites/{id}/checklist": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreChecklistModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What your store still needs before it opens and before it takes live orders, in order: each item done, to do or blocked, with why and a link to the field that fixes it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sites"
        ],
        "operationId": "retrieveSiteChecklist"
      }
    },
    "/v1/test_helpers/shipments/{id}/advance": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingWebhookReceiptModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: move a test parcel on, through the carrier's signed webhook and our intake",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AdvanceShipmentBody"
              }
            }
          }
        },
        "tags": [
          "Test helpers"
        ],
        "operationId": "simulateShipmentProgress"
      }
    },
    "/v1/fulfilments/collect": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FulfilmentModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Hand a collection over: the order's QR code (the link to its page, in the shopper's *ready to collect* email) or its number. Its collection becomes `collected`. One not ready yet or already collected is refused (`409 invalid_state`), saying which. A till hands over at `POST /v1/pos/fulfilments/collect`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CollectBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "collectFulfilment"
      }
    },
    "/v1/fulfilments/{id}/ready": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FulfilmentModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A collection is ready (without scanning it in): `ready_for_collection`, and the shopper is emailed that it's ready, with the order page whose QR code the till scans. Packing every item in does the same.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "readyFulfilment"
      }
    },
    "/v1/fulfilments/{id}/out_for_delivery": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FulfilmentModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A local delivery has left with your driver (`out_for_local_delivery`), once packed: the shopper is told it's on its way today.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "sendLocalDelivery"
      }
    },
    "/v1/fulfilments/{id}/delivered": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FulfilmentModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Your driver delivered a local delivery: `delivered`, and the shopper is told.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "deliverLocalDelivery"
      }
    },
    "/v1/fulfilments/labels": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LabelBatchModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Buy up to 50 labels with one approval, each as `POST /v1/fulfilments/{id}/label` buys it (an order not packed yet is packed as it is, in your default package). One refused doesn't stop the rest: each result says `bought`, `needs_confirmation` (its price rose: buy it alone with `confirm_amount`) or `failed`, with why.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LabelBatchBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "buyLabels"
      }
    },
    "/v1/fulfilments": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FulfilmentList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The pick list: what is still to leave, oldest promise first, each line with its barcodes and weight. `?status=` (comma separated; default `allocated,picking,packed,label_purchased`), `?location=`, `?kind=`, `?limit=` (up to 100). A till sees its own location's: its Online lane.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "listFulfilments"
      }
    },
    "/v1/fulfilments/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FulfilmentModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A fulfilment: its lines, what is packed, the parcel and its label.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "getFulfilment"
      }
    },
    "/v1/fulfilments/{id}/pack": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FulfilmentModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Pack by scan: each barcode packs one of the order's items, and a wrong one is refused (`422 wrong_item`, naming what it is and what the order wants); a line with no barcode is ticked by hand. When everything is in, the fulfilment is `packed` with the parcel from the package and the items' weights (or `weight_g` from the scales); again later, it changes the package or the weight until the label is bought.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PackBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "packFulfilment"
      }
    },
    "/v1/fulfilments/{id}/packing_slip": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PackingSlipModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The packing slip: the order number and its page's QR, where it goes, what is in the box (no prices), the shopper's note and how to return it. `@tuppence/pos-core`'s `packingSlip` prints it on a receipt printer.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "getPackingSlip"
      }
    },
    "/v1/fulfilments/{id}/rates": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LabelRateList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What a label costs for the packed parcel, by service, beside what it would have cost at the weight the product data gave (`expected_amount`). A till asks for its own location's (87-05b), to show the price before buying.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "listLabelRates"
      }
    },
    "/v1/fulfilments/{id}/label": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FulfilmentModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "description": "This call's own: `invalid_state` (the fulfilment is not packed with a parcel); `label_price_changed` (the label costs something other than `confirm_amount`; the message says the new price). Any other code is one every call can answer (`Conflict`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "422": {
            "description": "This call's own: `label_refused` (no service carries the parcel, or the shopper paid duties and only the business's own carrier account can ship it).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Buy the packed parcel's label (it spends money: `Idempotency-Key` required). Bought once per parcel: asking again returns the same shipment and charges nothing. A price more than a fifth above what the product data said is refused with `409 label_price_changed` until you send `confirm_amount`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LabelBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "buyLabel"
      }
    },
    "/v1/fulfilments/{id}/label/void": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FulfilmentModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Void the parcel's unused label (87-03): it can't be printed any more, the parcel is back to `packed` for another label, and a label paid from your balance is given back: not collected yet, nothing is taken; collected, it comes back by transfer once the carrier refunds it. Carriers whose labels can't be voided (DPD UK) are refused, saying so.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "voidLabel"
      }
    },
    "/v1/fulfilments/{id}/ship": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FulfilmentModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Mark it shipped: with our label, or posted without one (packed as it is), where a `tracking_number` starts the carrier's tracker so its events move the order on. Sends `fulfilment.shipped`; marking it again changes nothing.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShipBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "shipFulfilment"
      }
    },
    "/v1/locations/{id}/collection": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LocationCollectionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "How this shop hands over online orders: its collection slots and what each can still take, or how many hours after opening an order is ready.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "retrieveLocationCollection"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LocationCollectionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Set how this shop hands over online orders: `slots` (`slot_minutes`, `capacity`, `lead_minutes`, `days_ahead`), so shoppers choose a time and no slot takes more than its capacity, or `null` for none; and `ready_within_hours` (default 2) for a shop without slots.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LocationCollectionBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "updateLocationCollection"
      }
    },
    "/v1/orders/{id}/returns/preview": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReturnPreviewModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What could come back from a store order, and on what basis (the law's right to cancel, faulty goods, or your returns policy), with who pays the postage and what happens to the delivery charge. Nothing is written.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReturnPreviewBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "previewReturn"
      }
    },
    "/v1/returns/scan": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReturnScanModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Find a store order from its QR code (the link to its page, on the packing slip and the confirmation email) or its number: what could come back, with the returns rules' answer for each line, and its return if one is under way. Nothing is written.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReturnScanBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "scanReturnOrder"
      }
    },
    "/v1/products/{id}/return_insights": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReturnInsightList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What this product's returns say about it: the reason most returns of a size (or of the product) give, such as *Runs small: 6 of 9 returns of the Blue mug's Large size*, over the last 13 weeks.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "listReturnInsights"
      }
    },
    "/v1/returns": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReturnList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Returns, newest first. `?order=`, `?status=`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "order",
            "in": "query",
            "required": false,
            "description": "Only this order's returns (`ord_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only returns in this status: `requested`, `approved`…",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "listReturns"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReturnModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "description": "This call's own: `invalid_status` (the order is not a store order that was sent); `return_out_of_stock` (an exchange's replacement is out of stock). Any other code is one every call can answer (`Conflict`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Start a return of a store order's goods, with the shopper's reasons. The returns rules' answer is kept with it; it waits for approval.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReturnCreateBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "createReturn"
      }
    },
    "/v1/returns/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReturnModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A return: its lines, the returns rules' answer and where it has got to.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "getReturn"
      }
    },
    "/v1/returns/{id}/approve": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReturnModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "description": "This call's own: `invalid_status` (the return's status does not allow this now (`status` says where it is)). Any other code is one every call can answer (`Conflict`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Approve a return. Lines the returns rules refuse need `exception: true`, from a person in the dashboard.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReturnApproveBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "approveReturn"
      }
    },
    "/v1/returns/{id}/reject": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReturnModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "description": "This call's own: `invalid_status` (the return's status does not allow this now (`status` says where it is)). Any other code is one every call can answer (`Conflict`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Reject a return. One the law gives the shopper can't be rejected.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReturnRejectBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "rejectReturn"
      }
    },
    "/v1/returns/{id}/receive": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReturnModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "description": "This call's own: `invalid_status` (the return's status does not allow this now (`status` says where it is)). Any other code is one every call can answer (`Conflict`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The goods are back at a shop. Where the law sets a refund deadline, `refund_due_on` says the day.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReturnReceiveBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "receiveReturn"
      }
    },
    "/v1/returns/{id}/ways_back": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WayBackOptionList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "How the goods can come back (a label, a QR code for a Post Office or a locker, or one of your shops), each with its price, who pays it and what is kept from the refund for it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "listReturnWaysBack"
      }
    },
    "/v1/returns/{id}/way_back": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReturnModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Choose how an approved return comes back: buys its return label or drop-off code (once), or names the shop it is brought to.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReturnWayBackBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "chooseReturnWayBack"
      }
    },
    "/v1/returns/{id}/close": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReturnModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "description": "This call's own: `invalid_status` (the return's status does not allow this now (`status` says where it is)). Any other code is one every call can answer (`Conflict`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Close a return that is refunded, rejected or back.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "closeReturn"
      }
    },
    "/v1/sites/{id}/return_policy": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReturnPolicyModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The site's returns policy: 30 days from delivery, shopper pays postage unless faulty, until you change it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "getReturnPolicy"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReturnPolicyModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change the site's returns policy. Orders already placed keep the terms they were sold under, unless the new ones are kinder.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReturnPolicyBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "updateReturnPolicy"
      }
    },
    "/v1/shipments/{id}/label": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A bought label's file to print: `?format=` `pdf` (4x6, the default), `png` (4x6), `zpl` (thermal printers) or `pdf_a4` (an A4 page), or `?printer=` a label printer (`prn_…`) for the format it takes: ZPL, or a 4x6 PDF through AirPrint. It carries the shopper's address: never cached.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "format",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "printer",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "getShipmentLabel"
      }
    },
    "/v1/shipping_manifests": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingManifestList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The manifests made, newest first; `?location=` one shop's.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "query",
            "name": "location",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "listShippingManifests"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CloseDayModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Close the day: one manifest per carrier that needs one (a USPS SCAN form; the Royal Mail manifest on your own contract), over the shop's labels not on one yet. Closing again with nothing new makes nothing.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CloseDayBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "closeShippingDay"
      }
    },
    "/v1/shipping_manifests/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingManifestModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A manifest: its carrier, day, status and the tracking numbers it covers.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "getShippingManifest"
      }
    },
    "/v1/shipping_manifests/{id}/file": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The manifest's printable form (a PDF), for the driver to scan or sign.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "getShippingManifestFile"
      }
    },
    "/v1/carrier_pickups": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CarrierPickupList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The collections booked, newest first; `?location=` one shop's.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "query",
            "name": "location",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "listCarrierPickups"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CarrierPickupModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Book a collection: the carrier comes for the shop's labels waiting, 09:00 to 17:00 on `date` (default the next working day). One per shop, carrier and day: booking again returns it. On Tuppence's account only a free collection (USPS) is booked; a charged one needs your own carrier account.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PickupBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "bookCarrierPickup"
      }
    },
    "/v1/carrier_pickups/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CarrierPickupModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A collection: its day, window, status and the carrier's confirmation number.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "getCarrierPickup"
      }
    },
    "/v1/postage": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PostageModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Postage owed for labels bought from the balance at cost, and the postage credit limit. Over the limit, buying a label from the balance is refused (`409 postage_limit_reached`) until the balance covers what is owed.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "getPostage"
      }
    },
    "/v1/carrier_accounts": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CarrierAccountListModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Your own carrier account, if you connected one, and which carriers you can connect.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "listCarrierAccounts"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CarrierAccountModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Connect your own carrier account: in the UK your Sendcloud account's keys (your Royal Mail, DPD or Parcelforce contract), in the US your UPS, FedEx or USPS account. A test quote runs on it first; only an account that quotes is saved. Its labels are billed to you by the carrier, and Tuppence charges nothing.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ConnectCarrierAccountBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "connectCarrierAccount"
      }
    },
    "/v1/carrier_accounts/{id}": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CarrierAccountModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Rename it, or choose whether labels fall back to your Tuppence balance while it fails.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateCarrierAccountBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "updateCarrierAccount"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CarrierAccountModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Disconnect it: labels are bought from your Tuppence balance again.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "disconnectCarrierAccount"
      }
    },
    "/v1/shipping_profiles": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingProfileList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The shipping profiles, the default first, each with its zones and rates.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "listShippingProfiles"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingProfileModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A new profile, for products that ship differently (large, fragile, made to order).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProfileBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "createShippingProfile"
      }
    },
    "/v1/shipping_profiles/weights": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EstimatedWeightList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Products with no weight, and the weight their type suggests: what delivery is priced on until you confirm one.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "listEstimatedWeights"
      }
    },
    "/v1/shipping_profiles/preview": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeliveryPreviewModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What a shopper at an address sees for a parcel: the checkout's delivery options, prices and dates.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "query",
            "name": "country",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "region",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "postcode",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "weight_grams",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "subtotal",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "previewDeliveryOptions"
      }
    },
    "/v1/shipping_profiles/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingProfileModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A profile with its zones and rates.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "retrieveShippingProfile"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingProfileModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Rename a profile, make it the default, or confirm its rates.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProfileBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "updateShippingProfile"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingDeletedModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "description": "This call's own: `invalid_state` (it is the default profile; make another the default first). Any other code is one every call can answer (`Conflict`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Delete a profile that isn't the default; its products ship under the default again.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "deleteShippingProfile"
      }
    },
    "/v1/shipping_profiles/{id}/products": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingProfileModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Ship these products under this profile (the default: back to no profile of their own).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProfileProductsBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "assignShippingProfileProducts"
      }
    },
    "/v1/shipping_profiles/{id}/zones": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingProfileModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Add a zone: where the rates you add to it apply. Answers the whole profile.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ZoneBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "createShippingZone"
      }
    },
    "/v1/shipping_profiles/{id}/zones/{zone}": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingProfileModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change a zone's name, countries, regions or postcodes. Answers the whole profile.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "zone",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ZoneBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "updateShippingZone"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingProfileModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Delete a zone and its rates. Answers the whole profile.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "zone",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "deleteShippingZone"
      }
    },
    "/v1/shipping_profiles/{id}/zones/{zone}/rates": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingProfileModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Add a rate to a zone. Answers the whole profile.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "zone",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RateBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "createShippingRate"
      }
    },
    "/v1/shipping_profiles/{id}/zones/{zone}/rates/{rate}": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingProfileModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change a rate: its name, price, bands or service. Answers the whole profile.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "zone",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "rate",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RateBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "updateShippingRate"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingProfileModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Delete a rate. Answers the whole profile.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "zone",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "rate",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "deleteShippingRate"
      }
    },
    "/v1/shipping_packages": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingPackageList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The packages, seeded with Royal Mail's sizes (GB) or US mailers and boxes.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "listShippingPackages"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingPackageModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Add a package: its outside size and its empty weight.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PackageBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "createShippingPackage"
      }
    },
    "/v1/shipping_packages/{id}": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingPackageModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change a package, or make it the default.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PackageBody"
              }
            }
          }
        },
        "tags": [
          "Shipping"
        ],
        "operationId": "updateShippingPackage"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingDeletedModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Delete a package that isn't the default.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "deleteShippingPackage"
      }
    },
    "/v1/shipping_services": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingServiceList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The delivery services a rate can name, with their transit days and limits.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shipping"
        ],
        "operationId": "listShippingServices"
      }
    },
    "/v1/customers/{id}/preferences": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerPreferenceList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What a customer told your store they like, by attribute: kept only when they tick *Remember my answers* in your product quiz. It orders their search results, never their prices.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Customers"
        ],
        "operationId": "listCustomerPreferences"
      }
    },
    "/v1/country_packs/{cc}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CountryPackModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotFound"
                }
              }
            },
            "description": "Not Found"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a country's pack — or a province's or state's, with `region`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "description": "ISO 3166-1 alpha-2: `GB`, `CA`, `US`…",
            "in": "path",
            "name": "cc",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "A province or state — ISO 3166-2 without the country (`QC`, `TX`): its pack overlaid on the country's.",
            "in": "query",
            "name": "region",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Country packs"
        ],
        "operationId": "retrieveCountryPack"
      }
    },
    "/v1/customers/{id}/payment_methods": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SavedCardList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The cards and bank accounts a customer has saved, with what they agreed to (a bank account's Direct Debit mandate, too). A paired till reads their cards — the brand, last four and expiry to charge with; never where the customer agreed from.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Saved cards"
        ],
        "operationId": "listSavedCards"
      }
    },
    "/v1/payment_methods/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SavedCardModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a saved card or bank account",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Saved cards"
        ],
        "operationId": "retrieveSavedCard"
      }
    },
    "/v1/payment_methods/{id}/detach": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SavedCardModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Remove a saved card or bank account (ending its Direct Debit mandate). It can never be charged again.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Saved cards"
        ],
        "operationId": "detachSavedCard"
      }
    },
    "/v1/setup_sessions": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SetupSessionModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Save a customer's card with nothing charged: the terms they agree to (your words, and the most one charge may be), and a client secret for their browser to present a card with.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateSetupSessionBody"
              }
            }
          }
        },
        "tags": [
          "Saved cards"
        ],
        "operationId": "createSetupSession"
      }
    },
    "/v1/setup_sessions/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SetupSessionModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A setup session: whether the card is saved, and which",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Saved cards"
        ],
        "operationId": "retrieveSetupSession"
      }
    },
    "/v1/meters": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MeterList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List meters, newest first",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Credits"
        ],
        "operationId": "listMeters"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MeterModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a meter: a price per unit of usage. Prices never change — make a new meter.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateMeterBody"
              }
            }
          }
        },
        "tags": [
          "Credits"
        ],
        "operationId": "createMeter"
      }
    },
    "/v1/credits": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditHolderList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List customers' prepaid credit, newest balance first — with totals topped up and used",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Credits"
        ],
        "operationId": "listCreditBalances"
      }
    },
    "/v1/credits/{customer}/topups": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditTopupList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A customer's credit top-ups, newest first",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Credits"
        ],
        "operationId": "listCreditTopups"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TopupModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Sell a customer credit: creates a payment for them to pay (its `approval_url`). The credit appears when it succeeds.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TopupBody"
              }
            }
          }
        },
        "tags": [
          "Credits"
        ],
        "operationId": "createCreditTopup"
      }
    },
    "/v1/credits/{customer}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditBalanceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A customer's prepaid credit",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Credits"
        ],
        "operationId": "retrieveCreditBalance"
      }
    },
    "/v1/credits/{customer}/auto_topup": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditBalanceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Top up automatically on the customer's saved card when credit falls below `threshold` — within what they agreed to.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AutoTopupBody"
              }
            }
          }
        },
        "tags": [
          "Credits"
        ],
        "operationId": "updateCreditAutoTopup"
      }
    },
    "/v1/credits/{customer}/refunds": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditRefundModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Refund UNUSED credit — all of it, or `amount` — back against the top-up payments, newest first. Used credit is earned and is not refunded.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreditRefundBody"
              }
            }
          }
        },
        "tags": [
          "Credits"
        ],
        "operationId": "createCreditRefund"
      }
    },
    "/v1/meter_events": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageEventList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List recorded usage, newest first — optionally one `customer`'s, or one `meter`'s (name or id)",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "customer",
            "in": "query",
            "required": false,
            "description": "Only this customer's (`cus_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "meter",
            "in": "query",
            "required": false,
            "description": "Only this meter's usage: its name, or its id (`mtr_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Credits"
        ],
        "operationId": "listMeterEvents"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MeterEventModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "402": {
            "$ref": "#/components/responses/PaymentFailed"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Record usage: draws it from the customer's credit, atomically. `identifier` makes it safe to retry (`replayed: true`). 402 `insufficient_credits` if it cannot be covered.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UsageBody"
              }
            }
          }
        },
        "tags": [
          "Credits"
        ],
        "operationId": "createMeterEvent"
      }
    },
    "/v1/meter_events/summary": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageSummaryModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Usage per meter and per UTC day over `from`–`to` (YYYY-MM-DD, inclusive; default the last 30 days), summed from the meter events themselves",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "First day, `YYYY-MM-DD` (UTC). Defaults to 30 days ago.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "Last day, `YYYY-MM-DD` (UTC), inclusive. Defaults to today.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "customer",
            "in": "query",
            "required": false,
            "description": "Only this customer's (`cus_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Credits"
        ],
        "operationId": "retrieveUsageSummary"
      }
    },
    "/v1/credits/{customer}/tokens": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditTokenModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "402": {
            "$ref": "#/components/responses/PaymentFailed"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Let a customer's AI agent spend their credit on your priced routes: a signed token, capped at `max_amount` and short-lived. Shown once.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreditTokenBody"
              }
            }
          }
        },
        "tags": [
          "Credits"
        ],
        "operationId": "createCreditToken"
      }
    },
    "/v1/meter_events/batch": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BatchModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "402": {
            "$ref": "#/components/responses/PaymentFailed"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Record up to 100 usage events. Each succeeds or fails on its own: read `data[].status`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UsageBatchBody"
              }
            }
          }
        },
        "tags": [
          "Credits"
        ],
        "operationId": "createMeterEventBatch"
      }
    },
    "/v1/sandboxes/challenge": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SandboxChallengeModel"
                }
              }
            },
            "description": "Success"
          }
        },
        "summary": "A proof-of-work challenge for creating a sandbox: single use, five minutes",
        "parameters": [],
        "tags": [
          "Sandboxes"
        ],
        "operationId": "getSandboxChallenge",
        "security": []
      }
    },
    "/v1/sandboxes": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SandboxModel"
                }
              }
            },
            "description": "Created"
          }
        },
        "description": "Solve `GET /v1/sandboxes/challenge` first. Test mode only: an unclaimed sandbox can never go live. Limits: 5 an hour and 20 a day per address, 200 a day per network, 3 unclaimed per email (`429 rate_limited`).",
        "summary": "Create a claimable test account with no key: test keys at once, a claim link for a person, gone in 30 days unless claimed",
        "parameters": [],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateSandboxBody"
              }
            }
          }
        },
        "tags": [
          "Sandboxes"
        ],
        "operationId": "createSandbox",
        "security": []
      }
    },
    "/v1/sandboxes/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SandboxStateModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a sandbox with its own key: whether a person has claimed it, and when it expires",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Sandboxes"
        ],
        "operationId": "retrieveSandbox"
      }
    },
    "/v1/registers": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RegisterList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List registers, newest first. `?location=loc_…`, `?status=active|archived`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Only registers at this location (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only registers in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Registers"
        ],
        "operationId": "listRegisters"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RegisterModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a register — a till point at a location, with the till's defaults",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PosRegisterBody"
              }
            }
          }
        },
        "tags": [
          "Registers"
        ],
        "operationId": "createRegister"
      }
    },
    "/v1/registers/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RegisterModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a register",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Registers"
        ],
        "operationId": "retrieveRegister"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RegisterModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a register: its name, layout, receipt settings, tip prompt, defaults, printers and drawer. Only what is sent changes.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PosRegisterBody"
              }
            }
          }
        },
        "tags": [
          "Registers"
        ],
        "operationId": "updateRegister"
      }
    },
    "/v1/registers/{id}/pairing_codes": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PairingCodeModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Mint a pairing code for this register: six digits, ten minutes, one device — shown once, here. Five an hour per register.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Registers"
        ],
        "operationId": "createPairingCode"
      }
    },
    "/v1/registers/{id}/archive": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RegisterModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Archive a register: nothing new happens on it; its devices are revoked",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Registers"
        ],
        "operationId": "archiveRegister"
      }
    },
    "/v1/pos_devices": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PosDeviceList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List devices, newest first. `?register=reg_…`, `?location=loc_…`, `?status=active|revoked`. Never a token.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "register",
            "in": "query",
            "required": false,
            "description": "Only devices paired to this register (`reg_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Only devices at this location (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "`active` (paired) or `revoked`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "POS devices"
        ],
        "operationId": "listPosDevices"
      }
    },
    "/v1/pos_devices/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PosDeviceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a device",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "POS devices"
        ],
        "operationId": "retrievePosDevice"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PosDeviceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a device: its name, and whether it is a dedicated till — the app opens straight into the till and stays there. The device reads it back with its next heartbeat. Only what is sent changes.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PosDeviceBody"
              }
            }
          }
        },
        "tags": [
          "POS devices"
        ],
        "operationId": "updatePosDevice"
      }
    },
    "/v1/pos_devices/{id}/revoke": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PosDeviceModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Revoke a device: its token is refused from the very next request. Revoking twice changes nothing.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "POS devices"
        ],
        "operationId": "revokePosDevice"
      }
    },
    "/v1/staff/{id}/pin": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StaffPinModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Set or reset a staff member's till PIN: four to six digits, never shown again. A PIN someone else on the account has is refused (`409 pin_taken`) without saying whose.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StaffPinBody"
              }
            }
          }
        },
        "tags": [
          "Staff"
        ],
        "operationId": "setStaffPin"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StaffPinModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Remove a staff member's till PIN: they cannot sign in at a till until one is set again",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Staff"
        ],
        "operationId": "clearStaffPin"
      }
    },
    "/v1/staff/{id}/till_permissions": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TillPermissionsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What a staff member may do at a till: their own set, or — until one is set — the defaults for their login's role (owner, admin and manager everything; developer and analyst nothing; staff, and a person without a login, sell).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Staff"
        ],
        "operationId": "retrieveTillPermissions"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TillPermissionsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Set what a staff member may do at a till. Only what is sent changes; the rest stays as it is now. An action beyond these needs a second person's approval at the till.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TillPermissionsBody"
              }
            }
          }
        },
        "tags": [
          "Staff"
        ],
        "operationId": "updateTillPermissions"
      }
    },
    "/v1/test_helpers/pos/seed": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PosSeedModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: seed a café — categories, products with sizes and modifiers on the country pack's tax classes, a till layout and a register — once per account; and a day of orders paid in cash and on another terminal, once per business day, through the real orders and tenders.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PosSeedBody"
              }
            }
          }
        },
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersSeedPos"
      }
    },
    "/v1/test_helpers/pos/devices": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DevicePairingModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: pair a test device to a register (the seeded one by default) and answer its device token — once — as pairing does.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PosTestDeviceBody"
              }
            }
          }
        },
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersPairPosDevice"
      }
    },
    "/v1/test_helpers/pos/pair_code": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PairingCodeModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "TEST MODE: mint a pairing code for a register (the seeded one by default) without the hourly limit — six digits, ten minutes, one device.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PosPairCodeBody"
              }
            }
          }
        },
        "tags": [
          "Test helpers"
        ],
        "operationId": "testHelpersMintPosPairingCode"
      }
    },
    "/v1/product_categories": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductCategoryList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List product categories, newest first. `?status=active|archived`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only categories in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "listProductCategories"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductCategoryModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a product category — a shelf on the till",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductCategoryBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "createProductCategory"
      }
    },
    "/v1/product_categories/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductCategoryModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a product category",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "retrieveProductCategory"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductCategoryModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a product category. Only what is sent changes.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductCategoryBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "updateProductCategory"
      }
    },
    "/v1/product_categories/{id}/archive": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductCategoryModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Archive a product category: its products keep their `category`; the shelf is no longer shown",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "archiveProductCategory"
      }
    },
    "/v1/products": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List products, newest first, each with its active variants. `?status=` (`active`, `draft` or `archived`), `?category=`, `?available=`, `?kind=`, `?channel=` (`till`, `online` or `booking_page`); `?q=` searches names and SKUs (prefix, then a near miss) and answers a ranked list of up to `limit`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only products in this status: `active`, `draft` (sold nowhere yet) or `archived`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "category",
            "in": "query",
            "required": false,
            "description": "Only products on this shelf (`pcat_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "available",
            "in": "query",
            "required": false,
            "description": "`true` or `false`: only products on (or off) sale.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "kind",
            "in": "query",
            "required": false,
            "description": "`retail`, `food`, `drink`, `service`, `fee`, `ingredient`, `digital`, `gift_card`, `subscription` or `bundle`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "channel",
            "in": "query",
            "required": false,
            "description": "Only products sold there: `till`, `online` or `booking_page`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "q",
            "in": "query",
            "required": false,
            "description": "Search: the start of a name, of a word in it or of a SKU — the product's or a variant's — and near misses for a mistyped name. Answers a ranked list of up to `limit` (active products unless `status` says otherwise); no cursor.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "listProducts"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a product — with its options, whose every combination becomes a variant; a product with none has one default variant. A paired till adds the product an unknown barcode names (`name`, `amount`, `barcodes`, `sold_by`, `unit`, `category`) for a person whose till permissions include `price_override`, or with a second person's approval.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "createProduct"
      }
    },
    "/v1/products/lookup": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductLookupModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What a scanned barcode or a typed SKU names: the product and the variant. `?barcode=` or `?sku=`. 404 when nothing sellable carries it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "barcode",
            "in": "query",
            "required": false,
            "description": "A scanned barcode: the variant that carries it.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sku",
            "in": "query",
            "required": false,
            "description": "A SKU — a variant's own, or a product's (its default variant).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "lookupProduct"
      }
    },
    "/v1/products/bulk": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductBulkUpdateModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change many prices at once — products' and variants' `amount` and `cost_amount` — in one transaction: all applied, or none",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductBulkBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "bulkUpdateProducts"
      }
    },
    "/v1/products/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a product, with its active variants",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "retrieveProduct"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a product. Only what is sent changes; new `options` regenerate its variants, keeping the ones that still exist.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "updateProduct"
      }
    },
    "/v1/products/{id}/archive": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Archive a product: gone from the till and from lookups; kept for what already sold",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "archiveProduct"
      }
    },
    "/v1/products/{id}/available": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The 86 switch: `{available: false}` takes it off every channel at once; `true` puts it back",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductAvailableBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "setProductAvailability"
      }
    },
    "/v1/products/{id}/online_checklist": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OnlineChecklistModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What a product lacks before it can go online in the store, each with its field and the dashboard link to it",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "retrieveProductOnlineChecklist"
      }
    },
    "/v1/products/{id}/publish_online": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Put a product online in the store, the only way into it: it needs a fixed price, a photo with a description for people who can't see it, words its facts back, and to be active. Refused with everything missing (`checklist`, each with its `field` and `fix_url`).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "publishProductOnline"
      }
    },
    "/v1/products/{id}/unpublish_online": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Take a product out of the store; the till keeps selling it",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "unpublishProductOnline"
      }
    },
    "/v1/products/{id}/variants": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductVariantList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List a product's variants, newest first — archived ones included; `?status=active|archived`. The product itself carries its active variants in option order.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only variants in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "listProductVariants"
      }
    },
    "/v1/products/{id}/variants/{variant}": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductVariantModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a variant's own price, cost, SKU and barcodes. Which variants exist is the product's `options`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "variant",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductVariantBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "updateProductVariant"
      }
    },
    "/v1/products/{id}/image": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Give the product a picture: PNG or JPEG, re-encoded by Tuppence, served publicly",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductImageBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "setProductImage"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Remove the product's picture",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "removeProductImage"
      }
    },
    "/v1/modifier_groups": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ModifierGroupList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List modifier groups, newest first, each with its active modifiers. `?status=active|archived`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only modifier groups in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "listModifierGroups"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ModifierGroupModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a modifier group — `min`/`max` choices (0/1 an optional single, 1/1 required, 0/null any number) — with its modifiers",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ModifierGroupBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "createModifierGroup"
      }
    },
    "/v1/modifier_groups/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ModifierGroupModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a modifier group, with its active modifiers",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "retrieveModifierGroup"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ModifierGroupModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a modifier group's name, choices and place. A required group never asks for more choices than it has modifiers.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ModifierGroupBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "updateModifierGroup"
      }
    },
    "/v1/modifier_groups/{id}/archive": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ModifierGroupModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Archive a modifier group and its modifiers: no longer offered on any product or shelf that names it",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "archiveModifierGroup"
      }
    },
    "/v1/modifier_groups/{id}/modifiers": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ModifierList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List a group's modifiers, newest first — archived ones included; `?status=active|archived`. The group itself carries its active ones in order.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only modifiers in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "listModifiers"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ModifierModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Add a modifier to a group",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ModifierBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "createModifier"
      }
    },
    "/v1/modifier_groups/{id}/modifiers/{modifier}": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ModifierModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a modifier's name, price, default and kitchen flag — or retire it with `status: archived`, never below the group's `min`",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "modifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ModifierUpdateBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "updateModifier"
      }
    },
    "/v1/tax_rates": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaxRateList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List tax components, newest first — your country's pack seeds them the first time you look. `?status=active|archived`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only components in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Tax"
        ],
        "operationId": "listTaxRates"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaxRateModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a tax component — a rate in parts per million, where it is levied, and what the receipt prints beside it",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TaxRateBody"
              }
            }
          }
        },
        "tags": [
          "Tax"
        ],
        "operationId": "createTaxRate"
      }
    },
    "/v1/tax_rates/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaxRateModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a tax component",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Tax"
        ],
        "operationId": "retrieveTaxRate"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaxRateModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a tax component. Only what is sent changes; what is priced from now on uses it — a paid order keeps the tax it was charged.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TaxRateBody"
              }
            }
          }
        },
        "tags": [
          "Tax"
        ],
        "operationId": "updateTaxRate"
      }
    },
    "/v1/tax_rates/{id}/archive": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaxRateModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retire a tax component — refused while an active tax class names it",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Tax"
        ],
        "operationId": "archiveTaxRate"
      }
    },
    "/v1/tax_classes": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaxClassList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List tax classes, newest first — your country's pack seeds them the first time you look. `?status=active|archived`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only classes in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Tax"
        ],
        "operationId": "listTaxClasses"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaxClassModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a tax class — rules by order type, each naming its components; the last rule is the default",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TaxClassBody"
              }
            }
          }
        },
        "tags": [
          "Tax"
        ],
        "operationId": "createTaxClass"
      }
    },
    "/v1/tax_classes/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaxClassModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a tax class",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Tax"
        ],
        "operationId": "retrieveTaxClass"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaxClassModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a tax class. `rules` is the whole list and must end in a default rule. A class from your country's pack, once edited, is yours: choosing a province or state later leaves it as you made it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TaxClassBody"
              }
            }
          }
        },
        "tags": [
          "Tax"
        ],
        "operationId": "updateTaxClass"
      }
    },
    "/v1/tax_classes/{id}/archive": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaxClassModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retire a tax class — refused while an active product carries it or a location falls back to it",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Tax"
        ],
        "operationId": "archiveTaxClass"
      }
    },
    "/v1/tax_classes/{id}/preview": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaxClassPreviewModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What the class does to a price for an order type — the rule that applies, each component's tax, the net and the total — priced by the order engine under a location's settings. Nothing is stored.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TaxPreviewBody"
              }
            }
          }
        },
        "tags": [
          "Tax"
        ],
        "operationId": "previewTaxClass"
      }
    },
    "/v1/locations/{id}/tax": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LocationTaxSettingsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A location's tax settings: inclusive or exclusive prices, rounding, cash rounding, the default class, registration numbers, exempt reasons, and its province or state",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Tax"
        ],
        "operationId": "retrieveLocationTax"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LocationTaxSettingsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change a location's tax settings. Only what is sent changes; a `region` seeds that province's or state's pack. A change never reprices a paid order: orders keep the tax they were priced with.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LocationTaxBody"
              }
            }
          }
        },
        "tags": [
          "Tax"
        ],
        "operationId": "updateLocationTax"
      }
    },
    "/v1/discounts": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DiscountList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List discounts, newest first. `?status=active|archived`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only discounts in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "listDiscounts"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DiscountModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a named discount — a percentage or an amount off a line or the order, with the approval rule the till enforces",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DiscountBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "createDiscount"
      }
    },
    "/v1/discounts/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DiscountModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a discount",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "retrieveDiscount"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DiscountModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a discount. Only what is sent changes; orders it was applied to keep what they were given.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DiscountBody"
              }
            }
          }
        },
        "tags": [
          "Products"
        ],
        "operationId": "updateDiscount"
      }
    },
    "/v1/discounts/{id}/archive": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DiscountModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Archive a discount: no longer offered at the till",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "archiveDiscount"
      }
    },
    "/v1/pos_layouts": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PosLayoutList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List till layouts, newest first. `?status=active|archived`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only layouts in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Registers"
        ],
        "operationId": "listPosLayouts"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PosLayoutModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create a till layout — pages of tiles, each a product, a variant, a shelf, a discount or an action",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PosLayoutBody"
              }
            }
          }
        },
        "tags": [
          "Registers"
        ],
        "operationId": "createPosLayout"
      }
    },
    "/v1/pos_layouts/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PosLayoutModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a till layout",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Registers"
        ],
        "operationId": "retrievePosLayout"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PosLayoutModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a till layout. `pages` is the whole grid: what is sent replaces what was there.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PosLayoutBody"
              }
            }
          }
        },
        "tags": [
          "Registers"
        ],
        "operationId": "updatePosLayout"
      }
    },
    "/v1/pos_layouts/{id}/archive": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PosLayoutModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Archive a till layout — refused while a register shows it",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Registers"
        ],
        "operationId": "archivePosLayout"
      }
    },
    "/v1/pos/catalogue": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PosCatalogueModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The catalogue a till sells from — tax components and classes, shelves, products sold at the till with their variants, modifier groups, discounts, layouts and the location's tax settings — with its version: whole, or with `since` only what changed after that version (gone rows in `removed`).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "since",
            "in": "query",
            "required": false,
            "description": "A version you hold — an earlier answer's `version`: only what changed after it. Leave it out for the whole catalogue.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Whose tax settings to include (`loc_…`). A paired till always gets its own location's.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Products"
        ],
        "operationId": "retrievePosCatalogue"
      }
    },
    "/v1/orders": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List orders, newest first, each with its lines and tenders. `?register=`, `?device=`, `?location=`, `?status=`, `?business_day=`, `?staff_member=`, `?customer=`, `?booking=`, `?source=`, `?order_type=`, `?fulfilment_status=` (a store order's goods), `?total_gte=`, `?total_lte=`, `?needs_review=`, `?number=` (the number on its receipt), `?from=`/`?to=` (business days), `?q=` (a receipt or store number, or a customer's email or name). A till sees its own location's.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "register",
            "in": "query",
            "required": false,
            "description": "Only orders rung up on this register (`reg_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "device",
            "in": "query",
            "required": false,
            "description": "Only orders made on this till (`posd_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Only orders at this location (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only orders in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "business_day",
            "in": "query",
            "required": false,
            "description": "Only this business day's, `YYYY-MM-DD`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "staff_member",
            "in": "query",
            "required": false,
            "description": "Only orders this person rang up (`stf_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "customer",
            "in": "query",
            "required": false,
            "description": "Only this customer's (`cus_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "source",
            "in": "query",
            "required": false,
            "description": "`till`, `api`, `agent`, `online`, `table_qr`, `booking` or `kiosk`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "order_type",
            "in": "query",
            "required": false,
            "description": "`eat_in`, `takeaway`, `delivery` or `collection`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "total_gte",
            "in": "query",
            "required": false,
            "description": "Only orders whose total is at least this (minor units).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "total_lte",
            "in": "query",
            "required": false,
            "description": "Only orders whose total is at most this (minor units).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "needs_review",
            "in": "query",
            "required": false,
            "description": "`true`: only orders flagged for review (an offline conflict); `false`: none.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "booking",
            "in": "query",
            "required": false,
            "description": "Only the orders this booking was checked out on (`bk_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "number",
            "in": "query",
            "required": false,
            "description": "Only orders with this number — the one on the receipt (`42`, or `#0042`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "q",
            "in": "query",
            "required": false,
            "description": "Search: an order's number (`42`, `#0042`), or its customer's email (or the start of it) or part of their name.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "Only orders from this business day on, `YYYY-MM-DD`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "Only orders up to this business day, `YYYY-MM-DD`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Orders"
        ],
        "operationId": "listOrders"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Create an order — its lines priced by the server. A till's own id (`ord_…`) is accepted once (`409 order_exists`); a till's figures that disagree are refused with the server's (`422 totals_mismatch`).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateOrderBody"
              }
            }
          }
        },
        "tags": [
          "Orders"
        ],
        "operationId": "createOrder"
      }
    },
    "/v1/orders/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve an order, with its lines and tenders",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Orders"
        ],
        "operationId": "retrieveOrder"
      }
    },
    "/v1/orders/{id}/events": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderEventList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "An order's event log, in its sequence — who did what, when (by their clock and ours), and who approved it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Orders"
        ],
        "operationId": "listOrderEvents"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderSyncModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Append events to an order, in order — lines added, changed and voided, its type, a hold, a resume, a void — and answer the order as the server priced it. A till's events carry its own sequence: a gap is `409 sequence_gap`; what the server holds is skipped. All or nothing.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OrderEventsBody"
              }
            }
          }
        },
        "tags": [
          "Orders"
        ],
        "operationId": "appendOrderEvents"
      }
    },
    "/v1/orders/{id}/hold": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Hold an open order — parked for later, on this till or another",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReasonBody"
              }
            }
          }
        },
        "tags": [
          "Orders"
        ],
        "operationId": "holdOrder"
      }
    },
    "/v1/orders/{id}/resume": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Resume a held order",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReasonBody"
              }
            }
          }
        },
        "tags": [
          "Orders"
        ],
        "operationId": "resumeOrder"
      }
    },
    "/v1/orders/{id}/void": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Void an open or held order with nothing paid — a `reason` is required. A paid order is undone by a return.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReasonBody"
              }
            }
          }
        },
        "tags": [
          "Orders"
        ],
        "operationId": "voidOrder"
      }
    },
    "/v1/orders/{id}/order_type": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Switch an open order's type — eat in, takeaway, delivery or collection — and reprice every line for it",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OrderTypeBody"
              }
            }
          }
        },
        "tags": [
          "Orders"
        ],
        "operationId": "setOrderType"
      }
    },
    "/v1/orders/{id}/discounts": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Discount an open order: a reusable discount (`disc_…`, scoped `order`), or one typed at the till with a `reason`. Over the person's `discount_up_to_bps` — or the discount's own `requires_approval_over_bps` — it needs a manager's approval (`Tuppence-Approval`).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApplyDiscountBody"
              }
            }
          }
        },
        "tags": [
          "Orders"
        ],
        "operationId": "applyOrderDiscount"
      }
    },
    "/v1/orders/{id}/tax_exemption": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Exempt an open order from tax for one of its location's exempt reasons, with the buyer's reference (`reason: null` takes it off). At a till it is held to the `price_override` permission (an approval otherwise).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SetTaxExemptionBody"
              }
            }
          }
        },
        "tags": [
          "Orders"
        ],
        "operationId": "setOrderTaxExemption"
      }
    },
    "/v1/orders/{id}/customer": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Say who an order is for: a customer (`cus_…`), or someone new from a `name` and `phone` — the customer already holding that number is found, never duplicated. `customer: null` takes them off.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OrderCustomerBody"
              }
            }
          }
        },
        "tags": [
          "Orders"
        ],
        "operationId": "setOrderCustomer"
      }
    },
    "/v1/orders/{id}/tenders": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TenderList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "An order's tenders, in the order they were taken — failed ones included",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Orders"
        ],
        "operationId": "listOrderTenders"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderTenderModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Take a tender against an open order: cash (`tendered` — the change and the cash rounding worked out — or an exact `amount`), a card (QR-to-pay: show `next_action.url` as a QR code; or the customer's saved `payment_method`), or money taken outside Tuppence (`external`). Split and partial, up to 20; a tender's own tip raises the total and what is paid together. Paid when nothing is left due — completed at once where the register's receipt step is `none`. A card waits (`pending`) until its payment settles; one waits at a time, and the order's contents are fixed once a tender is taken.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TakeTenderBody"
              }
            }
          }
        },
        "tags": [
          "Orders"
        ],
        "operationId": "createOrderTender"
      }
    },
    "/v1/orders/{id}/returns": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderReturnModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Take a return against a paid or completed sale: particular `lines` (each with how many), or `all`. Priced from the sale as it was paid — the price and the tax then — and never more than was sold and not yet returned. The money goes back the way it came, apportioned over the sale's tenders by what each has left: a card's part as a refund on its own payment, never another card; cash out of the drawer, rounded as the location rounds cash. Everything back voids the sale. Needs the person's `refund_up_to` (and `void_after_payment` to void) — or an approval; a key needs `refunds:write` too.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReturnBody"
              }
            }
          }
        },
        "tags": [
          "Orders"
        ],
        "operationId": "createOrderReturn"
      }
    },
    "/v1/orders/{id}/complete": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Complete a paid order once the receipt step is done — `receipt` says how (`print`, `email`, `sms`, `qr` or `none`), with the `recipient` an e-mailed or texted receipt goes to and, for a full VAT invoice, the buyer's `customer_details`. Where the register's receipt step is `none`, a paid order completes by itself.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CompleteBody"
              }
            }
          }
        },
        "tags": [
          "Orders"
        ],
        "operationId": "completeOrder"
      }
    },
    "/v1/orders/{id}/details": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderDetailsModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The order page: who it is for, its delivery or collection, what the shopper was shown at checkout, whether it can still be changed, and its timeline — its log, payments, refunds, stock and messages, oldest first",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Orders"
        ],
        "operationId": "retrieveOrderDetails"
      }
    },
    "/v1/orders/{id}/delivery_address": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderAddressChangedModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "description": "This call's own: `invalid_status` (the order is not a store order waiting to be sent). Any other code is one every call can answer (`Conflict`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Change where a store order goes, before it is sent. The country stays the one it was priced for.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OrderDeliveryAddressBody"
              }
            }
          }
        },
        "tags": [
          "Orders"
        ],
        "operationId": "changeOrderDeliveryAddress"
      }
    },
    "/v1/orders/{id}/resend_confirmation": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderConfirmationSentModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "description": "This call's own: `invalid_status` (the order is not a paid store order, was cancelled, or the shopper gave no email address). Any other code is one every call can answer (`Conflict`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Send a store order's confirmation again, word for word, to the email the shopper gave at checkout, with the same link to the order's status page.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Orders"
        ],
        "operationId": "resendOrderConfirmation"
      }
    },
    "/v1/orders/{id}/release_hold": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Release the hold on a store order's sending (92-11b: the risky-order job's, or anyone's), so it can be packed and sent. Nothing is refunded or cancelled, and the job doesn't hold it again.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Orders"
        ],
        "operationId": "releaseOrderHold"
      }
    },
    "/v1/customers/{id}/orders": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What a customer has bought: their orders, newest first, each with its lines and tenders — `?status=`, `?location=` and the rest of `GET /v1/orders`'s filters. A till sees its own location's.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Only orders at this location (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Only orders in this status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Orders"
        ],
        "operationId": "listCustomerOrders"
      }
    },
    "/v1/orders/{id}/e_receipt": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderEReceiptModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The e-receipt's address, typed at the till: kept on the order's customer (or the customer holding it, put on the order when it is for nobody yet). Marketing is a separate, unticked box — `marketing_consent: true` records consent to your words with `source: pos`, the register and the person signed in; without it, consent is never set.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EReceiptBody"
              }
            }
          }
        },
        "tags": [
          "Orders"
        ],
        "operationId": "setOrderEReceipt"
      }
    },
    "/v1/orders/{id}/receipt": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderReceiptModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A paid order's receipt, in its location's language: `?format=json` (the default — the receipt's words and figures, the printer's lines and the customer's page), `?format=html` (a page for the browser's print dialog) or `?format=escpos` (a receipt printer's bytes, `&width=80` or `58`, with the page's QR code). `&full_invoice=true` renders it as a full VAT (or tax) invoice.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "`json` (the default), `html` (a page for the browser's print dialog) or `escpos` (`application/octet-stream`: ESC/POS in code page 858 for an Epson- or Star-compatible printer).",
            "in": "query",
            "name": "format",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "The paper, in mm: `80` (48 columns) or `58` (32). The register's when left out.",
            "in": "query",
            "name": "width",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "`true`: a full VAT (or tax) invoice — naming the buyer the last full invoice sent for the order named.",
            "in": "query",
            "name": "full_invoice",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "One of the order's receipts by its id (a reprint's, which says COPY) rather than the original — for printing it (32-10).",
            "in": "query",
            "name": "receipt",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Orders"
        ],
        "operationId": "retrieveOrderReceipt"
      }
    },
    "/v1/orders/by_receipt": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Find the order a receipt is for, from what its QR code says — the receipt page's address — or its token: the sale a customer brought back, for a return or a reprint. A till finds its own location's. Sent in the body, never the URL: the token opens the customer's page.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OrderByReceiptBody"
              }
            }
          }
        },
        "tags": [
          "Orders"
        ],
        "operationId": "findOrderByReceipt"
      }
    },
    "/v1/orders/{id}/receipts": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderReceiptModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Give an order's receipt: e-mailed (`recipient` an address) in the business's name, texted at cost (`recipient` a phone number), shown as a QR code that opens its page, or printed — and, with `customer_details`, as a full VAT invoice naming the buyer. A paid order is completed by it; a completed one gets another receipt beside its original (printed, it is a reprint that says COPY).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OrderReceiptSendBody"
              }
            }
          }
        },
        "tags": [
          "Orders"
        ],
        "operationId": "sendOrderReceipt"
      }
    },
    "/v1/orders/{id}/reprint": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderReceiptModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Print a completed order's receipt again: a `reprinted` event on its log (who, at which till) and a receipt that says COPY.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Orders"
        ],
        "operationId": "reprintOrderReceipt"
      }
    },
    "/v1/printers": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PrinterList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List printers, newest first: `?location=loc_…`, `?register=reg_…` (the ones it prints to), `?kind=receipt|kitchen`. A till sees its own register's.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Only printers at this location (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "register",
            "in": "query",
            "required": false,
            "description": "Only the printers this register prints to (`reg_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "kind",
            "in": "query",
            "required": false,
            "description": "`receipt` or `kitchen`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "include_archived",
            "in": "query",
            "required": false,
            "description": "`true`: archived printers too.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Printers"
        ],
        "operationId": "listPrinters"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PrinterModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Add a printer at a location. A CloudPRNT or Server Direct Print printer's `secret` is in this answer only.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PrinterBody"
              }
            }
          }
        },
        "tags": [
          "Printers"
        ],
        "operationId": "createPrinter"
      }
    },
    "/v1/printers/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PrinterModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a printer, with its status",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Printers"
        ],
        "operationId": "retrievePrinter"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PrinterModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Update a printer. Only what is sent changes; a move onto CloudPRNT or Server Direct Print mints its secret.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PrinterBody"
              }
            }
          }
        },
        "tags": [
          "Printers"
        ],
        "operationId": "updatePrinter"
      }
    },
    "/v1/printers/{id}/secret": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PrinterModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A new cloud secret for the printer, shown once; the old one stops working at once.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Printers"
        ],
        "operationId": "rotatePrinterSecret"
      }
    },
    "/v1/printers/{id}/compatibility": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PrinterModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The compatibility page's answers, from the till that printed it: what printed as it should. A QR code that did not prints as an image from then on; accents that did not, in PC437.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PrinterCapabilitiesBody"
              }
            }
          }
        },
        "tags": [
          "Printers"
        ],
        "operationId": "updatePrinterCompatibility"
      }
    },
    "/v1/printers/{id}/status": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PrinterModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A till's word on a printer it prints to directly: out of paper, cover open, ready again.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PrinterStatusBody"
              }
            }
          }
        },
        "tags": [
          "Printers"
        ],
        "operationId": "reportPrinterStatus"
      }
    },
    "/v1/printers/{id}/test": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PrintJobModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Queue the compatibility page for a printer that polls Tuppence. A LAN or Bluetooth printer prints it from a till beside it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Printers"
        ],
        "operationId": "testPrinter"
      }
    },
    "/v1/printers/{id}/test_label": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/zpl": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A label printer's test label, as it prints: ZPL to send it over the network, Bluetooth or USB, or a 4x6 PDF for AirPrint and the print dialog. Its name and TEST across a 4x6 label.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Printers"
        ],
        "operationId": "getPrinterTestLabel"
      }
    },
    "/v1/printers/{id}/archive": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PrinterModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Archive a printer: it stops answering its printer, and its secret with it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Printers"
        ],
        "operationId": "archivePrinter"
      }
    },
    "/v1/print_jobs": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PrintJobList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List print jobs, newest first: `?printer=prn_…` (a till must name one), `?status=`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "printer",
            "in": "query",
            "required": false,
            "description": "Only this printer's jobs (`prn_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "`queued`, `printing`, `printed`, `failed` or `cancelled`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Printers"
        ],
        "operationId": "listPrintJobs"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PrintJobModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Queue a print for a printer that polls Tuppence: a receipt, a kitchen ticket, the compatibility page, or the drawer's kick alone (a no-sale). `open_drawer` only on a cash sale's completion or a no-sale, once each.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PrintJobBody"
              }
            }
          }
        },
        "tags": [
          "Printers"
        ],
        "operationId": "createPrintJob"
      }
    },
    "/v1/print_jobs/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PrintJobModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a print job: queued, printing, printed, or failed after three tries",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Printers"
        ],
        "operationId": "retrievePrintJob"
      }
    },
    "/v1/print_jobs/{id}/retry": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PrintJobModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Send a failed or cancelled job again: three more tries.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Printers"
        ],
        "operationId": "retryPrintJob"
      }
    },
    "/v1/print_jobs/{id}/cancel": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PrintJobModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Cancel a job that has not printed.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Printers"
        ],
        "operationId": "cancelPrintJob"
      }
    },
    "/v1/tenders/{id}/cancel": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderTenderModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Cancel a card tender still waiting on its payment — the customer will not pay by QR after all: its payment is cancelled, so it can no longer be paid, and the tender fails (`tender_failed`). One whose payment has gone through counts as soon as it settles.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Orders"
        ],
        "operationId": "cancelTender"
      }
    },
    "/v1/bookings/{id}/order": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Check a booking out at the till: an open order with a line per item at the price booked (the staff member on the line), the client as its customer, the deposit paid before as a `booking_deposit` tender and any voucher, package or membership hold applied. Add to it and take the rest as any order; when it completes the tip goes to the visit's staff, the booking's money is worked out with it and the visit is marked done. `409 already_checked_out` once an order for it stands.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BookingCheckoutBody"
              }
            }
          }
        },
        "tags": [
          "Orders"
        ],
        "operationId": "checkoutBooking"
      }
    },
    "/v1/shifts": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShiftList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List shifts, newest first — the cash-up history. `?register=`, `?location=`, `?status=open|closed`, `?business_day=`. A till sees its own register's.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "register",
            "in": "query",
            "required": false,
            "description": "Only this register's shifts (`reg_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Only shifts at this location (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "`open` or `closed`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "business_day",
            "in": "query",
            "required": false,
            "description": "Only shifts opened on this business day, `YYYY-MM-DD`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shifts"
        ],
        "operationId": "listShifts"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShiftModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Open a shift on a register with its float — one open per register (`409 shift_open`). Cash tenders at the register go into its drawer from now on; a till with no open shift takes no cash (`409 no_open_shift`). Takes the person's `open_close_shift` at a till.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OpenShiftBody"
              }
            }
          }
        },
        "tags": [
          "Shifts"
        ],
        "operationId": "openShift"
      }
    },
    "/v1/shifts/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShiftModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a shift: its float, who opened and closed it, and at close the count and the variance",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shifts"
        ],
        "operationId": "retrieveShift"
      }
    },
    "/v1/shifts/{id}/report": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShiftReportModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A shift's report: the X while it is open (worked out now, kept nowhere) and the Z once it is closed, as it was written — takings by category and by tender, tax by rate, refunds, voids, tips, no-sales and the drawer's expected cash. At a till it takes `see_reports`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shifts"
        ],
        "operationId": "retrieveShiftReport"
      }
    },
    "/v1/shifts/{id}/pdf": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A shift's report as a PDF: the Z of a closed shift — the figures its owners were emailed — or the X of one still open",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Shifts"
        ],
        "operationId": "retrieveShiftPdf"
      }
    },
    "/v1/shifts/{id}/cash_movements": {
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CashMovementModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Move cash in or out of an open shift's drawer by hand: a `pay_in`, a `pay_out`, a `drop` to the safe, a `tip_out` (the person's `pay_in_out`) — or a `no_sale`, the drawer opened with nothing sold (`open_drawer_without_sale`), always on the Z. A pay-in, a pay-out and a no-sale say why.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": true,
            "description": "REQUIRED: a unique key per operation (a UUID). Retrying with the same key returns the first result — money moves once.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CashMovementBody"
              }
            }
          }
        },
        "tags": [
          "Shifts"
        ],
        "operationId": "createCashMovement"
      }
    },
    "/v1/shifts/{id}/close": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShiftModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Close a shift with the drawer's count — note by note and coin by coin in the country's denominations (`counted.denominations`), or one figure (`counted.total`) — and a note: expected against counted, the variance (reported, never corrected), and the Z written once. Takes the person's `open_close_shift` at a till.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CloseShiftBody"
              }
            }
          }
        },
        "tags": [
          "Shifts"
        ],
        "operationId": "closeShift"
      }
    },
    "/v1/stock_levels": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StockLevelList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List stock levels, newest first: a tracked variant's quantity at a location (the sum of its movements — below zero allowed, and flagged `negative`), its reorder point and whether it is `below_reorder`. `?location=`, `?product=`, `?variant=`, `?below_reorder=true`, `?negative=true`. A till sees its own location's.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Only levels at this location (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "product",
            "in": "query",
            "required": false,
            "description": "Only this product's variants (`prod_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "variant",
            "in": "query",
            "required": false,
            "description": "Only this variant (`pvar_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "below_reorder",
            "in": "query",
            "required": false,
            "description": "`true`: only those at or below their reorder point.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "negative",
            "in": "query",
            "required": false,
            "description": "`true`: only those below zero.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Stock"
        ],
        "operationId": "listStockLevels"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StockLevelModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Set (or clear, with null) a variant's reorder point at a location — the level is made at zero if it has none. The quantity is never set here: it moves only by movements.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReorderPointBody"
              }
            }
          }
        },
        "tags": [
          "Stock"
        ],
        "operationId": "setStockReorderPoint"
      }
    },
    "/v1/stock_movements": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StockMovementList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List stock movements, newest first: each sale (and its void), each return taken back into stock and each adjustment, with who made it and the level after. `?location=`, `?product=`, `?variant=`, `?order=`, `?kind=`. A till sees its own location's.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Only movements at this location (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "product",
            "in": "query",
            "required": false,
            "description": "Only this product's variants (`prod_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "variant",
            "in": "query",
            "required": false,
            "description": "Only this variant (`pvar_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "order",
            "in": "query",
            "required": false,
            "description": "Only those an order moved — a sale, or a return (`ord_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "kind",
            "in": "query",
            "required": false,
            "description": "`sale`, `return`, `adjustment` (and M34's `received`, `transfer`, `count`, `waste`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Stock"
        ],
        "operationId": "listStockMovements"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StockMovementModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Adjust a tracked variant's stock at a location by hand — counted in, found, broken — with a `reason`: an `adjustment` movement, signed. Crossing the reorder point on the way down raises `stock.low`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AdjustmentBody"
              }
            }
          }
        },
        "tags": [
          "Stock"
        ],
        "operationId": "createStockMovement"
      }
    },
    "/v1/fiscal/closures": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FiscalClosureList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List fiscal closures, newest first — a location's daily, monthly and annual totals. `?location=`, `?kind=day|month|year`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Only this location's closures (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "kind",
            "in": "query",
            "required": false,
            "description": "`day`, `month` or `year`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Fiscal"
        ],
        "operationId": "listFiscalClosures"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FiscalClosureModel"
                }
              }
            },
            "description": "Success"
          },
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FiscalClosureModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Close a location's ended business day, month or year: its receipts totalled, the grand totals carried on and the closure chained — once (asked again, the same closure). Earlier periods with receipts and no closure are closed first, in order; a period still running is `409 invalid_state`. The hourly sweep closes every ended period with receipts by itself.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CloseBody"
              }
            }
          }
        },
        "tags": [
          "Fiscal"
        ],
        "operationId": "createFiscalClosure"
      }
    },
    "/v1/fiscal/closures/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FiscalClosureModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a fiscal closure: its period's totals, the grand totals through it, its chain",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Fiscal"
        ],
        "operationId": "retrieveFiscalClosure"
      }
    },
    "/v1/fiscal/archive": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FiscalArchiveModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Export a location's fiscal journal for business days `from`–`to`: every receipt's canonical payload with its chain, and the closures inside — `?format=json` (the default; re-verifiable from nothing else) or `?format=csv` (a row per receipt with its hashes and payload).",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "description": "`json` (the default) or `csv`.",
            "in": "query",
            "name": "format",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "The location (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "The first business day, `YYYY-MM-DD`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "The last business day, `YYYY-MM-DD`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Fiscal"
        ],
        "operationId": "retrieveFiscalArchive"
      }
    },
    "/v1/fiscal/verify": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FiscalVerificationModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Re-check a location's fiscal journal for business days `from`–`to` from scratch: each receipt's hash recomputed from its rows and linked to the one before, no number missing, and each closure's totals re-added from its receipts and its chain recomputed. Answers what broke, where.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VerifyBody"
              }
            }
          }
        },
        "tags": [
          "Fiscal"
        ],
        "operationId": "verifyFiscalJournal"
      }
    },
    "/v1/pos_reports/sales": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PosSalesReportModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The point of sale's sales report: gross, discounts, refunds, net, VAT by rate, service charge, tips, what was taken by tender, transactions and the average sale; by item, shelf, staff member, hour and register; and the range's cash-ups with their variance. `business_day` (`YYYY-MM-DD`), or `from` and `to` (up to 366 business days); with none, today — each location's own business day by its cutoff, on the account's clock. `location` and `register` narrow it. A staff login sees its own line only.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "business_day",
            "in": "query",
            "required": false,
            "description": "One business day, `YYYY-MM-DD`. Leave out every day for today: each location's own.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "The first business day, `YYYY-MM-DD`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "The last business day, `YYYY-MM-DD` (up to 366 days after `from`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Only this location (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "register",
            "in": "query",
            "required": false,
            "description": "Only this register (`reg_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Orders"
        ],
        "operationId": "retrievePosSalesReport"
      }
    },
    "/v1/pos_reports/sales.csv": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "text/csv": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The sales report as CSV, money in the currency's units. `view`: `summary` (the default: every figure, rate, tender and shelf), `items`, `categories`, `staff`, `hours`, `registers` or `tenders`. `business_day` (`YYYY-MM-DD`), or `from` and `to` (up to 366 business days); with none, today — each location's own business day by its cutoff, on the account's clock. `location` and `register` narrow it.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "business_day",
            "in": "query",
            "required": false,
            "description": "One business day, `YYYY-MM-DD`. Leave out every day for today: each location's own.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "The first business day, `YYYY-MM-DD`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "The last business day, `YYYY-MM-DD` (up to 366 days after `from`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Only this location (`loc_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "register",
            "in": "query",
            "required": false,
            "description": "Only this register (`reg_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "view",
            "in": "query",
            "required": false,
            "description": "`summary` (the default), `items`, `categories`, `staff`, `hours`, `registers` or `tenders`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Orders"
        ],
        "operationId": "retrievePosSalesReportCsv"
      }
    },
    "/v1/imports": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ImportList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "The import log, newest first. `?kind=`, `?status=`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "kind",
            "in": "query",
            "required": false,
            "description": "`services`, `clients`, `bookings`, `staff` or `time_off`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "`draft`, `ready`, `completed` or `undone`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Imports"
        ],
        "operationId": "listImports"
      },
      "post": {
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ImportModel"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Upload a spreadsheet to import: its columns are matched to the kind's fields (or mapped as you say) and, once enough are, it is dry-run — `dry_run` says what would be made, what is already here, and every row that would be refused and why. An export from Fresha, Booksy, Square, Vagaro or Treatwell is read as that export (`source`, `format`). Nothing is made until `…/run`.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateImportBody"
              }
            }
          }
        },
        "tags": [
          "Imports"
        ],
        "operationId": "createImport"
      }
    },
    "/v1/imports/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ImportModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve an import: its mapping, its dry run, and — once run — what it made.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Imports"
        ],
        "operationId": "retrieveImport"
      }
    },
    "/v1/imports/{id}/dry_run": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ImportModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Dry-run the import again — with a new `mapping` or `date_order` if you send one, or as it is (after you changed your setup): what the run would do now. Nothing is made.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DryRunImportBody"
              }
            }
          }
        },
        "tags": [
          "Imports"
        ],
        "operationId": "dryRunImport"
      }
    },
    "/v1/imports/{id}/run": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ImportModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Run a dry-run import: its rows are made, all at once, checked again as they are — `result` says how it went. Everything it makes carries its id, and `…/undo` takes it back for 24 hours.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Imports"
        ],
        "operationId": "runImport"
      }
    },
    "/v1/imports/{id}/undo": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ImportModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Conflict"
                }
              }
            },
            "description": "Conflict"
          },
          "410": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Gone"
                }
              }
            },
            "description": "Gone"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Undo an import within 24 hours of its run: everything it made is removed — except what has been used since (a client who has booked again), which is kept and listed in `undo.kept`. `410 undo_window_closed` after.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "required": false,
            "description": "A unique key per operation (a UUID). Retrying with the same key returns the first result instead of acting twice.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Imports"
        ],
        "operationId": "undoImport"
      }
    },
    "/v1/change_sets": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ChangeSetList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List change sets, newest first — filter by who made them (`actor_type`, `actor`), how (`source`), a job's run, the object changed, or status",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "name": "actor_type",
            "in": "query",
            "required": false,
            "description": "Only those made by `user`, `job` (the assistant), `api_key` or `agent`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "actor",
            "in": "query",
            "required": false,
            "description": "Only those made by this person, key, job or agent (its id).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "source",
            "in": "query",
            "required": false,
            "description": "`job`, `sentence`, `editor`, `assistant_chat`, `api` or `mcp`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "job_run",
            "in": "query",
            "required": false,
            "description": "Only the one a job's run made (`jrn_…`).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "object_type",
            "in": "query",
            "required": false,
            "description": "Only those changing this kind of object: `product`…",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "object_id",
            "in": "query",
            "required": false,
            "description": "Only those changing this object.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "`proposed`, `applied`, `reverted`, `declined`, `failed` and so on.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Change sets"
        ],
        "operationId": "listChangeSets"
      }
    },
    "/v1/change_sets/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ChangeSetModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a change set: each change with its before, after and undo",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Change sets"
        ],
        "operationId": "retrieveChangeSet"
      }
    },
    "/v1/change_sets/{id}/revert": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ChangeSetModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Undo a change set: its changes are put back in reverse order, as you — refused (`409 change_set_conflict`) when someone has changed the same thing since",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Change sets"
        ],
        "operationId": "revertChangeSet"
      }
    },
    "/v1/assistant_jobs": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AssistantJobList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List the assistant's jobs for this business: status, brief, levels, schedule and budgets",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Assistant jobs"
        ],
        "operationId": "listAssistantJobs"
      }
    },
    "/v1/assistant_jobs/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AssistantJobModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve one of the assistant's jobs",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Assistant jobs"
        ],
        "operationId": "retrieveAssistantJob"
      }
    },
    "/v1/assistant_jobs/{id}/runs": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AssistantJobRunList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A job's runs, newest first: why each ran, what it read, said, spent and changed",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Assistant jobs"
        ],
        "operationId": "listAssistantJobRuns"
      }
    },
    "/v1/assistant_jobs/{id}/briefs": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AssistantJobBriefList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "A job's brief, version by version, newest first (at most 20)",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Assistant jobs"
        ],
        "operationId": "listAssistantJobBriefs"
      }
    },
    "/v1/assistant_jobs/{id}/examples": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AssistantJobExampleList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "What the owner taught a job, newest first: proposals they edited, declined or undid",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Assistant jobs"
        ],
        "operationId": "listAssistantJobExamples"
      }
    },
    "/v1/store_briefs": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreBriefList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "List the morning briefs, newest first: Monday's is the weekly report",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/StartingAfter"
          },
          {
            "$ref": "#/components/parameters/EndingBefore"
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Assistant jobs"
        ],
        "operationId": "listStoreBriefs"
      }
    },
    "/v1/store_briefs/{id}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreBriefModel"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          }
        },
        "summary": "Retrieve a morning brief: its figures from the engines and its sentences",
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Tuppence-Account",
            "required": false,
            "description": "Tuppence Connect: act as one of your connected accounts (`acct_…`) — its payments, customers and bookings, not yours. Omit to act as your own account.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/TuppenceVersion"
          }
        ],
        "tags": [
          "Assistant jobs"
        ],
        "operationId": "retrieveStoreBrief"
      }
    }
  },
  "x-webhooks": {
    "store.site_updated": {
      "post": {
        "summary": "store.site_updated",
        "description": "Sent to every endpoint subscribed to `store.site_updated` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreSiteUpdatedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.site_updated",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
                    "object": "site",
                    "livemode": false,
                    "slug": "harbourgifts",
                    "previous_slug": null,
                    "slug_redirect_until": null,
                    "name": "Harbour Gifts",
                    "brand": {
                      "colours": {
                        "primary": "oklch(42% 0.09 230)",
                        "surface": "oklch(98% 0.01 90)"
                      },
                      "type": {
                        "pair": "editorial"
                      },
                      "radius": "soft",
                      "logo": {
                        "primary": "med_01K7HB3A5C7E9G1J3L5N7Q9S1U",
                        "mark": null,
                        "on_dark": null
                      },
                      "seed": {
                        "header": {
                          "logo_placement": "left"
                        },
                        "hero": {
                          "image": null
                        }
                      }
                    },
                    "navigation": {
                      "header": [
                        {
                          "label": "Candles",
                          "target": {
                            "kind": "collection",
                            "ref": "coll_01K7HB4D6F8H0K2M4P6R8T0V2X"
                          }
                        },
                        {
                          "label": "Book a workshop",
                          "target": {
                            "kind": "booking"
                          }
                        }
                      ],
                      "footer": [
                        {
                          "title": "Help",
                          "items": [
                            {
                              "label": "Delivery and returns",
                              "target": {
                                "kind": "path",
                                "path": "/delivery"
                              }
                            }
                          ]
                        }
                      ]
                    },
                    "seo": {
                      "title_template": "{page} | {site}",
                      "description": "Candles, mugs and gifts made by the sea in Whitby.",
                      "social_image": "med_01K7HB3A5C7E9G1J3L5N7Q9S1U",
                      "noindex": false
                    },
                    "locale": "en-GB",
                    "store_enabled": true,
                    "home": "store",
                    "published_version": "sver_01K7HB5E7G9J1L3N5Q7S9U1W3Y",
                    "scheduled_version": null,
                    "scheduled_at": null,
                    "headless_origins": [
                      "https://www.harbourgifts.example"
                    ],
                    "headless_enabled": true,
                    "settings": {
                      "ship_from_location": "loc_01J8ZK2B4D6F8H0K2M4P6R8T0V",
                      "delivery": null,
                      "checkout": {
                        "note_enabled": true,
                        "marketing_text": null
                      },
                      "trader": {
                        "legal_name": "Harbour Gifts Ltd",
                        "trading_name": "Harbour Gifts",
                        "address": null,
                        "email": "hello@harbourgifts.example",
                        "phone": null,
                        "vat_number": "GB123456789",
                        "vat_registered": true
                      },
                      "ai_training_crawlers": false
                    },
                    "booking_page": "bpage_01J8ZK3C5E7G9J1L3N5Q7S9U1W",
                    "domains": [
                      {
                        "id": "sitedom_01K7HB6F8H0K2M4P6R8T0V2X4Z",
                        "object": "site_domain",
                        "livemode": false,
                        "site": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
                        "hostname": "shop.harbourgifts.example",
                        "kind": "custom",
                        "role": "primary",
                        "status": "active",
                        "records": [],
                        "error": null,
                        "forwarding": null,
                        "checked": 1792310400,
                        "created": 1791720000
                      }
                    ],
                    "free_address": "https://shop.tuppence.ai/test/harbourgifts",
                    "subdomain_address": "https://harbourgifts.tuppence.shop",
                    "created": 1791720000,
                    "checkouts_paused": null
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.site_published": {
      "post": {
        "summary": "store.site_published",
        "description": "Sent to every endpoint subscribed to `store.site_published` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreSitePublishedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.site_published",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
                    "object": "site",
                    "livemode": false,
                    "slug": "harbourgifts",
                    "previous_slug": null,
                    "slug_redirect_until": null,
                    "name": "Harbour Gifts",
                    "brand": {
                      "colours": {
                        "primary": "oklch(42% 0.09 230)",
                        "surface": "oklch(98% 0.01 90)"
                      },
                      "type": {
                        "pair": "editorial"
                      },
                      "radius": "soft",
                      "logo": {
                        "primary": "med_01K7HB3A5C7E9G1J3L5N7Q9S1U",
                        "mark": null,
                        "on_dark": null
                      },
                      "seed": {
                        "header": {
                          "logo_placement": "left"
                        },
                        "hero": {
                          "image": null
                        }
                      }
                    },
                    "navigation": {
                      "header": [
                        {
                          "label": "Candles",
                          "target": {
                            "kind": "collection",
                            "ref": "coll_01K7HB4D6F8H0K2M4P6R8T0V2X"
                          }
                        },
                        {
                          "label": "Book a workshop",
                          "target": {
                            "kind": "booking"
                          }
                        }
                      ],
                      "footer": [
                        {
                          "title": "Help",
                          "items": [
                            {
                              "label": "Delivery and returns",
                              "target": {
                                "kind": "path",
                                "path": "/delivery"
                              }
                            }
                          ]
                        }
                      ]
                    },
                    "seo": {
                      "title_template": "{page} | {site}",
                      "description": "Candles, mugs and gifts made by the sea in Whitby.",
                      "social_image": "med_01K7HB3A5C7E9G1J3L5N7Q9S1U",
                      "noindex": false
                    },
                    "locale": "en-GB",
                    "store_enabled": true,
                    "home": "store",
                    "published_version": "sver_01K7HB5E7G9J1L3N5Q7S9U1W3Y",
                    "scheduled_version": null,
                    "scheduled_at": null,
                    "headless_origins": [
                      "https://www.harbourgifts.example"
                    ],
                    "headless_enabled": true,
                    "settings": {
                      "ship_from_location": "loc_01J8ZK2B4D6F8H0K2M4P6R8T0V",
                      "delivery": null,
                      "checkout": {
                        "note_enabled": true,
                        "marketing_text": null
                      },
                      "trader": {
                        "legal_name": "Harbour Gifts Ltd",
                        "trading_name": "Harbour Gifts",
                        "address": null,
                        "email": "hello@harbourgifts.example",
                        "phone": null,
                        "vat_number": "GB123456789",
                        "vat_registered": true
                      },
                      "ai_training_crawlers": false
                    },
                    "booking_page": "bpage_01J8ZK3C5E7G9J1L3N5Q7S9U1W",
                    "domains": [
                      {
                        "id": "sitedom_01K7HB6F8H0K2M4P6R8T0V2X4Z",
                        "object": "site_domain",
                        "livemode": false,
                        "site": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
                        "hostname": "shop.harbourgifts.example",
                        "kind": "custom",
                        "role": "primary",
                        "status": "active",
                        "records": [],
                        "error": null,
                        "forwarding": null,
                        "checked": 1792310400,
                        "created": 1791720000
                      }
                    ],
                    "free_address": "https://shop.tuppence.ai/test/harbourgifts",
                    "subdomain_address": "https://harbourgifts.tuppence.shop",
                    "created": 1791720000,
                    "checkouts_paused": null
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.site_reverted": {
      "post": {
        "summary": "store.site_reverted",
        "description": "Sent to every endpoint subscribed to `store.site_reverted` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreSiteRevertedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.site_reverted",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
                    "object": "site",
                    "livemode": false,
                    "slug": "harbourgifts",
                    "previous_slug": null,
                    "slug_redirect_until": null,
                    "name": "Harbour Gifts",
                    "brand": {
                      "colours": {
                        "primary": "oklch(42% 0.09 230)",
                        "surface": "oklch(98% 0.01 90)"
                      },
                      "type": {
                        "pair": "editorial"
                      },
                      "radius": "soft",
                      "logo": {
                        "primary": "med_01K7HB3A5C7E9G1J3L5N7Q9S1U",
                        "mark": null,
                        "on_dark": null
                      },
                      "seed": {
                        "header": {
                          "logo_placement": "left"
                        },
                        "hero": {
                          "image": null
                        }
                      }
                    },
                    "navigation": {
                      "header": [
                        {
                          "label": "Candles",
                          "target": {
                            "kind": "collection",
                            "ref": "coll_01K7HB4D6F8H0K2M4P6R8T0V2X"
                          }
                        },
                        {
                          "label": "Book a workshop",
                          "target": {
                            "kind": "booking"
                          }
                        }
                      ],
                      "footer": [
                        {
                          "title": "Help",
                          "items": [
                            {
                              "label": "Delivery and returns",
                              "target": {
                                "kind": "path",
                                "path": "/delivery"
                              }
                            }
                          ]
                        }
                      ]
                    },
                    "seo": {
                      "title_template": "{page} | {site}",
                      "description": "Candles, mugs and gifts made by the sea in Whitby.",
                      "social_image": "med_01K7HB3A5C7E9G1J3L5N7Q9S1U",
                      "noindex": false
                    },
                    "locale": "en-GB",
                    "store_enabled": true,
                    "home": "store",
                    "published_version": "sver_01K7HB5E7G9J1L3N5Q7S9U1W3Y",
                    "scheduled_version": null,
                    "scheduled_at": null,
                    "headless_origins": [
                      "https://www.harbourgifts.example"
                    ],
                    "headless_enabled": true,
                    "settings": {
                      "ship_from_location": "loc_01J8ZK2B4D6F8H0K2M4P6R8T0V",
                      "delivery": null,
                      "checkout": {
                        "note_enabled": true,
                        "marketing_text": null
                      },
                      "trader": {
                        "legal_name": "Harbour Gifts Ltd",
                        "trading_name": "Harbour Gifts",
                        "address": null,
                        "email": "hello@harbourgifts.example",
                        "phone": null,
                        "vat_number": "GB123456789",
                        "vat_registered": true
                      },
                      "ai_training_crawlers": false
                    },
                    "booking_page": "bpage_01J8ZK3C5E7G9J1L3N5Q7S9U1W",
                    "domains": [
                      {
                        "id": "sitedom_01K7HB6F8H0K2M4P6R8T0V2X4Z",
                        "object": "site_domain",
                        "livemode": false,
                        "site": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
                        "hostname": "shop.harbourgifts.example",
                        "kind": "custom",
                        "role": "primary",
                        "status": "active",
                        "records": [],
                        "error": null,
                        "forwarding": null,
                        "checked": 1792310400,
                        "created": 1791720000
                      }
                    ],
                    "free_address": "https://shop.tuppence.ai/test/harbourgifts",
                    "subdomain_address": "https://harbourgifts.tuppence.shop",
                    "created": 1791720000,
                    "checkouts_paused": null
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.site_scheduled": {
      "post": {
        "summary": "store.site_scheduled",
        "description": "Sent to every endpoint subscribed to `store.site_scheduled` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreSiteScheduledEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.site_scheduled",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
                    "object": "site",
                    "livemode": false,
                    "slug": "harbourgifts",
                    "previous_slug": null,
                    "slug_redirect_until": null,
                    "name": "Harbour Gifts",
                    "brand": {
                      "colours": {
                        "primary": "oklch(42% 0.09 230)",
                        "surface": "oklch(98% 0.01 90)"
                      },
                      "type": {
                        "pair": "editorial"
                      },
                      "radius": "soft",
                      "logo": {
                        "primary": "med_01K7HB3A5C7E9G1J3L5N7Q9S1U",
                        "mark": null,
                        "on_dark": null
                      },
                      "seed": {
                        "header": {
                          "logo_placement": "left"
                        },
                        "hero": {
                          "image": null
                        }
                      }
                    },
                    "navigation": {
                      "header": [
                        {
                          "label": "Candles",
                          "target": {
                            "kind": "collection",
                            "ref": "coll_01K7HB4D6F8H0K2M4P6R8T0V2X"
                          }
                        },
                        {
                          "label": "Book a workshop",
                          "target": {
                            "kind": "booking"
                          }
                        }
                      ],
                      "footer": [
                        {
                          "title": "Help",
                          "items": [
                            {
                              "label": "Delivery and returns",
                              "target": {
                                "kind": "path",
                                "path": "/delivery"
                              }
                            }
                          ]
                        }
                      ]
                    },
                    "seo": {
                      "title_template": "{page} | {site}",
                      "description": "Candles, mugs and gifts made by the sea in Whitby.",
                      "social_image": "med_01K7HB3A5C7E9G1J3L5N7Q9S1U",
                      "noindex": false
                    },
                    "locale": "en-GB",
                    "store_enabled": true,
                    "home": "store",
                    "published_version": "sver_01K7HB5E7G9J1L3N5Q7S9U1W3Y",
                    "scheduled_version": null,
                    "scheduled_at": null,
                    "headless_origins": [
                      "https://www.harbourgifts.example"
                    ],
                    "headless_enabled": true,
                    "settings": {
                      "ship_from_location": "loc_01J8ZK2B4D6F8H0K2M4P6R8T0V",
                      "delivery": null,
                      "checkout": {
                        "note_enabled": true,
                        "marketing_text": null
                      },
                      "trader": {
                        "legal_name": "Harbour Gifts Ltd",
                        "trading_name": "Harbour Gifts",
                        "address": null,
                        "email": "hello@harbourgifts.example",
                        "phone": null,
                        "vat_number": "GB123456789",
                        "vat_registered": true
                      },
                      "ai_training_crawlers": false
                    },
                    "booking_page": "bpage_01J8ZK3C5E7G9J1L3N5Q7S9U1W",
                    "domains": [
                      {
                        "id": "sitedom_01K7HB6F8H0K2M4P6R8T0V2X4Z",
                        "object": "site_domain",
                        "livemode": false,
                        "site": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
                        "hostname": "shop.harbourgifts.example",
                        "kind": "custom",
                        "role": "primary",
                        "status": "active",
                        "records": [],
                        "error": null,
                        "forwarding": null,
                        "checked": 1792310400,
                        "created": 1791720000
                      }
                    ],
                    "free_address": "https://shop.tuppence.ai/test/harbourgifts",
                    "subdomain_address": "https://harbourgifts.tuppence.shop",
                    "created": 1791720000,
                    "checkouts_paused": null
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.domain_requested": {
      "post": {
        "summary": "store.domain_requested",
        "description": "Sent to every endpoint subscribed to `store.domain_requested` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreDomainRequestedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.domain_requested",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
                    "object": "site",
                    "livemode": false,
                    "slug": "harbourgifts",
                    "previous_slug": null,
                    "slug_redirect_until": null,
                    "name": "Harbour Gifts",
                    "brand": {
                      "colours": {
                        "primary": "oklch(42% 0.09 230)",
                        "surface": "oklch(98% 0.01 90)"
                      },
                      "type": {
                        "pair": "editorial"
                      },
                      "radius": "soft",
                      "logo": {
                        "primary": "med_01K7HB3A5C7E9G1J3L5N7Q9S1U",
                        "mark": null,
                        "on_dark": null
                      },
                      "seed": {
                        "header": {
                          "logo_placement": "left"
                        },
                        "hero": {
                          "image": null
                        }
                      }
                    },
                    "navigation": {
                      "header": [
                        {
                          "label": "Candles",
                          "target": {
                            "kind": "collection",
                            "ref": "coll_01K7HB4D6F8H0K2M4P6R8T0V2X"
                          }
                        },
                        {
                          "label": "Book a workshop",
                          "target": {
                            "kind": "booking"
                          }
                        }
                      ],
                      "footer": [
                        {
                          "title": "Help",
                          "items": [
                            {
                              "label": "Delivery and returns",
                              "target": {
                                "kind": "path",
                                "path": "/delivery"
                              }
                            }
                          ]
                        }
                      ]
                    },
                    "seo": {
                      "title_template": "{page} | {site}",
                      "description": "Candles, mugs and gifts made by the sea in Whitby.",
                      "social_image": "med_01K7HB3A5C7E9G1J3L5N7Q9S1U",
                      "noindex": false
                    },
                    "locale": "en-GB",
                    "store_enabled": true,
                    "home": "store",
                    "published_version": "sver_01K7HB5E7G9J1L3N5Q7S9U1W3Y",
                    "scheduled_version": null,
                    "scheduled_at": null,
                    "headless_origins": [
                      "https://www.harbourgifts.example"
                    ],
                    "headless_enabled": true,
                    "settings": {
                      "ship_from_location": "loc_01J8ZK2B4D6F8H0K2M4P6R8T0V",
                      "delivery": null,
                      "checkout": {
                        "note_enabled": true,
                        "marketing_text": null
                      },
                      "trader": {
                        "legal_name": "Harbour Gifts Ltd",
                        "trading_name": "Harbour Gifts",
                        "address": null,
                        "email": "hello@harbourgifts.example",
                        "phone": null,
                        "vat_number": "GB123456789",
                        "vat_registered": true
                      },
                      "ai_training_crawlers": false
                    },
                    "booking_page": "bpage_01J8ZK3C5E7G9J1L3N5Q7S9U1W",
                    "domains": [
                      {
                        "id": "sitedom_01K7HB6F8H0K2M4P6R8T0V2X4Z",
                        "object": "site_domain",
                        "livemode": false,
                        "site": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
                        "hostname": "shop.harbourgifts.example",
                        "kind": "custom",
                        "role": "primary",
                        "status": "active",
                        "records": [],
                        "error": null,
                        "forwarding": null,
                        "checked": 1792310400,
                        "created": 1791720000
                      }
                    ],
                    "free_address": "https://shop.tuppence.ai/test/harbourgifts",
                    "subdomain_address": "https://harbourgifts.tuppence.shop",
                    "created": 1791720000,
                    "checkouts_paused": null
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.domain_active": {
      "post": {
        "summary": "store.domain_active",
        "description": "Sent to every endpoint subscribed to `store.domain_active` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreDomainActiveEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.domain_active",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
                    "object": "site",
                    "livemode": false,
                    "slug": "harbourgifts",
                    "previous_slug": null,
                    "slug_redirect_until": null,
                    "name": "Harbour Gifts",
                    "brand": {
                      "colours": {
                        "primary": "oklch(42% 0.09 230)",
                        "surface": "oklch(98% 0.01 90)"
                      },
                      "type": {
                        "pair": "editorial"
                      },
                      "radius": "soft",
                      "logo": {
                        "primary": "med_01K7HB3A5C7E9G1J3L5N7Q9S1U",
                        "mark": null,
                        "on_dark": null
                      },
                      "seed": {
                        "header": {
                          "logo_placement": "left"
                        },
                        "hero": {
                          "image": null
                        }
                      }
                    },
                    "navigation": {
                      "header": [
                        {
                          "label": "Candles",
                          "target": {
                            "kind": "collection",
                            "ref": "coll_01K7HB4D6F8H0K2M4P6R8T0V2X"
                          }
                        },
                        {
                          "label": "Book a workshop",
                          "target": {
                            "kind": "booking"
                          }
                        }
                      ],
                      "footer": [
                        {
                          "title": "Help",
                          "items": [
                            {
                              "label": "Delivery and returns",
                              "target": {
                                "kind": "path",
                                "path": "/delivery"
                              }
                            }
                          ]
                        }
                      ]
                    },
                    "seo": {
                      "title_template": "{page} | {site}",
                      "description": "Candles, mugs and gifts made by the sea in Whitby.",
                      "social_image": "med_01K7HB3A5C7E9G1J3L5N7Q9S1U",
                      "noindex": false
                    },
                    "locale": "en-GB",
                    "store_enabled": true,
                    "home": "store",
                    "published_version": "sver_01K7HB5E7G9J1L3N5Q7S9U1W3Y",
                    "scheduled_version": null,
                    "scheduled_at": null,
                    "headless_origins": [
                      "https://www.harbourgifts.example"
                    ],
                    "headless_enabled": true,
                    "settings": {
                      "ship_from_location": "loc_01J8ZK2B4D6F8H0K2M4P6R8T0V",
                      "delivery": null,
                      "checkout": {
                        "note_enabled": true,
                        "marketing_text": null
                      },
                      "trader": {
                        "legal_name": "Harbour Gifts Ltd",
                        "trading_name": "Harbour Gifts",
                        "address": null,
                        "email": "hello@harbourgifts.example",
                        "phone": null,
                        "vat_number": "GB123456789",
                        "vat_registered": true
                      },
                      "ai_training_crawlers": false
                    },
                    "booking_page": "bpage_01J8ZK3C5E7G9J1L3N5Q7S9U1W",
                    "domains": [
                      {
                        "id": "sitedom_01K7HB6F8H0K2M4P6R8T0V2X4Z",
                        "object": "site_domain",
                        "livemode": false,
                        "site": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
                        "hostname": "shop.harbourgifts.example",
                        "kind": "custom",
                        "role": "primary",
                        "status": "active",
                        "records": [],
                        "error": null,
                        "forwarding": null,
                        "checked": 1792310400,
                        "created": 1791720000
                      }
                    ],
                    "free_address": "https://shop.tuppence.ai/test/harbourgifts",
                    "subdomain_address": "https://harbourgifts.tuppence.shop",
                    "created": 1791720000,
                    "checkouts_paused": null
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.domain_failed": {
      "post": {
        "summary": "store.domain_failed",
        "description": "Sent to every endpoint subscribed to `store.domain_failed` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreDomainFailedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.domain_failed",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
                    "object": "site",
                    "livemode": false,
                    "slug": "harbourgifts",
                    "previous_slug": null,
                    "slug_redirect_until": null,
                    "name": "Harbour Gifts",
                    "brand": {
                      "colours": {
                        "primary": "oklch(42% 0.09 230)",
                        "surface": "oklch(98% 0.01 90)"
                      },
                      "type": {
                        "pair": "editorial"
                      },
                      "radius": "soft",
                      "logo": {
                        "primary": "med_01K7HB3A5C7E9G1J3L5N7Q9S1U",
                        "mark": null,
                        "on_dark": null
                      },
                      "seed": {
                        "header": {
                          "logo_placement": "left"
                        },
                        "hero": {
                          "image": null
                        }
                      }
                    },
                    "navigation": {
                      "header": [
                        {
                          "label": "Candles",
                          "target": {
                            "kind": "collection",
                            "ref": "coll_01K7HB4D6F8H0K2M4P6R8T0V2X"
                          }
                        },
                        {
                          "label": "Book a workshop",
                          "target": {
                            "kind": "booking"
                          }
                        }
                      ],
                      "footer": [
                        {
                          "title": "Help",
                          "items": [
                            {
                              "label": "Delivery and returns",
                              "target": {
                                "kind": "path",
                                "path": "/delivery"
                              }
                            }
                          ]
                        }
                      ]
                    },
                    "seo": {
                      "title_template": "{page} | {site}",
                      "description": "Candles, mugs and gifts made by the sea in Whitby.",
                      "social_image": "med_01K7HB3A5C7E9G1J3L5N7Q9S1U",
                      "noindex": false
                    },
                    "locale": "en-GB",
                    "store_enabled": true,
                    "home": "store",
                    "published_version": "sver_01K7HB5E7G9J1L3N5Q7S9U1W3Y",
                    "scheduled_version": null,
                    "scheduled_at": null,
                    "headless_origins": [
                      "https://www.harbourgifts.example"
                    ],
                    "headless_enabled": true,
                    "settings": {
                      "ship_from_location": "loc_01J8ZK2B4D6F8H0K2M4P6R8T0V",
                      "delivery": null,
                      "checkout": {
                        "note_enabled": true,
                        "marketing_text": null
                      },
                      "trader": {
                        "legal_name": "Harbour Gifts Ltd",
                        "trading_name": "Harbour Gifts",
                        "address": null,
                        "email": "hello@harbourgifts.example",
                        "phone": null,
                        "vat_number": "GB123456789",
                        "vat_registered": true
                      },
                      "ai_training_crawlers": false
                    },
                    "booking_page": "bpage_01J8ZK3C5E7G9J1L3N5Q7S9U1W",
                    "domains": [
                      {
                        "id": "sitedom_01K7HB6F8H0K2M4P6R8T0V2X4Z",
                        "object": "site_domain",
                        "livemode": false,
                        "site": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
                        "hostname": "shop.harbourgifts.example",
                        "kind": "custom",
                        "role": "primary",
                        "status": "active",
                        "records": [],
                        "error": null,
                        "forwarding": null,
                        "checked": 1792310400,
                        "created": 1791720000
                      }
                    ],
                    "free_address": "https://shop.tuppence.ai/test/harbourgifts",
                    "subdomain_address": "https://harbourgifts.tuppence.shop",
                    "created": 1791720000,
                    "checkouts_paused": null
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.domain_removed": {
      "post": {
        "summary": "store.domain_removed",
        "description": "Sent to every endpoint subscribed to `store.domain_removed` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreDomainRemovedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.domain_removed",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
                    "object": "site",
                    "livemode": false,
                    "slug": "harbourgifts",
                    "previous_slug": null,
                    "slug_redirect_until": null,
                    "name": "Harbour Gifts",
                    "brand": {
                      "colours": {
                        "primary": "oklch(42% 0.09 230)",
                        "surface": "oklch(98% 0.01 90)"
                      },
                      "type": {
                        "pair": "editorial"
                      },
                      "radius": "soft",
                      "logo": {
                        "primary": "med_01K7HB3A5C7E9G1J3L5N7Q9S1U",
                        "mark": null,
                        "on_dark": null
                      },
                      "seed": {
                        "header": {
                          "logo_placement": "left"
                        },
                        "hero": {
                          "image": null
                        }
                      }
                    },
                    "navigation": {
                      "header": [
                        {
                          "label": "Candles",
                          "target": {
                            "kind": "collection",
                            "ref": "coll_01K7HB4D6F8H0K2M4P6R8T0V2X"
                          }
                        },
                        {
                          "label": "Book a workshop",
                          "target": {
                            "kind": "booking"
                          }
                        }
                      ],
                      "footer": [
                        {
                          "title": "Help",
                          "items": [
                            {
                              "label": "Delivery and returns",
                              "target": {
                                "kind": "path",
                                "path": "/delivery"
                              }
                            }
                          ]
                        }
                      ]
                    },
                    "seo": {
                      "title_template": "{page} | {site}",
                      "description": "Candles, mugs and gifts made by the sea in Whitby.",
                      "social_image": "med_01K7HB3A5C7E9G1J3L5N7Q9S1U",
                      "noindex": false
                    },
                    "locale": "en-GB",
                    "store_enabled": true,
                    "home": "store",
                    "published_version": "sver_01K7HB5E7G9J1L3N5Q7S9U1W3Y",
                    "scheduled_version": null,
                    "scheduled_at": null,
                    "headless_origins": [
                      "https://www.harbourgifts.example"
                    ],
                    "headless_enabled": true,
                    "settings": {
                      "ship_from_location": "loc_01J8ZK2B4D6F8H0K2M4P6R8T0V",
                      "delivery": null,
                      "checkout": {
                        "note_enabled": true,
                        "marketing_text": null
                      },
                      "trader": {
                        "legal_name": "Harbour Gifts Ltd",
                        "trading_name": "Harbour Gifts",
                        "address": null,
                        "email": "hello@harbourgifts.example",
                        "phone": null,
                        "vat_number": "GB123456789",
                        "vat_registered": true
                      },
                      "ai_training_crawlers": false
                    },
                    "booking_page": "bpage_01J8ZK3C5E7G9J1L3N5Q7S9U1W",
                    "domains": [
                      {
                        "id": "sitedom_01K7HB6F8H0K2M4P6R8T0V2X4Z",
                        "object": "site_domain",
                        "livemode": false,
                        "site": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
                        "hostname": "shop.harbourgifts.example",
                        "kind": "custom",
                        "role": "primary",
                        "status": "active",
                        "records": [],
                        "error": null,
                        "forwarding": null,
                        "checked": 1792310400,
                        "created": 1791720000
                      }
                    ],
                    "free_address": "https://shop.tuppence.ai/test/harbourgifts",
                    "subdomain_address": "https://harbourgifts.tuppence.shop",
                    "created": 1791720000,
                    "checkouts_paused": null
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.domain_switched": {
      "post": {
        "summary": "store.domain_switched",
        "description": "Sent to every endpoint subscribed to `store.domain_switched` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreDomainSwitchedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.domain_switched",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
                    "object": "site",
                    "livemode": false,
                    "slug": "harbourgifts",
                    "previous_slug": null,
                    "slug_redirect_until": null,
                    "name": "Harbour Gifts",
                    "brand": {
                      "colours": {
                        "primary": "oklch(42% 0.09 230)",
                        "surface": "oklch(98% 0.01 90)"
                      },
                      "type": {
                        "pair": "editorial"
                      },
                      "radius": "soft",
                      "logo": {
                        "primary": "med_01K7HB3A5C7E9G1J3L5N7Q9S1U",
                        "mark": null,
                        "on_dark": null
                      },
                      "seed": {
                        "header": {
                          "logo_placement": "left"
                        },
                        "hero": {
                          "image": null
                        }
                      }
                    },
                    "navigation": {
                      "header": [
                        {
                          "label": "Candles",
                          "target": {
                            "kind": "collection",
                            "ref": "coll_01K7HB4D6F8H0K2M4P6R8T0V2X"
                          }
                        },
                        {
                          "label": "Book a workshop",
                          "target": {
                            "kind": "booking"
                          }
                        }
                      ],
                      "footer": [
                        {
                          "title": "Help",
                          "items": [
                            {
                              "label": "Delivery and returns",
                              "target": {
                                "kind": "path",
                                "path": "/delivery"
                              }
                            }
                          ]
                        }
                      ]
                    },
                    "seo": {
                      "title_template": "{page} | {site}",
                      "description": "Candles, mugs and gifts made by the sea in Whitby.",
                      "social_image": "med_01K7HB3A5C7E9G1J3L5N7Q9S1U",
                      "noindex": false
                    },
                    "locale": "en-GB",
                    "store_enabled": true,
                    "home": "store",
                    "published_version": "sver_01K7HB5E7G9J1L3N5Q7S9U1W3Y",
                    "scheduled_version": null,
                    "scheduled_at": null,
                    "headless_origins": [
                      "https://www.harbourgifts.example"
                    ],
                    "headless_enabled": true,
                    "settings": {
                      "ship_from_location": "loc_01J8ZK2B4D6F8H0K2M4P6R8T0V",
                      "delivery": null,
                      "checkout": {
                        "note_enabled": true,
                        "marketing_text": null
                      },
                      "trader": {
                        "legal_name": "Harbour Gifts Ltd",
                        "trading_name": "Harbour Gifts",
                        "address": null,
                        "email": "hello@harbourgifts.example",
                        "phone": null,
                        "vat_number": "GB123456789",
                        "vat_registered": true
                      },
                      "ai_training_crawlers": false
                    },
                    "booking_page": "bpage_01J8ZK3C5E7G9J1L3N5Q7S9U1W",
                    "domains": [
                      {
                        "id": "sitedom_01K7HB6F8H0K2M4P6R8T0V2X4Z",
                        "object": "site_domain",
                        "livemode": false,
                        "site": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
                        "hostname": "shop.harbourgifts.example",
                        "kind": "custom",
                        "role": "primary",
                        "status": "active",
                        "records": [],
                        "error": null,
                        "forwarding": null,
                        "checked": 1792310400,
                        "created": 1791720000
                      }
                    ],
                    "free_address": "https://shop.tuppence.ai/test/harbourgifts",
                    "subdomain_address": "https://harbourgifts.tuppence.shop",
                    "created": 1791720000,
                    "checkouts_paused": null
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "merchant_sending_domain.verified": {
      "post": {
        "summary": "merchant_sending_domain.verified",
        "description": "Sent to every endpoint subscribed to `merchant_sending_domain.verified` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MerchantSendingDomainVerifiedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "merchant_sending_domain.verified",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "mercha_01K7HBW0EXAMPLE0000000000",
                    "object": "merchant_sending_domain"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.proposal_started": {
      "post": {
        "summary": "store.proposal_started",
        "description": "Sent to every endpoint subscribed to `store.proposal_started` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreProposalStartedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.proposal_started",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "storep_01K7HBW0EXAMPLE0000000000",
                    "object": "store_proposal"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.proposal_ready": {
      "post": {
        "summary": "store.proposal_ready",
        "description": "Sent to every endpoint subscribed to `store.proposal_ready` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreProposalReadyEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.proposal_ready",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "storep_01K7HBW0EXAMPLE0000000000",
                    "object": "store_proposal"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.proposal_failed": {
      "post": {
        "summary": "store.proposal_failed",
        "description": "Sent to every endpoint subscribed to `store.proposal_failed` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreProposalFailedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.proposal_failed",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "storep_01K7HBW0EXAMPLE0000000000",
                    "object": "store_proposal"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.proposal_published": {
      "post": {
        "summary": "store.proposal_published",
        "description": "Sent to every endpoint subscribed to `store.proposal_published` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreProposalPublishedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.proposal_published",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "storep_01K7HBW0EXAMPLE0000000000",
                    "object": "store_proposal"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.snap_started": {
      "post": {
        "summary": "store.snap_started",
        "description": "Sent to every endpoint subscribed to `store.snap_started` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreSnapStartedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.snap_started",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "stores_01K7HBW0EXAMPLE0000000000",
                    "object": "store_snap"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.snap_ready": {
      "post": {
        "summary": "store.snap_ready",
        "description": "Sent to every endpoint subscribed to `store.snap_ready` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreSnapReadyEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.snap_ready",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "stores_01K7HBW0EXAMPLE0000000000",
                    "object": "store_snap"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.snap_failed": {
      "post": {
        "summary": "store.snap_failed",
        "description": "Sent to every endpoint subscribed to `store.snap_failed` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreSnapFailedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.snap_failed",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "stores_01K7HBW0EXAMPLE0000000000",
                    "object": "store_snap"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.snap_published": {
      "post": {
        "summary": "store.snap_published",
        "description": "Sent to every endpoint subscribed to `store.snap_published` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreSnapPublishedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.snap_published",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "stores_01K7HBW0EXAMPLE0000000000",
                    "object": "store_snap"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.import_started": {
      "post": {
        "summary": "store.import_started",
        "description": "Sent to every endpoint subscribed to `store.import_started` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreImportStartedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.import_started",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "storei_01K7HBW0EXAMPLE0000000000",
                    "object": "store_import"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.import_completed": {
      "post": {
        "summary": "store.import_completed",
        "description": "Sent to every endpoint subscribed to `store.import_completed` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreImportCompletedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.import_completed",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "storei_01K7HBW0EXAMPLE0000000000",
                    "object": "store_import"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.import_undone": {
      "post": {
        "summary": "store.import_undone",
        "description": "Sent to every endpoint subscribed to `store.import_undone` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreImportUndoneEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.import_undone",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "storei_01K7HBW0EXAMPLE0000000000",
                    "object": "store_import"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "product.created": {
      "post": {
        "summary": "product.created",
        "description": "Sent to every endpoint subscribed to `product.created` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductCreatedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "product.created",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "prod_01K7HB2M4N6P8Q0R2S4T6V8W0X",
                    "object": "product",
                    "livemode": false,
                    "name": "Sea salt candle",
                    "short_name": "Sea salt",
                    "description": "Soy wax with sea salt and driftwood, in a reusable glass jar. Burns for 40 hours.",
                    "category": "pcat_01K7HBUC0F2H4K6M8P0R2T4W6Y",
                    "kind": "retail",
                    "service": null,
                    "sold_by": "each",
                    "unit": null,
                    "amount": 1200,
                    "currency": "gbp",
                    "min_amount": null,
                    "max_amount": null,
                    "cost_amount": 410,
                    "tax_class": "standard",
                    "track_stock": true,
                    "sku": "CND-SEA-200",
                    "barcodes": [
                      "5012345678900"
                    ],
                    "age_restricted": false,
                    "age_rule": null,
                    "allergens": [],
                    "image_url": "https://media.tuppence.ai/med_01K7HB3A5C7E9G1J3L5N7Q9S1U/sea-salt-candle.jpg",
                    "colour": null,
                    "emoji": null,
                    "tile_label": null,
                    "options": [],
                    "modifier_groups": [],
                    "available": true,
                    "channels": [
                      "till",
                      "online"
                    ],
                    "prep_minutes": null,
                    "deposit_amount": null,
                    "deposit_scheme": null,
                    "sort": 0,
                    "status": "active",
                    "slug": "sea-salt-candle",
                    "web_path": "/products/sea-salt-candle",
                    "web_title": "Sea salt candle, 200 g",
                    "web_description": "Hand-poured in Whitby. Soy wax, cotton wick, about 40 hours of burning.",
                    "brand": "Harbour Gifts",
                    "product_type": 4651,
                    "attributes": {},
                    "facts": [],
                    "weight_grams": 450,
                    "dimensions_mm": {
                      "l": 85,
                      "w": 85,
                      "h": 100
                    },
                    "hs_code": "340600",
                    "origin_country": "GB",
                    "gpsr": null,
                    "seo": {
                      "title": "Sea salt candle",
                      "description": "A hand-poured soy candle from Whitby."
                    },
                    "media": [
                      "med_01K7HB3A5C7E9G1J3L5N7Q9S1U"
                    ],
                    "inventory_policy": "deny",
                    "preorder_ships_on": null,
                    "preorder_cap": null,
                    "bundle_parts": [],
                    "subscription_plan": null,
                    "web_published_at": 1791806400,
                    "web_status": "published",
                    "web_publish_url": "https://shop.tuppence.ai/test/harbourgifts/products/sea-salt-candle",
                    "claims_check": null,
                    "compare_at_amount": null,
                    "variants": [],
                    "metadata": null,
                    "created": 1791720000
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "product.updated": {
      "post": {
        "summary": "product.updated",
        "description": "Sent to every endpoint subscribed to `product.updated` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductUpdatedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "product.updated",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "prod_01K7HB2M4N6P8Q0R2S4T6V8W0X",
                    "object": "product",
                    "livemode": false,
                    "name": "Sea salt candle",
                    "short_name": "Sea salt",
                    "description": "Soy wax with sea salt and driftwood, in a reusable glass jar. Burns for 40 hours.",
                    "category": "pcat_01K7HBUC0F2H4K6M8P0R2T4W6Y",
                    "kind": "retail",
                    "service": null,
                    "sold_by": "each",
                    "unit": null,
                    "amount": 1200,
                    "currency": "gbp",
                    "min_amount": null,
                    "max_amount": null,
                    "cost_amount": 410,
                    "tax_class": "standard",
                    "track_stock": true,
                    "sku": "CND-SEA-200",
                    "barcodes": [
                      "5012345678900"
                    ],
                    "age_restricted": false,
                    "age_rule": null,
                    "allergens": [],
                    "image_url": "https://media.tuppence.ai/med_01K7HB3A5C7E9G1J3L5N7Q9S1U/sea-salt-candle.jpg",
                    "colour": null,
                    "emoji": null,
                    "tile_label": null,
                    "options": [],
                    "modifier_groups": [],
                    "available": true,
                    "channels": [
                      "till",
                      "online"
                    ],
                    "prep_minutes": null,
                    "deposit_amount": null,
                    "deposit_scheme": null,
                    "sort": 0,
                    "status": "active",
                    "slug": "sea-salt-candle",
                    "web_path": "/products/sea-salt-candle",
                    "web_title": "Sea salt candle, 200 g",
                    "web_description": "Hand-poured in Whitby. Soy wax, cotton wick, about 40 hours of burning.",
                    "brand": "Harbour Gifts",
                    "product_type": 4651,
                    "attributes": {},
                    "facts": [],
                    "weight_grams": 450,
                    "dimensions_mm": {
                      "l": 85,
                      "w": 85,
                      "h": 100
                    },
                    "hs_code": "340600",
                    "origin_country": "GB",
                    "gpsr": null,
                    "seo": {
                      "title": "Sea salt candle",
                      "description": "A hand-poured soy candle from Whitby."
                    },
                    "media": [
                      "med_01K7HB3A5C7E9G1J3L5N7Q9S1U"
                    ],
                    "inventory_policy": "deny",
                    "preorder_ships_on": null,
                    "preorder_cap": null,
                    "bundle_parts": [],
                    "subscription_plan": null,
                    "web_published_at": 1791806400,
                    "web_status": "published",
                    "web_publish_url": "https://shop.tuppence.ai/test/harbourgifts/products/sea-salt-candle",
                    "claims_check": null,
                    "compare_at_amount": null,
                    "variants": [],
                    "metadata": null,
                    "created": 1791720000
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "product.archived": {
      "post": {
        "summary": "product.archived",
        "description": "Sent to every endpoint subscribed to `product.archived` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductArchivedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "product.archived",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "prod_01K7HB2M4N6P8Q0R2S4T6V8W0X",
                    "object": "product",
                    "livemode": false,
                    "name": "Sea salt candle",
                    "short_name": "Sea salt",
                    "description": "Soy wax with sea salt and driftwood, in a reusable glass jar. Burns for 40 hours.",
                    "category": "pcat_01K7HBUC0F2H4K6M8P0R2T4W6Y",
                    "kind": "retail",
                    "service": null,
                    "sold_by": "each",
                    "unit": null,
                    "amount": 1200,
                    "currency": "gbp",
                    "min_amount": null,
                    "max_amount": null,
                    "cost_amount": 410,
                    "tax_class": "standard",
                    "track_stock": true,
                    "sku": "CND-SEA-200",
                    "barcodes": [
                      "5012345678900"
                    ],
                    "age_restricted": false,
                    "age_rule": null,
                    "allergens": [],
                    "image_url": "https://media.tuppence.ai/med_01K7HB3A5C7E9G1J3L5N7Q9S1U/sea-salt-candle.jpg",
                    "colour": null,
                    "emoji": null,
                    "tile_label": null,
                    "options": [],
                    "modifier_groups": [],
                    "available": true,
                    "channels": [
                      "till",
                      "online"
                    ],
                    "prep_minutes": null,
                    "deposit_amount": null,
                    "deposit_scheme": null,
                    "sort": 0,
                    "status": "active",
                    "slug": "sea-salt-candle",
                    "web_path": "/products/sea-salt-candle",
                    "web_title": "Sea salt candle, 200 g",
                    "web_description": "Hand-poured in Whitby. Soy wax, cotton wick, about 40 hours of burning.",
                    "brand": "Harbour Gifts",
                    "product_type": 4651,
                    "attributes": {},
                    "facts": [],
                    "weight_grams": 450,
                    "dimensions_mm": {
                      "l": 85,
                      "w": 85,
                      "h": 100
                    },
                    "hs_code": "340600",
                    "origin_country": "GB",
                    "gpsr": null,
                    "seo": {
                      "title": "Sea salt candle",
                      "description": "A hand-poured soy candle from Whitby."
                    },
                    "media": [
                      "med_01K7HB3A5C7E9G1J3L5N7Q9S1U"
                    ],
                    "inventory_policy": "deny",
                    "preorder_ships_on": null,
                    "preorder_cap": null,
                    "bundle_parts": [],
                    "subscription_plan": null,
                    "web_published_at": 1791806400,
                    "web_status": "published",
                    "web_publish_url": "https://shop.tuppence.ai/test/harbourgifts/products/sea-salt-candle",
                    "claims_check": null,
                    "compare_at_amount": null,
                    "variants": [],
                    "metadata": null,
                    "created": 1791720000
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.product_published": {
      "post": {
        "summary": "store.product_published",
        "description": "Sent to every endpoint subscribed to `store.product_published` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreProductPublishedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.product_published",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "prod_01K7HB2M4N6P8Q0R2S4T6V8W0X",
                    "object": "product",
                    "livemode": false,
                    "name": "Sea salt candle",
                    "short_name": "Sea salt",
                    "description": "Soy wax with sea salt and driftwood, in a reusable glass jar. Burns for 40 hours.",
                    "category": "pcat_01K7HBUC0F2H4K6M8P0R2T4W6Y",
                    "kind": "retail",
                    "service": null,
                    "sold_by": "each",
                    "unit": null,
                    "amount": 1200,
                    "currency": "gbp",
                    "min_amount": null,
                    "max_amount": null,
                    "cost_amount": 410,
                    "tax_class": "standard",
                    "track_stock": true,
                    "sku": "CND-SEA-200",
                    "barcodes": [
                      "5012345678900"
                    ],
                    "age_restricted": false,
                    "age_rule": null,
                    "allergens": [],
                    "image_url": "https://media.tuppence.ai/med_01K7HB3A5C7E9G1J3L5N7Q9S1U/sea-salt-candle.jpg",
                    "colour": null,
                    "emoji": null,
                    "tile_label": null,
                    "options": [],
                    "modifier_groups": [],
                    "available": true,
                    "channels": [
                      "till",
                      "online"
                    ],
                    "prep_minutes": null,
                    "deposit_amount": null,
                    "deposit_scheme": null,
                    "sort": 0,
                    "status": "active",
                    "slug": "sea-salt-candle",
                    "web_path": "/products/sea-salt-candle",
                    "web_title": "Sea salt candle, 200 g",
                    "web_description": "Hand-poured in Whitby. Soy wax, cotton wick, about 40 hours of burning.",
                    "brand": "Harbour Gifts",
                    "product_type": 4651,
                    "attributes": {},
                    "facts": [],
                    "weight_grams": 450,
                    "dimensions_mm": {
                      "l": 85,
                      "w": 85,
                      "h": 100
                    },
                    "hs_code": "340600",
                    "origin_country": "GB",
                    "gpsr": null,
                    "seo": {
                      "title": "Sea salt candle",
                      "description": "A hand-poured soy candle from Whitby."
                    },
                    "media": [
                      "med_01K7HB3A5C7E9G1J3L5N7Q9S1U"
                    ],
                    "inventory_policy": "deny",
                    "preorder_ships_on": null,
                    "preorder_cap": null,
                    "bundle_parts": [],
                    "subscription_plan": null,
                    "web_published_at": 1791806400,
                    "web_status": "published",
                    "web_publish_url": "https://shop.tuppence.ai/test/harbourgifts/products/sea-salt-candle",
                    "claims_check": null,
                    "compare_at_amount": null,
                    "variants": [],
                    "metadata": null,
                    "created": 1791720000
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.product_unpublished": {
      "post": {
        "summary": "store.product_unpublished",
        "description": "Sent to every endpoint subscribed to `store.product_unpublished` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreProductUnpublishedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.product_unpublished",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "prod_01K7HB2M4N6P8Q0R2S4T6V8W0X",
                    "object": "product",
                    "livemode": false,
                    "name": "Sea salt candle",
                    "short_name": "Sea salt",
                    "description": "Soy wax with sea salt and driftwood, in a reusable glass jar. Burns for 40 hours.",
                    "category": "pcat_01K7HBUC0F2H4K6M8P0R2T4W6Y",
                    "kind": "retail",
                    "service": null,
                    "sold_by": "each",
                    "unit": null,
                    "amount": 1200,
                    "currency": "gbp",
                    "min_amount": null,
                    "max_amount": null,
                    "cost_amount": 410,
                    "tax_class": "standard",
                    "track_stock": true,
                    "sku": "CND-SEA-200",
                    "barcodes": [
                      "5012345678900"
                    ],
                    "age_restricted": false,
                    "age_rule": null,
                    "allergens": [],
                    "image_url": "https://media.tuppence.ai/med_01K7HB3A5C7E9G1J3L5N7Q9S1U/sea-salt-candle.jpg",
                    "colour": null,
                    "emoji": null,
                    "tile_label": null,
                    "options": [],
                    "modifier_groups": [],
                    "available": true,
                    "channels": [
                      "till",
                      "online"
                    ],
                    "prep_minutes": null,
                    "deposit_amount": null,
                    "deposit_scheme": null,
                    "sort": 0,
                    "status": "active",
                    "slug": "sea-salt-candle",
                    "web_path": "/products/sea-salt-candle",
                    "web_title": "Sea salt candle, 200 g",
                    "web_description": "Hand-poured in Whitby. Soy wax, cotton wick, about 40 hours of burning.",
                    "brand": "Harbour Gifts",
                    "product_type": 4651,
                    "attributes": {},
                    "facts": [],
                    "weight_grams": 450,
                    "dimensions_mm": {
                      "l": 85,
                      "w": 85,
                      "h": 100
                    },
                    "hs_code": "340600",
                    "origin_country": "GB",
                    "gpsr": null,
                    "seo": {
                      "title": "Sea salt candle",
                      "description": "A hand-poured soy candle from Whitby."
                    },
                    "media": [
                      "med_01K7HB3A5C7E9G1J3L5N7Q9S1U"
                    ],
                    "inventory_policy": "deny",
                    "preorder_ships_on": null,
                    "preorder_cap": null,
                    "bundle_parts": [],
                    "subscription_plan": null,
                    "web_published_at": 1791806400,
                    "web_status": "published",
                    "web_publish_url": "https://shop.tuppence.ai/test/harbourgifts/products/sea-salt-candle",
                    "claims_check": null,
                    "compare_at_amount": null,
                    "variants": [],
                    "metadata": null,
                    "created": 1791720000
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.collection_created": {
      "post": {
        "summary": "store.collection_created",
        "description": "Sent to every endpoint subscribed to `store.collection_created` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreCollectionCreatedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.collection_created",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "collec_01K7HBW0EXAMPLE0000000000",
                    "object": "collection"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.collection_updated": {
      "post": {
        "summary": "store.collection_updated",
        "description": "Sent to every endpoint subscribed to `store.collection_updated` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreCollectionUpdatedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.collection_updated",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "collec_01K7HBW0EXAMPLE0000000000",
                    "object": "collection"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.collection_deleted": {
      "post": {
        "summary": "store.collection_deleted",
        "description": "Sent to every endpoint subscribed to `store.collection_deleted` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreCollectionDeletedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.collection_deleted",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "collec_01K7HBW0EXAMPLE0000000000",
                    "object": "collection"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.drop_created": {
      "post": {
        "summary": "store.drop_created",
        "description": "Sent to every endpoint subscribed to `store.drop_created` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreDropCreatedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.drop_created",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "drop_01K7HB8H0K2M4P6R8T0V2X4Z6B",
                    "object": "drop",
                    "livemode": false,
                    "site": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
                    "name": "Winter solstice candle",
                    "products": [
                      "prod_01K7HB2M4N6P8Q0R2S4T6V8W0X"
                    ],
                    "collection": null,
                    "starts_at": 1795251600,
                    "ends_at": 1795338000,
                    "per_customer_limit": 2,
                    "per_card_limit": 2,
                    "queue_window_seconds": 600,
                    "waitlist": true,
                    "status": "active",
                    "state": "upcoming",
                    "created": 1791720000,
                    "updated": 1792310400
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.drop_updated": {
      "post": {
        "summary": "store.drop_updated",
        "description": "Sent to every endpoint subscribed to `store.drop_updated` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreDropUpdatedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.drop_updated",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "drop_01K7HB8H0K2M4P6R8T0V2X4Z6B",
                    "object": "drop",
                    "livemode": false,
                    "site": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
                    "name": "Winter solstice candle",
                    "products": [
                      "prod_01K7HB2M4N6P8Q0R2S4T6V8W0X"
                    ],
                    "collection": null,
                    "starts_at": 1795251600,
                    "ends_at": 1795338000,
                    "per_customer_limit": 2,
                    "per_card_limit": 2,
                    "queue_window_seconds": 600,
                    "waitlist": true,
                    "status": "active",
                    "state": "upcoming",
                    "created": 1791720000,
                    "updated": 1792310400
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "stock.available": {
      "post": {
        "summary": "stock.available",
        "description": "Sent to every endpoint subscribed to `stock.available` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StockAvailableEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "stock.available",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "stocka_01K7HBW0EXAMPLE0000000000",
                    "object": "stock_availability"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "stock_alert.sent": {
      "post": {
        "summary": "stock_alert.sent",
        "description": "Sent to every endpoint subscribed to `stock_alert.sent` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StockAlertSentEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "stock_alert.sent",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "stocka_01K7HBW0EXAMPLE0000000000",
                    "object": "stock_alert"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "stock_movement.created": {
      "post": {
        "summary": "stock_movement.created",
        "description": "Sent to every endpoint subscribed to `stock_movement.created` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StockMovementCreatedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "stock_movement.created",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "stockm_01K7HBW0EXAMPLE0000000000",
                    "object": "stock_movement"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.order_placed": {
      "post": {
        "summary": "store.order_placed",
        "description": "Sent to every endpoint subscribed to `store.order_placed` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreOrderPlacedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.order_placed",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "order_01K7HBW0EXAMPLE0000000000",
                    "object": "order"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "order.created": {
      "post": {
        "summary": "order.created",
        "description": "Sent to every endpoint subscribed to `order.created` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OrderCreatedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "order.created",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
                    "object": "order",
                    "livemode": false,
                    "number": 1042,
                    "business_day": "2026-10-24",
                    "register": null,
                    "device": null,
                    "location": "loc_01J8ZK2B4D6F8H0K2M4P6R8T0V",
                    "staff_member": null,
                    "status": "completed",
                    "kind": "sale",
                    "refunds_order": null,
                    "order_type": "delivery",
                    "source": "online",
                    "store_number": 318,
                    "fulfilment_status": "fulfilled",
                    "customer": "cus_01J8ZK1Q9H2B4C6D8E0F2G4H6J",
                    "booking": null,
                    "table": null,
                    "covers": null,
                    "tab_name": null,
                    "currency": "gbp",
                    "lines": [
                      {
                        "id": "ordl_01K7HBFR8T0V2X4Z6B8D0F2H4K",
                        "object": "order_line",
                        "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
                        "product": "prod_01K7HB2M4N6P8Q0R2S4T6V8W0X",
                        "variant": null,
                        "service": null,
                        "staff_member": null,
                        "category": "Gifts",
                        "tax_class": "standard",
                        "name": "Sea salt candle",
                        "sold_by": "each",
                        "unit": null,
                        "quantity": "2",
                        "unit_amount": 1200,
                        "modifiers": [],
                        "gross_amount": 2400,
                        "line_discount": null,
                        "discount_amount": 0,
                        "taxes": [
                          {
                            "tax_rate": "taxr_01J8ZK5E7G9J1L3N5Q7S9U1W3Y",
                            "name": "VAT 20%",
                            "rate_ppm": 200000,
                            "amount": 400,
                            "inclusive": true
                          }
                        ],
                        "tax_amount": 400,
                        "amount": 2400,
                        "cost_amount": null,
                        "notes": null,
                        "seat": null,
                        "course": null,
                        "kitchen_station": null,
                        "sent_to_kitchen_at": null,
                        "voided": null,
                        "sort": 0,
                        "ticket": null,
                        "created": 1792310400
                      },
                      {
                        "id": "ordl_01K7HBFR8T0V2X4Z6B8D0F2H4M",
                        "object": "order_line",
                        "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
                        "product": "prod_01K7HB2M4N6P8Q0R2S4T6V8W0Y",
                        "variant": null,
                        "service": null,
                        "staff_member": null,
                        "category": "Gifts",
                        "tax_class": "standard",
                        "name": "Harbour mug",
                        "sold_by": "each",
                        "unit": null,
                        "quantity": "1",
                        "unit_amount": 695,
                        "modifiers": [],
                        "gross_amount": 695,
                        "line_discount": null,
                        "discount_amount": 0,
                        "taxes": [
                          {
                            "tax_rate": "taxr_01J8ZK5E7G9J1L3N5Q7S9U1W3Y",
                            "name": "VAT 20%",
                            "rate_ppm": 200000,
                            "amount": 116,
                            "inclusive": true
                          }
                        ],
                        "tax_amount": 116,
                        "amount": 695,
                        "cost_amount": null,
                        "notes": null,
                        "seat": null,
                        "course": null,
                        "kitchen_station": null,
                        "sent_to_kitchen_at": null,
                        "voided": null,
                        "sort": 1,
                        "ticket": null,
                        "created": 1792310400
                      },
                      {
                        "id": "ordl_01K7HBFR8T0V2X4Z6B8D0F2H4N",
                        "object": "order_line",
                        "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
                        "product": null,
                        "variant": null,
                        "service": null,
                        "staff_member": null,
                        "category": null,
                        "tax_class": "standard",
                        "name": "Royal Mail Tracked 48",
                        "sold_by": "open",
                        "unit": null,
                        "quantity": "1",
                        "unit_amount": 355,
                        "modifiers": [],
                        "gross_amount": 355,
                        "line_discount": null,
                        "discount_amount": 0,
                        "taxes": [
                          {
                            "tax_rate": "taxr_01J8ZK5E7G9J1L3N5Q7S9U1W3Y",
                            "name": "VAT 20%",
                            "rate_ppm": 200000,
                            "amount": 59,
                            "inclusive": true
                          }
                        ],
                        "tax_amount": 59,
                        "amount": 355,
                        "cost_amount": null,
                        "notes": null,
                        "seat": null,
                        "course": null,
                        "kitchen_station": null,
                        "sent_to_kitchen_at": null,
                        "voided": null,
                        "sort": 2,
                        "ticket": null,
                        "created": 1792310400
                      }
                    ],
                    "tenders": [
                      {
                        "id": "tndr_01K7HBGS9U1W3Y5A7C9E1G3J5L",
                        "object": "tender",
                        "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
                        "method": "card",
                        "external_kind": null,
                        "payment": "pay_01K7HBHT0V2X4Z6B8D0F2H4K6M",
                        "voucher_redemption": null,
                        "amount": 3450,
                        "currency": "gbp",
                        "tip_amount": 0,
                        "tendered": null,
                        "change": 0,
                        "rounding_amount": 0,
                        "network": null,
                        "status": "succeeded",
                        "refunded_amount": 0,
                        "staff_member": null,
                        "device": null,
                        "reader": null,
                        "client_created_at": null,
                        "created_offline": false,
                        "sort": 0,
                        "shift": null,
                        "created": 1792310400
                      }
                    ],
                    "discounts": [],
                    "service_charge": null,
                    "tax_exemption": null,
                    "tip_amount": 0,
                    "tip_shares": [],
                    "totals": {
                      "subtotal": 3450,
                      "discount": 0,
                      "service_charge": 0,
                      "tax_by_rate": [
                        {
                          "tax_rate": "taxr_01J8ZK5E7G9J1L3N5Q7S9U1W3Y",
                          "name": "VAT 20%",
                          "rate_ppm": 200000,
                          "taxable": 3450,
                          "tax": 575,
                          "inclusive": true
                        }
                      ],
                      "tax": 575,
                      "tip": 0,
                      "total": 3450,
                      "cash_rounding": 0,
                      "paid": 3450,
                      "due": 0,
                      "change": 0
                    },
                    "catalogue_version": null,
                    "notes": null,
                    "needs_review": null,
                    "fulfilment_hold": null,
                    "client_created_at": null,
                    "created_offline": false,
                    "synced_at": null,
                    "completed_at": 1792310400,
                    "voided": null,
                    "metadata": {},
                    "created": 1792310400
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "order.updated": {
      "post": {
        "summary": "order.updated",
        "description": "Sent to every endpoint subscribed to `order.updated` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OrderUpdatedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "order.updated",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
                    "object": "order",
                    "livemode": false,
                    "number": 1042,
                    "business_day": "2026-10-24",
                    "register": null,
                    "device": null,
                    "location": "loc_01J8ZK2B4D6F8H0K2M4P6R8T0V",
                    "staff_member": null,
                    "status": "completed",
                    "kind": "sale",
                    "refunds_order": null,
                    "order_type": "delivery",
                    "source": "online",
                    "store_number": 318,
                    "fulfilment_status": "fulfilled",
                    "customer": "cus_01J8ZK1Q9H2B4C6D8E0F2G4H6J",
                    "booking": null,
                    "table": null,
                    "covers": null,
                    "tab_name": null,
                    "currency": "gbp",
                    "lines": [
                      {
                        "id": "ordl_01K7HBFR8T0V2X4Z6B8D0F2H4K",
                        "object": "order_line",
                        "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
                        "product": "prod_01K7HB2M4N6P8Q0R2S4T6V8W0X",
                        "variant": null,
                        "service": null,
                        "staff_member": null,
                        "category": "Gifts",
                        "tax_class": "standard",
                        "name": "Sea salt candle",
                        "sold_by": "each",
                        "unit": null,
                        "quantity": "2",
                        "unit_amount": 1200,
                        "modifiers": [],
                        "gross_amount": 2400,
                        "line_discount": null,
                        "discount_amount": 0,
                        "taxes": [
                          {
                            "tax_rate": "taxr_01J8ZK5E7G9J1L3N5Q7S9U1W3Y",
                            "name": "VAT 20%",
                            "rate_ppm": 200000,
                            "amount": 400,
                            "inclusive": true
                          }
                        ],
                        "tax_amount": 400,
                        "amount": 2400,
                        "cost_amount": null,
                        "notes": null,
                        "seat": null,
                        "course": null,
                        "kitchen_station": null,
                        "sent_to_kitchen_at": null,
                        "voided": null,
                        "sort": 0,
                        "ticket": null,
                        "created": 1792310400
                      },
                      {
                        "id": "ordl_01K7HBFR8T0V2X4Z6B8D0F2H4M",
                        "object": "order_line",
                        "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
                        "product": "prod_01K7HB2M4N6P8Q0R2S4T6V8W0Y",
                        "variant": null,
                        "service": null,
                        "staff_member": null,
                        "category": "Gifts",
                        "tax_class": "standard",
                        "name": "Harbour mug",
                        "sold_by": "each",
                        "unit": null,
                        "quantity": "1",
                        "unit_amount": 695,
                        "modifiers": [],
                        "gross_amount": 695,
                        "line_discount": null,
                        "discount_amount": 0,
                        "taxes": [
                          {
                            "tax_rate": "taxr_01J8ZK5E7G9J1L3N5Q7S9U1W3Y",
                            "name": "VAT 20%",
                            "rate_ppm": 200000,
                            "amount": 116,
                            "inclusive": true
                          }
                        ],
                        "tax_amount": 116,
                        "amount": 695,
                        "cost_amount": null,
                        "notes": null,
                        "seat": null,
                        "course": null,
                        "kitchen_station": null,
                        "sent_to_kitchen_at": null,
                        "voided": null,
                        "sort": 1,
                        "ticket": null,
                        "created": 1792310400
                      },
                      {
                        "id": "ordl_01K7HBFR8T0V2X4Z6B8D0F2H4N",
                        "object": "order_line",
                        "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
                        "product": null,
                        "variant": null,
                        "service": null,
                        "staff_member": null,
                        "category": null,
                        "tax_class": "standard",
                        "name": "Royal Mail Tracked 48",
                        "sold_by": "open",
                        "unit": null,
                        "quantity": "1",
                        "unit_amount": 355,
                        "modifiers": [],
                        "gross_amount": 355,
                        "line_discount": null,
                        "discount_amount": 0,
                        "taxes": [
                          {
                            "tax_rate": "taxr_01J8ZK5E7G9J1L3N5Q7S9U1W3Y",
                            "name": "VAT 20%",
                            "rate_ppm": 200000,
                            "amount": 59,
                            "inclusive": true
                          }
                        ],
                        "tax_amount": 59,
                        "amount": 355,
                        "cost_amount": null,
                        "notes": null,
                        "seat": null,
                        "course": null,
                        "kitchen_station": null,
                        "sent_to_kitchen_at": null,
                        "voided": null,
                        "sort": 2,
                        "ticket": null,
                        "created": 1792310400
                      }
                    ],
                    "tenders": [
                      {
                        "id": "tndr_01K7HBGS9U1W3Y5A7C9E1G3J5L",
                        "object": "tender",
                        "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
                        "method": "card",
                        "external_kind": null,
                        "payment": "pay_01K7HBHT0V2X4Z6B8D0F2H4K6M",
                        "voucher_redemption": null,
                        "amount": 3450,
                        "currency": "gbp",
                        "tip_amount": 0,
                        "tendered": null,
                        "change": 0,
                        "rounding_amount": 0,
                        "network": null,
                        "status": "succeeded",
                        "refunded_amount": 0,
                        "staff_member": null,
                        "device": null,
                        "reader": null,
                        "client_created_at": null,
                        "created_offline": false,
                        "sort": 0,
                        "shift": null,
                        "created": 1792310400
                      }
                    ],
                    "discounts": [],
                    "service_charge": null,
                    "tax_exemption": null,
                    "tip_amount": 0,
                    "tip_shares": [],
                    "totals": {
                      "subtotal": 3450,
                      "discount": 0,
                      "service_charge": 0,
                      "tax_by_rate": [
                        {
                          "tax_rate": "taxr_01J8ZK5E7G9J1L3N5Q7S9U1W3Y",
                          "name": "VAT 20%",
                          "rate_ppm": 200000,
                          "taxable": 3450,
                          "tax": 575,
                          "inclusive": true
                        }
                      ],
                      "tax": 575,
                      "tip": 0,
                      "total": 3450,
                      "cash_rounding": 0,
                      "paid": 3450,
                      "due": 0,
                      "change": 0
                    },
                    "catalogue_version": null,
                    "notes": null,
                    "needs_review": null,
                    "fulfilment_hold": null,
                    "client_created_at": null,
                    "created_offline": false,
                    "synced_at": null,
                    "completed_at": 1792310400,
                    "voided": null,
                    "metadata": {},
                    "created": 1792310400
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "order.paid": {
      "post": {
        "summary": "order.paid",
        "description": "Sent to every endpoint subscribed to `order.paid` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OrderPaidEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "order.paid",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
                    "object": "order",
                    "livemode": false,
                    "number": 1042,
                    "business_day": "2026-10-24",
                    "register": null,
                    "device": null,
                    "location": "loc_01J8ZK2B4D6F8H0K2M4P6R8T0V",
                    "staff_member": null,
                    "status": "completed",
                    "kind": "sale",
                    "refunds_order": null,
                    "order_type": "delivery",
                    "source": "online",
                    "store_number": 318,
                    "fulfilment_status": "fulfilled",
                    "customer": "cus_01J8ZK1Q9H2B4C6D8E0F2G4H6J",
                    "booking": null,
                    "table": null,
                    "covers": null,
                    "tab_name": null,
                    "currency": "gbp",
                    "lines": [
                      {
                        "id": "ordl_01K7HBFR8T0V2X4Z6B8D0F2H4K",
                        "object": "order_line",
                        "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
                        "product": "prod_01K7HB2M4N6P8Q0R2S4T6V8W0X",
                        "variant": null,
                        "service": null,
                        "staff_member": null,
                        "category": "Gifts",
                        "tax_class": "standard",
                        "name": "Sea salt candle",
                        "sold_by": "each",
                        "unit": null,
                        "quantity": "2",
                        "unit_amount": 1200,
                        "modifiers": [],
                        "gross_amount": 2400,
                        "line_discount": null,
                        "discount_amount": 0,
                        "taxes": [
                          {
                            "tax_rate": "taxr_01J8ZK5E7G9J1L3N5Q7S9U1W3Y",
                            "name": "VAT 20%",
                            "rate_ppm": 200000,
                            "amount": 400,
                            "inclusive": true
                          }
                        ],
                        "tax_amount": 400,
                        "amount": 2400,
                        "cost_amount": null,
                        "notes": null,
                        "seat": null,
                        "course": null,
                        "kitchen_station": null,
                        "sent_to_kitchen_at": null,
                        "voided": null,
                        "sort": 0,
                        "ticket": null,
                        "created": 1792310400
                      },
                      {
                        "id": "ordl_01K7HBFR8T0V2X4Z6B8D0F2H4M",
                        "object": "order_line",
                        "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
                        "product": "prod_01K7HB2M4N6P8Q0R2S4T6V8W0Y",
                        "variant": null,
                        "service": null,
                        "staff_member": null,
                        "category": "Gifts",
                        "tax_class": "standard",
                        "name": "Harbour mug",
                        "sold_by": "each",
                        "unit": null,
                        "quantity": "1",
                        "unit_amount": 695,
                        "modifiers": [],
                        "gross_amount": 695,
                        "line_discount": null,
                        "discount_amount": 0,
                        "taxes": [
                          {
                            "tax_rate": "taxr_01J8ZK5E7G9J1L3N5Q7S9U1W3Y",
                            "name": "VAT 20%",
                            "rate_ppm": 200000,
                            "amount": 116,
                            "inclusive": true
                          }
                        ],
                        "tax_amount": 116,
                        "amount": 695,
                        "cost_amount": null,
                        "notes": null,
                        "seat": null,
                        "course": null,
                        "kitchen_station": null,
                        "sent_to_kitchen_at": null,
                        "voided": null,
                        "sort": 1,
                        "ticket": null,
                        "created": 1792310400
                      },
                      {
                        "id": "ordl_01K7HBFR8T0V2X4Z6B8D0F2H4N",
                        "object": "order_line",
                        "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
                        "product": null,
                        "variant": null,
                        "service": null,
                        "staff_member": null,
                        "category": null,
                        "tax_class": "standard",
                        "name": "Royal Mail Tracked 48",
                        "sold_by": "open",
                        "unit": null,
                        "quantity": "1",
                        "unit_amount": 355,
                        "modifiers": [],
                        "gross_amount": 355,
                        "line_discount": null,
                        "discount_amount": 0,
                        "taxes": [
                          {
                            "tax_rate": "taxr_01J8ZK5E7G9J1L3N5Q7S9U1W3Y",
                            "name": "VAT 20%",
                            "rate_ppm": 200000,
                            "amount": 59,
                            "inclusive": true
                          }
                        ],
                        "tax_amount": 59,
                        "amount": 355,
                        "cost_amount": null,
                        "notes": null,
                        "seat": null,
                        "course": null,
                        "kitchen_station": null,
                        "sent_to_kitchen_at": null,
                        "voided": null,
                        "sort": 2,
                        "ticket": null,
                        "created": 1792310400
                      }
                    ],
                    "tenders": [
                      {
                        "id": "tndr_01K7HBGS9U1W3Y5A7C9E1G3J5L",
                        "object": "tender",
                        "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
                        "method": "card",
                        "external_kind": null,
                        "payment": "pay_01K7HBHT0V2X4Z6B8D0F2H4K6M",
                        "voucher_redemption": null,
                        "amount": 3450,
                        "currency": "gbp",
                        "tip_amount": 0,
                        "tendered": null,
                        "change": 0,
                        "rounding_amount": 0,
                        "network": null,
                        "status": "succeeded",
                        "refunded_amount": 0,
                        "staff_member": null,
                        "device": null,
                        "reader": null,
                        "client_created_at": null,
                        "created_offline": false,
                        "sort": 0,
                        "shift": null,
                        "created": 1792310400
                      }
                    ],
                    "discounts": [],
                    "service_charge": null,
                    "tax_exemption": null,
                    "tip_amount": 0,
                    "tip_shares": [],
                    "totals": {
                      "subtotal": 3450,
                      "discount": 0,
                      "service_charge": 0,
                      "tax_by_rate": [
                        {
                          "tax_rate": "taxr_01J8ZK5E7G9J1L3N5Q7S9U1W3Y",
                          "name": "VAT 20%",
                          "rate_ppm": 200000,
                          "taxable": 3450,
                          "tax": 575,
                          "inclusive": true
                        }
                      ],
                      "tax": 575,
                      "tip": 0,
                      "total": 3450,
                      "cash_rounding": 0,
                      "paid": 3450,
                      "due": 0,
                      "change": 0
                    },
                    "catalogue_version": null,
                    "notes": null,
                    "needs_review": null,
                    "fulfilment_hold": null,
                    "client_created_at": null,
                    "created_offline": false,
                    "synced_at": null,
                    "completed_at": 1792310400,
                    "voided": null,
                    "metadata": {},
                    "created": 1792310400
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "order.completed": {
      "post": {
        "summary": "order.completed",
        "description": "Sent to every endpoint subscribed to `order.completed` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OrderCompletedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "order.completed",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
                    "object": "order",
                    "livemode": false,
                    "number": 1042,
                    "business_day": "2026-10-24",
                    "register": null,
                    "device": null,
                    "location": "loc_01J8ZK2B4D6F8H0K2M4P6R8T0V",
                    "staff_member": null,
                    "status": "completed",
                    "kind": "sale",
                    "refunds_order": null,
                    "order_type": "delivery",
                    "source": "online",
                    "store_number": 318,
                    "fulfilment_status": "fulfilled",
                    "customer": "cus_01J8ZK1Q9H2B4C6D8E0F2G4H6J",
                    "booking": null,
                    "table": null,
                    "covers": null,
                    "tab_name": null,
                    "currency": "gbp",
                    "lines": [
                      {
                        "id": "ordl_01K7HBFR8T0V2X4Z6B8D0F2H4K",
                        "object": "order_line",
                        "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
                        "product": "prod_01K7HB2M4N6P8Q0R2S4T6V8W0X",
                        "variant": null,
                        "service": null,
                        "staff_member": null,
                        "category": "Gifts",
                        "tax_class": "standard",
                        "name": "Sea salt candle",
                        "sold_by": "each",
                        "unit": null,
                        "quantity": "2",
                        "unit_amount": 1200,
                        "modifiers": [],
                        "gross_amount": 2400,
                        "line_discount": null,
                        "discount_amount": 0,
                        "taxes": [
                          {
                            "tax_rate": "taxr_01J8ZK5E7G9J1L3N5Q7S9U1W3Y",
                            "name": "VAT 20%",
                            "rate_ppm": 200000,
                            "amount": 400,
                            "inclusive": true
                          }
                        ],
                        "tax_amount": 400,
                        "amount": 2400,
                        "cost_amount": null,
                        "notes": null,
                        "seat": null,
                        "course": null,
                        "kitchen_station": null,
                        "sent_to_kitchen_at": null,
                        "voided": null,
                        "sort": 0,
                        "ticket": null,
                        "created": 1792310400
                      },
                      {
                        "id": "ordl_01K7HBFR8T0V2X4Z6B8D0F2H4M",
                        "object": "order_line",
                        "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
                        "product": "prod_01K7HB2M4N6P8Q0R2S4T6V8W0Y",
                        "variant": null,
                        "service": null,
                        "staff_member": null,
                        "category": "Gifts",
                        "tax_class": "standard",
                        "name": "Harbour mug",
                        "sold_by": "each",
                        "unit": null,
                        "quantity": "1",
                        "unit_amount": 695,
                        "modifiers": [],
                        "gross_amount": 695,
                        "line_discount": null,
                        "discount_amount": 0,
                        "taxes": [
                          {
                            "tax_rate": "taxr_01J8ZK5E7G9J1L3N5Q7S9U1W3Y",
                            "name": "VAT 20%",
                            "rate_ppm": 200000,
                            "amount": 116,
                            "inclusive": true
                          }
                        ],
                        "tax_amount": 116,
                        "amount": 695,
                        "cost_amount": null,
                        "notes": null,
                        "seat": null,
                        "course": null,
                        "kitchen_station": null,
                        "sent_to_kitchen_at": null,
                        "voided": null,
                        "sort": 1,
                        "ticket": null,
                        "created": 1792310400
                      },
                      {
                        "id": "ordl_01K7HBFR8T0V2X4Z6B8D0F2H4N",
                        "object": "order_line",
                        "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
                        "product": null,
                        "variant": null,
                        "service": null,
                        "staff_member": null,
                        "category": null,
                        "tax_class": "standard",
                        "name": "Royal Mail Tracked 48",
                        "sold_by": "open",
                        "unit": null,
                        "quantity": "1",
                        "unit_amount": 355,
                        "modifiers": [],
                        "gross_amount": 355,
                        "line_discount": null,
                        "discount_amount": 0,
                        "taxes": [
                          {
                            "tax_rate": "taxr_01J8ZK5E7G9J1L3N5Q7S9U1W3Y",
                            "name": "VAT 20%",
                            "rate_ppm": 200000,
                            "amount": 59,
                            "inclusive": true
                          }
                        ],
                        "tax_amount": 59,
                        "amount": 355,
                        "cost_amount": null,
                        "notes": null,
                        "seat": null,
                        "course": null,
                        "kitchen_station": null,
                        "sent_to_kitchen_at": null,
                        "voided": null,
                        "sort": 2,
                        "ticket": null,
                        "created": 1792310400
                      }
                    ],
                    "tenders": [
                      {
                        "id": "tndr_01K7HBGS9U1W3Y5A7C9E1G3J5L",
                        "object": "tender",
                        "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
                        "method": "card",
                        "external_kind": null,
                        "payment": "pay_01K7HBHT0V2X4Z6B8D0F2H4K6M",
                        "voucher_redemption": null,
                        "amount": 3450,
                        "currency": "gbp",
                        "tip_amount": 0,
                        "tendered": null,
                        "change": 0,
                        "rounding_amount": 0,
                        "network": null,
                        "status": "succeeded",
                        "refunded_amount": 0,
                        "staff_member": null,
                        "device": null,
                        "reader": null,
                        "client_created_at": null,
                        "created_offline": false,
                        "sort": 0,
                        "shift": null,
                        "created": 1792310400
                      }
                    ],
                    "discounts": [],
                    "service_charge": null,
                    "tax_exemption": null,
                    "tip_amount": 0,
                    "tip_shares": [],
                    "totals": {
                      "subtotal": 3450,
                      "discount": 0,
                      "service_charge": 0,
                      "tax_by_rate": [
                        {
                          "tax_rate": "taxr_01J8ZK5E7G9J1L3N5Q7S9U1W3Y",
                          "name": "VAT 20%",
                          "rate_ppm": 200000,
                          "taxable": 3450,
                          "tax": 575,
                          "inclusive": true
                        }
                      ],
                      "tax": 575,
                      "tip": 0,
                      "total": 3450,
                      "cash_rounding": 0,
                      "paid": 3450,
                      "due": 0,
                      "change": 0
                    },
                    "catalogue_version": null,
                    "notes": null,
                    "needs_review": null,
                    "fulfilment_hold": null,
                    "client_created_at": null,
                    "created_offline": false,
                    "synced_at": null,
                    "completed_at": 1792310400,
                    "voided": null,
                    "metadata": {},
                    "created": 1792310400
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "tender.created": {
      "post": {
        "summary": "tender.created",
        "description": "Sent to every endpoint subscribed to `tender.created` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TenderCreatedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "tender.created",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "tender_01K7HBW0EXAMPLE0000000000",
                    "object": "tender"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.checkout_abandoned": {
      "post": {
        "summary": "store.checkout_abandoned",
        "description": "Sent to every endpoint subscribed to `store.checkout_abandoned` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreCheckoutAbandonedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.checkout_abandoned",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "checko_01K7HBW0EXAMPLE0000000000",
                    "object": "checkout"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.cancellation_received": {
      "post": {
        "summary": "store.cancellation_received",
        "description": "Sent to every endpoint subscribed to `store.cancellation_received` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreCancellationReceivedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.cancellation_received",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "storec_01K7HBW0EXAMPLE0000000000",
                    "object": "store_cancellation"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "subscription.renewal_skipped": {
      "post": {
        "summary": "subscription.renewal_skipped",
        "description": "Sent to every endpoint subscribed to `subscription.renewal_skipped` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SubscriptionRenewalSkippedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "subscription.renewal_skipped",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "subscr_01K7HBW0EXAMPLE0000000000",
                    "object": "subscription"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "subscription.renewal_notice_sent": {
      "post": {
        "summary": "subscription.renewal_notice_sent",
        "description": "Sent to every endpoint subscribed to `subscription.renewal_notice_sent` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SubscriptionRenewalNoticeSentEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "subscription.renewal_notice_sent",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "subscr_01K7HBW0EXAMPLE0000000000",
                    "object": "subscription"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "fulfilment.shipped": {
      "post": {
        "summary": "fulfilment.shipped",
        "description": "Sent to every endpoint subscribed to `fulfilment.shipped` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FulfilmentShippedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "fulfilment.shipped",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "ful_01K7HBTB9E1G3J5L7N9Q1S3V5X",
                    "object": "fulfilment",
                    "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
                    "order_number": "#318",
                    "location": "loc_01J8ZK2B4D6F8H0K2M4P6R8T0V",
                    "kind": "shipping",
                    "status": "shipped",
                    "service_code": "royal_mail_tracked_48",
                    "promise": {
                      "dispatch_by": "2026-10-26",
                      "earliest": "2026-10-27",
                      "latest": "2026-10-28"
                    },
                    "needs_stock": false,
                    "parcel": {
                      "weight_g": 1450,
                      "length_mm": 300,
                      "width_mm": 200,
                      "height_mm": 150,
                      "package": null
                    },
                    "ship_to": {
                      "name": "Sam Taylor",
                      "line1": "12 Park Row",
                      "line2": null,
                      "city": "Leeds",
                      "region": null,
                      "postcode": "LS1 5HD",
                      "country": "GB"
                    },
                    "lines": [
                      {
                        "id": "fulln_01K7HBJV1W3Y5A7C9E1G3J5L7N",
                        "object": "fulfilment_line",
                        "order_line": "ordl_01K7HBFR8T0V2X4Z6B8D0F2H4K",
                        "variant": null,
                        "name": "Sea salt candle",
                        "sku": "CND-SEA-200",
                        "category": "Candles",
                        "barcodes": [
                          "5012345678900"
                        ],
                        "weight_g": 450,
                        "quantity": "2",
                        "packed_quantity": "2",
                        "scanned": true
                      }
                    ],
                    "shipment": {
                      "id": "shp_01K7HBKW2X4Z6B8D0F2H4K6M8P",
                      "object": "shipment",
                      "status": "in_transit",
                      "vendor": "fake",
                      "carrier": "royal_mail",
                      "service_code": "royal_mail_tracked_48",
                      "tracking_number": "TT123456785GB",
                      "cost_amount": 329,
                      "currency": "gbp",
                      "paid_by": "tuppence_balance",
                      "label_formats": [
                        "pdf",
                        "zpl"
                      ],
                      "created": 1792314000
                    },
                    "packed_at": 1792313400,
                    "shipped_at": 1792314000,
                    "created": 1792310400
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "fulfilment.delayed": {
      "post": {
        "summary": "fulfilment.delayed",
        "description": "Sent to every endpoint subscribed to `fulfilment.delayed` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FulfilmentDelayedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "fulfilment.delayed",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "fulfil_01K7HBW0EXAMPLE0000000000",
                    "object": "fulfilment"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "shipment.updated": {
      "post": {
        "summary": "shipment.updated",
        "description": "Sent to every endpoint subscribed to `shipment.updated` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShipmentUpdatedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "shipment.updated",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "shipme_01K7HBW0EXAMPLE0000000000",
                    "object": "shipment"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "shipment.in_transit": {
      "post": {
        "summary": "shipment.in_transit",
        "description": "Sent to every endpoint subscribed to `shipment.in_transit` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShipmentInTransitEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "shipment.in_transit",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "shipme_01K7HBW0EXAMPLE0000000000",
                    "object": "shipment"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "shipment.out_for_delivery": {
      "post": {
        "summary": "shipment.out_for_delivery",
        "description": "Sent to every endpoint subscribed to `shipment.out_for_delivery` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShipmentOutForDeliveryEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "shipment.out_for_delivery",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "shipme_01K7HBW0EXAMPLE0000000000",
                    "object": "shipment"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "shipment.available_for_pickup": {
      "post": {
        "summary": "shipment.available_for_pickup",
        "description": "Sent to every endpoint subscribed to `shipment.available_for_pickup` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShipmentAvailableForPickupEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "shipment.available_for_pickup",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "shipme_01K7HBW0EXAMPLE0000000000",
                    "object": "shipment"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "shipment.delivered": {
      "post": {
        "summary": "shipment.delivered",
        "description": "Sent to every endpoint subscribed to `shipment.delivered` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShipmentDeliveredEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "shipment.delivered",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "shipme_01K7HBW0EXAMPLE0000000000",
                    "object": "shipment"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "shipment.exception": {
      "post": {
        "summary": "shipment.exception",
        "description": "Sent to every endpoint subscribed to `shipment.exception` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShipmentExceptionEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "shipment.exception",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "shipme_01K7HBW0EXAMPLE0000000000",
                    "object": "shipment"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "shipment.returned_to_sender": {
      "post": {
        "summary": "shipment.returned_to_sender",
        "description": "Sent to every endpoint subscribed to `shipment.returned_to_sender` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShipmentReturnedToSenderEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "shipment.returned_to_sender",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "shipme_01K7HBW0EXAMPLE0000000000",
                    "object": "shipment"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "return.requested": {
      "post": {
        "summary": "return.requested",
        "description": "Sent to every endpoint subscribed to `return.requested` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReturnRequestedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "return.requested",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "return_01K7HBW0EXAMPLE0000000000",
                    "object": "return"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "return.approved": {
      "post": {
        "summary": "return.approved",
        "description": "Sent to every endpoint subscribed to `return.approved` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReturnApprovedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "return.approved",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "return_01K7HBW0EXAMPLE0000000000",
                    "object": "return"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "return.rejected": {
      "post": {
        "summary": "return.rejected",
        "description": "Sent to every endpoint subscribed to `return.rejected` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReturnRejectedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "return.rejected",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "return_01K7HBW0EXAMPLE0000000000",
                    "object": "return"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "return.received": {
      "post": {
        "summary": "return.received",
        "description": "Sent to every endpoint subscribed to `return.received` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReturnReceivedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "return.received",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "return_01K7HBW0EXAMPLE0000000000",
                    "object": "return"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "return.refunded": {
      "post": {
        "summary": "return.refunded",
        "description": "Sent to every endpoint subscribed to `return.refunded` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReturnRefundedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "return.refunded",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "return_01K7HBW0EXAMPLE0000000000",
                    "object": "return"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "return.closed": {
      "post": {
        "summary": "return.closed",
        "description": "Sent to every endpoint subscribed to `return.closed` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReturnClosedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "return.closed",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "return_01K7HBW0EXAMPLE0000000000",
                    "object": "return"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "return.refund_due_soon": {
      "post": {
        "summary": "return.refund_due_soon",
        "description": "Sent to every endpoint subscribed to `return.refund_due_soon` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReturnRefundDueSoonEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "return.refund_due_soon",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "return_01K7HBW0EXAMPLE0000000000",
                    "object": "return"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.channel_connected": {
      "post": {
        "summary": "store.channel_connected",
        "description": "Sent to every endpoint subscribed to `store.channel_connected` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreChannelConnectedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.channel_connected",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "salesc_01K7HBW0EXAMPLE0000000000",
                    "object": "sales_channel"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.channel_updated": {
      "post": {
        "summary": "store.channel_updated",
        "description": "Sent to every endpoint subscribed to `store.channel_updated` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreChannelUpdatedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.channel_updated",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "salesc_01K7HBW0EXAMPLE0000000000",
                    "object": "sales_channel"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.channel_disconnected": {
      "post": {
        "summary": "store.channel_disconnected",
        "description": "Sent to every endpoint subscribed to `store.channel_disconnected` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreChannelDisconnectedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.channel_disconnected",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "salesc_01K7HBW0EXAMPLE0000000000",
                    "object": "sales_channel"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.channel_error": {
      "post": {
        "summary": "store.channel_error",
        "description": "Sent to every endpoint subscribed to `store.channel_error` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreChannelErrorEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.channel_error",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "salesc_01K7HBW0EXAMPLE0000000000",
                    "object": "sales_channel"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "listing.live": {
      "post": {
        "summary": "listing.live",
        "description": "Sent to every endpoint subscribed to `listing.live` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ListingLiveEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "listing.live",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "listin_01K7HBW0EXAMPLE0000000000",
                    "object": "listing"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "listing.rejected": {
      "post": {
        "summary": "listing.rejected",
        "description": "Sent to every endpoint subscribed to `listing.rejected` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ListingRejectedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "listing.rejected",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "listin_01K7HBW0EXAMPLE0000000000",
                    "object": "listing"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "listing.removed": {
      "post": {
        "summary": "listing.removed",
        "description": "Sent to every endpoint subscribed to `listing.removed` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ListingRemovedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "listing.removed",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "listin_01K7HBW0EXAMPLE0000000000",
                    "object": "listing"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "listing.restricted": {
      "post": {
        "summary": "listing.restricted",
        "description": "Sent to every endpoint subscribed to `listing.restricted` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ListingRestrictedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "listing.restricted",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "produc_01K7HBW0EXAMPLE0000000000",
                    "object": "product_screen"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.agent_settings.updated": {
      "post": {
        "summary": "store.agent_settings.updated",
        "description": "Sent to every endpoint subscribed to `store.agent_settings.updated` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreAgentSettingsUpdatedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.agent_settings.updated",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "storea_01K7HBW0EXAMPLE0000000000",
                    "object": "store_ai_channels_change"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.agent.blocked": {
      "post": {
        "summary": "store.agent.blocked",
        "description": "Sent to every endpoint subscribed to `store.agent.blocked` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreAgentBlockedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.agent.blocked",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "storea_01K7HBW0EXAMPLE0000000000",
                    "object": "store_agent_block"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.agent.unblocked": {
      "post": {
        "summary": "store.agent.unblocked",
        "description": "Sent to every endpoint subscribed to `store.agent.unblocked` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreAgentUnblockedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.agent.unblocked",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "storea_01K7HBW0EXAMPLE0000000000",
                    "object": "store_agent_block"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "review.created": {
      "post": {
        "summary": "review.created",
        "description": "Sent to every endpoint subscribed to `review.created` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReviewCreatedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "review.created",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "rev_01K7HB9J1L3N5Q7S9U1W3Y5A7C",
                    "object": "review",
                    "livemode": false,
                    "booking": "bk_01K7HBAK2M4P6R8T0V2X4Z6B8D",
                    "customer": "cus_01J8ZK1Q9H2B4C6D8E0F2G4H6J",
                    "staff_member": "stf_01J8ZK4D6F8H0K2M4P6R8T0V2X",
                    "rating": 5,
                    "body": "A lovely candle-making workshop. We went home with three candles each.",
                    "author": "Priya S.",
                    "status": "published",
                    "reply": "Thank you, Priya. See you at the winter one!",
                    "replied_at": 1792310400,
                    "visited_on": "2026-10-18",
                    "created": 1792224000,
                    "edited": null
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "review.replied": {
      "post": {
        "summary": "review.replied",
        "description": "Sent to every endpoint subscribed to `review.replied` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReviewRepliedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "review.replied",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "rev_01K7HB9J1L3N5Q7S9U1W3Y5A7C",
                    "object": "review",
                    "livemode": false,
                    "booking": "bk_01K7HBAK2M4P6R8T0V2X4Z6B8D",
                    "customer": "cus_01J8ZK1Q9H2B4C6D8E0F2G4H6J",
                    "staff_member": "stf_01J8ZK4D6F8H0K2M4P6R8T0V2X",
                    "rating": 5,
                    "body": "A lovely candle-making workshop. We went home with three candles each.",
                    "author": "Priya S.",
                    "status": "published",
                    "reply": "Thank you, Priya. See you at the winter one!",
                    "replied_at": 1792310400,
                    "visited_on": "2026-10-18",
                    "created": 1792224000,
                    "edited": null
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "product_review.requested": {
      "post": {
        "summary": "product_review.requested",
        "description": "Sent to every endpoint subscribed to `product_review.requested` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductReviewRequestedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "product_review.requested",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "produc_01K7HBW0EXAMPLE0000000000",
                    "object": "product_review"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "product_review.published": {
      "post": {
        "summary": "product_review.published",
        "description": "Sent to every endpoint subscribed to `product_review.published` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductReviewPublishedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "product_review.published",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "produc_01K7HBW0EXAMPLE0000000000",
                    "object": "product_review"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "product_review.rejected": {
      "post": {
        "summary": "product_review.rejected",
        "description": "Sent to every endpoint subscribed to `product_review.rejected` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductReviewRejectedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "product_review.rejected",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "produc_01K7HBW0EXAMPLE0000000000",
                    "object": "product_review"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store_thread.message_received": {
      "post": {
        "summary": "store_thread.message_received",
        "description": "Sent to every endpoint subscribed to `store_thread.message_received` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreThreadMessageReceivedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store_thread.message_received",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "storet_01K7HBW0EXAMPLE0000000000",
                    "object": "store_thread"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store_thread.needs_you": {
      "post": {
        "summary": "store_thread.needs_you",
        "description": "Sent to every endpoint subscribed to `store_thread.needs_you` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreThreadNeedsYouEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store_thread.needs_you",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "storet_01K7HBW0EXAMPLE0000000000",
                    "object": "store_thread"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.privacy_request_received": {
      "post": {
        "summary": "store.privacy_request_received",
        "description": "Sent to every endpoint subscribed to `store.privacy_request_received` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StorePrivacyRequestReceivedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.privacy_request_received",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "storep_01K7HBW0EXAMPLE0000000000",
                    "object": "store_privacy_request"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store_flow.paused": {
      "post": {
        "summary": "store_flow.paused",
        "description": "Sent to every endpoint subscribed to `store_flow.paused` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreFlowPausedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store_flow.paused",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "storef_01K7HBW0EXAMPLE0000000000",
                    "object": "store_flow"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "change_set.applied": {
      "post": {
        "summary": "change_set.applied",
        "description": "Sent to every endpoint subscribed to `change_set.applied` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ChangeSetAppliedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "change_set.applied",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "change_01K7HBW0EXAMPLE0000000000",
                    "object": "change_set"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "change_set.reverted": {
      "post": {
        "summary": "change_set.reverted",
        "description": "Sent to every endpoint subscribed to `change_set.reverted` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ChangeSetRevertedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "change_set.reverted",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "change_01K7HBW0EXAMPLE0000000000",
                    "object": "change_set"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "change_set.proposed": {
      "post": {
        "summary": "change_set.proposed",
        "description": "Sent to every endpoint subscribed to `change_set.proposed` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ChangeSetProposedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "change_set.proposed",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "change_01K7HBW0EXAMPLE0000000000",
                    "object": "change_set"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "change_set.declined": {
      "post": {
        "summary": "change_set.declined",
        "description": "Sent to every endpoint subscribed to `change_set.declined` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ChangeSetDeclinedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "change_set.declined",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "change_01K7HBW0EXAMPLE0000000000",
                    "object": "change_set"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "change_set.expired": {
      "post": {
        "summary": "change_set.expired",
        "description": "Sent to every endpoint subscribed to `change_set.expired` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ChangeSetExpiredEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "change_set.expired",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "change_01K7HBW0EXAMPLE0000000000",
                    "object": "change_set"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "assistant_job.updated": {
      "post": {
        "summary": "assistant_job.updated",
        "description": "Sent to every endpoint subscribed to `assistant_job.updated` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AssistantJobUpdatedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "assistant_job.updated",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "assist_01K7HBW0EXAMPLE0000000000",
                    "object": "assistant_job"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "assistant_job.paused": {
      "post": {
        "summary": "assistant_job.paused",
        "description": "Sent to every endpoint subscribed to `assistant_job.paused` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AssistantJobPausedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "assistant_job.paused",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "assist_01K7HBW0EXAMPLE0000000000",
                    "object": "assistant_job"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "job_run.finished": {
      "post": {
        "summary": "job_run.finished",
        "description": "Sent to every endpoint subscribed to `job_run.finished` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/JobRunFinishedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "job_run.finished",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "jobrun_01K7HBW0EXAMPLE0000000000",
                    "object": "job_run"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store_brief.ready": {
      "post": {
        "summary": "store_brief.ready",
        "description": "Sent to every endpoint subscribed to `store_brief.ready` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreBriefReadyEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store_brief.ready",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "storeb_01K7HBW0EXAMPLE0000000000",
                    "object": "store_brief"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.tax_threshold_near": {
      "post": {
        "summary": "store.tax_threshold_near",
        "description": "Sent to every endpoint subscribed to `store.tax_threshold_near` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreTaxThresholdNearEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.tax_threshold_near",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "taxnex_01K7HBW0EXAMPLE0000000000",
                    "object": "tax_nexus_state"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "store.tax_threshold_reached": {
      "post": {
        "summary": "store.tax_threshold_reached",
        "description": "Sent to every endpoint subscribed to `store.tax_threshold_reached` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreTaxThresholdReachedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "store.tax_threshold_reached",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "taxnex_01K7HBW0EXAMPLE0000000000",
                    "object": "tax_nexus_state"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "tax_registration.created": {
      "post": {
        "summary": "tax_registration.created",
        "description": "Sent to every endpoint subscribed to `tax_registration.created` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TaxRegistrationCreatedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "tax_registration.created",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "taxreg_01K7HBW0EXAMPLE0000000000",
                    "object": "tax_registration"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "policy.version_drafted": {
      "post": {
        "summary": "policy.version_drafted",
        "description": "Sent to every endpoint subscribed to `policy.version_drafted` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PolicyVersionDraftedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "policy.version_drafted",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "sitepo_01K7HBW0EXAMPLE0000000000",
                    "object": "site_policy_version"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "policy.version_published": {
      "post": {
        "summary": "policy.version_published",
        "description": "Sent to every endpoint subscribed to `policy.version_published` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PolicyVersionPublishedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "policy.version_published",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "sitepo_01K7HBW0EXAMPLE0000000000",
                    "object": "site_policy_version"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "event.published": {
      "post": {
        "summary": "event.published",
        "description": "Sent to every endpoint subscribed to `event.published` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EventPublishedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "event.published",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "tev_01K9EXAMPLE0000000000000",
                    "object": "ticketing.event",
                    "livemode": false,
                    "slug": "agents-after-dark",
                    "url": "https://book.tuppence.ai/e/agents-after-dark",
                    "title": "Agents after dark",
                    "about": "An evening of demos from people building with AI agents.",
                    "venue_name": "The Old Library",
                    "venue_address": "1 Example Street, London",
                    "venue_latitude": "51.5194",
                    "venue_longitude": "-0.127",
                    "named_tickets": false,
                    "online_url": null,
                    "timezone": "Europe/London",
                    "currency": "gbp",
                    "status": "on_sale",
                    "visibility": "public",
                    "approval_required": false,
                    "donations_enabled": false,
                    "refund_policy": "until_1_day",
                    "reminder_hours_before": 24,
                    "code_reveal": "auto",
                    "code_reveal_hours_before": 3,
                    "announce_to_past_attendees": true,
                    "dates": [
                      {
                        "id": "tocc_01K9EXAMPLE000000000000",
                        "object": "ticketing.event_date",
                        "starts_at": "2026-12-04T18:30:00+00:00",
                        "ends_at": "2026-12-04T22:00:00+00:00",
                        "doors_at": "2026-12-04T18:00:00+00:00",
                        "capacity": 120,
                        "status": "scheduled"
                      }
                    ],
                    "repeat": null,
                    "published_at": 1792310400,
                    "metadata": {},
                    "questions": [],
                    "gates": [
                      "Main"
                    ],
                    "cover": null,
                    "cover_url": null,
                    "theme": "aurora",
                    "palette": [],
                    "palette_overrides": null,
                    "title_font": null,
                    "theme_tokens": {
                      "theme": "aurora",
                      "scheme": "dark",
                      "title_font": "instrument-serif",
                      "colors": {
                        "bg": "#020e1d",
                        "ink": "#f0f6fc",
                        "muted": "#a8b2be",
                        "accent": "#8976ff",
                        "accent_ink": "#11101a",
                        "card": "#121e2b",
                        "line": "#1f2d3c"
                      },
                      "decor": [
                        "#8976ff",
                        "#3ddc97",
                        "#1fb6ff"
                      ],
                      "adjusted": []
                    },
                    "pixels": null,
                    "created": 1792306800
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "event.unpublished": {
      "post": {
        "summary": "event.unpublished",
        "description": "Sent to every endpoint subscribed to `event.unpublished` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EventUnpublishedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "event.unpublished",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "tev_01K9EXAMPLE0000000000000",
                    "object": "ticketing.event",
                    "livemode": false,
                    "slug": "agents-after-dark",
                    "url": "https://book.tuppence.ai/e/agents-after-dark",
                    "title": "Agents after dark",
                    "about": "An evening of demos from people building with AI agents.",
                    "venue_name": "The Old Library",
                    "venue_address": "1 Example Street, London",
                    "venue_latitude": "51.5194",
                    "venue_longitude": "-0.127",
                    "named_tickets": false,
                    "online_url": null,
                    "timezone": "Europe/London",
                    "currency": "gbp",
                    "status": "on_sale",
                    "visibility": "public",
                    "approval_required": false,
                    "donations_enabled": false,
                    "refund_policy": "until_1_day",
                    "reminder_hours_before": 24,
                    "code_reveal": "auto",
                    "code_reveal_hours_before": 3,
                    "announce_to_past_attendees": true,
                    "dates": [
                      {
                        "id": "tocc_01K9EXAMPLE000000000000",
                        "object": "ticketing.event_date",
                        "starts_at": "2026-12-04T18:30:00+00:00",
                        "ends_at": "2026-12-04T22:00:00+00:00",
                        "doors_at": "2026-12-04T18:00:00+00:00",
                        "capacity": 120,
                        "status": "scheduled"
                      }
                    ],
                    "repeat": null,
                    "published_at": 1792310400,
                    "metadata": {},
                    "questions": [],
                    "gates": [
                      "Main"
                    ],
                    "cover": null,
                    "cover_url": null,
                    "theme": "aurora",
                    "palette": [],
                    "palette_overrides": null,
                    "title_font": null,
                    "theme_tokens": {
                      "theme": "aurora",
                      "scheme": "dark",
                      "title_font": "instrument-serif",
                      "colors": {
                        "bg": "#020e1d",
                        "ink": "#f0f6fc",
                        "muted": "#a8b2be",
                        "accent": "#8976ff",
                        "accent_ink": "#11101a",
                        "card": "#121e2b",
                        "line": "#1f2d3c"
                      },
                      "decor": [
                        "#8976ff",
                        "#3ddc97",
                        "#1fb6ff"
                      ],
                      "adjusted": []
                    },
                    "pixels": null,
                    "created": 1792306800
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "event.cancelled": {
      "post": {
        "summary": "event.cancelled",
        "description": "Sent to every endpoint subscribed to `event.cancelled` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EventCancelledEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "event.cancelled",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "tev_01K9EXAMPLE0000000000000",
                    "object": "ticketing.event",
                    "livemode": false,
                    "slug": "agents-after-dark",
                    "url": "https://book.tuppence.ai/e/agents-after-dark",
                    "title": "Agents after dark",
                    "about": "An evening of demos from people building with AI agents.",
                    "venue_name": "The Old Library",
                    "venue_address": "1 Example Street, London",
                    "venue_latitude": "51.5194",
                    "venue_longitude": "-0.127",
                    "named_tickets": false,
                    "online_url": null,
                    "timezone": "Europe/London",
                    "currency": "gbp",
                    "status": "on_sale",
                    "visibility": "public",
                    "approval_required": false,
                    "donations_enabled": false,
                    "refund_policy": "until_1_day",
                    "reminder_hours_before": 24,
                    "code_reveal": "auto",
                    "code_reveal_hours_before": 3,
                    "announce_to_past_attendees": true,
                    "dates": [
                      {
                        "id": "tocc_01K9EXAMPLE000000000000",
                        "object": "ticketing.event_date",
                        "starts_at": "2026-12-04T18:30:00+00:00",
                        "ends_at": "2026-12-04T22:00:00+00:00",
                        "doors_at": "2026-12-04T18:00:00+00:00",
                        "capacity": 120,
                        "status": "scheduled"
                      }
                    ],
                    "repeat": null,
                    "published_at": 1792310400,
                    "metadata": {},
                    "questions": [],
                    "gates": [
                      "Main"
                    ],
                    "cover": null,
                    "cover_url": null,
                    "theme": "aurora",
                    "palette": [],
                    "palette_overrides": null,
                    "title_font": null,
                    "theme_tokens": {
                      "theme": "aurora",
                      "scheme": "dark",
                      "title_font": "instrument-serif",
                      "colors": {
                        "bg": "#020e1d",
                        "ink": "#f0f6fc",
                        "muted": "#a8b2be",
                        "accent": "#8976ff",
                        "accent_ink": "#11101a",
                        "card": "#121e2b",
                        "line": "#1f2d3c"
                      },
                      "decor": [
                        "#8976ff",
                        "#3ddc97",
                        "#1fb6ff"
                      ],
                      "adjusted": []
                    },
                    "pixels": null,
                    "created": 1792306800
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "ticket_order.paid": {
      "post": {
        "summary": "ticket_order.paid",
        "description": "Sent to every endpoint subscribed to `ticket_order.paid` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TicketOrderPaidEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "ticket_order.paid",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "tord_01K9EXAMPLE000000000000",
                    "object": "ticket_order",
                    "livemode": false,
                    "event": "tev_01K9EXAMPLE0000000000000",
                    "date": "tocc_01K9EXAMPLE000000000000",
                    "buyer": {
                      "name": "Ada Lovelace",
                      "email": "ada@example.com",
                      "phone": null,
                      "sms_opt_in": false,
                      "whatsapp_opt_in": false,
                      "marketing_opt_in": false
                    },
                    "status": "paid",
                    "quantity": 2,
                    "lines": [
                      {
                        "ticket_type": "tkty_01K9EXAMPLE000000000000",
                        "quantity": 2,
                        "unit_price": 2000,
                        "price_phase": null,
                        "unit_discount": 0,
                        "unit_group_discount": 0,
                        "amount": 4000,
                        "amount_discount": 0
                      }
                    ],
                    "amount_subtotal": 4000,
                    "amount_discount": 0,
                    "amount_donation": 0,
                    "amount_total": 4000,
                    "amount_refunded": 0,
                    "currency": "gbp",
                    "payment": "pay_01K9EXAMPLE0000000000000",
                    "promo_code": null,
                    "membership": null,
                    "source": "page",
                    "pos_order": null,
                    "utm": {},
                    "expires_at": 1792311000,
                    "paid_at": 1792310460,
                    "failure_reason": null,
                    "created": 1792310400
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "ticket_order.refunded": {
      "post": {
        "summary": "ticket_order.refunded",
        "description": "Sent to every endpoint subscribed to `ticket_order.refunded` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TicketOrderRefundedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "ticket_order.refunded",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "tord_01K9EXAMPLE000000000000",
                    "object": "ticket_order",
                    "livemode": false,
                    "event": "tev_01K9EXAMPLE0000000000000",
                    "date": "tocc_01K9EXAMPLE000000000000",
                    "buyer": {
                      "name": "Ada Lovelace",
                      "email": "ada@example.com",
                      "phone": null,
                      "sms_opt_in": false,
                      "whatsapp_opt_in": false,
                      "marketing_opt_in": false
                    },
                    "status": "paid",
                    "quantity": 2,
                    "lines": [
                      {
                        "ticket_type": "tkty_01K9EXAMPLE000000000000",
                        "quantity": 2,
                        "unit_price": 2000,
                        "price_phase": null,
                        "unit_discount": 0,
                        "unit_group_discount": 0,
                        "amount": 4000,
                        "amount_discount": 0
                      }
                    ],
                    "amount_subtotal": 4000,
                    "amount_discount": 0,
                    "amount_donation": 0,
                    "amount_total": 4000,
                    "amount_refunded": 0,
                    "currency": "gbp",
                    "payment": "pay_01K9EXAMPLE0000000000000",
                    "promo_code": null,
                    "membership": null,
                    "source": "page",
                    "pos_order": null,
                    "utm": {},
                    "expires_at": 1792311000,
                    "paid_at": 1792310460,
                    "failure_reason": null,
                    "created": 1792310400
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "ticket_order.requested": {
      "post": {
        "summary": "ticket_order.requested",
        "description": "Sent to every endpoint subscribed to `ticket_order.requested` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TicketOrderRequestedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "ticket_order.requested",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "tord_01K9EXAMPLE000000000000",
                    "object": "ticket_order",
                    "livemode": false,
                    "event": "tev_01K9EXAMPLE0000000000000",
                    "date": "tocc_01K9EXAMPLE000000000000",
                    "buyer": {
                      "name": "Ada Lovelace",
                      "email": "ada@example.com",
                      "phone": null,
                      "sms_opt_in": false,
                      "whatsapp_opt_in": false,
                      "marketing_opt_in": false
                    },
                    "status": "paid",
                    "quantity": 2,
                    "lines": [
                      {
                        "ticket_type": "tkty_01K9EXAMPLE000000000000",
                        "quantity": 2,
                        "unit_price": 2000,
                        "price_phase": null,
                        "unit_discount": 0,
                        "unit_group_discount": 0,
                        "amount": 4000,
                        "amount_discount": 0
                      }
                    ],
                    "amount_subtotal": 4000,
                    "amount_discount": 0,
                    "amount_donation": 0,
                    "amount_total": 4000,
                    "amount_refunded": 0,
                    "currency": "gbp",
                    "payment": "pay_01K9EXAMPLE0000000000000",
                    "promo_code": null,
                    "membership": null,
                    "source": "page",
                    "pos_order": null,
                    "utm": {},
                    "expires_at": 1792311000,
                    "paid_at": 1792310460,
                    "failure_reason": null,
                    "created": 1792310400
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "ticket_order.declined": {
      "post": {
        "summary": "ticket_order.declined",
        "description": "Sent to every endpoint subscribed to `ticket_order.declined` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TicketOrderDeclinedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "ticket_order.declined",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "tord_01K9EXAMPLE000000000000",
                    "object": "ticket_order",
                    "livemode": false,
                    "event": "tev_01K9EXAMPLE0000000000000",
                    "date": "tocc_01K9EXAMPLE000000000000",
                    "buyer": {
                      "name": "Ada Lovelace",
                      "email": "ada@example.com",
                      "phone": null,
                      "sms_opt_in": false,
                      "whatsapp_opt_in": false,
                      "marketing_opt_in": false
                    },
                    "status": "paid",
                    "quantity": 2,
                    "lines": [
                      {
                        "ticket_type": "tkty_01K9EXAMPLE000000000000",
                        "quantity": 2,
                        "unit_price": 2000,
                        "price_phase": null,
                        "unit_discount": 0,
                        "unit_group_discount": 0,
                        "amount": 4000,
                        "amount_discount": 0
                      }
                    ],
                    "amount_subtotal": 4000,
                    "amount_discount": 0,
                    "amount_donation": 0,
                    "amount_total": 4000,
                    "amount_refunded": 0,
                    "currency": "gbp",
                    "payment": "pay_01K9EXAMPLE0000000000000",
                    "promo_code": null,
                    "membership": null,
                    "source": "page",
                    "pos_order": null,
                    "utm": {},
                    "expires_at": 1792311000,
                    "paid_at": 1792310460,
                    "failure_reason": null,
                    "created": 1792310400
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "ticket.issued": {
      "post": {
        "summary": "ticket.issued",
        "description": "Sent to every endpoint subscribed to `ticket.issued` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TicketIssuedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "ticket.issued",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "tkt_01K9EXAMPLE00000000000000",
                    "object": "ticket",
                    "livemode": false,
                    "order": "tord_01K9EXAMPLE000000000000",
                    "event": "tev_01K9EXAMPLE0000000000000",
                    "date": "tocc_01K9EXAMPLE000000000000",
                    "ticket_type": "tkty_01K9EXAMPLE000000000000",
                    "holder": {
                      "name": "Ada Lovelace",
                      "email": "ada@example.com"
                    },
                    "status": "valid",
                    "short_code": "T-8F2K-QX41",
                    "code": "t1.tkt_01K9EXAMPLE00000000000000.EXAMPLESIGNATURE",
                    "amount": 2000,
                    "currency": "gbp",
                    "checked_in_at": null,
                    "voided_at": null,
                    "refund": null,
                    "returned_at": null,
                    "answers": {},
                    "created": 1792310460
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "ticket.refunded": {
      "post": {
        "summary": "ticket.refunded",
        "description": "Sent to every endpoint subscribed to `ticket.refunded` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TicketRefundedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "ticket.refunded",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "tkt_01K9EXAMPLE00000000000000",
                    "object": "ticket",
                    "livemode": false,
                    "order": "tord_01K9EXAMPLE000000000000",
                    "event": "tev_01K9EXAMPLE0000000000000",
                    "date": "tocc_01K9EXAMPLE000000000000",
                    "ticket_type": "tkty_01K9EXAMPLE000000000000",
                    "holder": {
                      "name": "Ada Lovelace",
                      "email": "ada@example.com"
                    },
                    "status": "valid",
                    "short_code": "T-8F2K-QX41",
                    "code": "t1.tkt_01K9EXAMPLE00000000000000.EXAMPLESIGNATURE",
                    "amount": 2000,
                    "currency": "gbp",
                    "checked_in_at": null,
                    "voided_at": null,
                    "refund": null,
                    "returned_at": null,
                    "answers": {},
                    "created": 1792310460
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "ticket.transferred": {
      "post": {
        "summary": "ticket.transferred",
        "description": "Sent to every endpoint subscribed to `ticket.transferred` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TicketTransferredEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "ticket.transferred",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "ttr_01K9EXAMPLE00000000000000",
                    "object": "ticket_transfer",
                    "livemode": false,
                    "kind": "gift",
                    "event": "tev_01K9EXAMPLE0000000000000",
                    "from_ticket": "tkt_01K9EXAMPLE00000000000000",
                    "ticket": "tkt_01K9EXAMPLE00000000000001",
                    "order": "tord_01K9EXAMPLE000000000000",
                    "from": {
                      "name": "Ada Lovelace",
                      "email": "ada@example.com"
                    },
                    "to": {
                      "name": "Bob Babbage",
                      "email": "bob@example.com"
                    },
                    "refund": null,
                    "created": 1792310520
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "ticket.checked_in": {
      "post": {
        "summary": "ticket.checked_in",
        "description": "Sent to every endpoint subscribed to `ticket.checked_in` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TicketCheckedInEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "ticket.checked_in",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "tkt_01K9EXAMPLE00000000000000",
                    "object": "ticket",
                    "livemode": false,
                    "order": "tord_01K9EXAMPLE000000000000",
                    "event": "tev_01K9EXAMPLE0000000000000",
                    "date": "tocc_01K9EXAMPLE000000000000",
                    "ticket_type": "tkty_01K9EXAMPLE000000000000",
                    "holder": {
                      "name": "Ada Lovelace",
                      "email": "ada@example.com"
                    },
                    "status": "valid",
                    "short_code": "T-8F2K-QX41",
                    "code": "t1.tkt_01K9EXAMPLE00000000000000.EXAMPLESIGNATURE",
                    "amount": 2000,
                    "currency": "gbp",
                    "checked_in_at": null,
                    "voided_at": null,
                    "refund": null,
                    "returned_at": null,
                    "answers": {},
                    "created": 1792310460
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "ticket_funds.released": {
      "post": {
        "summary": "ticket_funds.released",
        "description": "Sent to every endpoint subscribed to `ticket_funds.released` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TicketFundsReleasedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "ticket_funds.released",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "tfh_01K9EXAMPLE00000000000000",
                    "object": "ticket_funds_hold",
                    "livemode": false,
                    "event": "tev_01K9EXAMPLE0000000000000",
                    "date": "tocc_01K9EXAMPLE000000000000",
                    "currency": "gbp",
                    "amount": 3880,
                    "status": "released",
                    "release_after": 1792540800,
                    "released_at": 1792544400,
                    "extended_reason": null
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    },
    "ticket_funds.extended": {
      "post": {
        "summary": "ticket_funds.extended",
        "description": "Sent to every endpoint subscribed to `ticket_funds.extended` (or to `*`), signed with `Tuppence-Signature`. An endpoint with `connect: true` receives it for its connected accounts, with `account`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TicketFundsExtendedEvent"
              },
              "example": {
                "id": "evt_01K7HBW0EXAMPLE0000000000",
                "object": "event",
                "type": "ticket_funds.extended",
                "livemode": false,
                "created": 1792310400,
                "api_version": "2026-09-20",
                "request_id": null,
                "data": {
                  "object": {
                    "id": "tfh_01K9EXAMPLE00000000000000",
                    "object": "ticket_funds_hold",
                    "livemode": false,
                    "event": "tev_01K9EXAMPLE0000000000000",
                    "date": "tocc_01K9EXAMPLE000000000000",
                    "currency": "gbp",
                    "amount": 3880,
                    "status": "released",
                    "release_after": 1792540800,
                    "released_at": 1792544400,
                    "extended_reason": null
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Any 2xx answer marks the event delivered."
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "AbroadGroupModel": {
        "type": "object",
        "properties": {
          "group": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "countries": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "wanted": {
            "type": "boolean"
          },
          "open": {
            "type": "boolean"
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AbroadItemModel"
            }
          }
        },
        "required": [
          "group",
          "name",
          "countries",
          "wanted",
          "open",
          "items"
        ]
      },
      "AbroadItemModel": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "blocking": {
            "type": "boolean"
          },
          "message": {
            "type": "string",
            "minLength": 1
          },
          "products": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AbroadProductModel"
            }
          },
          "fix_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "key",
          "status",
          "blocking",
          "message",
          "products",
          "fix_url"
        ]
      },
      "AbroadProductModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "missing": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "id",
          "name",
          "missing"
        ]
      },
      "AcceptAllModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "accepted": {
            "type": "integer",
            "multipleOf": 1
          },
          "left": {
            "type": "integer",
            "multipleOf": 1
          },
          "message": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "accepted",
          "left",
          "message"
        ]
      },
      "AccountApplicationFeesModel": {
        "type": "object",
        "properties": {
          "percent": {
            "type": "string",
            "minLength": 1
          },
          "fixed_amount": {
            "type": "integer"
          }
        },
        "required": [
          "percent",
          "fixed_amount"
        ]
      },
      "AccountBusinessProfileModel": {
        "type": "object",
        "properties": {
          "name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "product_description": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "mcc": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "name",
          "url",
          "product_description",
          "mcc"
        ]
      },
      "AccountCapabilitiesModel": {
        "type": "object",
        "properties": {
          "card_payments": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "transfers": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "card_issuing": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "card_payments",
          "transfers",
          "card_issuing"
        ]
      },
      "AccountCardPaymentsSettingsModel": {
        "type": "object",
        "properties": {
          "statement_descriptor_prefix": {
            "type": "string",
            "minLength": 1
          },
          "statement_descriptor_suffix": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "statement_descriptor_prefix",
          "statement_descriptor_suffix"
        ]
      },
      "AccountCompanyBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 100
          },
          "phone": {
            "type": "string",
            "pattern": "^\\+?[0-9 ()-]{6,20}$"
          },
          "address": {
            "$ref": "#/components/schemas/PersonAddressBody"
          },
          "tax_id": {
            "type": "string",
            "maxLength": 40
          },
          "registration_number": {
            "type": "string",
            "maxLength": 40
          },
          "vat_id": {
            "type": "string",
            "maxLength": 40
          },
          "owners_provided": {
            "type": "boolean"
          },
          "directors_provided": {
            "type": "boolean"
          },
          "executives_provided": {
            "type": "boolean"
          },
          "verification": {
            "$ref": "#/components/schemas/CompanyVerificationBody"
          }
        }
      },
      "AccountCompanyModel": {
        "type": "object",
        "properties": {
          "name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "tax_id_provided": {
            "type": "boolean"
          },
          "phone_provided": {
            "type": "boolean"
          },
          "address_provided": {
            "type": "boolean"
          },
          "owners_provided": {
            "type": "boolean"
          },
          "directors_provided": {
            "type": "boolean"
          },
          "executives_provided": {
            "type": "boolean"
          }
        },
        "required": [
          "name",
          "tax_id_provided",
          "phone_provided",
          "address_provided",
          "owners_provided",
          "directors_provided",
          "executives_provided"
        ]
      },
      "AccountControllerModel": {
        "type": "object",
        "properties": {
          "fees": {
            "$ref": "#/components/schemas/ControllerFeesModel"
          },
          "losses": {
            "$ref": "#/components/schemas/ControllerLossesModel"
          },
          "requirement_collection": {
            "type": "string",
            "minLength": 1
          },
          "dashboard": {
            "$ref": "#/components/schemas/ControllerDashboardModel"
          }
        },
        "required": [
          "fees",
          "losses",
          "requirement_collection",
          "dashboard"
        ]
      },
      "AccountFutureRequirementsModel": {
        "type": "object",
        "properties": {
          "currently_due": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "currently_due"
        ]
      },
      "AccountLinkModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          },
          "expires_at": {
            "type": "integer"
          },
          "url": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "created",
          "expires_at",
          "url"
        ]
      },
      "AccountModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "business_type": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "country": {
            "type": "string",
            "description": "Where the business is registered (ISO 3166-1 alpha-2), fixed when it is created: `GB`, `US`, or one of the eurozone's 20 (`DE`, `FR`, `IE`…). It sets the company number, bank format (an IBAN in the eurozone), holidays and formats.",
            "minLength": 1
          },
          "default_currency": {
            "type": "string",
            "minLength": 1
          },
          "timezone": {
            "type": "string",
            "description": "The business's IANA time zone (`Europe/London`): the one it signed up in, else its country's. New events start in it, and reports and emails keep its days.",
            "minLength": 1
          },
          "region": {
            "type": "string",
            "description": "Which Tuppence platform the business is on, from its country and fixed when it is created: `gb` (GBP), `us` (USD) or `eu` (EUR, the eurozone's 20 countries). It decides the prices, payout rails, card issuer and terms.",
            "enum": [
              "gb",
              "us",
              "eu"
            ],
            "minLength": 1
          },
          "minimum_payment_amount": {
            "nullable": true,
            "type": "integer"
          },
          "fee_tier": {
            "type": "string",
            "minLength": 1
          },
          "live_enabled": {
            "type": "boolean"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "platform": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          },
          "origin": {
            "type": "string",
            "enum": [
              "signup",
              "sandbox",
              "sandbox_claimed"
            ],
            "minLength": 1
          },
          "claimed_at": {
            "nullable": true,
            "type": "integer"
          },
          "settings": {
            "$ref": "#/components/schemas/OwnAccountSettingsModel"
          }
        },
        "required": [
          "id",
          "object",
          "name",
          "business_type",
          "country",
          "default_currency",
          "timezone",
          "region",
          "minimum_payment_amount",
          "fee_tier",
          "live_enabled",
          "api_version",
          "platform",
          "created",
          "origin",
          "claimed_at",
          "settings"
        ]
      },
      "AccountNotificationSettingsModel": {
        "type": "object",
        "properties": {
          "email_connected_accounts": {
            "type": "boolean"
          }
        },
        "required": [
          "email_connected_accounts"
        ]
      },
      "AccountPaymentsSettingsModel": {
        "type": "object",
        "properties": {
          "statement_descriptor": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "statement_descriptor"
        ]
      },
      "AccountPayoutScheduleModel": {
        "type": "object",
        "properties": {
          "interval": {
            "type": "string",
            "minLength": 1
          },
          "delay_days": {
            "nullable": true,
            "type": "integer"
          },
          "weekly_anchor": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "monthly_anchor": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "interval",
          "delay_days",
          "weekly_anchor",
          "monthly_anchor"
        ]
      },
      "AccountPayoutSettingsModel": {
        "type": "object",
        "properties": {
          "statement_descriptor": {
            "type": "string",
            "minLength": 1
          },
          "schedule": {
            "$ref": "#/components/schemas/AccountPayoutScheduleModel"
          }
        },
        "required": [
          "statement_descriptor",
          "schedule"
        ]
      },
      "AccountPriceModel": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "card_rate",
              "surcharge_amex",
              "surcharge_commercial",
              "surcharge_foreign",
              "next_day_payouts",
              "instant_payouts",
              "dispute_fee"
            ],
            "minLength": 1
          },
          "bps": {
            "description": "The percentage, in basis points (79 is 0.79%); null where there is none.",
            "nullable": true,
            "type": "integer"
          },
          "fixed": {
            "description": "The fixed part in minor units (the dispute fee, the US card rate's 20¢); null where there is none.",
            "nullable": true,
            "type": "integer"
          },
          "list_bps": {
            "description": "The price list's percentage, for comparison.",
            "nullable": true,
            "type": "integer"
          },
          "list_fixed": {
            "description": "The price list's fixed part, for comparison.",
            "nullable": true,
            "type": "integer"
          },
          "source": {
            "type": "string",
            "description": "`agreed`: a price agreed with Tuppence for this business; `list`: the published price.",
            "enum": [
              "list",
              "agreed"
            ],
            "minLength": 1
          },
          "effective_from": {
            "description": "When the agreed price started (unix seconds); null on the list price.",
            "nullable": true,
            "type": "integer"
          },
          "ends_at": {
            "description": "When the agreed price ends and the list price returns (unix seconds); null: no end date, or the list price.",
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "type",
          "bps",
          "fixed",
          "list_bps",
          "list_fixed",
          "source",
          "effective_from",
          "ends_at"
        ]
      },
      "AccountPricingModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "schedule_version": {
            "type": "string",
            "description": "The price list the prices are read against, e.g. `v2`.",
            "minLength": 1
          },
          "prices": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AccountPriceModel"
            }
          },
          "agreement": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PricingAgreementModel"
              }
            ],
            "nullable": true
          },
          "next_agreement": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PricingAgreementModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "object",
          "livemode",
          "currency",
          "schedule_version",
          "prices",
          "agreement",
          "next_agreement"
        ]
      },
      "AccountRequirementsModel": {
        "type": "object",
        "properties": {
          "currently_due": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "eventually_due": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "past_due": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "pending_verification": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RequirementErrorModel"
            }
          },
          "alternatives": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RequirementAlternativeModel"
            }
          },
          "current_deadline": {
            "nullable": true,
            "type": "integer"
          },
          "disabled_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "currently_due",
          "eventually_due",
          "past_due",
          "pending_verification",
          "errors",
          "alternatives",
          "current_deadline",
          "disabled_reason"
        ]
      },
      "AccountSettingsBody": {
        "type": "object",
        "properties": {
          "notifications": {
            "$ref": "#/components/schemas/NotificationSettingsBody"
          },
          "card_payments": {
            "$ref": "#/components/schemas/OwnCardPaymentsSettingsBody"
          },
          "payments": {
            "$ref": "#/components/schemas/OwnStatementLineBody"
          },
          "payouts": {
            "$ref": "#/components/schemas/OwnStatementLineBody"
          },
          "connect": {
            "$ref": "#/components/schemas/PlatformConnectSettingsBody"
          }
        }
      },
      "AccountSettingsModel": {
        "type": "object",
        "properties": {
          "card_payments": {
            "$ref": "#/components/schemas/AccountCardPaymentsSettingsModel"
          },
          "payments": {
            "$ref": "#/components/schemas/AccountPaymentsSettingsModel"
          },
          "statement_descriptors": {
            "$ref": "#/components/schemas/StatementDescriptorsModel"
          },
          "payouts": {
            "$ref": "#/components/schemas/AccountPayoutSettingsModel"
          },
          "application_fees": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/AccountApplicationFeesModel"
              }
            ],
            "nullable": true
          },
          "cashback_share": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "store": {
            "$ref": "#/components/schemas/AccountStoreSettingsModel"
          }
        },
        "required": [
          "card_payments",
          "payments",
          "statement_descriptors",
          "payouts",
          "application_fees",
          "cashback_share",
          "store"
        ]
      },
      "AccountStoreSettingsModel": {
        "type": "object",
        "properties": {
          "application_fee": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/AccountApplicationFeesModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "application_fee"
        ]
      },
      "AccountTosAcceptanceModel": {
        "type": "object",
        "properties": {
          "date": {
            "nullable": true,
            "type": "integer"
          },
          "ip": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "user_agent": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "service_agreement": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "date",
          "ip",
          "user_agent",
          "service_agreement"
        ]
      },
      "AccountingRunModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "posted": {
            "type": "integer"
          },
          "adopted": {
            "type": "integer"
          },
          "failed": {
            "type": "integer"
          }
        },
        "required": [
          "object",
          "posted",
          "adopted",
          "failed"
        ]
      },
      "AddCartBody": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "currency": {
            "type": "string",
            "maxLength": 3,
            "minLength": 1
          },
          "merchant": {
            "type": "string",
            "maxLength": 200,
            "minLength": 1
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CartItemBody"
            }
          },
          "kid": {
            "type": "string",
            "maxLength": 64,
            "minLength": 1
          },
          "signature": {
            "type": "string",
            "maxLength": 200,
            "minLength": 1
          }
        },
        "required": [
          "amount",
          "currency",
          "merchant",
          "kid",
          "signature"
        ]
      },
      "AddRecordsBody": {
        "type": "object",
        "properties": {
          "except": {
            "type": "string",
            "enum": [
              "return_path",
              "spf",
              "dkim"
            ]
          }
        },
        "additionalProperties": false
      },
      "AddStoreImportFileBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 255
          },
          "content": {
            "type": "string",
            "maxLength": 800000,
            "minLength": 1
          },
          "file": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "more": {
            "type": "boolean",
            "default": false
          }
        },
        "required": [
          "content"
        ]
      },
      "AddressBody": {
        "type": "object",
        "properties": {
          "line1": {
            "type": "string",
            "maxLength": 200
          },
          "line2": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          },
          "city": {
            "type": "string",
            "maxLength": 100
          },
          "postal_code": {
            "type": "string",
            "maxLength": 20
          },
          "state": {
            "nullable": true,
            "type": "string",
            "maxLength": 100
          },
          "country": {
            "type": "string",
            "maxLength": 2
          }
        }
      },
      "AddressModel": {
        "type": "object",
        "properties": {
          "line1": {
            "type": "string",
            "minLength": 1
          },
          "line2": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "city": {
            "type": "string",
            "minLength": 1
          },
          "postal_code": {
            "type": "string",
            "minLength": 1
          },
          "state": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "country": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "line1",
          "line2",
          "city",
          "postal_code",
          "state",
          "country"
        ]
      },
      "AdjustmentBody": {
        "type": "object",
        "properties": {
          "variant": {
            "type": "string",
            "maxLength": 40
          },
          "location": {
            "type": "string",
            "maxLength": 40
          },
          "kind": {
            "type": "string",
            "maxLength": 20
          },
          "delta": {
            "type": "string",
            "maxLength": 20
          },
          "reason": {
            "type": "string",
            "maxLength": 200
          }
        }
      },
      "AdvanceBody": {
        "type": "object",
        "properties": {
          "days": {
            "type": "integer",
            "minimum": 0,
            "multipleOf": 1
          },
          "hours": {
            "type": "integer",
            "minimum": 0,
            "multipleOf": 1
          },
          "minutes": {
            "type": "integer",
            "minimum": 0,
            "multipleOf": 1
          },
          "seconds": {
            "type": "integer",
            "minimum": 0,
            "multipleOf": 1
          }
        }
      },
      "AdvanceShipmentBody": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "pre_transit",
              "in_transit",
              "out_for_delivery",
              "available_for_pickup",
              "delivered",
              "exception",
              "returned_to_sender",
              "failure"
            ],
            "minLength": 1
          }
        },
        "required": [
          "status"
        ]
      },
      "AgentBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 100
          },
          "description": {
            "nullable": true,
            "type": "string",
            "maxLength": 500
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "disabled"
            ]
          },
          "default_policy": {
            "nullable": true,
            "type": "string"
          },
          "metadata": {
            "type": "object"
          }
        }
      },
      "AgentCartList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AgentCartModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "AgentCartModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "mandate": {
            "type": "string",
            "minLength": 1
          },
          "agent": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "merchant": {
            "type": "string",
            "minLength": 1
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CartItemBody"
            }
          },
          "kid": {
            "type": "string",
            "minLength": 1
          },
          "digest": {
            "type": "string",
            "minLength": 1
          },
          "within_limits": {
            "type": "boolean"
          },
          "broke": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "mandate",
          "agent",
          "amount",
          "currency",
          "merchant",
          "items",
          "kid",
          "digest",
          "within_limits",
          "broke",
          "created"
        ]
      },
      "AgentConfirmationLinkModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "booking": {
            "type": "string",
            "minLength": 1
          },
          "url": {
            "type": "string",
            "minLength": 1
          },
          "expires_at": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "livemode",
          "booking",
          "url",
          "expires_at"
        ]
      },
      "AgentCreateFundingMandateBody": {
        "type": "object",
        "properties": {
          "max_per_topup": {
            "type": "integer",
            "multipleOf": 1
          },
          "max_per_day": {
            "type": "integer",
            "multipleOf": 1
          },
          "methods": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AgentFundingMandateMethodBody"
            }
          }
        },
        "required": [
          "max_per_topup",
          "max_per_day",
          "methods"
        ]
      },
      "AgentCredentialList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AgentCredentialModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "AgentCredentialModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "agent": {
            "type": "string",
            "minLength": 1
          },
          "kid": {
            "type": "string",
            "minLength": 1
          },
          "label": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "generated": {
            "type": "boolean"
          },
          "public_key": {
            "$ref": "#/components/schemas/PublicJwkModel"
          },
          "created": {
            "type": "integer"
          },
          "revoked_at": {
            "nullable": true,
            "type": "integer"
          },
          "private_key": {
            "type": "object"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "agent",
          "kid",
          "label",
          "status",
          "generated",
          "public_key",
          "created",
          "revoked_at"
        ]
      },
      "AgentFundingMandateList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AgentFundingMandateModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "AgentFundingMandateMethodBody": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "balance",
              "card"
            ],
            "minLength": 1
          },
          "payment_method": {
            "type": "string"
          }
        },
        "required": [
          "type"
        ]
      },
      "AgentFundingMandateMethodModel": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "balance",
              "card"
            ],
            "minLength": 1
          },
          "payment_method": {
            "type": "string"
          }
        },
        "required": [
          "type"
        ]
      },
      "AgentFundingMandateModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "agent": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "max_per_topup": {
            "type": "integer"
          },
          "max_per_day": {
            "type": "integer"
          },
          "methods": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AgentFundingMandateMethodModel"
            }
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "revoked"
            ],
            "minLength": 1
          },
          "created_by": {
            "type": "string",
            "minLength": 1
          },
          "revoked_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "agent",
          "currency",
          "max_per_topup",
          "max_per_day",
          "methods",
          "status",
          "created_by",
          "revoked_at",
          "created"
        ]
      },
      "AgentList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AgentModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "AgentMandateList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AgentMandateModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "AgentMandateModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "agent": {
            "type": "string",
            "minLength": 1
          },
          "customer": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "description": {
            "type": "string",
            "minLength": 1
          },
          "limits": {
            "$ref": "#/components/schemas/MandateLimitsModel"
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "uses": {
            "type": "integer"
          },
          "expires_at": {
            "type": "integer"
          },
          "accepted_at": {
            "nullable": true,
            "type": "integer"
          },
          "accepted_ip": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "revoked_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          },
          "approval_url": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "agent",
          "customer",
          "description",
          "limits",
          "status",
          "uses",
          "expires_at",
          "accepted_at",
          "accepted_ip",
          "revoked_at",
          "created",
          "approval_url"
        ]
      },
      "AgentModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "description": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "disabled"
            ],
            "minLength": 1
          },
          "default_policy": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "metadata": {
            "type": "object"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "name",
          "description",
          "status",
          "default_policy",
          "metadata",
          "created"
        ]
      },
      "AgentProfileModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "agent": {
            "type": "string",
            "minLength": 1
          },
          "mature": {
            "type": "boolean"
          },
          "purchases": {
            "type": "integer"
          },
          "days": {
            "type": "integer"
          },
          "typical_amount": {
            "type": "integer"
          },
          "high_amount": {
            "type": "integer"
          },
          "largest_amount": {
            "type": "integer"
          },
          "merchants": {
            "type": "integer"
          },
          "hours": {
            "type": "array",
            "items": {
              "type": "integer"
            }
          },
          "declines": {
            "type": "integer"
          },
          "computed_at": {
            "nullable": true,
            "type": "integer"
          },
          "recent_unusual": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UnusualPurchaseModel"
            }
          }
        },
        "required": [
          "object",
          "agent",
          "mature",
          "purchases",
          "days",
          "typical_amount",
          "high_amount",
          "largest_amount",
          "merchants",
          "hours",
          "declines",
          "computed_at",
          "recent_unusual"
        ]
      },
      "AiProposalBody": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "maxLength": 2048
          },
          "instagram": {
            "type": "string",
            "maxLength": 200
          },
          "image": {
            "type": "string",
            "maxLength": 5100000
          }
        }
      },
      "AiProposalModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "source": {
            "type": "string",
            "enum": [
              "url",
              "instagram",
              "image"
            ],
            "minLength": 1
          },
          "url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "proposed",
              "empty",
              "discarded"
            ],
            "minLength": 1
          },
          "discarded_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "services": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProposedServiceModel"
            }
          },
          "hours": {
            "nullable": true
          },
          "about": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "dropped": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "object",
          "source",
          "url",
          "status",
          "discarded_reason",
          "currency",
          "services",
          "hours",
          "about",
          "dropped"
        ]
      },
      "AllocatedUnitModel": {
        "type": "object",
        "properties": {
          "resource": {
            "type": "string",
            "minLength": 1
          },
          "unit": {
            "type": "integer"
          },
          "kind": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "resource",
          "unit",
          "kind"
        ]
      },
      "AllowanceModel": {
        "type": "object",
        "properties": {
          "max_amount": {
            "type": "integer"
          },
          "expires_at": {
            "type": "integer"
          }
        },
        "required": [
          "max_amount",
          "expires_at"
        ]
      },
      "AmountBody": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "ApplicationFeeList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ApplicationFeeModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ApplicationFeeModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "account": {
            "type": "string",
            "minLength": 1
          },
          "payment": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "amount_refunded": {
            "type": "integer"
          },
          "refunded": {
            "type": "boolean"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "tuppence_fee": {
            "type": "integer"
          },
          "net": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "available_on": {
            "type": "integer"
          },
          "sweep": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "source": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "account",
          "payment",
          "amount",
          "amount_refunded",
          "refunded",
          "currency",
          "tuppence_fee",
          "net",
          "status",
          "available_on",
          "sweep",
          "source",
          "created"
        ],
        "example": {
          "id": "fee_01J8ZKD6E8F0G2H4J6K8M0N2P4",
          "object": "application_fee",
          "livemode": false,
          "account": "acct_01J8ZKC5D7E9F1G3H5J7K9M1N3",
          "payment": "pay_01J8ZK3V5M7Q2N4R6T8W0XYZAB",
          "amount": 100,
          "amount_refunded": 0,
          "refunded": false,
          "currency": "gbp",
          "tuppence_fee": 0,
          "net": 100,
          "status": "pending",
          "available_on": 1790259200,
          "sweep": null,
          "source": null,
          "created": 1790000004
        }
      },
      "ApplicationFeesBody": {
        "type": "object",
        "properties": {
          "percent": {
            "type": "string",
            "description": "The percentage of each payment (`\"1.5\"`), rounded up, plus `fixed_amount`: at most 20% unless Tuppence raised your platform's cap — over it is refused when it is set (`400 application_fee_too_high`). A `fixed_amount` that would take a small payment past the cap is taken up to the cap."
          },
          "fixed_amount": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "AppliedDiscountModel": {
        "type": "object",
        "properties": {
          "id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "discount": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "percent",
              "fixed"
            ],
            "minLength": 1
          },
          "value": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "approved_by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "discount",
          "kind",
          "value",
          "amount",
          "reason",
          "approved_by"
        ]
      },
      "ApplyDiscountBody": {
        "type": "object",
        "properties": {
          "discount": {
            "type": "string",
            "maxLength": 40
          },
          "kind": {
            "type": "string",
            "enum": [
              "percent",
              "fixed"
            ]
          },
          "value": {
            "type": "integer"
          },
          "reason": {
            "type": "string",
            "maxLength": 200
          },
          "totals": {
            "$ref": "#/components/schemas/TotalsBody"
          }
        }
      },
      "ApplyForDirectDebitBody": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "maxLength": 2000,
            "minLength": 1
          },
          "use": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "expected_monthly_volume": {
            "type": "integer",
            "multipleOf": 1
          },
          "typical_amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "largest_amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "customers": {
            "type": "string",
            "enum": [
              "consumers",
              "businesses",
              "both"
            ],
            "minLength": 1
          },
          "how_customers_sign_up": {
            "type": "string",
            "maxLength": 500
          }
        },
        "required": [
          "reason",
          "use",
          "expected_monthly_volume",
          "typical_amount",
          "largest_amount",
          "customers"
        ]
      },
      "ApplyMembershipBody": {
        "type": "object",
        "properties": {
          "subscription": {
            "type": "string",
            "maxLength": 40
          }
        }
      },
      "ApplyPackageBody": {
        "type": "object",
        "properties": {
          "package_balance": {
            "type": "string",
            "maxLength": 40
          }
        }
      },
      "ApplyTemplateBody": {
        "type": "object",
        "properties": {
          "template": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "sections": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "preview": {
            "type": "boolean"
          }
        },
        "required": [
          "template"
        ]
      },
      "ApprovalList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ApprovalModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ApprovalMerchantModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "network_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "name",
          "network_id"
        ]
      },
      "ApprovalModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "card": {
            "type": "string",
            "minLength": 1
          },
          "agent": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "authorization": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "merchant": {
            "$ref": "#/components/schemas/ApprovalMerchantModel"
          },
          "description": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "approved",
              "declined",
              "expired",
              "consumed"
            ],
            "minLength": 1
          },
          "requested_by": {
            "type": "string",
            "enum": [
              "purchase",
              "agent"
            ],
            "minLength": 1
          },
          "expires_at": {
            "type": "integer"
          },
          "decided_by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "decided_via": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "decided_at": {
            "nullable": true,
            "type": "integer"
          },
          "allowance": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/AllowanceModel"
              }
            ],
            "nullable": true
          },
          "consumed_by_authorization": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "trigger": {
            "type": "string",
            "enum": [
              "threshold",
              "unusual"
            ],
            "minLength": 1
          },
          "unusual": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "kind": {
            "type": "string",
            "enum": [
              "purchase",
              "card_dispute_submission"
            ],
            "minLength": 1
          },
          "card_dispute": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "card",
          "agent",
          "authorization",
          "amount",
          "currency",
          "merchant",
          "description",
          "status",
          "requested_by",
          "expires_at",
          "decided_by",
          "decided_via",
          "decided_at",
          "allowance",
          "consumed_by_authorization",
          "trigger",
          "unusual",
          "kind",
          "card_dispute",
          "created"
        ]
      },
      "ApproveTimeOffBody": {
        "type": "object",
        "properties": {
          "keep_bookings": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "note": {
            "nullable": true,
            "type": "string",
            "maxLength": 300
          }
        }
      },
      "AssistantJobActionModel": {
        "type": "object",
        "properties": {
          "action": {
            "type": "string",
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "risk": {
            "type": "string",
            "enum": [
              "read",
              "change",
              "money",
              "destructive"
            ],
            "minLength": 1
          },
          "level": {
            "nullable": true,
            "type": "string",
            "minLength": 1,
            "enum": [
              "suggest",
              "ask",
              "act"
            ]
          },
          "ceiling": {
            "nullable": true,
            "type": "string",
            "minLength": 1,
            "enum": [
              "suggest",
              "ask",
              "act"
            ]
          },
          "liftable": {
            "type": "boolean"
          },
          "lifted": {
            "type": "boolean"
          },
          "streak": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "action",
          "title",
          "risk",
          "level",
          "ceiling",
          "liftable",
          "lifted",
          "streak"
        ]
      },
      "AssistantJobBriefList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AssistantJobBriefModel"
            }
          }
        },
        "required": [
          "object",
          "data"
        ]
      },
      "AssistantJobBriefModel": {
        "type": "object",
        "properties": {
          "id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "job": {
            "type": "string",
            "minLength": 1
          },
          "version": {
            "type": "integer",
            "multipleOf": 1
          },
          "brief": {
            "type": "string",
            "minLength": 1
          },
          "is_default": {
            "type": "boolean"
          },
          "set_by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "id",
          "object",
          "job",
          "version",
          "brief",
          "is_default",
          "set_by",
          "created"
        ]
      },
      "AssistantJobEventData": {
        "type": "object",
        "description": "What an event carrying a `assistant_job` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/AssistantJobEventObject"
          }
        }
      },
      "AssistantJobEventObject": {
        "type": "object",
        "description": "A `assistant_job` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "assistant_job"
          }
        },
        "additionalProperties": true
      },
      "AssistantJobExampleList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AssistantJobExampleModel"
            }
          }
        },
        "required": [
          "object",
          "data"
        ]
      },
      "AssistantJobExampleModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "job": {
            "type": "string",
            "minLength": 1
          },
          "change": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "edited",
              "declined",
              "reverted"
            ],
            "minLength": 1
          },
          "proposed": {
            "type": "object"
          },
          "final": {
            "nullable": true
          },
          "note": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "id",
          "object",
          "job",
          "change",
          "kind",
          "proposed",
          "final",
          "note",
          "created"
        ]
      },
      "AssistantJobList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AssistantJobModel"
            }
          },
          "allowance_used_percent": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "object",
          "data",
          "allowance_used_percent"
        ]
      },
      "AssistantJobModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "key": {
            "type": "string",
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "paused",
              "off"
            ],
            "minLength": 1
          },
          "paused_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1,
            "enum": [
              "owner",
              "budget",
              "allowance",
              "sponsor_lost",
              "kill_switch",
              "failures"
            ]
          },
          "paused_message": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "brief": {
            "type": "string",
            "minLength": 1
          },
          "brief_version": {
            "type": "integer",
            "multipleOf": 1
          },
          "brief_is_default": {
            "type": "boolean"
          },
          "actions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AssistantJobActionModel"
            }
          },
          "offers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AssistantJobOfferModel"
            }
          },
          "schedule": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/JobScheduleModel"
              }
            ],
            "nullable": true
          },
          "events": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "budget_run_cents": {
            "type": "integer",
            "multipleOf": 1
          },
          "budget_month_cents": {
            "type": "integer",
            "multipleOf": 1
          },
          "last_7_days": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/AssistantJobWeekModel"
              }
            ],
            "nullable": true
          },
          "last_words": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "month_budget_percent": {
            "nullable": true,
            "type": "integer"
          },
          "month_spent_percent": {
            "nullable": true,
            "type": "integer"
          },
          "sponsor": {
            "type": "string",
            "minLength": 1
          },
          "next_run_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer",
            "multipleOf": 1
          },
          "updated": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "key",
          "title",
          "status",
          "paused_reason",
          "paused_message",
          "brief",
          "brief_version",
          "brief_is_default",
          "actions",
          "offers",
          "schedule",
          "events",
          "budget_run_cents",
          "budget_month_cents",
          "last_7_days",
          "last_words",
          "month_budget_percent",
          "month_spent_percent",
          "sponsor",
          "next_run_at",
          "created",
          "updated"
        ]
      },
      "AssistantJobOfferModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "job": {
            "type": "string",
            "minLength": 1
          },
          "action": {
            "type": "string",
            "minLength": 1
          },
          "intent": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "from": {
            "type": "string",
            "enum": [
              "suggest",
              "ask",
              "act"
            ],
            "minLength": 1
          },
          "to": {
            "type": "string",
            "enum": [
              "suggest",
              "ask",
              "act"
            ],
            "minLength": 1
          },
          "streak": {
            "type": "integer",
            "multipleOf": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "open",
              "accepted",
              "declined",
              "withdrawn"
            ],
            "minLength": 1
          },
          "message": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "id",
          "object",
          "job",
          "action",
          "intent",
          "from",
          "to",
          "streak",
          "status",
          "message",
          "created"
        ]
      },
      "AssistantJobPausedEvent": {
        "type": "object",
        "description": "The `assistant_job.paused` event (the store's assistant events): `data.object` is the `assistant_job`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "assistant_job.paused"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/AssistantJobEventData"
          }
        }
      },
      "AssistantJobRunList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AssistantJobRunModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "AssistantJobRunModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "job": {
            "type": "string",
            "minLength": 1
          },
          "trigger_kind": {
            "type": "string",
            "enum": [
              "schedule",
              "event",
              "manual",
              "prepare"
            ],
            "minLength": 1
          },
          "trigger_key": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "queued",
              "running",
              "proposed",
              "applied",
              "nothing_to_do",
              "over_budget",
              "failed",
              "cancelled"
            ],
            "minLength": 1
          },
          "read": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/JobReadModel"
            }
          },
          "events": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "words": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "model": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "cost_cents": {
            "type": "integer",
            "multipleOf": 1
          },
          "change_sets": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "started_at": {
            "nullable": true,
            "type": "integer"
          },
          "finished_at": {
            "nullable": true,
            "type": "integer"
          },
          "error": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "job",
          "trigger_kind",
          "trigger_key",
          "status",
          "read",
          "events",
          "words",
          "model",
          "cost_cents",
          "change_sets",
          "started_at",
          "finished_at",
          "error",
          "created"
        ]
      },
      "AssistantJobUpdatedEvent": {
        "type": "object",
        "description": "The `assistant_job.updated` event (the store's assistant events): `data.object` is the `assistant_job`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "assistant_job.updated"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/AssistantJobEventData"
          }
        }
      },
      "AssistantJobWeekModel": {
        "type": "object",
        "properties": {
          "runs": {
            "type": "integer",
            "multipleOf": 1
          },
          "applied": {
            "type": "integer",
            "multipleOf": 1
          },
          "proposed": {
            "type": "integer",
            "multipleOf": 1
          },
          "failed": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "runs",
          "applied",
          "proposed",
          "failed"
        ]
      },
      "AuthenticationExemptionModel": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "minLength": 1
          },
          "claimed_by": {
            "type": "string",
            "enum": [
              "issuer",
              "acquirer"
            ],
            "minLength": 1
          }
        },
        "required": [
          "type",
          "claimed_by"
        ]
      },
      "AuthorizationChecksModel": {
        "type": "object",
        "properties": {
          "cvc": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "expiry": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "address_line1": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "address_postal_code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "cvc",
          "expiry",
          "address_line1",
          "address_postal_code"
        ]
      },
      "AuthorizationMerchantModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "network_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "country": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "mcc": {
            "type": "integer"
          }
        },
        "required": [
          "name",
          "network_id",
          "country",
          "mcc"
        ]
      },
      "AutoTopupBody": {
        "type": "object",
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "threshold": {
            "type": "integer",
            "multipleOf": 1
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "AutoTopupModel": {
        "type": "object",
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "threshold": {
            "nullable": true,
            "type": "integer"
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "paused_until": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "enabled",
          "threshold",
          "amount",
          "paused_until"
        ]
      },
      "AvailabilityItemSlotModel": {
        "type": "object",
        "properties": {
          "service": {
            "type": "string",
            "minLength": 1
          },
          "variant": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "starts_at": {
            "type": "string",
            "minLength": 1
          },
          "ends_at": {
            "type": "string",
            "minLength": 1
          },
          "staff_member": {
            "type": "string",
            "minLength": 1
          },
          "resources": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AllocatedUnitModel"
            }
          }
        },
        "required": [
          "service",
          "variant",
          "starts_at",
          "ends_at",
          "staff_member",
          "resources"
        ]
      },
      "AvailabilityModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "timezone": {
            "type": "string",
            "minLength": 1
          },
          "from": {
            "type": "string",
            "minLength": 1
          },
          "to": {
            "type": "string",
            "minLength": 1
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AvailabilityRequestItemModel"
            }
          },
          "slots": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AvailabilitySlotModel"
            }
          }
        },
        "required": [
          "object",
          "location",
          "timezone",
          "from",
          "to",
          "staff_member",
          "items",
          "slots"
        ]
      },
      "AvailabilityRequestItemModel": {
        "type": "object",
        "properties": {
          "service": {
            "type": "string",
            "minLength": 1
          },
          "variant": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "addons": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "duration_minutes": {
            "type": "integer"
          }
        },
        "required": [
          "service",
          "variant",
          "addons",
          "duration_minutes"
        ]
      },
      "AvailabilitySlotModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "starts_at": {
            "type": "string",
            "minLength": 1
          },
          "ends_at": {
            "type": "string",
            "minLength": 1
          },
          "staff_member": {
            "type": "string",
            "minLength": 1
          },
          "resources": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AllocatedUnitModel"
            }
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AvailabilityItemSlotModel"
            }
          },
          "class_session": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "seats_left": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "object",
          "starts_at",
          "ends_at",
          "staff_member",
          "resources",
          "items",
          "class_session",
          "seats_left"
        ]
      },
      "AwaitingTopupsModel": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer"
          },
          "count": {
            "type": "integer"
          }
        },
        "required": [
          "amount",
          "count"
        ]
      },
      "BadRequest": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "description": "The error name",
            "example": "BAD_REQUEST",
            "default": "BAD_REQUEST"
          },
          "message": {
            "type": "string",
            "minLength": 1,
            "description": "An error message"
          },
          "status": {
            "type": "integer",
            "description": "The status code of the exception",
            "example": 400,
            "default": 400
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GenericError"
            },
            "description": "A list of related errors"
          },
          "stack": {
            "type": "string",
            "description": "The stack trace (only in development mode)"
          }
        },
        "required": [
          "name",
          "message",
          "status"
        ]
      },
      "BalanceBreakdownModel": {
        "type": "object",
        "properties": {
          "gross": {
            "type": "integer"
          },
          "fees": {
            "type": "integer"
          },
          "application_fees": {
            "type": "integer"
          },
          "connect_swept": {
            "type": "integer"
          },
          "refunds": {
            "type": "integer"
          },
          "disputes": {
            "type": "integer"
          },
          "paid_out": {
            "type": "integer"
          },
          "postage": {
            "type": "integer"
          },
          "affiliate_commission": {
            "type": "integer"
          },
          "written_off": {
            "type": "integer"
          },
          "net": {
            "type": "integer"
          },
          "credits_outstanding": {
            "type": "integer"
          }
        },
        "required": [
          "gross",
          "fees",
          "application_fees",
          "connect_swept",
          "refunds",
          "disputes",
          "paid_out",
          "postage",
          "affiliate_commission",
          "written_off",
          "net",
          "credits_outstanding"
        ]
      },
      "BalanceModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "available": {
            "type": "integer"
          },
          "pending": {
            "type": "integer"
          },
          "held_for_events": {
            "type": "integer"
          },
          "breakdown": {
            "$ref": "#/components/schemas/BalanceBreakdownModel"
          },
          "connect": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ConnectBalanceModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "object",
          "livemode",
          "currency",
          "available",
          "pending",
          "held_for_events",
          "breakdown",
          "connect"
        ],
        "example": {
          "object": "balance",
          "livemode": false,
          "currency": "gbp",
          "available": 9872,
          "pending": 1974,
          "held_for_events": 0,
          "breakdown": {
            "gross": 12000,
            "fees": 154,
            "application_fees": 0,
            "connect_swept": 0,
            "refunds": 0,
            "disputes": 0,
            "paid_out": 0,
            "postage": 0,
            "affiliate_commission": 0,
            "written_off": 0,
            "net": 11846,
            "credits_outstanding": 0
          },
          "connect": null
        }
      },
      "BalanceTransactionList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BalanceTransactionModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "BalanceTransactionModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "type": {
            "type": "string",
            "minLength": 1
          },
          "source": {
            "type": "string",
            "minLength": 1
          },
          "payment": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "fee": {
            "type": "integer"
          },
          "fee_details": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FeeDetailModel"
            }
          },
          "net": {
            "type": "integer"
          },
          "created": {
            "type": "integer"
          },
          "balance": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "object",
          "type",
          "source",
          "payment",
          "currency",
          "amount",
          "fee",
          "fee_details",
          "net",
          "created",
          "balance"
        ]
      },
      "BalanceTransferBody": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "BalanceTransferRouteModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "method": {
            "type": "string",
            "minLength": 1
          },
          "path": {
            "type": "string",
            "minLength": 1
          },
          "arrives": {
            "type": "string",
            "enum": [
              "minutes",
              "next_day"
            ],
            "minLength": 1
          }
        },
        "required": [
          "object",
          "method",
          "path",
          "arrives"
        ]
      },
      "BankAccountModel": {
        "type": "object",
        "properties": {
          "bank_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "last4": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "country": {
            "type": "string",
            "minLength": 1
          },
          "instant_eligible": {
            "type": "boolean"
          }
        },
        "required": [
          "bank_name",
          "last4",
          "currency",
          "country",
          "instant_eligible"
        ]
      },
      "BankDebitList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BankDebitModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "BankDebitModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "reason": {
            "type": "string",
            "description": "Why: `negative_balance`, your balance went below zero (a dispute or refunds took more than it held), so it was made up from your bank account.",
            "enum": [
              "negative_balance"
            ],
            "minLength": 1
          },
          "destination": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "arrival_date": {
            "nullable": true,
            "type": "integer"
          },
          "failure_code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          },
          "paid_at": {
            "nullable": true,
            "type": "integer"
          },
          "failed_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "amount",
          "currency",
          "status",
          "reason",
          "destination",
          "arrival_date",
          "failure_code",
          "created",
          "paid_at",
          "failed_at"
        ]
      },
      "BatchErrorModel": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "minLength": 1
          },
          "code": {
            "type": "string",
            "minLength": 1
          },
          "message": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "type",
          "code",
          "message"
        ]
      },
      "BatchModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BatchResultModel"
            }
          }
        },
        "required": [
          "object",
          "data"
        ]
      },
      "BatchResultModel": {
        "type": "object",
        "properties": {
          "identifier": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "event": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/MeterEventModel"
              }
            ],
            "nullable": true
          },
          "error": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/BatchErrorModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "identifier",
          "status",
          "event",
          "error"
        ]
      },
      "BillingBody": {
        "type": "object",
        "properties": {
          "address": {
            "$ref": "#/components/schemas/AddressBody"
          }
        }
      },
      "BillingModel": {
        "type": "object",
        "properties": {
          "address": {
            "$ref": "#/components/schemas/AddressModel"
          }
        },
        "required": [
          "address"
        ]
      },
      "BirthdayModel": {
        "type": "object",
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "words": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "enabled",
          "words"
        ]
      },
      "BlockCustomerBody": {
        "type": "object",
        "properties": {
          "reason": {
            "nullable": true,
            "type": "string",
            "maxLength": 300
          },
          "online": {
            "nullable": true,
            "type": "string",
            "maxLength": 12
          }
        }
      },
      "BookingAgentModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "contact": {
            "type": "string",
            "minLength": 1
          },
          "agent_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "name",
          "contact",
          "agent_id"
        ]
      },
      "BookingBalanceChargeModel": {
        "type": "object",
        "properties": {
          "at": {
            "type": "string",
            "minLength": 1
          },
          "outcome": {
            "type": "string",
            "minLength": 1
          },
          "payment": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "at",
          "outcome",
          "payment"
        ]
      },
      "BookingChannelModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "code": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "link",
              "qr",
              "widget",
              "google_link",
              "google_reserve",
              "instagram",
              "facebook",
              "apple",
              "whatsapp",
              "tiktok",
              "bing",
              "linktree",
              "email",
              "agent",
              "other"
            ],
            "minLength": 1
          },
          "label": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "suggested",
              "set_up",
              "live",
              "error"
            ],
            "minLength": 1
          },
          "external_ref": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "last_booking_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "nullable": true,
            "type": "integer"
          },
          "stats": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingChannelStatsModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "object",
          "id",
          "livemode",
          "code",
          "kind",
          "label",
          "status",
          "external_ref",
          "last_booking_at",
          "created",
          "stats"
        ]
      },
      "BookingChannelStatsModel": {
        "type": "object",
        "properties": {
          "bookings": {
            "type": "integer",
            "multipleOf": 1
          },
          "completed": {
            "type": "integer",
            "multipleOf": 1
          },
          "no_shows": {
            "type": "integer",
            "multipleOf": 1
          },
          "cancelled": {
            "type": "integer",
            "multipleOf": 1
          },
          "revenue": {
            "type": "integer",
            "multipleOf": 1
          },
          "no_show_rate": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "bookings",
          "completed",
          "no_shows",
          "cancelled",
          "revenue",
          "no_show_rate"
        ]
      },
      "BookingChannelSummaryModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "from": {
            "type": "string",
            "minLength": 1
          },
          "to": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "channels": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingChannelModel"
            }
          },
          "without_channel": {
            "$ref": "#/components/schemas/BookingChannelStatsModel"
          },
          "totals": {
            "$ref": "#/components/schemas/BookingChannelStatsModel"
          }
        },
        "required": [
          "object",
          "livemode",
          "from",
          "to",
          "location",
          "currency",
          "channels",
          "without_channel",
          "totals"
        ]
      },
      "BookingChecklistItemModel": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "enum": [
              "payments",
              "first_booking",
              "reminders",
              "staff_invited",
              "calendar_connected",
              "second_channel"
            ],
            "minLength": 1
          },
          "done": {
            "type": "boolean"
          },
          "done_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "key",
          "done",
          "done_at"
        ]
      },
      "BookingChecklistModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "set_up": {
            "type": "boolean"
          },
          "published_at": {
            "nullable": true,
            "type": "integer"
          },
          "complete": {
            "type": "boolean"
          },
          "next": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingChecklistItemModel"
            }
          }
        },
        "required": [
          "object",
          "livemode",
          "set_up",
          "published_at",
          "complete",
          "next",
          "items"
        ]
      },
      "BookingCheckoutBody": {
        "type": "object",
        "properties": {
          "register": {
            "type": "string",
            "maxLength": 40
          }
        }
      },
      "BookingCheckoutOrderModel": {
        "type": "object",
        "properties": {
          "order": {
            "type": "string",
            "minLength": 1
          },
          "number": {
            "type": "integer",
            "multipleOf": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "balance",
              "full"
            ],
            "minLength": 1
          },
          "total": {
            "type": "integer",
            "multipleOf": 1
          },
          "tip_amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "tip_shares": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TipShareModel"
            }
          },
          "tenders": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingCheckoutTenderModel"
            }
          },
          "completed_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "order",
          "number",
          "status",
          "kind",
          "total",
          "tip_amount",
          "tip_shares",
          "tenders",
          "completed_at"
        ]
      },
      "BookingCheckoutTenderModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "method": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "tip_amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "payment": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "method",
          "status",
          "amount",
          "tip_amount",
          "payment"
        ]
      },
      "BookingClientBody": {
        "type": "object",
        "properties": {
          "name": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          },
          "email": {
            "nullable": true,
            "type": "string",
            "maxLength": 320
          },
          "phone": {
            "nullable": true,
            "type": "string",
            "maxLength": 30
          }
        }
      },
      "BookingClientModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "first_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "first_name"
        ]
      },
      "BookingCountsModel": {
        "type": "object",
        "properties": {
          "total": {
            "type": "integer"
          },
          "completed": {
            "type": "integer"
          },
          "no_shows": {
            "type": "integer"
          },
          "cancelled": {
            "type": "integer"
          },
          "cancelled_by_client": {
            "type": "integer"
          },
          "cancelled_by_business": {
            "type": "integer"
          },
          "late_cancellations": {
            "type": "integer"
          },
          "upcoming": {
            "type": "integer"
          }
        },
        "required": [
          "total",
          "completed",
          "no_shows",
          "cancelled",
          "cancelled_by_client",
          "cancelled_by_business",
          "late_cancellations",
          "upcoming"
        ]
      },
      "BookingFeeModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "late_cancel",
              "no_show"
            ],
            "minLength": 1
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "deposit_applied": {
            "type": "integer",
            "multipleOf": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "due",
              "pending_authentication",
              "charged",
              "failed",
              "waived",
              "refunded"
            ],
            "minLength": 1
          },
          "payment": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "failure": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "waived": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingFeeWaiverModel"
              }
            ],
            "nullable": true
          },
          "clause": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "kind",
          "amount",
          "deposit_applied",
          "status",
          "payment",
          "failure",
          "waived",
          "clause"
        ]
      },
      "BookingFeeWaiverModel": {
        "type": "object",
        "properties": {
          "at": {
            "type": "string",
            "minLength": 1
          },
          "by": {
            "type": "string",
            "minLength": 1
          },
          "reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "at",
          "by",
          "reason"
        ]
      },
      "BookingHoldBody": {
        "type": "object",
        "properties": {
          "location": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingItemBody"
            }
          },
          "class_session": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "starts_at": {
            "type": "string",
            "maxLength": 40
          },
          "group_size": {
            "type": "integer"
          },
          "metadata": {
            "type": "object"
          }
        },
        "required": [
          "location"
        ]
      },
      "BookingItemBody": {
        "type": "object",
        "properties": {
          "service": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "variant": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "addons": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          }
        },
        "required": [
          "service"
        ]
      },
      "BookingItemModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "service": {
            "type": "string",
            "minLength": 1
          },
          "variant": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "addons": {
            "type": "array",
            "items": {
              "nullable": true
            }
          },
          "staff_member": {
            "type": "string",
            "minLength": 1
          },
          "starts_at": {
            "type": "string",
            "minLength": 1
          },
          "ends_at": {
            "type": "string",
            "minLength": 1
          },
          "duration_minutes": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "class_session": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "quantity": {
            "type": "integer"
          },
          "subject": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "object",
          "service",
          "variant",
          "addons",
          "staff_member",
          "starts_at",
          "ends_at",
          "duration_minutes",
          "amount",
          "status",
          "class_session",
          "quantity",
          "subject"
        ]
      },
      "BookingList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "BookingMembershipUseModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "subscription": {
            "type": "string",
            "minLength": 1
          },
          "service": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "origin": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          },
          "finalised_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "subscription",
          "service",
          "amount",
          "currency",
          "status",
          "origin",
          "created",
          "finalised_at"
        ]
      },
      "BookingMessageList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingMessageModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "BookingMessageModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "booking": {
            "type": "string",
            "minLength": 1
          },
          "template": {
            "type": "string",
            "minLength": 1
          },
          "channel": {
            "type": "string",
            "enum": [
              "email",
              "sms",
              "whatsapp",
              "push"
            ],
            "minLength": 1
          },
          "offset_minutes": {
            "type": "integer",
            "multipleOf": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "scheduled_for": {
            "type": "integer"
          },
          "sent_at": {
            "nullable": true,
            "type": "integer"
          },
          "segments": {
            "type": "integer",
            "multipleOf": 1
          },
          "cost_minor": {
            "type": "integer",
            "multipleOf": 1
          },
          "error": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "preview": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "booking",
          "template",
          "channel",
          "offset_minutes",
          "status",
          "scheduled_for",
          "sent_at",
          "segments",
          "cost_minor",
          "error",
          "preview",
          "created"
        ]
      },
      "BookingModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "timezone": {
            "type": "string",
            "minLength": 1
          },
          "starts_at": {
            "type": "string",
            "minLength": 1
          },
          "ends_at": {
            "type": "string",
            "minLength": 1
          },
          "local_date": {
            "type": "string",
            "minLength": 1
          },
          "customer": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "client": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingClientModel"
              }
            ],
            "nullable": true
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingItemModel"
            }
          },
          "source": {
            "type": "string",
            "minLength": 1
          },
          "channel": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "channel_raw": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "referrer": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "agent": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingAgentModel"
              }
            ],
            "nullable": true
          },
          "verified_agent": {
            "type": "boolean"
          },
          "client_proven": {
            "type": "boolean"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "total_amount": {
            "type": "integer"
          },
          "deposit_amount": {
            "type": "integer"
          },
          "amount_due": {
            "type": "integer"
          },
          "payment_status": {
            "type": "string",
            "minLength": 1
          },
          "policy_snapshot": {
            "nullable": true
          },
          "express_request_at": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "answers": {
            "nullable": true
          },
          "subject": {
            "nullable": true
          },
          "client_notes": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "internal_notes": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "group_size": {
            "type": "integer"
          },
          "held_until": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "series": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created_by": {
            "nullable": true
          },
          "cancellation": {
            "nullable": true
          },
          "fee": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingFeeModel"
              }
            ],
            "nullable": true
          },
          "balance_charge": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingBalanceChargeModel"
              }
            ],
            "nullable": true
          },
          "status_at": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "metadata": {
            "type": "object"
          },
          "import": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "status",
          "location",
          "timezone",
          "starts_at",
          "ends_at",
          "local_date",
          "customer",
          "client",
          "items",
          "source",
          "channel",
          "channel_raw",
          "referrer",
          "agent",
          "verified_agent",
          "client_proven",
          "currency",
          "total_amount",
          "deposit_amount",
          "amount_due",
          "payment_status",
          "policy_snapshot",
          "express_request_at",
          "answers",
          "subject",
          "client_notes",
          "internal_notes",
          "group_size",
          "held_until",
          "series",
          "created_by",
          "cancellation",
          "fee",
          "balance_charge",
          "status_at",
          "metadata",
          "import",
          "created"
        ]
      },
      "BookingMoneyModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "booking": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "total_amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "paid": {
            "type": "integer",
            "multipleOf": 1
          },
          "recorded": {
            "type": "integer",
            "multipleOf": 1
          },
          "vouchers": {
            "type": "integer",
            "multipleOf": 1
          },
          "voucher_redemptions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingVoucherRedemptionModel"
            }
          },
          "packages": {
            "type": "integer",
            "multipleOf": 1
          },
          "package_uses": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingPackageUseModel"
            }
          },
          "memberships": {
            "type": "integer",
            "multipleOf": 1
          },
          "membership_uses": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingMembershipUseModel"
            }
          },
          "till": {
            "type": "integer",
            "multipleOf": 1
          },
          "orders": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingCheckoutOrderModel"
            }
          },
          "store": {
            "type": "integer",
            "multipleOf": 1
          },
          "store_orders": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingStoreOrderModel"
            }
          },
          "amount_due": {
            "type": "integer",
            "multipleOf": 1
          },
          "payment_status": {
            "type": "string",
            "minLength": 1
          },
          "tips": {
            "type": "integer",
            "multipleOf": 1
          },
          "refunded": {
            "type": "integer",
            "multipleOf": 1
          },
          "card_on_file": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/SavedCardModel"
              }
            ],
            "nullable": true
          },
          "charge_balance_after": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "booking",
          "currency",
          "total_amount",
          "paid",
          "recorded",
          "vouchers",
          "voucher_redemptions",
          "packages",
          "package_uses",
          "memberships",
          "membership_uses",
          "till",
          "orders",
          "store",
          "store_orders",
          "amount_due",
          "payment_status",
          "tips",
          "refunded",
          "card_on_file",
          "charge_balance_after"
        ]
      },
      "BookingMoneyTotalsModel": {
        "type": "object",
        "properties": {
          "revenue": {
            "type": "integer"
          },
          "deposits": {
            "type": "integer"
          },
          "fees": {
            "type": "integer"
          },
          "tips": {
            "type": "integer"
          }
        },
        "required": [
          "revenue",
          "deposits",
          "fees",
          "tips"
        ]
      },
      "BookingPackageUseModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "package_balance": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "held",
              "consumed",
              "released"
            ],
            "minLength": 1
          },
          "origin": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          },
          "finalised_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "package_balance",
          "amount",
          "currency",
          "status",
          "origin",
          "created",
          "finalised_at"
        ]
      },
      "BookingPageBody": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string",
            "maxLength": 40
          },
          "theme": {
            "$ref": "#/components/schemas/PageThemeBody"
          },
          "content": {
            "$ref": "#/components/schemas/PageContentBody"
          },
          "gallery": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "flow": {
            "$ref": "#/components/schemas/PageFlowBody"
          },
          "seo": {
            "$ref": "#/components/schemas/PageSeoBody"
          },
          "reviews": {
            "$ref": "#/components/schemas/PageReviewsBody"
          }
        }
      },
      "BookingPageModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "slug": {
            "type": "string",
            "minLength": 1
          },
          "url": {
            "type": "string",
            "minLength": 1
          },
          "previous_slug": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "slug_redirect_until": {
            "nullable": true,
            "type": "integer"
          },
          "custom_domain": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "custom_domain_status": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "custom_domain_records": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomDomainRecordModel"
            }
          },
          "custom_domain_error": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "custom_domain_checked": {
            "nullable": true,
            "type": "integer"
          },
          "theme": {
            "$ref": "#/components/schemas/PageThemeModel"
          },
          "content": {
            "$ref": "#/components/schemas/PageContentModel"
          },
          "gallery": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PageImageModel"
            }
          },
          "flow": {
            "$ref": "#/components/schemas/PageFlowModel"
          },
          "seo": {
            "$ref": "#/components/schemas/PageSeoModel"
          },
          "reviews": {
            "$ref": "#/components/schemas/PageReviewsModel"
          },
          "published": {
            "type": "boolean"
          },
          "published_at": {
            "nullable": true,
            "type": "integer"
          },
          "has_preview_token": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "slug",
          "url",
          "previous_slug",
          "slug_redirect_until",
          "custom_domain",
          "custom_domain_status",
          "custom_domain_records",
          "custom_domain_error",
          "custom_domain_checked",
          "theme",
          "content",
          "gallery",
          "flow",
          "seo",
          "reviews",
          "published",
          "published_at",
          "has_preview_token",
          "created"
        ]
      },
      "BookingPagePreviewTokenModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "token": {
            "type": "string",
            "minLength": 1
          },
          "url": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "token",
          "url"
        ]
      },
      "BookingPaymentLinkModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "booking": {
            "type": "string",
            "minLength": 1
          },
          "payment": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "url": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "booking",
          "payment",
          "amount",
          "currency",
          "url"
        ]
      },
      "BookingPaymentRecordList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingPaymentRecordModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "BookingPaymentRecordModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "booking": {
            "type": "string",
            "minLength": 1
          },
          "method": {
            "type": "string",
            "enum": [
              "cash",
              "other_terminal",
              "bank_transfer",
              "other"
            ],
            "minLength": 1
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "tip_amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "tip_shares": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TipShareModel"
            }
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "note": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "recorded_by": {
            "type": "string",
            "minLength": 1
          },
          "voided": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingPaymentRecordVoidModel"
              }
            ],
            "nullable": true
          },
          "created": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "id",
          "object",
          "booking",
          "method",
          "amount",
          "tip_amount",
          "tip_shares",
          "currency",
          "note",
          "recorded_by",
          "voided",
          "created"
        ]
      },
      "BookingPaymentRecordVoidModel": {
        "type": "object",
        "properties": {
          "at": {
            "type": "string",
            "minLength": 1
          },
          "by": {
            "type": "string",
            "minLength": 1
          },
          "reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "at",
          "by",
          "reason"
        ]
      },
      "BookingPolicyBody": {
        "type": "object",
        "properties": {
          "deposit": {
            "nullable": true
          },
          "card_required": {
            "type": "string",
            "maxLength": 16
          },
          "card_required_over_amount": {
            "nullable": true,
            "type": "integer"
          },
          "card_after_no_shows": {
            "nullable": true,
            "type": "integer"
          },
          "cancellation": {
            "nullable": true
          },
          "no_show_fee": {
            "nullable": true
          },
          "reschedule_until_hours": {
            "type": "integer",
            "multipleOf": 1
          },
          "min_notice_minutes": {
            "type": "integer",
            "multipleOf": 1
          },
          "max_advance_days": {
            "type": "integer",
            "multipleOf": 1
          },
          "approval_mode": {
            "type": "string",
            "maxLength": 12
          },
          "approval_window_hours": {
            "type": "integer",
            "multipleOf": 1
          },
          "hold_minutes": {
            "type": "integer",
            "multipleOf": 1
          },
          "slot_interval_minutes": {
            "type": "integer",
            "multipleOf": 1
          },
          "slot_mode": {
            "type": "string",
            "maxLength": 12
          },
          "auto_charge": {
            "type": "boolean"
          },
          "auto_no_show": {
            "type": "boolean"
          },
          "charge_balance_after": {
            "type": "boolean"
          },
          "business_cancel_compensation": {
            "type": "object",
            "additionalProperties": true,
            "nullable": true
          },
          "terms_text": {
            "nullable": true,
            "type": "string",
            "maxLength": 2000
          },
          "blocked_message": {
            "nullable": true,
            "type": "string",
            "maxLength": 500
          }
        }
      },
      "BookingPolicyList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingPolicyModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "BookingPolicyModel": {
        "type": "object",
        "properties": {
          "deposit": {
            "$ref": "#/components/schemas/DepositModel"
          },
          "card_required": {
            "type": "string",
            "enum": [
              "never",
              "new_clients",
              "always",
              "over_amount"
            ],
            "minLength": 1
          },
          "card_required_over_amount": {
            "nullable": true,
            "type": "integer"
          },
          "card_after_no_shows": {
            "nullable": true,
            "type": "integer"
          },
          "cancellation": {
            "$ref": "#/components/schemas/CancellationModel"
          },
          "no_show_fee": {
            "$ref": "#/components/schemas/FeeModel"
          },
          "reschedule_until_hours": {
            "type": "integer"
          },
          "min_notice_minutes": {
            "type": "integer"
          },
          "max_advance_days": {
            "type": "integer"
          },
          "approval_mode": {
            "type": "string",
            "enum": [
              "instant",
              "request"
            ],
            "minLength": 1
          },
          "terms_text": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "version": {
            "type": "integer"
          },
          "active": {
            "type": "boolean"
          },
          "approval_window_hours": {
            "type": "integer"
          },
          "hold_minutes": {
            "type": "integer"
          },
          "slot_interval_minutes": {
            "type": "integer"
          },
          "slot_mode": {
            "type": "string",
            "enum": [
              "interval",
              "smart"
            ],
            "minLength": 1
          },
          "auto_charge": {
            "type": "boolean"
          },
          "auto_no_show": {
            "type": "boolean"
          },
          "charge_balance_after": {
            "type": "boolean"
          },
          "blocked_message": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "deposit",
          "card_required",
          "card_required_over_amount",
          "card_after_no_shows",
          "cancellation",
          "no_show_fee",
          "reschedule_until_hours",
          "min_notice_minutes",
          "max_advance_days",
          "approval_mode",
          "terms_text",
          "id",
          "object",
          "livemode",
          "version",
          "active",
          "approval_window_hours",
          "hold_minutes",
          "slot_interval_minutes",
          "slot_mode",
          "auto_charge",
          "auto_no_show",
          "charge_balance_after",
          "blocked_message",
          "created"
        ]
      },
      "BookingReportModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "from": {
            "type": "string",
            "minLength": 1
          },
          "to": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "bookings": {
            "$ref": "#/components/schemas/BookingCountsModel"
          },
          "no_show_rate": {
            "$ref": "#/components/schemas/NoShowSplitModel"
          },
          "late_cancellation_rate": {
            "$ref": "#/components/schemas/LateCancellationSplitModel"
          },
          "money": {
            "$ref": "#/components/schemas/BookingMoneyTotalsModel"
          },
          "revenue_by_service": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RevenueByServiceModel"
            }
          },
          "revenue_by_staff": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RevenueByStaffModel"
            }
          },
          "revenue_by_category": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RevenueByCategoryModel"
            }
          },
          "utilisation": {
            "$ref": "#/components/schemas/UtilisationModel"
          },
          "sources": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SourceRowModel"
            }
          },
          "clients": {
            "$ref": "#/components/schemas/ClientsModel"
          },
          "rebooking": {
            "$ref": "#/components/schemas/RebookingModel"
          },
          "lead_time": {
            "$ref": "#/components/schemas/LeadTimeModel"
          },
          "busiest_hours": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BusyHourModel"
            }
          },
          "staff": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StaffPerformanceModel"
            }
          }
        },
        "required": [
          "object",
          "livemode",
          "from",
          "to",
          "location",
          "currency",
          "bookings",
          "no_show_rate",
          "late_cancellation_rate",
          "money",
          "revenue_by_service",
          "revenue_by_staff",
          "revenue_by_category",
          "utilisation",
          "sources",
          "clients",
          "rebooking",
          "lead_time",
          "busiest_hours",
          "staff"
        ]
      },
      "BookingSeriesBody": {
        "type": "object",
        "properties": {
          "location": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SeriesItemBody"
            }
          },
          "class": {
            "$ref": "#/components/schemas/SeriesClassBody"
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "starts_at": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "frequency": {
            "nullable": true,
            "type": "string",
            "maxLength": 20
          },
          "interval": {
            "type": "integer"
          },
          "until": {
            "nullable": true,
            "type": "string",
            "maxLength": 10
          },
          "count": {
            "type": "integer"
          },
          "customer": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "client": {
            "$ref": "#/components/schemas/SeriesClientBody"
          },
          "group_size": {
            "type": "integer"
          },
          "client_notes": {
            "nullable": true,
            "type": "string",
            "maxLength": 1000
          },
          "internal_notes": {
            "nullable": true,
            "type": "string",
            "maxLength": 2000
          },
          "source": {
            "nullable": true,
            "type": "string",
            "maxLength": 20
          },
          "channel": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "metadata": {
            "type": "object"
          }
        },
        "required": [
          "location",
          "starts_at"
        ]
      },
      "BookingSeriesEditBody": {
        "type": "object",
        "properties": {
          "time": {
            "nullable": true,
            "type": "string",
            "maxLength": 5
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "from": {
            "nullable": true,
            "type": "string",
            "maxLength": 10
          },
          "capacity": {
            "type": "integer"
          }
        }
      },
      "BookingSeriesEndBody": {
        "type": "object",
        "properties": {
          "after": {
            "nullable": true,
            "type": "string",
            "maxLength": 10
          }
        }
      },
      "BookingSeriesList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingSeriesModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "BookingSeriesModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "timezone": {
            "type": "string",
            "minLength": 1
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "customer": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "items": {
            "type": "array",
            "items": {
              "nullable": true
            }
          },
          "class": {
            "nullable": true
          },
          "start_date": {
            "type": "string",
            "minLength": 1
          },
          "local_time": {
            "type": "string",
            "minLength": 1
          },
          "frequency": {
            "type": "string",
            "minLength": 1
          },
          "interval": {
            "type": "integer"
          },
          "until": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "count": {
            "nullable": true,
            "type": "integer"
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "ended_after": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "materialised_through": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "skipped": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "conflict_dates": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "occurrences": {
            "$ref": "#/components/schemas/BookingSeriesOccurrencesModel"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "kind",
          "location",
          "timezone",
          "staff_member",
          "customer",
          "items",
          "class",
          "start_date",
          "local_time",
          "frequency",
          "interval",
          "until",
          "count",
          "status",
          "ended_after",
          "materialised_through",
          "skipped",
          "conflict_dates",
          "occurrences",
          "created"
        ]
      },
      "BookingSeriesOccurrencesModel": {
        "type": "object",
        "properties": {
          "made": {
            "type": "integer"
          },
          "conflicts": {
            "type": "integer"
          }
        },
        "required": [
          "made",
          "conflicts"
        ]
      },
      "BookingSeriesSkipBody": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string",
            "maxLength": 10,
            "minLength": 1
          }
        },
        "required": [
          "date"
        ]
      },
      "BookingSetupChangeModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": [
              "service_category",
              "resource",
              "service",
              "form",
              "location",
              "booking_policy",
              "booking_page",
              "messaging_settings"
            ],
            "minLength": 1
          },
          "action": {
            "type": "string",
            "enum": [
              "create",
              "exists",
              "set",
              "keep"
            ],
            "minLength": 1
          },
          "id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "fields": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "object",
          "action",
          "id",
          "name",
          "fields"
        ]
      },
      "BookingSetupDraftModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "step": {
            "type": "integer",
            "multipleOf": 1
          },
          "template": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "updated": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "object",
          "step",
          "template",
          "updated"
        ]
      },
      "BookingSetupModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "template": {
            "type": "string",
            "minLength": 1
          },
          "preview": {
            "type": "boolean"
          },
          "sections": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "changes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingSetupChangeModel"
            }
          }
        },
        "required": [
          "object",
          "template",
          "preview",
          "sections",
          "changes"
        ]
      },
      "BookingShortLinkList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingShortLinkModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "BookingShortLinkModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "id": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "code": {
            "type": "string",
            "minLength": 1
          },
          "url": {
            "type": "string",
            "minLength": 1
          },
          "target": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "service": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "staff": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "channel": {
            "type": "string",
            "minLength": 1
          },
          "visits": {
            "type": "integer",
            "multipleOf": 1
          },
          "last_visited": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "object",
          "id",
          "livemode",
          "code",
          "url",
          "target",
          "service",
          "staff",
          "channel",
          "visits",
          "last_visited",
          "created"
        ]
      },
      "BookingStoreOrderModel": {
        "type": "object",
        "properties": {
          "order": {
            "type": "string",
            "minLength": 1
          },
          "number": {
            "nullable": true,
            "type": "integer"
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "payment": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "order",
          "number",
          "status",
          "amount",
          "payment"
        ]
      },
      "BookingTemplateFormModel": {
        "type": "object",
        "properties": {
          "template": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "before_booking": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "on_the_day": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "optional": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "template",
          "name",
          "before_booking",
          "on_the_day",
          "optional"
        ]
      },
      "BookingTemplateList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingTemplateModel"
            }
          }
        },
        "required": [
          "object",
          "data"
        ]
      },
      "BookingTemplateLocationModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "premises",
              "mobile",
              "online"
            ],
            "minLength": 1
          },
          "opening_hours": {
            "type": "object"
          },
          "travel_buffer_minutes": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "kind",
          "opening_hours",
          "travel_buffer_minutes"
        ]
      },
      "BookingTemplateModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "description": {
            "type": "string",
            "minLength": 1
          },
          "keywords": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "subject_kind": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "json_ld_type": {
            "type": "string",
            "minLength": 1
          },
          "mcc": {
            "type": "string",
            "minLength": 1
          },
          "share_channels": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "location": {
            "$ref": "#/components/schemas/BookingTemplateLocationModel"
          },
          "categories": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "resources": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingTemplateResourceModel"
            }
          },
          "services": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingTemplateServiceModel"
            }
          },
          "policy": {
            "type": "object"
          },
          "page": {
            "$ref": "#/components/schemas/BookingTemplatePageModel"
          },
          "forms": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingTemplateFormModel"
            }
          },
          "reminders": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReminderRuleModel"
            }
          }
        },
        "required": [
          "id",
          "object",
          "name",
          "description",
          "keywords",
          "currency",
          "subject_kind",
          "json_ld_type",
          "mcc",
          "share_channels",
          "location",
          "categories",
          "resources",
          "services",
          "policy",
          "page",
          "forms",
          "reminders"
        ]
      },
      "BookingTemplateOptionModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "duration_minutes": {
            "type": "integer",
            "multipleOf": 1
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "name",
          "duration_minutes",
          "amount"
        ]
      },
      "BookingTemplatePageModel": {
        "type": "object",
        "properties": {
          "about": {
            "type": "string",
            "minLength": 1
          },
          "amenities": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "seo_description": {
            "type": "string",
            "minLength": 1
          },
          "flow": {
            "type": "object"
          }
        },
        "required": [
          "about",
          "amenities",
          "seo_description",
          "flow"
        ]
      },
      "BookingTemplateRequirementModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "count": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "kind",
          "count"
        ]
      },
      "BookingTemplateResourceModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "capacity": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "kind",
          "name",
          "capacity"
        ]
      },
      "BookingTemplateServiceModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "category": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "description": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "duration_minutes": {
            "type": "integer",
            "multipleOf": 1
          },
          "price_type": {
            "type": "string",
            "enum": [
              "from"
            ],
            "minLength": 1
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "processing": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ProcessingModel"
              }
            ],
            "nullable": true
          },
          "buffer_before_minutes": {
            "type": "integer",
            "multipleOf": 1
          },
          "buffer_after_minutes": {
            "type": "integer",
            "multipleOf": 1
          },
          "max_group_size": {
            "type": "integer",
            "multipleOf": 1
          },
          "variants": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingTemplateOptionModel"
            }
          },
          "addons": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingTemplateOptionModel"
            }
          },
          "resources": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingTemplateRequirementModel"
            }
          }
        },
        "required": [
          "name",
          "category",
          "description",
          "duration_minutes",
          "price_type",
          "amount",
          "processing",
          "buffer_before_minutes",
          "buffer_after_minutes",
          "max_group_size",
          "variants",
          "addons",
          "resources"
        ]
      },
      "BookingTimelineEntryModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "at": {
            "type": "integer"
          },
          "event": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "message": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "template": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "channel": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "source": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "payment": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "refund": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "record": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "currency": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "method": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "purpose": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "starts_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "kind",
          "at",
          "event",
          "message",
          "template",
          "channel",
          "status",
          "source",
          "by",
          "reason",
          "payment",
          "refund",
          "record",
          "amount",
          "currency",
          "method",
          "purpose",
          "starts_at"
        ]
      },
      "BookingTimelineModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "booking": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingTimelineEntryModel"
            }
          }
        },
        "required": [
          "object",
          "booking",
          "data"
        ]
      },
      "BookingVoucherRedemptionModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "voucher": {
            "type": "string",
            "minLength": 1
          },
          "code_last4": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "held",
              "redeemed",
              "released"
            ],
            "minLength": 1
          },
          "origin": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          },
          "finalised_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "voucher",
          "code_last4",
          "amount",
          "currency",
          "status",
          "origin",
          "created",
          "finalised_at"
        ]
      },
      "BookingWaitlistEntryList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingWaitlistEntryModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "BookingWaitlistEntryModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "client": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingClientModel"
              }
            ],
            "nullable": true
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "service": {
            "type": "string",
            "minLength": 1
          },
          "variant": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "date_from": {
            "type": "string",
            "minLength": 1
          },
          "date_to": {
            "type": "string",
            "minLength": 1
          },
          "time_windows": {
            "nullable": true
          },
          "position": {
            "nullable": true,
            "type": "integer"
          },
          "offer": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingWaitlistOfferModel"
              }
            ],
            "nullable": true
          },
          "booking": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "notes": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "status",
          "customer",
          "client",
          "location",
          "service",
          "variant",
          "staff_member",
          "date_from",
          "date_to",
          "time_windows",
          "position",
          "offer",
          "booking",
          "notes",
          "created"
        ]
      },
      "BookingWaitlistOfferModel": {
        "type": "object",
        "properties": {
          "booking": {
            "type": "string",
            "minLength": 1
          },
          "starts_at": {
            "type": "string",
            "minLength": 1
          },
          "ends_at": {
            "type": "string",
            "minLength": 1
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "expires_at": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "booking",
          "starts_at",
          "ends_at",
          "staff_member",
          "expires_at"
        ]
      },
      "BrandingBody": {
        "type": "object",
        "properties": {
          "display_name": {
            "nullable": true,
            "type": "string",
            "maxLength": 60
          },
          "accent_color": {
            "nullable": true,
            "type": "string",
            "maxLength": 7
          },
          "support_email": {
            "nullable": true,
            "type": "string",
            "maxLength": 254
          },
          "support_url": {
            "nullable": true,
            "type": "string",
            "maxLength": 500
          },
          "statement_descriptor_suffix": {
            "nullable": true,
            "type": "string",
            "maxLength": 22
          },
          "preview_price": {
            "nullable": true,
            "type": "boolean"
          },
          "invite_preview_name": {
            "nullable": true,
            "type": "boolean"
          }
        }
      },
      "BrandingModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "display_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "accent_color": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "support_email": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "support_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "statement_descriptor_suffix": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "logo_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "preview_price": {
            "type": "boolean"
          },
          "invite_preview_name": {
            "type": "boolean"
          },
          "share_image_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "accent_color_adjusted": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "display_name",
          "accent_color",
          "support_email",
          "support_url",
          "statement_descriptor_suffix",
          "logo_url",
          "preview_price",
          "invite_preview_name",
          "share_image_url"
        ]
      },
      "BundlePartBody": {
        "type": "object",
        "properties": {
          "variant": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "quantity": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "variant",
          "quantity"
        ]
      },
      "BundlePartModel": {
        "type": "object",
        "properties": {
          "variant": {
            "type": "string",
            "minLength": 1
          },
          "quantity": {
            "type": "integer"
          }
        },
        "required": [
          "variant",
          "quantity"
        ]
      },
      "BusinessProfileBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 100
          },
          "url": {
            "type": "string",
            "maxLength": 5000
          },
          "product_description": {
            "type": "string",
            "maxLength": 500
          },
          "mcc": {
            "type": "string",
            "maxLength": 4
          }
        }
      },
      "BusyHourModel": {
        "type": "object",
        "properties": {
          "weekday": {
            "type": "integer"
          },
          "hour": {
            "type": "integer"
          },
          "bookings": {
            "type": "integer"
          }
        },
        "required": [
          "weekday",
          "hour",
          "bookings"
        ]
      },
      "CalendarBookingModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "payment_status": {
            "type": "string",
            "minLength": 1
          },
          "source": {
            "type": "string",
            "minLength": 1
          },
          "starts_at": {
            "type": "string",
            "minLength": 1
          },
          "ends_at": {
            "type": "string",
            "minLength": 1
          },
          "local_date": {
            "type": "string",
            "minLength": 1
          },
          "group_size": {
            "type": "integer",
            "multipleOf": 1
          },
          "customer": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "client": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CalendarClientModel"
              }
            ],
            "nullable": true
          },
          "subject": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CalendarSubjectModel"
              }
            ],
            "nullable": true
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CalendarItemModel"
            }
          },
          "flags": {
            "$ref": "#/components/schemas/CalendarFlagsModel"
          },
          "held_until": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "object",
          "status",
          "payment_status",
          "source",
          "starts_at",
          "ends_at",
          "local_date",
          "group_size",
          "customer",
          "client",
          "subject",
          "items",
          "flags",
          "held_until"
        ]
      },
      "CalendarClassSessionModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "service": {
            "type": "string",
            "minLength": 1
          },
          "staff_member": {
            "type": "string",
            "minLength": 1
          },
          "resource": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "starts_at": {
            "type": "string",
            "minLength": 1
          },
          "ends_at": {
            "type": "string",
            "minLength": 1
          },
          "capacity": {
            "type": "integer",
            "multipleOf": 1
          },
          "booked": {
            "type": "integer",
            "multipleOf": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "service",
          "staff_member",
          "resource",
          "starts_at",
          "ends_at",
          "capacity",
          "booked",
          "status"
        ]
      },
      "CalendarClientModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "first_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "last_initial": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "first_name",
          "last_initial"
        ]
      },
      "CalendarExceptionModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "location": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "starts_at": {
            "type": "string",
            "minLength": 1
          },
          "ends_at": {
            "type": "string",
            "minLength": 1
          },
          "all_day": {
            "type": "boolean"
          },
          "reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "source": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "staff_member",
          "location",
          "kind",
          "starts_at",
          "ends_at",
          "all_day",
          "reason",
          "source"
        ]
      },
      "CalendarFlagsModel": {
        "type": "object",
        "properties": {
          "new_client": {
            "type": "boolean"
          },
          "notes": {
            "type": "boolean"
          },
          "unpaid": {
            "type": "boolean"
          },
          "pending_approval": {
            "type": "boolean"
          },
          "blocked": {
            "type": "boolean"
          },
          "no_shows": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "new_client",
          "notes",
          "unpaid",
          "pending_approval",
          "blocked",
          "no_shows"
        ]
      },
      "CalendarHoursModel": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string",
            "minLength": 1
          },
          "open": {
            "type": "array",
            "items": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "minItems": 2,
              "maxItems": 2
            }
          }
        },
        "required": [
          "date",
          "open"
        ]
      },
      "CalendarItemModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "service": {
            "type": "string",
            "minLength": 1
          },
          "variant": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "staff_member": {
            "type": "string",
            "minLength": 1
          },
          "starts_at": {
            "type": "string",
            "minLength": 1
          },
          "ends_at": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "service",
          "variant",
          "staff_member",
          "starts_at",
          "ends_at"
        ]
      },
      "CalendarLocationModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "timezone": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "name",
          "timezone"
        ]
      },
      "CalendarModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "from": {
            "type": "string",
            "minLength": 1
          },
          "to": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "$ref": "#/components/schemas/CalendarLocationModel"
          },
          "hours": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CalendarHoursModel"
            }
          },
          "staff": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CalendarStaffModel"
            }
          },
          "bookings": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CalendarBookingModel"
            }
          },
          "holds": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CalendarBookingModel"
            }
          },
          "exceptions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CalendarExceptionModel"
            }
          },
          "class_sessions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CalendarClassSessionModel"
            }
          }
        },
        "required": [
          "object",
          "livemode",
          "from",
          "to",
          "location",
          "hours",
          "staff",
          "bookings",
          "holds",
          "exceptions",
          "class_sessions"
        ]
      },
      "CalendarSpanModel": {
        "type": "object",
        "properties": {
          "starts_at": {
            "type": "string",
            "minLength": 1
          },
          "ends_at": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "starts_at",
          "ends_at"
        ]
      },
      "CalendarStaffDayModel": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string",
            "minLength": 1
          },
          "working": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CalendarSpanModel"
            }
          }
        },
        "required": [
          "date",
          "working"
        ]
      },
      "CalendarStaffModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "colour": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "days": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CalendarStaffDayModel"
            }
          }
        },
        "required": [
          "id",
          "name",
          "colour",
          "days"
        ]
      },
      "CalendarSubjectModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "kind",
          "name"
        ]
      },
      "CampaignMessageModel": {
        "type": "object",
        "properties": {
          "subject": {
            "type": "string",
            "minLength": 1
          },
          "heading": {
            "type": "string",
            "minLength": 1
          },
          "body": {
            "type": "string",
            "minLength": 1
          },
          "action_path": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "subject",
          "heading",
          "body",
          "action_path"
        ]
      },
      "CampaignSegmentBody": {
        "type": "object",
        "properties": {
          "last_visit_before": {
            "nullable": true,
            "type": "string"
          },
          "last_visit_after": {
            "nullable": true,
            "type": "string"
          },
          "service": {
            "nullable": true,
            "type": "string"
          },
          "tag": {
            "nullable": true,
            "type": "string"
          }
        }
      },
      "CampaignSegmentModel": {
        "type": "object",
        "properties": {
          "last_visit_before": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "last_visit_after": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "service": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "tag": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "last_visit_before",
          "last_visit_after",
          "service",
          "tag"
        ]
      },
      "CampaignSlotBody": {
        "type": "object",
        "properties": {
          "service": {
            "nullable": true,
            "type": "string"
          },
          "starts_at": {
            "nullable": true,
            "type": "string"
          },
          "staff_member": {
            "nullable": true,
            "type": "string"
          }
        }
      },
      "CampaignSlotModel": {
        "type": "object",
        "properties": {
          "service": {
            "type": "string",
            "minLength": 1
          },
          "starts_at": {
            "type": "string",
            "minLength": 1
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "service",
          "starts_at",
          "staff_member"
        ]
      },
      "CancelBookingBody": {
        "type": "object",
        "properties": {
          "by": {
            "nullable": true,
            "type": "string",
            "maxLength": 10
          },
          "reason": {
            "nullable": true,
            "type": "string",
            "maxLength": 300
          }
        }
      },
      "CancelSubscriptionBody": {
        "type": "object",
        "properties": {
          "at_period_end": {
            "type": "boolean"
          }
        }
      },
      "CancellationFeeDueModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "late_cancel"
            ],
            "minLength": 1
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "deposit_applied": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "kind",
          "amount",
          "deposit_applied"
        ]
      },
      "CancellationFormModel": {
        "type": "object",
        "properties": {
          "goods": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "ordered_on": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "received_on": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "address": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "date": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "goods",
          "ordered_on",
          "received_on",
          "name",
          "address",
          "date"
        ]
      },
      "CancellationModel": {
        "type": "object",
        "properties": {
          "free_until_hours": {
            "type": "integer"
          },
          "late_fee": {
            "$ref": "#/components/schemas/FeeModel"
          }
        },
        "required": [
          "free_until_hours",
          "late_fee"
        ]
      },
      "CancellationPreviewModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "booking": {
            "type": "string",
            "minLength": 1
          },
          "by": {
            "type": "string",
            "enum": [
              "client",
              "business"
            ],
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "refund_amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "deposit_kept": {
            "type": "integer",
            "multipleOf": 1
          },
          "fee_due": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CancellationFeeDueModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "object",
          "booking",
          "by",
          "currency",
          "refund_amount",
          "deposit_kept",
          "fee_due"
        ]
      },
      "CapabilitiesBody": {
        "type": "object",
        "properties": {
          "card_payments": {
            "$ref": "#/components/schemas/CapabilityRequestBody"
          },
          "transfers": {
            "$ref": "#/components/schemas/CapabilityRequestBody"
          },
          "card_issuing": {
            "$ref": "#/components/schemas/CapabilityRequestBody"
          }
        }
      },
      "CapabilityList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CapabilityModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "CapabilityModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string",
            "minLength": 1
          },
          "requested": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "requirements": {
            "$ref": "#/components/schemas/CapabilityRequirementsModel"
          }
        },
        "required": [
          "id",
          "object",
          "account",
          "requested",
          "status",
          "requirements"
        ]
      },
      "CapabilityRequestBody": {
        "type": "object",
        "properties": {
          "requested": {
            "type": "boolean"
          }
        }
      },
      "CapabilityRequirementsModel": {
        "type": "object",
        "properties": {
          "currently_due": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "past_due": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "pending_verification": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "current_deadline": {
            "nullable": true,
            "type": "integer"
          },
          "disabled_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "currently_due",
          "past_due",
          "pending_verification",
          "current_deadline",
          "disabled_reason"
        ]
      },
      "CapabilityTosAcceptanceBody": {
        "type": "object",
        "properties": {
          "date": {
            "type": "integer",
            "multipleOf": 1
          },
          "ip": {
            "type": "string",
            "maxLength": 64,
            "minLength": 1
          },
          "user_agent": {
            "type": "string",
            "maxLength": 255
          }
        },
        "required": [
          "date",
          "ip"
        ]
      },
      "CapturePaymentBody": {
        "type": "object",
        "properties": {
          "amount_to_capture": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "CardAuthorizationList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CardAuthorizationModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "CardAuthorizationModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "card": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "merchant": {
            "$ref": "#/components/schemas/AuthorizationMerchantModel"
          },
          "approved": {
            "type": "boolean"
          },
          "decline_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "decline_message": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "decided_by": {
            "type": "string",
            "minLength": 1
          },
          "mandate": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "cart": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "spend_policy": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "spend_policy_version": {
            "nullable": true,
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "closed",
              "reversed",
              "expired"
            ],
            "minLength": 1
          },
          "three_d_secure": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "authentication_exemption": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/AuthenticationExemptionModel"
              }
            ],
            "nullable": true
          },
          "unusual": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "checks": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/AuthorizationChecksModel"
              }
            ],
            "nullable": true
          },
          "verified_by_fraud_challenge": {
            "nullable": true,
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "card",
          "amount",
          "currency",
          "merchant",
          "approved",
          "decline_reason",
          "decline_message",
          "decided_by",
          "mandate",
          "cart",
          "spend_policy",
          "spend_policy_version",
          "status",
          "three_d_secure",
          "authentication_exemption",
          "unusual",
          "checks",
          "verified_by_fraud_challenge",
          "created"
        ]
      },
      "CardDetailsModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "card": {
            "type": "string",
            "minLength": 1
          },
          "number": {
            "type": "string",
            "minLength": 1
          },
          "cvc": {
            "type": "string",
            "minLength": 1
          },
          "exp_month": {
            "type": "integer",
            "multipleOf": 1
          },
          "exp_year": {
            "type": "integer",
            "multipleOf": 1
          },
          "livemode": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "card",
          "number",
          "cvc",
          "exp_month",
          "exp_year",
          "livemode"
        ]
      },
      "CardDisputeBalanceTransactionModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "type": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "type",
          "amount",
          "created"
        ]
      },
      "CardDisputeEvidenceModel": {
        "type": "object",
        "properties": {
          "explanation": {
            "type": "string"
          },
          "product_type": {
            "type": "string",
            "enum": [
              "merchandise",
              "service"
            ]
          },
          "product_description": {
            "type": "string"
          },
          "expected_at": {
            "type": "integer"
          },
          "received_at": {
            "type": "integer"
          },
          "canceled_at": {
            "type": "integer"
          },
          "cancellation_policy_provided": {
            "type": "boolean"
          },
          "cancellation_reason": {
            "type": "string"
          },
          "return_status": {
            "type": "string",
            "enum": [
              "successful",
              "merchant_rejected"
            ]
          },
          "returned_at": {
            "type": "integer"
          },
          "return_description": {
            "type": "string"
          },
          "original_transaction": {
            "type": "string"
          },
          "additional_documentation": {
            "type": "string"
          },
          "card_statement": {
            "type": "string"
          },
          "cash_receipt": {
            "type": "string"
          },
          "check_image": {
            "type": "string"
          },
          "drafted_from_trail": {
            "type": "boolean"
          }
        },
        "required": [
          "drafted_from_trail"
        ]
      },
      "CardDisputeFileModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "field": {
            "type": "string",
            "minLength": 1
          },
          "filename": {
            "type": "string",
            "minLength": 1
          },
          "type": {
            "type": "string",
            "enum": [
              "pdf",
              "jpg"
            ],
            "minLength": 1
          },
          "size": {
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "field",
          "filename",
          "type",
          "size",
          "created"
        ]
      },
      "CardDisputeFiledModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "card_transaction": {
            "type": "string",
            "minLength": 1
          },
          "card": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "reason": {
            "type": "string",
            "enum": [
              "fraudulent",
              "not_received",
              "canceled",
              "duplicate",
              "merchandise_not_as_described",
              "service_not_as_described",
              "no_valid_authorization",
              "other"
            ],
            "minLength": 1
          },
          "explanation": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "unsubmitted",
              "submitted",
              "won",
              "lost",
              "expired"
            ],
            "minLength": 1
          },
          "evidence": {
            "$ref": "#/components/schemas/CardDisputeEvidenceModel"
          },
          "files": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CardDisputeFileModel"
            }
          },
          "dispute_by": {
            "nullable": true,
            "type": "integer"
          },
          "loss_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "loss_reason_text": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "provisional_credit": {
            "$ref": "#/components/schemas/CardDisputeProvisionalCreditModel"
          },
          "balance_transactions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CardDisputeBalanceTransactionModel"
            }
          },
          "replacement_card": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "submitted_at": {
            "nullable": true,
            "type": "integer"
          },
          "closed_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          },
          "other_recent_purchases": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CardTransactionModel"
            }
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "card_transaction",
          "card",
          "amount",
          "currency",
          "reason",
          "explanation",
          "status",
          "evidence",
          "files",
          "dispute_by",
          "loss_reason",
          "loss_reason_text",
          "provisional_credit",
          "balance_transactions",
          "replacement_card",
          "submitted_at",
          "closed_at",
          "created"
        ]
      },
      "CardDisputeList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CardDisputeModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "CardDisputeModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "card_transaction": {
            "type": "string",
            "minLength": 1
          },
          "card": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "reason": {
            "type": "string",
            "enum": [
              "fraudulent",
              "not_received",
              "canceled",
              "duplicate",
              "merchandise_not_as_described",
              "service_not_as_described",
              "no_valid_authorization",
              "other"
            ],
            "minLength": 1
          },
          "explanation": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "unsubmitted",
              "submitted",
              "won",
              "lost",
              "expired"
            ],
            "minLength": 1
          },
          "evidence": {
            "$ref": "#/components/schemas/CardDisputeEvidenceModel"
          },
          "files": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CardDisputeFileModel"
            }
          },
          "dispute_by": {
            "nullable": true,
            "type": "integer"
          },
          "loss_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "loss_reason_text": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "provisional_credit": {
            "$ref": "#/components/schemas/CardDisputeProvisionalCreditModel"
          },
          "balance_transactions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CardDisputeBalanceTransactionModel"
            }
          },
          "replacement_card": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "submitted_at": {
            "nullable": true,
            "type": "integer"
          },
          "closed_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "card_transaction",
          "card",
          "amount",
          "currency",
          "reason",
          "explanation",
          "status",
          "evidence",
          "files",
          "dispute_by",
          "loss_reason",
          "loss_reason_text",
          "provisional_credit",
          "balance_transactions",
          "replacement_card",
          "submitted_at",
          "closed_at",
          "created"
        ],
        "example": {
          "id": "cdsp_01K6CD3E5F7G9H1J3K5M7N9P2A",
          "object": "card_dispute",
          "livemode": false,
          "card_transaction": "ctx_01K6CD3E5F7G9H1J3K5M7N9P2B",
          "card": "card_01K6CD3E5F7G9H1J3K5M7N9P2C",
          "amount": 5000,
          "currency": "gbp",
          "reason": "not_received",
          "explanation": "The dataset was never delivered; the merchant stopped answering emails.",
          "status": "submitted",
          "evidence": {
            "explanation": "The dataset was never delivered; the merchant stopped answering emails.",
            "product_type": "merchandise",
            "product_description": "A cleaned dataset of 2025 UK retail prices, as a CSV download",
            "expected_at": 1759190400,
            "additional_documentation": "file_1SbcDeFgHiJkLmNo",
            "drafted_from_trail": true
          },
          "files": [
            {
              "id": "file_1SbcDeFgHiJkLmNo",
              "field": "additional_documentation",
              "filename": "order-confirmation.pdf",
              "type": "pdf",
              "size": 48213,
              "created": 1759363200
            }
          ],
          "dispute_by": 1768348800,
          "loss_reason": null,
          "loss_reason_text": null,
          "provisional_credit": {
            "amount": 5000,
            "status": "credited"
          },
          "balance_transactions": [
            {
              "id": "txn_1SbcProvisional0001",
              "type": "issuing_dispute_provisional_credit",
              "amount": 5000,
              "created": 1759363260
            }
          ],
          "replacement_card": null,
          "submitted_at": 1759363250,
          "closed_at": null,
          "created": 1759363000
        }
      },
      "CardDisputeProvisionalCreditModel": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "none",
              "credited",
              "held",
              "spendable",
              "reversed"
            ],
            "minLength": 1
          }
        },
        "required": [
          "amount",
          "status"
        ]
      },
      "CardFeeLineModel": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "count",
          "amount"
        ]
      },
      "CardFeesModel": {
        "type": "object",
        "properties": {
          "virtual_cards": {
            "$ref": "#/components/schemas/CardFeeLineModel"
          },
          "fx": {
            "$ref": "#/components/schemas/CardFeeLineModel"
          },
          "replacements": {
            "$ref": "#/components/schemas/CardFeeLineModel"
          },
          "total": {
            "type": "integer"
          }
        },
        "required": [
          "virtual_cards",
          "fx",
          "replacements",
          "total"
        ]
      },
      "CardLimitsModel": {
        "type": "object",
        "properties": {
          "per_authorization": {
            "nullable": true,
            "type": "integer"
          },
          "daily": {
            "nullable": true,
            "type": "integer"
          },
          "weekly": {
            "nullable": true,
            "type": "integer"
          },
          "monthly": {
            "nullable": true,
            "type": "integer"
          },
          "all_time": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "per_authorization",
          "daily",
          "weekly",
          "monthly",
          "all_time"
        ]
      },
      "CardList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CardModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "CardMerchantLockModel": {
        "type": "object",
        "properties": {
          "name": {
            "nullable": true,
            "type": "string"
          },
          "network_id": {
            "nullable": true,
            "type": "string"
          }
        }
      },
      "CardModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "agent": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "cardholder": {
            "type": "string",
            "minLength": 1
          },
          "type": {
            "type": "string",
            "enum": [
              "virtual",
              "physical"
            ],
            "minLength": 1
          },
          "usage": {
            "type": "string",
            "enum": [
              "standing",
              "single_use"
            ],
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "inactive",
              "active",
              "frozen",
              "canceled"
            ],
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "brand": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "last4": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "exp_month": {
            "nullable": true,
            "type": "integer"
          },
          "exp_year": {
            "nullable": true,
            "type": "integer"
          },
          "limits": {
            "$ref": "#/components/schemas/CardLimitsModel"
          },
          "spend_policy": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "merchant_lock": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CardMerchantLockModel"
              }
            ],
            "nullable": true
          },
          "canceled_at": {
            "nullable": true,
            "type": "integer"
          },
          "shipping": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CardShippingModel"
              }
            ],
            "nullable": true
          },
          "replacement_for": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "replacement_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "metadata": {
            "type": "object"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "agent",
          "cardholder",
          "type",
          "usage",
          "status",
          "currency",
          "brand",
          "last4",
          "exp_month",
          "exp_year",
          "limits",
          "spend_policy",
          "merchant_lock",
          "canceled_at",
          "shipping",
          "replacement_for",
          "replacement_reason",
          "metadata",
          "created"
        ]
      },
      "CardPaymentsSettingsBody": {
        "type": "object",
        "properties": {
          "statement_descriptor_prefix": {
            "nullable": true,
            "type": "string",
            "maxLength": 10
          },
          "statement_descriptor_suffix": {
            "nullable": true,
            "type": "string",
            "maxLength": 22
          }
        }
      },
      "CardRateModel": {
        "type": "object",
        "properties": {
          "bps": {
            "type": "integer",
            "description": "The card rate in basis points of the amount (79 is 0.79%)."
          },
          "fixed": {
            "type": "integer",
            "description": "Added to each card payment after the percentage, in minor units."
          }
        },
        "required": [
          "bps",
          "fixed"
        ]
      },
      "CardShippingModel": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "shipped",
              "delivered",
              "returned",
              "failure",
              "canceled"
            ],
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "address": {
            "$ref": "#/components/schemas/ShippingAddressModel"
          },
          "service": {
            "type": "string",
            "enum": [
              "standard",
              "express",
              "priority"
            ],
            "minLength": 1
          },
          "carrier": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "tracking_number": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "eta": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "status",
          "name",
          "address",
          "service",
          "carrier",
          "tracking_number",
          "eta"
        ]
      },
      "CardTransactionList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CardTransactionModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "CardTransactionModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "card": {
            "type": "string",
            "minLength": 1
          },
          "authorization": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "type": {
            "type": "string",
            "enum": [
              "capture",
              "refund"
            ],
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "merchant_amount": {
            "type": "integer"
          },
          "merchant_currency": {
            "type": "string",
            "minLength": 1
          },
          "merchant": {
            "$ref": "#/components/schemas/TransactionMerchantModel"
          },
          "cashback_eligible": {
            "nullable": true,
            "type": "boolean"
          },
          "cashback_exclusion_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "settled_at": {
            "type": "integer"
          },
          "dispute_by": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          },
          "timeline": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TimelineStepModel"
            }
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "card",
          "authorization",
          "type",
          "amount",
          "currency",
          "merchant_amount",
          "merchant_currency",
          "merchant",
          "cashback_eligible",
          "cashback_exclusion_reason",
          "settled_at",
          "dispute_by",
          "created"
        ]
      },
      "CardholderBody": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "individual",
              "company"
            ]
          },
          "name": {
            "type": "string",
            "maxLength": 100
          },
          "email": {
            "nullable": true,
            "type": "string",
            "maxLength": 320
          },
          "phone_number": {
            "nullable": true,
            "type": "string",
            "maxLength": 20
          },
          "billing": {
            "$ref": "#/components/schemas/BillingBody"
          },
          "individual": {
            "$ref": "#/components/schemas/IndividualBody"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "inactive"
            ]
          },
          "metadata": {
            "type": "object"
          }
        }
      },
      "CardholderList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CardholderModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "CardholderModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "type": {
            "type": "string",
            "enum": [
              "individual",
              "company"
            ],
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "individual": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/IndividualModel"
              }
            ],
            "nullable": true
          },
          "email": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "phone_number": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "billing": {
            "$ref": "#/components/schemas/BillingModel"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "inactive",
              "blocked"
            ],
            "minLength": 1
          },
          "requirements": {
            "$ref": "#/components/schemas/RequirementsModel"
          },
          "user": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "metadata": {
            "type": "object"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "type",
          "name",
          "individual",
          "email",
          "phone_number",
          "billing",
          "status",
          "requirements",
          "user",
          "metadata",
          "created"
        ]
      },
      "CarrierAccountFieldsModel": {
        "type": "object",
        "properties": {
          "public_key": {
            "type": "string",
            "maxLength": 200
          },
          "secret_key": {
            "type": "string",
            "maxLength": 200
          },
          "account_number": {
            "type": "string",
            "maxLength": 200
          },
          "postal_code": {
            "type": "string",
            "maxLength": 200
          },
          "country": {
            "type": "string",
            "maxLength": 200
          }
        }
      },
      "CarrierAccountListModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CarrierAccountModel"
            }
          },
          "carriers": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "fields": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "object",
          "data",
          "carriers",
          "fields"
        ]
      },
      "CarrierAccountModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "carrier": {
            "type": "string",
            "minLength": 1
          },
          "label": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "failure": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "checked_at": {
            "nullable": true,
            "type": "integer"
          },
          "fallback_to_balance": {
            "type": "boolean"
          },
          "livemode": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "object",
          "carrier",
          "label",
          "status",
          "failure",
          "checked_at",
          "fallback_to_balance",
          "livemode"
        ]
      },
      "CarrierPickupList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CarrierPickupModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "CarrierPickupModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "day": {
            "type": "string",
            "minLength": 1
          },
          "carrier": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "failure": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "confirmation": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "window_start": {
            "type": "integer"
          },
          "window_end": {
            "type": "integer"
          },
          "cost_amount": {
            "nullable": true,
            "type": "integer"
          },
          "currency": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "labels": {
            "type": "integer"
          },
          "instructions": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "location",
          "day",
          "carrier",
          "status",
          "failure",
          "confirmation",
          "window_start",
          "window_end",
          "cost_amount",
          "currency",
          "labels",
          "instructions",
          "created"
        ]
      },
      "CartItemBody": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "maxLength": 200,
            "minLength": 1
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "description",
          "amount"
        ]
      },
      "CashDrawerBody": {
        "type": "object",
        "properties": {
          "printer_id": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          }
        }
      },
      "CashDrawerModel": {
        "type": "object",
        "properties": {
          "printer_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "printer_id"
        ]
      },
      "CashMovementBody": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "pay_in",
              "pay_out",
              "drop",
              "tip_out",
              "no_sale"
            ]
          },
          "amount": {
            "type": "integer"
          },
          "reason": {
            "type": "string",
            "maxLength": 200
          }
        }
      },
      "CashMovementModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "shift": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "float",
              "sale",
              "refund",
              "pay_in",
              "pay_out",
              "drop",
              "tip_out",
              "no_sale",
              "deposit_refund"
            ],
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "device": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "order": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "tender": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "approved_by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "shift",
          "kind",
          "amount",
          "currency",
          "reason",
          "staff_member",
          "device",
          "order",
          "tender",
          "approved_by",
          "created"
        ]
      },
      "CashRoundingBody": {
        "type": "object",
        "properties": {
          "increment": {
            "type": "integer",
            "multipleOf": 1
          },
          "mode": {
            "type": "string",
            "enum": [
              "nearest",
              "up",
              "down"
            ],
            "minLength": 1
          },
          "half": {
            "type": "string",
            "enum": [
              "up",
              "down"
            ]
          },
          "mandatory": {
            "type": "boolean"
          }
        },
        "required": [
          "increment",
          "mode"
        ]
      },
      "CashRoundingModel": {
        "type": "object",
        "properties": {
          "increment": {
            "type": "integer"
          },
          "mode": {
            "type": "string",
            "enum": [
              "nearest",
              "up",
              "down"
            ],
            "minLength": 1
          },
          "half": {
            "type": "string",
            "enum": [
              "up",
              "down"
            ]
          },
          "mandatory": {
            "type": "boolean"
          }
        },
        "required": [
          "increment",
          "mode"
        ]
      },
      "CashbackAccrualList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CashbackAccrualModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "CashbackAccrualModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "card_transaction": {
            "type": "string",
            "minLength": 1
          },
          "card": {
            "type": "string",
            "minLength": 1
          },
          "type": {
            "type": "string",
            "enum": [
              "capture",
              "refund",
              "dispute"
            ],
            "minLength": 1
          },
          "period": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "eligible": {
            "type": "boolean"
          },
          "exclusion_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "classifier_version": {
            "type": "string",
            "minLength": 1
          },
          "provisional_cashback": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "accrued",
              "reversed"
            ],
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "card_transaction",
          "card",
          "type",
          "period",
          "amount",
          "currency",
          "eligible",
          "exclusion_reason",
          "classifier_version",
          "provisional_cashback",
          "status",
          "created"
        ]
      },
      "CashbackStatementList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CashbackStatementModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "CashbackStatementModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "period": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "accept_earnings": {
            "type": "integer"
          },
          "eligible_spend": {
            "type": "integer"
          },
          "excluded_spend": {
            "type": "integer"
          },
          "capped_spend": {
            "type": "integer"
          },
          "rate_bps": {
            "type": "integer"
          },
          "gross": {
            "type": "integer"
          },
          "reversals": {
            "type": "integer"
          },
          "platform_fees_netted": {
            "type": "integer"
          },
          "platform_fees_outstanding": {
            "type": "integer"
          },
          "net": {
            "type": "integer"
          },
          "carry_forward": {
            "type": "integer"
          },
          "classifier_version": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "approved",
              "paid",
              "void"
            ],
            "minLength": 1
          },
          "computed_at": {
            "type": "integer"
          },
          "paid_at": {
            "nullable": true,
            "type": "integer"
          },
          "beneficiary": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "share_bps": {
            "type": "integer"
          },
          "share_gross": {
            "type": "integer"
          },
          "share_reversals": {
            "type": "integer"
          },
          "share_net": {
            "type": "integer"
          },
          "share_transfer_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "period",
          "currency",
          "accept_earnings",
          "eligible_spend",
          "excluded_spend",
          "capped_spend",
          "rate_bps",
          "gross",
          "reversals",
          "platform_fees_netted",
          "platform_fees_outstanding",
          "net",
          "carry_forward",
          "classifier_version",
          "status",
          "computed_at",
          "paid_at",
          "beneficiary",
          "share_bps",
          "share_gross",
          "share_reversals",
          "share_net",
          "share_transfer_id",
          "created"
        ]
      },
      "CategorySummaryModel": {
        "type": "object",
        "properties": {
          "category": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "lines": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "category",
          "lines",
          "amount"
        ]
      },
      "ChangeActorModel": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "user",
              "job",
              "api_key",
              "agent",
              "oauth"
            ],
            "minLength": 1
          },
          "id": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "type",
          "id",
          "name"
        ]
      },
      "ChangeInverseModel": {
        "type": "object",
        "properties": {
          "action": {
            "type": "string",
            "minLength": 1
          },
          "input": {
            "type": "object"
          }
        },
        "required": [
          "action",
          "input"
        ]
      },
      "ChangeModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "seq": {
            "type": "integer",
            "multipleOf": 1
          },
          "action": {
            "type": "string",
            "minLength": 1
          },
          "input": {
            "type": "object"
          },
          "risk": {
            "type": "string",
            "enum": [
              "read",
              "change",
              "money",
              "destructive"
            ],
            "minLength": 1
          },
          "card": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ToolCallSummaryModel"
              }
            ],
            "nullable": true
          },
          "object_type": {
            "type": "string",
            "minLength": 1
          },
          "object_id": {
            "type": "string",
            "minLength": 1
          },
          "before": {
            "nullable": true
          },
          "after": {
            "nullable": true
          },
          "inverse": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ChangeInverseModel"
              }
            ],
            "nullable": true
          },
          "not_revertible_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "proposed",
              "applied",
              "failed",
              "skipped",
              "reverted"
            ],
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "error": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "object",
          "seq",
          "action",
          "input",
          "risk",
          "card",
          "object_type",
          "object_id",
          "before",
          "after",
          "inverse",
          "not_revertible_reason",
          "status",
          "request_id",
          "error"
        ]
      },
      "ChangeSetAppliedEvent": {
        "type": "object",
        "description": "The `change_set.applied` event (the store's assistant events): `data.object` is the `change_set`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "change_set.applied"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ChangeSetEventData"
          }
        }
      },
      "ChangeSetDeclinedEvent": {
        "type": "object",
        "description": "The `change_set.declined` event (the store's assistant events): `data.object` is the `change_set`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "change_set.declined"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ChangeSetEventData"
          }
        }
      },
      "ChangeSetEventData": {
        "type": "object",
        "description": "What an event carrying a `change_set` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/ChangeSetEventObject"
          }
        }
      },
      "ChangeSetEventObject": {
        "type": "object",
        "description": "A `change_set` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "change_set"
          }
        },
        "additionalProperties": true
      },
      "ChangeSetExpiredEvent": {
        "type": "object",
        "description": "The `change_set.expired` event (the store's assistant events): `data.object` is the `change_set`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "change_set.expired"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ChangeSetEventData"
          }
        }
      },
      "ChangeSetList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ChangeSetModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ChangeSetModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "actor": {
            "$ref": "#/components/schemas/ChangeActorModel"
          },
          "job_run": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "source": {
            "type": "string",
            "enum": [
              "job",
              "sentence",
              "editor",
              "assistant_chat",
              "api",
              "mcp"
            ],
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "summary": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "suggested",
              "proposed",
              "applying",
              "applied",
              "failed",
              "declined",
              "expired",
              "superseded",
              "reverted"
            ],
            "minLength": 1
          },
          "level": {
            "type": "string",
            "enum": [
              "suggest",
              "ask",
              "act"
            ],
            "minLength": 1
          },
          "risk": {
            "type": "string",
            "enum": [
              "read",
              "change",
              "money",
              "destructive"
            ],
            "minLength": 1
          },
          "revertible": {
            "type": "boolean"
          },
          "preview": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "expires_at": {
            "nullable": true,
            "type": "integer"
          },
          "decided_by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "decided_via": {
            "nullable": true,
            "type": "string",
            "minLength": 1,
            "enum": [
              "web",
              "app",
              "push"
            ]
          },
          "edited": {
            "type": "boolean"
          },
          "decline_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "applied_at": {
            "nullable": true,
            "type": "integer"
          },
          "reverted_at": {
            "nullable": true,
            "type": "integer"
          },
          "reverted_by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "revert_of": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "reverted_with": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer",
            "multipleOf": 1
          },
          "changes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ChangeModel"
            }
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "actor",
          "job_run",
          "source",
          "title",
          "summary",
          "reason",
          "status",
          "level",
          "risk",
          "revertible",
          "preview",
          "expires_at",
          "decided_by",
          "decided_via",
          "edited",
          "decline_reason",
          "applied_at",
          "reverted_at",
          "reverted_by",
          "revert_of",
          "reverted_with",
          "created",
          "changes"
        ],
        "example": {
          "id": "chs_01K7HBCN5Q7S9U1W3Y5A7C9E1G",
          "object": "change_set",
          "livemode": false,
          "actor": {
            "type": "job",
            "id": "jrn_01K7HBDP6R8T0V2X4Z6B8D0F2H",
            "name": "Merchandising"
          },
          "job_run": "jrn_01K7HBDP6R8T0V2X4Z6B8D0F2H",
          "source": "job",
          "title": "Put the sea salt candle first in Candles",
          "summary": "It sold 38 last week, more than any other candle.",
          "reason": "Best seller for three weeks running.",
          "status": "applied",
          "level": "ask",
          "risk": "change",
          "revertible": true,
          "preview": null,
          "expires_at": null,
          "decided_by": "usr_01J8ZK0A2C4E6G8J0L2N4Q6S8U",
          "decided_via": "app",
          "edited": false,
          "decline_reason": null,
          "applied_at": 1792310400,
          "reverted_at": null,
          "reverted_by": null,
          "revert_of": null,
          "reverted_with": null,
          "created": 1792306800,
          "changes": [
            {
              "id": "chg_01K7HBEQ7S9U1W3Y5A7C9E1G3J",
              "object": "change",
              "seq": 1,
              "action": "update_collection",
              "input": {
                "collection": "coll_01K7HB4D6F8H0K2M4P6R8T0V2X",
                "products": [
                  "prod_01K7HB2M4N6P8Q0R2S4T6V8W0X",
                  "prod_01K7HB2M4N6P8Q0R2S4T6V8W0Y"
                ]
              },
              "risk": "change",
              "card": null,
              "object_type": "collection",
              "object_id": "coll_01K7HB4D6F8H0K2M4P6R8T0V2X",
              "before": {
                "products": [
                  "prod_01K7HB2M4N6P8Q0R2S4T6V8W0Y",
                  "prod_01K7HB2M4N6P8Q0R2S4T6V8W0X"
                ]
              },
              "after": {
                "products": [
                  "prod_01K7HB2M4N6P8Q0R2S4T6V8W0X",
                  "prod_01K7HB2M4N6P8Q0R2S4T6V8W0Y"
                ]
              },
              "inverse": {
                "action": "update_collection",
                "input": {
                  "collection": "coll_01K7HB4D6F8H0K2M4P6R8T0V2X",
                  "products": [
                    "prod_01K7HB2M4N6P8Q0R2S4T6V8W0Y",
                    "prod_01K7HB2M4N6P8Q0R2S4T6V8W0X"
                  ]
                }
              },
              "not_revertible_reason": null,
              "status": "applied",
              "request_id": null,
              "error": null
            }
          ]
        }
      },
      "ChangeSetProposedEvent": {
        "type": "object",
        "description": "The `change_set.proposed` event (the store's assistant events): `data.object` is the `change_set`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "change_set.proposed"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ChangeSetEventData"
          }
        }
      },
      "ChangeSetRevertedEvent": {
        "type": "object",
        "description": "The `change_set.reverted` event (the store's assistant events): `data.object` is the `change_set`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "change_set.reverted"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ChangeSetEventData"
          }
        }
      },
      "ChangeSubscriptionBody": {
        "type": "object",
        "properties": {
          "plan": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "at_period_end": {
            "type": "boolean"
          },
          "proration_at": {
            "type": "integer"
          }
        },
        "required": [
          "plan"
        ]
      },
      "ChannelFeesModel": {
        "type": "object",
        "properties": {
          "estimated": {
            "type": "integer"
          },
          "final": {
            "type": "integer"
          }
        },
        "required": [
          "estimated",
          "final"
        ]
      },
      "ChannelReportModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "from": {
            "type": "string",
            "minLength": 1
          },
          "to": {
            "type": "string",
            "minLength": 1
          },
          "channels": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ChannelReportRowModel"
            }
          },
          "totals": {
            "$ref": "#/components/schemas/ChannelReportTotalsModel"
          }
        },
        "required": [
          "object",
          "livemode",
          "currency",
          "from",
          "to",
          "channels",
          "totals"
        ]
      },
      "ChannelReportRowModel": {
        "type": "object",
        "properties": {
          "orders": {
            "type": "integer"
          },
          "units": {
            "type": "integer"
          },
          "gross": {
            "type": "integer"
          },
          "discounts": {
            "type": "integer"
          },
          "refunds": {
            "type": "integer"
          },
          "channel_fees": {
            "$ref": "#/components/schemas/ChannelFeesModel"
          },
          "net": {
            "type": "integer"
          },
          "channel": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "impressions": {
            "nullable": true,
            "type": "integer"
          },
          "clicks": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "orders",
          "units",
          "gross",
          "discounts",
          "refunds",
          "channel_fees",
          "net",
          "channel",
          "name",
          "impressions",
          "clicks"
        ]
      },
      "ChannelReportTotalsModel": {
        "type": "object",
        "properties": {
          "orders": {
            "type": "integer"
          },
          "units": {
            "type": "integer"
          },
          "gross": {
            "type": "integer"
          },
          "discounts": {
            "type": "integer"
          },
          "refunds": {
            "type": "integer"
          },
          "channel_fees": {
            "$ref": "#/components/schemas/ChannelFeesModel"
          },
          "net": {
            "type": "integer"
          }
        },
        "required": [
          "orders",
          "units",
          "gross",
          "discounts",
          "refunds",
          "channel_fees",
          "net"
        ]
      },
      "ChargeFeeBody": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "late_cancel",
              "no_show"
            ]
          },
          "amount": {
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          },
          "reason": {
            "type": "string",
            "maxLength": 300
          }
        }
      },
      "ChargeSavedBody": {
        "type": "object",
        "properties": {
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "payment_method": {
            "type": "string"
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "description": {
            "type": "string",
            "maxLength": 500
          },
          "statement_descriptor_suffix": {
            "type": "string",
            "maxLength": 22
          },
          "receipt_email": {
            "type": "string",
            "maxLength": 320
          },
          "metadata": {
            "type": "object"
          },
          "application_fee_amount": {
            "type": "integer",
            "description": "The platform's fee in minor units, made as its connected account (`Tuppence-Account`): at most 20% of the amount, rounded down, unless Tuppence raised the platform's cap (`400 application_fee_too_high`), and no more than our fee leaves (checked at confirm).",
            "minimum": 0,
            "multipleOf": 1
          }
        },
        "required": [
          "customer",
          "amount",
          "currency"
        ]
      },
      "CheckInCountsModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "event": {
            "type": "string",
            "minLength": 1
          },
          "issued": {
            "type": "integer"
          },
          "checked_in": {
            "type": "integer"
          },
          "gates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CheckInGateCountModel"
            }
          },
          "ticket_types": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CheckInTypeCountModel"
            }
          },
          "last_scan_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "object",
          "event",
          "issued",
          "checked_in",
          "gates",
          "ticket_types",
          "last_scan_at"
        ]
      },
      "CheckInEventList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CheckInEventModel"
            }
          }
        },
        "required": [
          "object",
          "data"
        ]
      },
      "CheckInEventModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "starts_at": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "title",
          "status",
          "starts_at"
        ]
      },
      "CheckInFirstModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "gate": {
            "type": "string",
            "minLength": 1
          },
          "device": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "scanned_at": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "gate",
          "device",
          "scanned_at"
        ]
      },
      "CheckInGateCountModel": {
        "type": "object",
        "properties": {
          "gate": {
            "type": "string",
            "minLength": 1
          },
          "admitted": {
            "type": "integer"
          },
          "duplicates": {
            "type": "integer"
          }
        },
        "required": [
          "gate",
          "admitted",
          "duplicates"
        ]
      },
      "CheckInList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CheckInModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "CheckInManifestModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "event": {
            "type": "string",
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "verification_key": {
            "type": "string",
            "minLength": 1
          },
          "generated_at": {
            "type": "integer"
          },
          "refresh_after": {
            "type": "integer"
          },
          "gates": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "dates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ManifestDateModel"
            }
          },
          "ticket_types": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ManifestTypeModel"
            }
          },
          "tickets": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ManifestTicketModel"
            }
          }
        },
        "required": [
          "object",
          "livemode",
          "event",
          "title",
          "verification_key",
          "generated_at",
          "refresh_after",
          "gates",
          "dates",
          "ticket_types",
          "tickets"
        ]
      },
      "CheckInModel": {
        "type": "object",
        "properties": {
          "id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "result": {
            "type": "string",
            "minLength": 1
          },
          "reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "ticket": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "event": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "date": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "ticket_type": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "ticket_type_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "holder_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "hand_over": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "short_code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "gate": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "device": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "method": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "scanned_at": {
            "nullable": true,
            "type": "integer"
          },
          "offline": {
            "type": "boolean"
          },
          "first": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CheckInFirstModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "result",
          "reason",
          "ticket",
          "event",
          "date",
          "ticket_type",
          "ticket_type_name",
          "holder_name",
          "hand_over",
          "short_code",
          "gate",
          "device",
          "method",
          "scanned_at",
          "offline",
          "first"
        ]
      },
      "CheckInScanBody": {
        "type": "object",
        "properties": {
          "id": {
            "nullable": true,
            "type": "string"
          },
          "code": {
            "nullable": true,
            "type": "string"
          },
          "short_code": {
            "nullable": true,
            "type": "string"
          },
          "ticket": {
            "nullable": true,
            "type": "string"
          },
          "event": {
            "nullable": true,
            "type": "string"
          },
          "gate": {
            "nullable": true,
            "type": "string"
          },
          "device": {
            "nullable": true,
            "type": "string"
          },
          "scanned_at": {
            "nullable": true,
            "type": "integer",
            "multipleOf": 1
          },
          "offline": {
            "type": "boolean"
          }
        }
      },
      "CheckInSyncBody": {
        "type": "object",
        "properties": {
          "scans": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CheckInScanBody"
            },
            "maxItems": 500
          }
        },
        "required": [
          "scans"
        ]
      },
      "CheckInSyncModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CheckInModel"
            }
          }
        },
        "required": [
          "object",
          "data"
        ]
      },
      "CheckInTypeCountModel": {
        "type": "object",
        "properties": {
          "ticket_type": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "issued": {
            "type": "integer"
          },
          "checked_in": {
            "type": "integer"
          }
        },
        "required": [
          "ticket_type",
          "name",
          "issued",
          "checked_in"
        ]
      },
      "CheckoutAddressModel": {
        "type": "object",
        "properties": {
          "name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "line1": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "line2": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "city": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "region": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "postcode": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "country": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "name",
          "line1",
          "line2",
          "city",
          "region",
          "postcode",
          "country"
        ]
      },
      "CheckoutContactModel": {
        "type": "object",
        "properties": {
          "email": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "phone": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "email",
          "phone",
          "name"
        ]
      },
      "CheckoutDeliveryModel": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "earliest": {
            "type": "string",
            "minLength": 1
          },
          "latest": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "key",
          "name",
          "kind",
          "amount",
          "earliest",
          "latest"
        ]
      },
      "CheckoutEventData": {
        "type": "object",
        "description": "What an event carrying a `checkout` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/CheckoutEventObject"
          }
        }
      },
      "CheckoutEventObject": {
        "type": "object",
        "description": "A `checkout` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "checkout"
          }
        },
        "additionalProperties": true
      },
      "CheckoutMarketingConsentModel": {
        "type": "object",
        "properties": {
          "given": {
            "type": "boolean"
          },
          "text": {
            "type": "string",
            "minLength": 1
          },
          "at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "given",
          "text",
          "at"
        ]
      },
      "CheckoutModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "cart": {
            "type": "string",
            "minLength": 1
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "attempt": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "presented_to": {
            "type": "string",
            "minLength": 1
          },
          "protocol": {
            "type": "string",
            "minLength": 1
          },
          "agent_session": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "contact": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CheckoutContactModel"
              }
            ],
            "nullable": true
          },
          "shipping_address": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CheckoutAddressModel"
              }
            ],
            "nullable": true
          },
          "billing_address": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CheckoutAddressModel"
              }
            ],
            "nullable": true
          },
          "delivery": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CheckoutDeliveryModel"
              }
            ],
            "nullable": true
          },
          "collection_slot": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "collection_slots": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CollectionSlotModel"
            }
          },
          "marketing_consent": {
            "$ref": "#/components/schemas/CheckoutMarketingConsentModel"
          },
          "note": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "snapshot": {
            "$ref": "#/components/schemas/CheckoutSnapshotModel"
          },
          "snapshot_sha256": {
            "type": "string",
            "minLength": 1
          },
          "digital_consent_text": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "age_declaration_text": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "age_declared": {
            "type": "boolean"
          },
          "expires_at": {
            "type": "integer"
          },
          "completed_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "cart",
          "site",
          "attempt",
          "status",
          "presented_to",
          "protocol",
          "agent_session",
          "contact",
          "shipping_address",
          "billing_address",
          "delivery",
          "collection_slot",
          "collection_slots",
          "marketing_consent",
          "note",
          "snapshot",
          "snapshot_sha256",
          "digital_consent_text",
          "age_declaration_text",
          "age_declared",
          "expires_at",
          "completed_at",
          "created"
        ]
      },
      "CheckoutSnapshotModel": {
        "type": "object",
        "properties": {
          "shown_at": {
            "type": "integer"
          },
          "locale": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SnapshotLineModel"
            }
          },
          "delivery": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CheckoutDeliveryModel"
              }
            ],
            "nullable": true
          },
          "discounts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SnapshotDiscountModel"
            }
          },
          "gift_cards": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SnapshotGiftCardModel"
            }
          },
          "tax_lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SnapshotTaxLineModel"
            }
          },
          "prices_include_tax": {
            "type": "boolean"
          },
          "tax_notice": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "paid_on_delivery": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "subtotal": {
            "type": "integer"
          },
          "discount": {
            "type": "integer"
          },
          "delivery_amount": {
            "type": "integer"
          },
          "tax": {
            "type": "integer"
          },
          "total": {
            "type": "integer"
          },
          "due": {
            "type": "integer"
          },
          "trader": {
            "$ref": "#/components/schemas/SnapshotTraderModel"
          },
          "terms_version": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "cancellation": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/SnapshotCancellationModel"
              }
            ],
            "nullable": true
          },
          "returns_policy_version": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "digital_consent": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/SnapshotDigitalConsentModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "shown_at",
          "locale",
          "currency",
          "lines",
          "delivery",
          "discounts",
          "gift_cards",
          "tax_lines",
          "prices_include_tax",
          "tax_notice",
          "paid_on_delivery",
          "subtotal",
          "discount",
          "delivery_amount",
          "tax",
          "total",
          "due",
          "trader",
          "terms_version",
          "cancellation",
          "returns_policy_version",
          "digital_consent"
        ]
      },
      "ClaimsCheckModel": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "pass",
              "blocked",
              "checking",
              "rules_only"
            ],
            "minLength": 1
          },
          "lexicon_version": {
            "type": "string",
            "minLength": 1
          },
          "model": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "checked_at": {
            "type": "integer"
          },
          "sentences": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ClaimsSentenceModel"
            }
          }
        },
        "required": [
          "status",
          "lexicon_version",
          "model",
          "checked_at",
          "sentences"
        ]
      },
      "ClaimsSentenceModel": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "minLength": 1
          },
          "text": {
            "type": "string",
            "minLength": 1
          },
          "verdict": {
            "type": "string",
            "enum": [
              "supported",
              "not_a_claim",
              "unsupported",
              "regulated",
              "unchecked"
            ],
            "minLength": 1
          },
          "terms": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "needs": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "needs_kind": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "confirm_fact_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "fact_ids": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "reason": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "field",
          "text",
          "verdict",
          "terms",
          "needs",
          "needs_kind",
          "confirm_fact_id",
          "fact_ids",
          "reason"
        ]
      },
      "ClassSessionBody": {
        "type": "object",
        "properties": {
          "service": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "staff_member": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "location": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "resource": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "starts_at": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "capacity": {
            "type": "integer"
          }
        },
        "required": [
          "service",
          "staff_member",
          "location",
          "starts_at"
        ]
      },
      "ClassSessionCancelBody": {
        "type": "object",
        "properties": {
          "reason": {
            "nullable": true,
            "type": "string",
            "maxLength": 300
          }
        }
      },
      "ClassSessionList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ClassSessionModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ClassSessionModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "service": {
            "type": "string",
            "minLength": 1
          },
          "staff_member": {
            "type": "string",
            "minLength": 1
          },
          "resource": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "timezone": {
            "type": "string",
            "minLength": 1
          },
          "starts_at": {
            "type": "string",
            "minLength": 1
          },
          "ends_at": {
            "type": "string",
            "minLength": 1
          },
          "capacity": {
            "type": "integer"
          },
          "booked": {
            "type": "integer"
          },
          "seats_left": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "series": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "service",
          "staff_member",
          "resource",
          "location",
          "timezone",
          "starts_at",
          "ends_at",
          "capacity",
          "booked",
          "seats_left",
          "status",
          "series",
          "created"
        ]
      },
      "ClassSessionUpdateBody": {
        "type": "object",
        "properties": {
          "capacity": {
            "type": "integer"
          }
        }
      },
      "ClientSubjectList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ClientSubjectModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ClientSubjectModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "fields": {
            "nullable": true
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          },
          "updated": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "customer",
          "kind",
          "name",
          "fields",
          "status",
          "created",
          "updated"
        ],
        "example": {
          "id": "csub_01J8ZK1Q9H2B4C6D8E0F2G4H6P",
          "object": "client_subject",
          "customer": "cus_01J8ZK1Q9H2B4C6D8E0F2G4H6J",
          "kind": "pet",
          "name": "Milo",
          "fields": {
            "species": "Dog",
            "breed": "Cockapoo",
            "size": "medium",
            "vaccinated_on": "2026-03-01"
          },
          "status": "active",
          "created": 1789990000,
          "updated": 1789990000
        }
      },
      "ClientsModel": {
        "type": "object",
        "properties": {
          "clients": {
            "type": "integer"
          },
          "new": {
            "type": "integer"
          },
          "returning": {
            "type": "integer"
          }
        },
        "required": [
          "clients",
          "new",
          "returning"
        ]
      },
      "CloseBody": {
        "type": "object",
        "properties": {
          "note": {
            "type": "string",
            "maxLength": 1000
          },
          "outcome": {
            "type": "string",
            "enum": [
              "won",
              "lost",
              "expired"
            ]
          },
          "location": {
            "type": "string",
            "maxLength": 40
          },
          "kind": {
            "type": "string",
            "enum": [
              "day",
              "month",
              "year"
            ]
          },
          "period": {
            "type": "string",
            "maxLength": 10
          }
        }
      },
      "CloseDayBody": {
        "type": "object",
        "properties": {
          "location": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          }
        }
      },
      "CloseDayModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "day": {
            "type": "string",
            "minLength": 1
          },
          "manifests": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShippingManifestModel"
            }
          },
          "not_needed": {
            "type": "integer"
          },
          "unavailable": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ManifestUnavailableModel"
            }
          }
        },
        "required": [
          "object",
          "location",
          "day",
          "manifests",
          "not_needed",
          "unavailable"
        ]
      },
      "CloseDisputeBody": {
        "type": "object",
        "properties": {
          "outcome": {
            "type": "string",
            "enum": [
              "won",
              "lost"
            ],
            "minLength": 1
          }
        },
        "required": [
          "outcome"
        ]
      },
      "CloseShiftBody": {
        "type": "object",
        "properties": {
          "counted": {
            "$ref": "#/components/schemas/CountedBody"
          },
          "note": {
            "type": "string",
            "maxLength": 500
          }
        }
      },
      "CollectBody": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "maxLength": 500
          }
        }
      },
      "CollectionBody": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "maxLength": 120
          },
          "slug": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          },
          "web_path": {
            "nullable": true,
            "type": "string",
            "maxLength": 400
          },
          "description": {
            "nullable": true
          },
          "kind": {
            "type": "string",
            "maxLength": 8
          },
          "products": {
            "nullable": true
          },
          "rules": {
            "nullable": true
          },
          "sort": {
            "type": "string",
            "maxLength": 16
          },
          "image": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "seo": {
            "nullable": true
          },
          "status": {
            "type": "string",
            "maxLength": 12
          },
          "published": {
            "type": "boolean"
          }
        },
        "example": {
          "title": "Candles",
          "kind": "rule",
          "rules": {
            "match": "all",
            "conditions": [
              {
                "field": "category",
                "op": "eq",
                "value": "Candles"
              }
            ]
          },
          "sort": "best_selling",
          "status": "active",
          "published": true
        }
      },
      "CollectionConditionModel": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "minLength": 1
          },
          "op": {
            "type": "string",
            "enum": [
              "eq",
              "neq",
              "gt",
              "gte",
              "lt",
              "lte",
              "in",
              "contains"
            ],
            "minLength": 1
          },
          "value": {
            "nullable": true
          }
        },
        "required": [
          "field",
          "op",
          "value"
        ]
      },
      "CollectionEventData": {
        "type": "object",
        "description": "What an event carrying a `collection` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/CollectionEventObject"
          }
        }
      },
      "CollectionEventObject": {
        "type": "object",
        "description": "A `collection` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "collection"
          }
        },
        "additionalProperties": true
      },
      "CollectionList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CollectionModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "CollectionModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "slug": {
            "type": "string",
            "minLength": 1
          },
          "web_path": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "description": {
            "nullable": true
          },
          "kind": {
            "type": "string",
            "enum": [
              "manual",
              "rule"
            ],
            "minLength": 1
          },
          "products": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "rules": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CollectionRulesModel"
              }
            ],
            "nullable": true
          },
          "sort": {
            "type": "string",
            "enum": [
              "manual",
              "best_selling",
              "newest",
              "price_asc",
              "price_desc",
              "ai"
            ],
            "minLength": 1
          },
          "image": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "seo": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ProductSeoModel"
              }
            ],
            "nullable": true
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ],
            "minLength": 1
          },
          "published": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "updated": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "title",
          "slug",
          "web_path",
          "description",
          "kind",
          "products",
          "rules",
          "sort",
          "image",
          "seo",
          "status",
          "published",
          "created",
          "updated"
        ],
        "example": {
          "id": "coll_01K7HB4D6F8H0K2M4P6R8T0V2X",
          "object": "collection",
          "livemode": false,
          "title": "Candles",
          "slug": "candles",
          "web_path": "/collections/candles",
          "description": "Hand-poured soy candles, scented with the coast.",
          "kind": "rule",
          "products": [
            "prod_01K7HB2M4N6P8Q0R2S4T6V8W0X"
          ],
          "rules": {
            "match": "all",
            "conditions": [
              {
                "field": "category",
                "op": "eq",
                "value": "Candles"
              }
            ]
          },
          "sort": "best_selling",
          "image": "med_01K7HB3A5C7E9G1J3L5N7Q9S1U",
          "seo": {
            "title": "Candles",
            "description": "Hand-poured soy candles from Whitby."
          },
          "status": "active",
          "published": true,
          "created": 1791720000,
          "updated": 1792310400
        }
      },
      "CollectionOptionsBody": {
        "type": "object",
        "properties": {
          "fields": {
            "type": "string",
            "enum": [
              "currently_due",
              "eventually_due"
            ]
          },
          "future_requirements": {
            "type": "string",
            "enum": [
              "omit",
              "include"
            ]
          }
        }
      },
      "CollectionRulesModel": {
        "type": "object",
        "properties": {
          "match": {
            "type": "string",
            "enum": [
              "all",
              "any"
            ],
            "minLength": 1
          },
          "conditions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CollectionConditionModel"
            }
          }
        },
        "required": [
          "match",
          "conditions"
        ]
      },
      "CollectionSlotModel": {
        "type": "object",
        "properties": {
          "slot": {
            "type": "string",
            "minLength": 1
          },
          "date": {
            "type": "string",
            "minLength": 1
          },
          "from": {
            "type": "string",
            "minLength": 1
          },
          "to": {
            "type": "string",
            "minLength": 1
          },
          "left": {
            "type": "integer"
          }
        },
        "required": [
          "slot",
          "date",
          "from",
          "to",
          "left"
        ]
      },
      "CollectionSlotsBody": {
        "type": "object",
        "properties": {
          "slot_minutes": {
            "type": "integer",
            "multipleOf": 1
          },
          "capacity": {
            "type": "integer",
            "multipleOf": 1
          },
          "lead_minutes": {
            "type": "integer",
            "multipleOf": 1
          },
          "days_ahead": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "slot_minutes",
          "capacity"
        ]
      },
      "CollectionSlotsSettingsModel": {
        "type": "object",
        "properties": {
          "slot_minutes": {
            "type": "integer"
          },
          "capacity": {
            "type": "integer"
          },
          "lead_minutes": {
            "type": "integer"
          },
          "days_ahead": {
            "type": "integer"
          }
        },
        "required": [
          "slot_minutes",
          "capacity",
          "lead_minutes",
          "days_ahead"
        ]
      },
      "CommissionOverrideModel": {
        "type": "object",
        "properties": {
          "service": {
            "type": "string",
            "minLength": 1
          },
          "percent_bps": {
            "type": "integer"
          }
        },
        "required": [
          "service",
          "percent_bps"
        ]
      },
      "CommissionProductLineModel": {
        "type": "object",
        "properties": {
          "product": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "count": {
            "type": "integer"
          },
          "revenue": {
            "type": "integer"
          }
        },
        "required": [
          "product",
          "name",
          "count",
          "revenue"
        ]
      },
      "CommissionReportModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "period": {
            "type": "string",
            "minLength": 1
          },
          "from": {
            "type": "string",
            "minLength": 1
          },
          "to": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "totals": {
            "$ref": "#/components/schemas/CommissionTotalsModel"
          },
          "staff": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CommissionStaffModel"
            }
          }
        },
        "required": [
          "object",
          "livemode",
          "period",
          "from",
          "to",
          "currency",
          "totals",
          "staff"
        ]
      },
      "CommissionRuleBody": {
        "type": "object",
        "properties": {
          "staff_member": {
            "type": "string",
            "maxLength": 40
          },
          "percent_bps": {
            "type": "integer"
          },
          "tiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CommissionTierModel"
            }
          },
          "service_overrides": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CommissionOverrideModel"
            }
          },
          "effective_from": {
            "type": "string",
            "maxLength": 7
          }
        }
      },
      "CommissionRuleList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CommissionRuleModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "CommissionRuleModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "staff_member": {
            "type": "string",
            "minLength": 1
          },
          "effective_from": {
            "type": "string",
            "minLength": 1
          },
          "percent_bps": {
            "type": "integer"
          },
          "tiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CommissionTierModel"
            }
          },
          "service_overrides": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CommissionOverrideModel"
            }
          },
          "created_by": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "staff_member",
          "effective_from",
          "percent_bps",
          "tiers",
          "service_overrides",
          "created_by",
          "created"
        ]
      },
      "CommissionServiceLineModel": {
        "type": "object",
        "properties": {
          "service": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "count": {
            "type": "integer"
          },
          "revenue": {
            "type": "integer"
          },
          "commission": {
            "type": "integer"
          }
        },
        "required": [
          "service",
          "name",
          "count",
          "revenue",
          "commission"
        ]
      },
      "CommissionStaffModel": {
        "type": "object",
        "properties": {
          "staff_member": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "rule": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "bookings": {
            "type": "integer"
          },
          "revenue": {
            "type": "integer"
          },
          "commission": {
            "type": "integer"
          },
          "tips": {
            "type": "integer"
          },
          "services": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CommissionServiceLineModel"
            }
          },
          "products": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CommissionProductLineModel"
            }
          }
        },
        "required": [
          "staff_member",
          "name",
          "rule",
          "bookings",
          "revenue",
          "commission",
          "tips",
          "services",
          "products"
        ]
      },
      "CommissionTierModel": {
        "type": "object",
        "properties": {
          "above": {
            "type": "integer"
          },
          "percent_bps": {
            "type": "integer"
          }
        },
        "required": [
          "above",
          "percent_bps"
        ]
      },
      "CommissionTotalsModel": {
        "type": "object",
        "properties": {
          "bookings": {
            "type": "integer"
          },
          "revenue": {
            "type": "integer"
          },
          "commission": {
            "type": "integer"
          },
          "tips": {
            "type": "integer"
          }
        },
        "required": [
          "bookings",
          "revenue",
          "commission",
          "tips"
        ]
      },
      "CompanyVerificationBody": {
        "type": "object",
        "properties": {
          "document": {
            "$ref": "#/components/schemas/PersonDocumentBody"
          }
        }
      },
      "CompleteBody": {
        "type": "object",
        "properties": {
          "receipt": {
            "type": "string",
            "enum": [
              "print",
              "email",
              "sms",
              "qr",
              "none"
            ]
          },
          "recipient": {
            "type": "string",
            "maxLength": 320
          },
          "customer_details": {
            "$ref": "#/components/schemas/ReceiptCustomerDetailsBody"
          },
          "totals": {
            "$ref": "#/components/schemas/TotalsBody"
          }
        }
      },
      "ConfirmBookingBody": {
        "type": "object",
        "properties": {
          "customer": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "client": {
            "$ref": "#/components/schemas/BookingClientBody"
          },
          "client_notes": {
            "nullable": true,
            "type": "string",
            "maxLength": 1000
          },
          "internal_notes": {
            "nullable": true,
            "type": "string",
            "maxLength": 2000
          },
          "metadata": {
            "type": "object"
          }
        }
      },
      "ConfirmPaymentBody": {
        "type": "object",
        "properties": {
          "confirmation_token": {
            "type": "string"
          },
          "payment_method": {
            "type": "string"
          },
          "return_url": {
            "type": "string",
            "maxLength": 2048
          }
        }
      },
      "Conflict": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "description": "The error name",
            "example": "CONFLICT",
            "default": "CONFLICT"
          },
          "message": {
            "type": "string",
            "minLength": 1,
            "description": "An error message"
          },
          "status": {
            "type": "integer",
            "description": "The status code of the exception",
            "example": 409,
            "default": 409
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GenericError"
            },
            "description": "A list of related errors"
          },
          "stack": {
            "type": "string",
            "description": "The stack trace (only in development mode)"
          }
        },
        "required": [
          "name",
          "message",
          "status"
        ]
      },
      "ConnectAccountDeletedModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "deleted": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "object",
          "deleted"
        ]
      },
      "ConnectAccountList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ConnectAccountModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ConnectAccountModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "platform": {
            "type": "string",
            "minLength": 1
          },
          "email": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "business_type": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "country": {
            "type": "string",
            "description": "The connected account's country (ISO 3166-1 alpha-2), fixed when it is created: one of its platform's region's countries.",
            "minLength": 1
          },
          "default_currency": {
            "type": "string",
            "minLength": 1
          },
          "region": {
            "type": "string",
            "description": "Always its platform's region: `gb`, `us` or `eu`. Fixed when it is created.",
            "enum": [
              "gb",
              "us",
              "eu"
            ],
            "minLength": 1
          },
          "business_profile": {
            "$ref": "#/components/schemas/AccountBusinessProfileModel"
          },
          "company": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/AccountCompanyModel"
              }
            ],
            "nullable": true
          },
          "capabilities": {
            "$ref": "#/components/schemas/AccountCapabilitiesModel"
          },
          "charges_enabled": {
            "type": "boolean"
          },
          "payouts_enabled": {
            "type": "boolean"
          },
          "details_submitted": {
            "type": "boolean"
          },
          "controller": {
            "$ref": "#/components/schemas/AccountControllerModel"
          },
          "requirements": {
            "$ref": "#/components/schemas/AccountRequirementsModel"
          },
          "future_requirements": {
            "$ref": "#/components/schemas/AccountFutureRequirementsModel"
          },
          "settings": {
            "$ref": "#/components/schemas/AccountSettingsModel"
          },
          "tos_acceptance": {
            "$ref": "#/components/schemas/AccountTosAcceptanceModel"
          },
          "onboarding_status": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "rejected_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "metadata": {
            "type": "object"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "created",
          "platform",
          "email",
          "business_type",
          "country",
          "default_currency",
          "region",
          "business_profile",
          "company",
          "capabilities",
          "charges_enabled",
          "payouts_enabled",
          "details_submitted",
          "controller",
          "requirements",
          "future_requirements",
          "settings",
          "tos_acceptance",
          "onboarding_status",
          "status",
          "rejected_reason",
          "metadata"
        ]
      },
      "ConnectBalanceModel": {
        "type": "object",
        "properties": {
          "available": {
            "type": "integer"
          },
          "pending": {
            "type": "integer"
          },
          "sweeping": {
            "type": "integer"
          },
          "next_sweep": {
            "type": "integer"
          }
        },
        "required": [
          "available",
          "pending",
          "sweeping",
          "next_sweep"
        ]
      },
      "ConnectCarrierAccountBody": {
        "type": "object",
        "properties": {
          "carrier": {
            "type": "string",
            "maxLength": 30,
            "minLength": 1
          },
          "label": {
            "type": "string",
            "maxLength": 80
          },
          "fields": {
            "$ref": "#/components/schemas/CarrierAccountFieldsModel"
          },
          "fallback_to_balance": {
            "type": "boolean"
          }
        },
        "required": [
          "carrier",
          "fields"
        ]
      },
      "ConnectStoreModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "site": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "address": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "month": {
            "$ref": "#/components/schemas/ConnectStoreMonthModel"
          }
        },
        "required": [
          "object",
          "account",
          "livemode",
          "site",
          "address",
          "status",
          "currency",
          "month"
        ]
      },
      "ConnectStoreMonthModel": {
        "type": "object",
        "properties": {
          "start": {
            "type": "integer",
            "multipleOf": 1
          },
          "orders": {
            "type": "integer",
            "multipleOf": 1
          },
          "revenue": {
            "type": "integer",
            "multipleOf": 1
          },
          "application_fees": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "start",
          "orders",
          "revenue",
          "application_fees"
        ]
      },
      "ConnectStoreSettingsBody": {
        "type": "object",
        "properties": {
          "application_fee": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ApplicationFeesBody"
              }
            ],
            "nullable": true
          }
        }
      },
      "ConnectedAccountCashbackList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ConnectedAccountCashbackModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ConnectedAccountCashbackModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "period": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "eligible_spend": {
            "type": "integer"
          },
          "rate_bps": {
            "type": "integer"
          },
          "earned": {
            "type": "integer"
          },
          "share_bps": {
            "type": "integer"
          },
          "passed_on": {
            "type": "integer"
          },
          "kept": {
            "type": "integer"
          },
          "provisional": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "account",
          "name",
          "period",
          "currency",
          "eligible_spend",
          "rate_bps",
          "earned",
          "share_bps",
          "passed_on",
          "kept",
          "provisional"
        ]
      },
      "ConsentBody": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string"
          },
          "granted": {
            "type": "boolean"
          }
        },
        "required": [
          "granted"
        ]
      },
      "ConsentList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ConsentModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ConsentModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "granted": {
            "type": "boolean"
          },
          "wording_version": {
            "nullable": true,
            "type": "integer"
          },
          "wording": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "source": {
            "type": "string",
            "minLength": 1
          },
          "ip": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "register": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "customer",
          "kind",
          "granted",
          "wording_version",
          "wording",
          "source",
          "ip",
          "register",
          "staff_member",
          "created"
        ]
      },
      "ControllerBody": {
        "type": "object",
        "properties": {
          "fees": {
            "$ref": "#/components/schemas/FeesBody"
          },
          "losses": {
            "$ref": "#/components/schemas/LossesBody"
          },
          "requirement_collection": {
            "type": "string",
            "enum": [
              "application",
              "stripe"
            ]
          },
          "dashboard": {
            "$ref": "#/components/schemas/DashboardBody"
          }
        }
      },
      "ControllerDashboardModel": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "type"
        ]
      },
      "ControllerFeesModel": {
        "type": "object",
        "properties": {
          "payer": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "payer"
        ]
      },
      "ControllerLossesModel": {
        "type": "object",
        "properties": {
          "payments": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "payments"
        ]
      },
      "CountedBody": {
        "type": "object",
        "properties": {
          "denominations": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DenominationBody"
            }
          },
          "total": {
            "type": "integer"
          }
        }
      },
      "CountryPackModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "id": {
            "type": "string",
            "minLength": 1
          },
          "country": {
            "type": "string",
            "minLength": 1
          },
          "region": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "regions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "version": {
            "type": "string",
            "minLength": 1
          },
          "launched": {
            "type": "boolean"
          },
          "sources": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "tax": {
            "$ref": "#/components/schemas/TaxSectionModel"
          },
          "location_defaults": {
            "$ref": "#/components/schemas/LocationTaxDefaultsModel"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "locale": {
            "type": "string",
            "minLength": 1
          },
          "locales": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "units": {
            "type": "string",
            "minLength": 1
          },
          "week_start": {
            "type": "string",
            "minLength": 1
          },
          "day_cutoff": {
            "type": "string",
            "minLength": 1
          },
          "fiscal_regime": {
            "type": "string",
            "minLength": 1
          },
          "fiscal_regime_scope": {
            "type": "string"
          },
          "retention_years": {
            "type": "integer",
            "multipleOf": 1
          },
          "receipt": {
            "nullable": true
          },
          "cash": {
            "nullable": true
          },
          "conventions": {
            "nullable": true
          },
          "ages": {
            "nullable": true
          },
          "allergens": {
            "nullable": true
          },
          "deposits": {
            "nullable": true
          },
          "gift_cards": {
            "nullable": true
          },
          "consent": {
            "nullable": true
          },
          "meal_vouchers": {
            "nullable": true
          },
          "local_schemes": {
            "type": "array",
            "items": {
              "nullable": true
            }
          },
          "contactless_limit": {
            "nullable": true
          },
          "notes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "unverified": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UnverifiedItemModel"
            }
          }
        },
        "required": [
          "object",
          "id",
          "country",
          "region",
          "regions",
          "name",
          "version",
          "launched",
          "sources",
          "tax",
          "location_defaults",
          "currency",
          "locale",
          "locales",
          "units",
          "week_start",
          "day_cutoff",
          "fiscal_regime",
          "retention_years",
          "receipt",
          "cash",
          "conventions",
          "ages",
          "allergens",
          "deposits",
          "gift_cards",
          "consent",
          "meal_vouchers",
          "local_schemes",
          "contactless_limit",
          "unverified"
        ]
      },
      "CountrySpecList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CountrySpecModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "CountrySpecModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "default_currency": {
            "type": "string",
            "minLength": 1
          },
          "supported_bank_account_currencies": {
            "type": "object"
          },
          "supported_payment_currencies": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "supported_payment_methods": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "supported_transfer_countries": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "verification_fields": {
            "$ref": "#/components/schemas/VerificationFieldsModel"
          }
        },
        "required": [
          "id",
          "object",
          "default_currency",
          "supported_bank_account_currencies",
          "supported_payment_currencies",
          "supported_payment_methods",
          "supported_transfer_countries",
          "verification_fields"
        ]
      },
      "CouponList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CouponModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "CouponModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "percent_off": {
            "nullable": true,
            "type": "integer"
          },
          "amount_off": {
            "nullable": true,
            "type": "integer"
          },
          "currency": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "duration": {
            "type": "string",
            "enum": [
              "once",
              "repeating",
              "forever"
            ],
            "minLength": 1
          },
          "duration_in_periods": {
            "nullable": true,
            "type": "integer"
          },
          "max_redemptions": {
            "nullable": true,
            "type": "integer"
          },
          "times_redeemed": {
            "type": "integer"
          },
          "redeem_by": {
            "nullable": true,
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ],
            "minLength": 1
          },
          "metadata": {
            "type": "object"
          },
          "created": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "name",
          "percent_off",
          "amount_off",
          "currency",
          "duration",
          "duration_in_periods",
          "max_redemptions",
          "times_redeemed",
          "redeem_by",
          "status",
          "metadata",
          "created"
        ]
      },
      "CoverageModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "covered": {
            "type": "boolean"
          },
          "reason": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "location",
          "covered",
          "reason"
        ]
      },
      "CreateAccountLinkBody": {
        "type": "object",
        "properties": {
          "account": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "type": {
            "type": "string",
            "enum": [
              "account_onboarding",
              "account_update"
            ],
            "minLength": 1
          },
          "refresh_url": {
            "type": "string",
            "maxLength": 2048,
            "minLength": 1
          },
          "return_url": {
            "type": "string",
            "maxLength": 2048,
            "minLength": 1
          },
          "collection_options": {
            "$ref": "#/components/schemas/CollectionOptionsBody"
          }
        },
        "required": [
          "account",
          "type",
          "refresh_url",
          "return_url"
        ]
      },
      "CreateBookingBody": {
        "type": "object",
        "properties": {
          "location": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingItemBody"
            }
          },
          "class_session": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "starts_at": {
            "type": "string",
            "maxLength": 40
          },
          "group_size": {
            "type": "integer"
          },
          "metadata": {
            "type": "object"
          },
          "customer": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "client": {
            "$ref": "#/components/schemas/BookingClientBody"
          },
          "client_notes": {
            "nullable": true,
            "type": "string",
            "maxLength": 1000
          },
          "internal_notes": {
            "nullable": true,
            "type": "string",
            "maxLength": 2000
          },
          "source": {
            "nullable": true,
            "type": "string",
            "maxLength": 20
          },
          "channel": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "subject": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          }
        },
        "required": [
          "location"
        ]
      },
      "CreateBookingPaymentBody": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "deposit",
              "balance",
              "full",
              "tip_only",
              "late_cancel_fee",
              "no_show_fee"
            ],
            "minLength": 1
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "tip_amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "description": {
            "type": "string",
            "maxLength": 500
          },
          "receipt_email": {
            "type": "string",
            "maxLength": 320
          },
          "metadata": {
            "type": "object"
          },
          "application_fee_amount": {
            "type": "integer",
            "description": "The platform's fee in minor units, made as its connected account (`Tuppence-Account`): at most 20% of the amount, rounded down, unless Tuppence raised the platform's cap (`400 application_fee_too_high`), and no more than our fee leaves (checked at confirm).",
            "minimum": 0,
            "multipleOf": 1
          }
        },
        "required": [
          "kind"
        ]
      },
      "CreateCardBody": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "virtual",
              "physical"
            ]
          },
          "shipping": {
            "$ref": "#/components/schemas/ShippingBody"
          },
          "agent": {
            "type": "string"
          },
          "cardholder": {
            "type": "string"
          },
          "usage": {
            "type": "string",
            "enum": [
              "standing",
              "single_use"
            ]
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "currency": {
            "type": "string",
            "description": "Your account's own currency (`gbp` in the UK, `usd` in the US), which is the default. Cards are issued in no other."
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "inactive"
            ]
          },
          "limits": {
            "$ref": "#/components/schemas/LimitsBody"
          },
          "merchant": {
            "$ref": "#/components/schemas/CardMerchantLockModel"
          },
          "spend_policy": {
            "nullable": true,
            "type": "string"
          },
          "metadata": {
            "type": "object"
          }
        }
      },
      "CreateCodeSectionBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 60
          },
          "title": {
            "type": "string",
            "maxLength": 120,
            "minLength": 1
          },
          "code": {
            "type": "string",
            "maxLength": 256000,
            "minLength": 1
          },
          "fallback": {
            "nullable": true
          }
        },
        "required": [
          "title",
          "code",
          "fallback"
        ]
      },
      "CreateConnectAccountBody": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "maxLength": 320
          },
          "business_type": {
            "type": "string",
            "enum": [
              "individual",
              "company"
            ]
          },
          "country": {
            "type": "string",
            "description": "Default: your own country. Any country of your platform's region: `GB` for a UK platform, `US` for a US one, any of the eurozone's 20 (`DE`, `FR`, `IE`…) for a European one. Another region's is refused with `country_not_supported`.",
            "maxLength": 2
          },
          "business_profile": {
            "$ref": "#/components/schemas/BusinessProfileBody"
          },
          "controller": {
            "$ref": "#/components/schemas/ControllerBody"
          },
          "capabilities": {
            "$ref": "#/components/schemas/CapabilitiesBody"
          },
          "settings": {
            "$ref": "#/components/schemas/SettingsBody"
          },
          "metadata": {
            "type": "object"
          },
          "company": {
            "$ref": "#/components/schemas/AccountCompanyBody"
          },
          "individual": {
            "$ref": "#/components/schemas/PersonBody"
          },
          "tos_acceptance": {
            "$ref": "#/components/schemas/TosAcceptanceBody"
          },
          "external_account": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/ExternalAccountDetailsBody"
              }
            ]
          }
        }
      },
      "CreateCouponBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 120
          },
          "percent_off": {
            "type": "integer",
            "multipleOf": 1
          },
          "amount_off": {
            "type": "integer",
            "multipleOf": 1
          },
          "currency": {
            "type": "string",
            "maxLength": 3
          },
          "duration": {
            "type": "string",
            "enum": [
              "once",
              "repeating",
              "forever"
            ],
            "minLength": 1
          },
          "duration_in_periods": {
            "type": "integer",
            "multipleOf": 1
          },
          "max_redemptions": {
            "type": "integer",
            "multipleOf": 1
          },
          "redeem_by": {
            "type": "integer",
            "multipleOf": 1
          },
          "metadata": {
            "type": "object"
          }
        },
        "required": [
          "duration"
        ]
      },
      "CreateCredentialBody": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "maxLength": 100
          },
          "public_key": {
            "type": "object"
          }
        }
      },
      "CreateExternalAccountBody": {
        "type": "object",
        "properties": {
          "external_account": {
            "anyOf": [
              {
                "type": "string",
                "minLength": 1
              },
              {
                "$ref": "#/components/schemas/ExternalAccountDetailsBody"
              }
            ]
          },
          "default_for_currency": {
            "type": "boolean"
          }
        },
        "required": [
          "external_account"
        ]
      },
      "CreateFormBody": {
        "type": "object",
        "properties": {
          "template": {
            "type": "string"
          },
          "name": {
            "type": "string",
            "maxLength": 121
          },
          "kind": {
            "type": "string"
          },
          "questions": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "attachment": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "valid_for_days": {
            "nullable": true,
            "type": "integer"
          },
          "clinical": {
            "type": "boolean"
          }
        }
      },
      "CreateFormResponseBody": {
        "type": "object",
        "properties": {
          "form": {
            "type": "string",
            "minLength": 1
          },
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "booking": {
            "nullable": true,
            "type": "string"
          },
          "answers": {
            "type": "object"
          },
          "signature": {
            "type": "string"
          },
          "signer_name": {
            "type": "string",
            "maxLength": 200
          },
          "result": {
            "type": "string"
          }
        },
        "required": [
          "form",
          "customer"
        ]
      },
      "CreateImportBody": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "services",
              "clients",
              "bookings",
              "staff",
              "time_off"
            ],
            "minLength": 1
          },
          "file": {
            "type": "string",
            "maxLength": 1000000,
            "minLength": 1
          },
          "filename": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          },
          "mapping": {
            "type": "object"
          },
          "date_order": {
            "type": "string",
            "enum": [
              "dmy",
              "mdy"
            ]
          },
          "source": {
            "type": "string",
            "enum": [
              "csv",
              "fresha",
              "booksy",
              "square",
              "vagaro",
              "treatwell"
            ]
          }
        },
        "required": [
          "kind",
          "file"
        ]
      },
      "CreateMandateBody": {
        "type": "object",
        "properties": {
          "agent": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "description": {
            "type": "string",
            "maxLength": 500,
            "minLength": 1
          },
          "limits": {
            "$ref": "#/components/schemas/MandateLimitsBody"
          },
          "customer": {
            "type": "string",
            "maxLength": 40
          },
          "expires_in_days": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "agent",
          "description",
          "limits"
        ]
      },
      "CreateMarketingCampaignBody": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "subject": {
            "nullable": true,
            "type": "string"
          },
          "heading": {
            "nullable": true,
            "type": "string"
          },
          "body": {
            "nullable": true,
            "type": "string"
          },
          "segment": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CampaignSegmentBody"
              }
            ],
            "nullable": true
          },
          "slot": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CampaignSlotBody"
              }
            ],
            "nullable": true
          },
          "cap": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "CreateMeterBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 60,
            "minLength": 1
          },
          "unit_amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "currency": {
            "type": "string"
          },
          "description": {
            "type": "string",
            "maxLength": 200
          }
        },
        "required": [
          "name",
          "unit_amount"
        ]
      },
      "CreateNoteBody": {
        "type": "object",
        "properties": {
          "body": {
            "type": "string",
            "maxLength": 5001,
            "minLength": 1
          },
          "visibility": {
            "type": "string"
          },
          "pinned": {
            "type": "boolean"
          }
        },
        "required": [
          "body"
        ]
      },
      "CreateOrderBody": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "maxLength": 40
          },
          "location": {
            "type": "string",
            "maxLength": 40
          },
          "register": {
            "type": "string",
            "maxLength": 40
          },
          "order_type": {
            "type": "string",
            "enum": [
              "eat_in",
              "takeaway",
              "delivery",
              "collection"
            ]
          },
          "lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OrderLineBody"
            }
          },
          "notes": {
            "nullable": true,
            "type": "string",
            "maxLength": 1000
          },
          "covers": {
            "nullable": true,
            "type": "integer"
          },
          "tab_name": {
            "nullable": true,
            "type": "string",
            "maxLength": 80
          },
          "metadata": {
            "type": "object"
          },
          "client_created_at": {
            "nullable": true,
            "type": "integer"
          },
          "created_offline": {
            "type": "boolean"
          },
          "sold_offline": {
            "type": "boolean"
          },
          "catalogue_version": {
            "type": "string",
            "maxLength": 40
          },
          "customer": {
            "type": "string",
            "maxLength": 40
          },
          "totals": {
            "$ref": "#/components/schemas/TotalsBody"
          }
        }
      },
      "CreatePackageBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 100,
            "minLength": 1
          },
          "service": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "sessions": {
            "type": "integer",
            "minimum": 2,
            "multipleOf": 1
          },
          "amount": {
            "type": "integer",
            "minimum": 100,
            "multipleOf": 1
          },
          "validity_days": {
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          },
          "offer_on_page": {
            "type": "boolean"
          }
        },
        "required": [
          "name",
          "service",
          "sessions",
          "amount"
        ]
      },
      "CreatePaymentBody": {
        "type": "object",
        "properties": {
          "receipt_email": {
            "type": "string",
            "maxLength": 320
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "capture_method": {
            "type": "string",
            "description": "`manual`: the payer's approval holds the money (`requires_capture`) until you capture it, within six days. Where your account can use it; otherwise refused `403 manual_capture_unavailable`, with `fix_url` to contact us.",
            "enum": [
              "automatic",
              "manual"
            ]
          },
          "customer": {
            "type": "string"
          },
          "description": {
            "type": "string",
            "maxLength": 500
          },
          "statement_descriptor_suffix": {
            "type": "string",
            "maxLength": 22
          },
          "metadata": {
            "type": "object"
          },
          "resource": {
            "type": "string",
            "maxLength": 500
          },
          "save_card": {
            "type": "string",
            "enum": [
              "off_session"
            ]
          },
          "mandate": {
            "$ref": "#/components/schemas/MandateTermsBody"
          },
          "application_fee_amount": {
            "type": "integer",
            "description": "The platform's fee in minor units, made as its connected account (`Tuppence-Account`): at most 20% of the amount, rounded down, unless Tuppence raised the platform's cap (`400 application_fee_too_high`), and no more than our fee leaves (checked at confirm).",
            "minimum": 0,
            "multipleOf": 1
          }
        },
        "required": [
          "amount",
          "currency"
        ]
      },
      "CreatePayoutBody": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "method": {
            "type": "string",
            "enum": [
              "standard",
              "instant"
            ]
          },
          "statement_descriptor": {
            "type": "string",
            "maxLength": 22
          }
        }
      },
      "CreatePlanBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 120,
            "minLength": 1
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "currency": {
            "type": "string",
            "maxLength": 3
          },
          "interval": {
            "type": "string",
            "enum": [
              "day",
              "week",
              "month",
              "year"
            ],
            "minLength": 1
          },
          "interval_count": {
            "type": "integer",
            "multipleOf": 1
          },
          "trial_days": {
            "type": "integer",
            "multipleOf": 1
          },
          "metadata": {
            "type": "object"
          },
          "entitlements": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PlanEntitlementsModel"
              }
            ],
            "nullable": true
          },
          "event_entitlements": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PlanEventEntitlementsBody"
              }
            ],
            "nullable": true
          },
          "offer_on_page": {
            "type": "boolean"
          },
          "application_fee_percent": {
            "type": "string",
            "description": "The platform's percentage of each payment, as a decimal string (`\"2.5\"`), set as its connected account: at most 20% unless Tuppence raised the platform's cap — over it is refused when it is set (`400 application_fee_too_high`)."
          }
        },
        "required": [
          "name",
          "amount",
          "interval"
        ]
      },
      "CreatePortalSessionBody": {
        "type": "object",
        "properties": {
          "customer": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "return_url": {
            "type": "string",
            "maxLength": 2048
          },
          "allowed_actions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "plans": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "customer"
        ]
      },
      "CreatePromoCodeBody": {
        "type": "object",
        "properties": {
          "coupon": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "code": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "max_redemptions": {
            "type": "integer",
            "multipleOf": 1
          },
          "expires_at": {
            "type": "integer",
            "multipleOf": 1
          },
          "first_time_only": {
            "type": "boolean"
          }
        },
        "required": [
          "coupon",
          "code"
        ]
      },
      "CreateRefundBody": {
        "type": "object",
        "properties": {
          "payment": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "reason": {
            "type": "string",
            "enum": [
              "duplicate",
              "fraudulent",
              "requested_by_customer"
            ]
          },
          "metadata": {
            "type": "object"
          },
          "refund_application_fee": {
            "type": "boolean"
          }
        },
        "required": [
          "payment"
        ]
      },
      "CreateSandboxBody": {
        "type": "object",
        "properties": {
          "pow": {
            "$ref": "#/components/schemas/SandboxPowBody"
          },
          "email": {
            "type": "string"
          },
          "business_name": {
            "type": "string"
          },
          "country": {
            "type": "string",
            "enum": [
              "GB",
              "US"
            ]
          },
          "agent": {
            "type": "string"
          }
        }
      },
      "CreateSetupSessionBody": {
        "type": "object",
        "properties": {
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "mandate": {
            "$ref": "#/components/schemas/CreateSetupSessionMandateBody"
          },
          "metadata": {
            "type": "object"
          }
        },
        "required": [
          "customer",
          "mandate"
        ]
      },
      "CreateSetupSessionMandateBody": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "minLength": 1
          },
          "max_amount": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "description"
        ]
      },
      "CreateStoreImportBody": {
        "type": "object",
        "properties": {
          "source": {
            "type": "string",
            "enum": [
              "shopify",
              "woocommerce",
              "squarespace",
              "wix",
              "etsy",
              "big_cartel",
              "square_online"
            ],
            "minLength": 1
          },
          "method": {
            "type": "string",
            "enum": [
              "api",
              "files"
            ]
          },
          "shop": {
            "nullable": true,
            "type": "string",
            "maxLength": 255
          },
          "credentials": {
            "nullable": true,
            "type": "string",
            "maxLength": 2000
          },
          "mapping": {
            "type": "object"
          }
        },
        "required": [
          "source"
        ]
      },
      "CreateSubjectBody": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "maxLength": 101,
            "minLength": 1
          },
          "fields": {
            "nullable": true
          }
        },
        "required": [
          "kind",
          "name"
        ]
      },
      "CreateSubscriptionBody": {
        "type": "object",
        "properties": {
          "customer": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "plan": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "payment_method": {
            "type": "string",
            "maxLength": 40
          },
          "metadata": {
            "type": "object"
          },
          "coupon": {
            "type": "string",
            "maxLength": 40
          },
          "promo_code": {
            "type": "string",
            "maxLength": 40
          }
        },
        "required": [
          "customer",
          "plan"
        ]
      },
      "CreateTransferBody": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "destination": {
            "type": "string",
            "minLength": 1
          },
          "description": {
            "type": "string",
            "maxLength": 500
          },
          "transfer_group": {
            "type": "string",
            "maxLength": 100
          },
          "metadata": {
            "type": "object"
          }
        },
        "required": [
          "amount",
          "currency",
          "destination"
        ]
      },
      "CreateVoucherBody": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "recipient": {
            "$ref": "#/components/schemas/VoucherRecipientBody"
          },
          "purchaser": {
            "$ref": "#/components/schemas/VoucherPurchaserBody"
          },
          "expires_at": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "amount",
          "recipient",
          "purchaser"
        ]
      },
      "CreditBalanceModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "balance": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "topup_url": {
            "type": "string",
            "minLength": 1
          },
          "auto_topup": {
            "$ref": "#/components/schemas/AutoTopupModel"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "customer",
          "balance",
          "currency",
          "topup_url",
          "auto_topup"
        ]
      },
      "CreditHolderList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CreditHolderModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "CreditHolderModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "balance": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "topup_url": {
            "type": "string",
            "minLength": 1
          },
          "auto_topup": {
            "$ref": "#/components/schemas/AutoTopupModel"
          },
          "customer_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "customer_email": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "total_topped_up": {
            "type": "integer"
          },
          "total_used": {
            "type": "integer"
          },
          "last_used_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "customer",
          "balance",
          "currency",
          "topup_url",
          "auto_topup",
          "customer_name",
          "customer_email",
          "total_topped_up",
          "total_used",
          "last_used_at"
        ]
      },
      "CreditRefundBody": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "CreditRefundModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "refunds": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RefundModel"
            }
          },
          "balance": {
            "$ref": "#/components/schemas/CreditBalanceModel"
          }
        },
        "required": [
          "object",
          "amount",
          "refunds",
          "balance"
        ]
      },
      "CreditTokenBody": {
        "type": "object",
        "properties": {
          "max_amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "expires_in": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "max_amount"
        ]
      },
      "CreditTokenModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "max_amount": {
            "type": "integer"
          },
          "spent": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "expires_at": {
            "type": "integer"
          },
          "token": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "customer",
          "max_amount",
          "spent",
          "currency",
          "expires_at"
        ]
      },
      "CreditTopupList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CreditTopupModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "CreditTopupModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "payment": {
            "$ref": "#/components/schemas/PaymentModel"
          },
          "trigger": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          },
          "succeeded_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "amount",
          "status",
          "payment",
          "trigger",
          "created",
          "succeeded_at"
        ]
      },
      "CustomDomainBody": {
        "type": "object",
        "properties": {
          "domain": {
            "type": "string",
            "maxLength": 300,
            "minLength": 1
          }
        },
        "required": [
          "domain"
        ]
      },
      "CustomDomainRecordModel": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "value": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "type",
          "name",
          "value"
        ]
      },
      "CustomerAddressBody": {
        "type": "object",
        "properties": {
          "line1": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          },
          "line2": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          },
          "city": {
            "nullable": true,
            "type": "string",
            "maxLength": 100
          },
          "state": {
            "nullable": true,
            "type": "string",
            "maxLength": 100
          },
          "postal_code": {
            "nullable": true,
            "type": "string",
            "maxLength": 20
          },
          "country": {
            "nullable": true,
            "type": "string",
            "maxLength": 2
          }
        },
        "additionalProperties": false
      },
      "CustomerAddressModel": {
        "type": "object",
        "properties": {
          "line1": {
            "nullable": true,
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "line2": {
            "nullable": true,
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "city": {
            "nullable": true,
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          },
          "state": {
            "nullable": true,
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          },
          "postal_code": {
            "nullable": true,
            "type": "string",
            "minLength": 1,
            "maxLength": 20
          },
          "country": {
            "nullable": true,
            "type": "string",
            "minLength": 1,
            "maxLength": 2
          }
        },
        "additionalProperties": false,
        "required": [
          "line1",
          "line2",
          "city",
          "state",
          "postal_code",
          "country"
        ]
      },
      "CustomerBody": {
        "type": "object",
        "properties": {
          "email": {
            "nullable": true,
            "type": "string",
            "maxLength": 320
          },
          "name": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          },
          "phone": {
            "nullable": true,
            "type": "string",
            "maxLength": 30
          },
          "description": {
            "nullable": true,
            "type": "string",
            "maxLength": 500
          },
          "metadata": {
            "type": "object"
          },
          "messaging_preferences": {
            "nullable": true
          },
          "address": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerAddressBody"
              }
            ],
            "nullable": true
          },
          "date_of_birth": {
            "nullable": true,
            "type": "string",
            "maxLength": 10
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "preferred_staff_member": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          }
        }
      },
      "CustomerExportModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "generated_at": {
            "type": "integer"
          },
          "customer": {
            "$ref": "#/components/schemas/CustomerModel"
          },
          "consents": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ConsentModel"
            }
          },
          "subjects": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ClientSubjectModel"
            }
          },
          "notes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerNoteModel"
            }
          },
          "forms": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ExportFormModel"
            }
          },
          "form_responses": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FormResponseModel"
            }
          },
          "files": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ExportFileModel"
            }
          },
          "bookings": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingModel"
            }
          },
          "messages": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingMessageModel"
            }
          },
          "reviews": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReviewModel"
            }
          },
          "payments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PaymentModel"
            }
          },
          "summary": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerTotalsModel"
            }
          },
          "payment_methods": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SavedCardModel"
            }
          },
          "credit": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CreditBalanceModel"
            }
          },
          "credit_topups": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CreditTopupModel"
            }
          },
          "credit_usage": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UsageEventModel"
            }
          },
          "services": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ExportNameModel"
            }
          },
          "staff_members": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ExportNameModel"
            }
          },
          "store": {
            "$ref": "#/components/schemas/CustomerStoreExportModel"
          },
          "withheld": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "object",
          "livemode",
          "generated_at",
          "customer",
          "consents",
          "subjects",
          "notes",
          "forms",
          "form_responses",
          "files",
          "bookings",
          "messages",
          "reviews",
          "payments",
          "summary",
          "payment_methods",
          "credit",
          "credit_topups",
          "credit_usage",
          "services",
          "staff_members",
          "store",
          "withheld"
        ]
      },
      "CustomerList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "CustomerModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "email": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "phone": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "description": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "metadata": {
            "type": "object"
          },
          "messaging_preferences": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/MessagingPreferencesModel"
              }
            ],
            "nullable": true
          },
          "address": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerAddressModel"
              }
            ],
            "nullable": true
          },
          "date_of_birth": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "blocked": {
            "type": "boolean"
          },
          "blocked_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "blocked_at": {
            "nullable": true,
            "type": "integer"
          },
          "blocked_online": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "preferred_staff_member": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "marketing_consent": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/MarketingConsentModel"
              }
            ],
            "nullable": true
          },
          "no_show_count": {
            "type": "integer"
          },
          "late_cancel_count": {
            "type": "integer"
          },
          "first_booking": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/FirstBookingModel"
              }
            ],
            "nullable": true
          },
          "first_booking_source": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "import": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "deleted_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "email",
          "name",
          "phone",
          "description",
          "metadata",
          "messaging_preferences",
          "address",
          "date_of_birth",
          "tags",
          "blocked",
          "blocked_reason",
          "blocked_at",
          "blocked_online",
          "preferred_staff_member",
          "marketing_consent",
          "no_show_count",
          "late_cancel_count",
          "first_booking",
          "first_booking_source",
          "import",
          "deleted_at",
          "created"
        ],
        "example": {
          "id": "cus_01J8ZK1Q9H2B4C6D8E0F2G4H6J",
          "object": "customer",
          "livemode": false,
          "email": "ada@example.com",
          "name": "Ada Lovelace",
          "phone": "+447700900123",
          "description": null,
          "metadata": {},
          "messaging_preferences": null,
          "address": {
            "line1": "1 High Street",
            "line2": null,
            "city": "Bristol",
            "state": null,
            "postal_code": "BS1 4DJ",
            "country": "GB"
          },
          "date_of_birth": null,
          "tags": [
            "regular"
          ],
          "blocked": false,
          "blocked_reason": null,
          "blocked_at": null,
          "blocked_online": null,
          "preferred_staff_member": null,
          "marketing_consent": null,
          "no_show_count": 0,
          "late_cancel_count": 0,
          "first_booking": {
            "booking": "bk_01J8ZK1Q9H2B4C6D8E0F2G4H6K",
            "source": "online",
            "channel": "instagram",
            "created": 1789990000
          },
          "first_booking_source": "online",
          "import": null,
          "deleted_at": null,
          "created": 1789990000
        }
      },
      "CustomerNoteDeleted": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "deleted": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "object",
          "deleted"
        ]
      },
      "CustomerNoteList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerNoteModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "CustomerNoteModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "visibility": {
            "type": "string",
            "minLength": 1
          },
          "body": {
            "type": "string",
            "minLength": 1
          },
          "pinned": {
            "type": "boolean"
          },
          "author": {
            "$ref": "#/components/schemas/NoteAuthorModel"
          },
          "created": {
            "type": "integer"
          },
          "updated": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "customer",
          "visibility",
          "body",
          "pinned",
          "author",
          "created",
          "updated"
        ],
        "example": {
          "id": "cnote_01J8ZK1Q9H2B4C6D8E0F2G4H6M",
          "object": "customer_note",
          "customer": "cus_01J8ZK1Q9H2B4C6D8E0F2G4H6J",
          "visibility": "shared",
          "body": "Prefers the quiet room.",
          "pinned": true,
          "author": {
            "type": "user",
            "id": "usr_01J8ZK1Q9H2B4C6D8E0F2G4H6N"
          },
          "created": 1789990000,
          "updated": 1789990000
        }
      },
      "CustomerPreferenceList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerPreferenceModel"
            }
          }
        },
        "required": [
          "object",
          "customer",
          "data"
        ]
      },
      "CustomerPreferenceModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "key": {
            "type": "string",
            "minLength": 1
          },
          "value": {
            "type": "string",
            "minLength": 1
          },
          "label": {
            "type": "string",
            "minLength": 1
          },
          "source": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "customer",
          "key",
          "value",
          "label",
          "source",
          "created"
        ]
      },
      "CustomerStoreExportModel": {
        "type": "object",
        "properties": {
          "carts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreExportCartModel"
            }
          },
          "checkouts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CheckoutModel"
            }
          },
          "orders": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreExportOrderModel"
            }
          },
          "fulfilments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreExportFulfilmentModel"
            }
          },
          "shipments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreExportShipmentModel"
            }
          },
          "tracking_messages": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreExportTrackingMessageModel"
            }
          },
          "returns": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReturnModel"
            }
          },
          "files": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreExportFileModel"
            }
          },
          "waitlist": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreExportWaitlistModel"
            }
          },
          "stock_alerts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreExportStockAlertModel"
            }
          },
          "cancellations": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreCancellationModel"
            }
          },
          "elsewhere": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreExportRecipientModel"
            }
          }
        },
        "required": [
          "carts",
          "checkouts",
          "orders",
          "fulfilments",
          "shipments",
          "tracking_messages",
          "returns",
          "files",
          "waitlist",
          "stock_alerts",
          "cancellations",
          "elsewhere"
        ]
      },
      "CustomerSummaryModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "totals": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerTotalsModel"
            }
          }
        },
        "required": [
          "object",
          "customer",
          "totals"
        ]
      },
      "CustomerTotalsModel": {
        "type": "object",
        "properties": {
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "payments": {
            "type": "integer"
          },
          "received": {
            "type": "integer"
          },
          "refunded": {
            "type": "integer"
          },
          "lifetime_value": {
            "type": "integer"
          },
          "fees": {
            "type": "integer"
          },
          "disputed": {
            "type": "integer"
          },
          "first_paid_at": {
            "nullable": true,
            "type": "integer"
          },
          "last_paid_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "currency",
          "payments",
          "received",
          "refunded",
          "lifetime_value",
          "fees",
          "disputed",
          "first_paid_at",
          "last_paid_at"
        ]
      },
      "DashboardBody": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "none",
              "express",
              "full"
            ]
          }
        }
      },
      "DeclineBookingBody": {
        "type": "object",
        "properties": {
          "reason": {
            "nullable": true,
            "type": "string",
            "maxLength": 300
          }
        }
      },
      "DeclineTimeOffBody": {
        "type": "object",
        "properties": {
          "note": {
            "nullable": true,
            "type": "string",
            "maxLength": 300
          }
        }
      },
      "DeliveryAttemptModel": {
        "type": "object",
        "properties": {
          "at": {
            "type": "integer"
          },
          "status_code": {
            "nullable": true,
            "type": "integer"
          },
          "error": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "duration_ms": {
            "type": "integer"
          }
        },
        "required": [
          "at",
          "status_code",
          "error",
          "duration_ms"
        ]
      },
      "DeliveryPreviewDestinationModel": {
        "type": "object",
        "properties": {
          "country": {
            "type": "string",
            "minLength": 1
          },
          "region": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "postcode": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "country",
          "region",
          "postcode"
        ]
      },
      "DeliveryPreviewModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "destination": {
            "$ref": "#/components/schemas/DeliveryPreviewDestinationModel"
          },
          "weight_grams": {
            "type": "integer"
          },
          "subtotal": {
            "type": "integer"
          },
          "options": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DeliveryPreviewOptionModel"
            }
          },
          "refusal": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/DeliveryPreviewRefusalModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "object",
          "currency",
          "destination",
          "weight_grams",
          "subtotal",
          "options",
          "refusal"
        ]
      },
      "DeliveryPreviewOptionModel": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "service_code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "location": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "dispatch_by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "earliest": {
            "type": "string",
            "minLength": 1
          },
          "latest": {
            "type": "string",
            "minLength": 1
          },
          "label": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "key",
          "name",
          "kind",
          "amount",
          "currency",
          "service_code",
          "location",
          "dispatch_by",
          "earliest",
          "latest",
          "label"
        ]
      },
      "DeliveryPreviewRefusalModel": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "minLength": 1
          },
          "message": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "code",
          "message"
        ]
      },
      "DenominationBody": {
        "type": "object",
        "properties": {
          "denomination": {
            "type": "integer"
          },
          "count": {
            "type": "integer"
          }
        }
      },
      "DenominationCountModel": {
        "type": "object",
        "properties": {
          "denomination": {
            "type": "integer"
          },
          "count": {
            "type": "integer"
          }
        },
        "required": [
          "denomination",
          "count"
        ]
      },
      "DepositModel": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "none",
              "fixed",
              "percent",
              "full"
            ],
            "minLength": 1
          },
          "value": {
            "type": "integer"
          },
          "refundable": {
            "type": "boolean"
          }
        },
        "required": [
          "type",
          "value",
          "refundable"
        ]
      },
      "DescriptorSourcesModel": {
        "type": "object",
        "properties": {
          "prefix": {
            "type": "string",
            "enum": [
              "account",
              "platform",
              "default"
            ],
            "minLength": 1
          },
          "suffix": {
            "type": "string",
            "enum": [
              "account",
              "platform",
              "default"
            ],
            "minLength": 1
          },
          "full": {
            "type": "string",
            "enum": [
              "account",
              "platform",
              "default"
            ],
            "minLength": 1
          },
          "payouts": {
            "type": "string",
            "enum": [
              "account",
              "platform",
              "default"
            ],
            "minLength": 1
          }
        },
        "required": [
          "prefix",
          "suffix",
          "full",
          "payouts"
        ]
      },
      "DesignRunBody": {
        "type": "object",
        "properties": {
          "request": {
            "type": "string",
            "maxLength": 2000,
            "minLength": 1
          },
          "page": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "reference_url": {
            "type": "string",
            "maxLength": 2000
          },
          "sketch": {
            "type": "string",
            "maxLength": 40
          },
          "pointed": {
            "nullable": true
          }
        },
        "required": [
          "request",
          "page"
        ]
      },
      "DesignRunModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "page": {
            "type": "string",
            "minLength": 1
          },
          "request": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "layer": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "summary": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "could_not": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "rounds": {
            "type": "integer"
          },
          "cost_cents": {
            "type": "integer"
          },
          "budget_cents": {
            "type": "integer"
          },
          "checks": {
            "nullable": true
          },
          "issues": {
            "type": "array",
            "items": {
              "nullable": true
            }
          },
          "external_hosts": {
            "type": "array",
            "items": {
              "nullable": true
            }
          },
          "section": {
            "nullable": true
          },
          "code_section": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "style_rule": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "settings_patch": {
            "nullable": true
          },
          "critique": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "card": {
            "nullable": true
          },
          "change_set": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "handed_to": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "site",
          "page",
          "request",
          "status",
          "kind",
          "layer",
          "summary",
          "could_not",
          "rounds",
          "cost_cents",
          "budget_cents",
          "checks",
          "issues",
          "external_hosts",
          "section",
          "code_section",
          "style_rule",
          "settings_patch",
          "critique",
          "card",
          "change_set",
          "handed_to",
          "created"
        ]
      },
      "DeskVoucherBody": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "amount": {
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          }
        },
        "required": [
          "code"
        ]
      },
      "DeviceLocationModel": {
        "type": "object",
        "properties": {
          "locale": {
            "type": "string",
            "minLength": 1
          },
          "units": {
            "type": "string",
            "enum": [
              "metric",
              "imperial"
            ],
            "minLength": 1
          },
          "timezone": {
            "type": "string",
            "minLength": 1
          },
          "country": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "locale",
          "units",
          "timezone",
          "country",
          "currency"
        ]
      },
      "DevicePairingModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "device": {
            "$ref": "#/components/schemas/PosDeviceModel"
          },
          "register": {
            "$ref": "#/components/schemas/RegisterModel"
          },
          "business_name": {
            "type": "string",
            "minLength": 1
          },
          "token": {
            "type": "string"
          },
          "marketing_consent_text": {
            "nullable": true,
            "type": "string"
          },
          "sells_online": {
            "type": "boolean"
          },
          "takes_payments": {
            "type": "boolean"
          },
          "location": {
            "$ref": "#/components/schemas/DeviceLocationModel"
          }
        },
        "required": [
          "object",
          "device",
          "register",
          "business_name",
          "location"
        ]
      },
      "DigitalAssetBody": {
        "type": "object",
        "properties": {
          "product": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "data": {
            "type": "string",
            "maxLength": 14000000,
            "minLength": 1
          },
          "filename": {
            "type": "string",
            "maxLength": 400,
            "minLength": 1
          },
          "content_type": {
            "nullable": true,
            "type": "string",
            "maxLength": 120
          }
        },
        "required": [
          "product",
          "data",
          "filename"
        ]
      },
      "DigitalAssetList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DigitalAssetModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "DigitalAssetModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "product": {
            "type": "string",
            "minLength": 1
          },
          "filename": {
            "type": "string",
            "minLength": 1
          },
          "content_type": {
            "type": "string",
            "minLength": 1
          },
          "size_bytes": {
            "type": "integer"
          },
          "sha256": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "product",
          "filename",
          "content_type",
          "size_bytes",
          "sha256",
          "created"
        ]
      },
      "DimensionsModel": {
        "type": "object",
        "properties": {
          "l": {
            "type": "integer"
          },
          "w": {
            "type": "integer"
          },
          "h": {
            "type": "integer"
          }
        },
        "required": [
          "l",
          "w",
          "h"
        ]
      },
      "DirectDebitApplicationModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "info_requested",
              "approved",
              "declined",
              "revoked",
              "withdrawn"
            ],
            "minLength": 1
          },
          "activation": {
            "type": "string",
            "enum": [
              "none",
              "pending_capability",
              "on",
              "paused",
              "off"
            ],
            "minLength": 1
          },
          "reason": {
            "type": "string",
            "minLength": 1
          },
          "use": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "expected_monthly_volume": {
            "type": "integer",
            "multipleOf": 1
          },
          "typical_amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "largest_amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "customers": {
            "type": "string",
            "minLength": 1
          },
          "how_customers_sign_up": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "connect_platform": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "submitted_at": {
            "nullable": true,
            "type": "integer"
          },
          "decided_at": {
            "nullable": true,
            "type": "integer"
          },
          "decision_note": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "response_note": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "responded_at": {
            "nullable": true,
            "type": "integer"
          },
          "limits": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/DirectDebitLimitsModel"
              }
            ],
            "nullable": true
          },
          "limit_increase": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/DirectDebitLimitIncreaseModel"
              }
            ],
            "nullable": true
          },
          "revoked_at": {
            "nullable": true,
            "type": "integer"
          },
          "revoke_note": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "withdrawn_at": {
            "nullable": true,
            "type": "integer"
          },
          "reapply_after": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "nullable": true,
            "type": "integer"
          },
          "updated": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "account",
          "livemode",
          "status",
          "activation",
          "reason",
          "use",
          "expected_monthly_volume",
          "typical_amount",
          "largest_amount",
          "currency",
          "customers",
          "how_customers_sign_up",
          "connect_platform",
          "submitted_at",
          "decided_at",
          "decision_note",
          "response_note",
          "responded_at",
          "limits",
          "limit_increase",
          "revoked_at",
          "revoke_note",
          "withdrawn_at",
          "reapply_after",
          "created",
          "updated"
        ]
      },
      "DirectDebitLimitIncreaseBody": {
        "type": "object",
        "properties": {
          "monthly": {
            "type": "integer",
            "multipleOf": 1
          },
          "per_debit": {
            "type": "integer",
            "multipleOf": 1
          },
          "reason": {
            "type": "string",
            "maxLength": 2000,
            "minLength": 1
          }
        },
        "required": [
          "reason"
        ]
      },
      "DirectDebitLimitIncreaseModel": {
        "type": "object",
        "properties": {
          "per_debit": {
            "nullable": true,
            "type": "integer"
          },
          "monthly": {
            "nullable": true,
            "type": "integer"
          },
          "reason": {
            "type": "string",
            "minLength": 1
          },
          "requested_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "per_debit",
          "monthly",
          "reason",
          "requested_at"
        ]
      },
      "DirectDebitLimitsModel": {
        "type": "object",
        "properties": {
          "per_debit": {
            "type": "integer",
            "multipleOf": 1
          },
          "monthly": {
            "type": "integer",
            "multipleOf": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "per_debit",
          "monthly",
          "currency"
        ]
      },
      "DirectDebitModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "enum": [
              "not_applied",
              "ineligible",
              "pending",
              "info_requested",
              "declined",
              "pending_capability",
              "needs_action",
              "on",
              "paused",
              "revoked"
            ],
            "minLength": 1
          },
          "application": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/DirectDebitApplicationModel"
              }
            ],
            "nullable": true
          },
          "limits": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/DirectDebitLimitsModel"
              }
            ],
            "nullable": true
          },
          "usage": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/DirectDebitUsageModel"
              }
            ],
            "nullable": true
          },
          "price": {
            "$ref": "#/components/schemas/DirectDebitPriceModel"
          },
          "scheme": {
            "$ref": "#/components/schemas/DirectDebitSchemeModel"
          },
          "reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "message": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "fix_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "requirements": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/DirectDebitRequirementsModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "object",
          "livemode",
          "status",
          "application",
          "limits",
          "usage",
          "price",
          "scheme",
          "reason",
          "message",
          "fix_url",
          "requirements"
        ]
      },
      "DirectDebitPriceModel": {
        "type": "object",
        "properties": {
          "bps": {
            "type": "integer",
            "multipleOf": 1
          },
          "fixed_minor": {
            "type": "integer",
            "multipleOf": 1
          },
          "cap_minor": {
            "type": "integer",
            "multipleOf": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "renewal_addon_bps": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "bps",
          "fixed_minor",
          "cap_minor",
          "currency",
          "renewal_addon_bps"
        ]
      },
      "DirectDebitRequirementsModel": {
        "type": "object",
        "properties": {
          "currently_due": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "past_due": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "capability_status": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "currently_due",
          "past_due",
          "capability_status"
        ]
      },
      "DirectDebitSchemeModel": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "bacs_debit",
              "sepa_debit"
            ],
            "minLength": 1
          },
          "label": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "max_debit": {
            "type": "integer",
            "multipleOf": 1
          },
          "refund_right_days": {
            "nullable": true,
            "type": "integer"
          },
          "unauthorised_claim_months": {
            "nullable": true,
            "type": "integer"
          },
          "pre_notification_days": {
            "type": "integer",
            "multipleOf": 1
          },
          "pre_notification_day_kind": {
            "type": "string",
            "enum": [
              "working",
              "calendar"
            ],
            "minLength": 1
          }
        },
        "required": [
          "type",
          "label",
          "currency",
          "max_debit",
          "refund_right_days",
          "unauthorised_claim_months",
          "pre_notification_days",
          "pre_notification_day_kind"
        ]
      },
      "DirectDebitUsageModel": {
        "type": "object",
        "properties": {
          "period_days": {
            "type": "integer",
            "multipleOf": 1
          },
          "used": {
            "type": "integer",
            "multipleOf": 1
          },
          "remaining": {
            "type": "integer",
            "multipleOf": 1
          },
          "per_debit_limit": {
            "type": "integer",
            "multipleOf": 1
          },
          "monthly_limit": {
            "type": "integer",
            "multipleOf": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "period_days",
          "used",
          "remaining",
          "per_debit_limit",
          "monthly_limit",
          "currency"
        ]
      },
      "DiscountBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 80
          },
          "kind": {
            "type": "string",
            "enum": [
              "percent",
              "fixed"
            ]
          },
          "value": {
            "type": "integer",
            "multipleOf": 1
          },
          "scope": {
            "type": "string",
            "enum": [
              "line",
              "order"
            ]
          },
          "requires_approval_over_bps": {
            "nullable": true,
            "type": "integer"
          },
          "reason_required": {
            "type": "boolean"
          }
        }
      },
      "DiscountList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DiscountModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "DiscountModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "percent",
              "fixed"
            ],
            "minLength": 1
          },
          "value": {
            "type": "integer"
          },
          "scope": {
            "type": "string",
            "enum": [
              "line",
              "order"
            ],
            "minLength": 1
          },
          "requires_approval_over_bps": {
            "nullable": true,
            "type": "integer"
          },
          "reason_required": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ],
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "name",
          "kind",
          "value",
          "scope",
          "requires_approval_over_bps",
          "reason_required",
          "status",
          "created"
        ]
      },
      "DisputeBody": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "enum": [
              "fraudulent",
              "not_received",
              "canceled",
              "duplicate",
              "merchandise_not_as_described",
              "service_not_as_described",
              "no_valid_authorization",
              "other"
            ]
          },
          "explanation": {
            "type": "string",
            "maxLength": 2000
          },
          "evidence": {
            "$ref": "#/components/schemas/EvidenceBody"
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "submit": {
            "type": "boolean"
          },
          "prefill": {
            "type": "boolean"
          }
        }
      },
      "DisputeEvidenceModel": {
        "type": "object",
        "properties": {
          "product_description": {
            "nullable": true,
            "type": "string",
            "maxLength": 20000
          },
          "customer_name": {
            "nullable": true,
            "type": "string",
            "maxLength": 20000
          },
          "customer_email": {
            "nullable": true,
            "type": "string",
            "maxLength": 20000
          },
          "customer_ip": {
            "nullable": true,
            "type": "string",
            "maxLength": 20000
          },
          "service_date": {
            "nullable": true,
            "type": "string",
            "maxLength": 20000
          },
          "access_activity_log": {
            "nullable": true,
            "type": "string",
            "maxLength": 20000
          },
          "refund_policy_disclosure": {
            "nullable": true,
            "type": "string",
            "maxLength": 20000
          },
          "refund_refusal_explanation": {
            "nullable": true,
            "type": "string",
            "maxLength": 20000
          },
          "cancellation_policy_disclosure": {
            "nullable": true,
            "type": "string",
            "maxLength": 20000
          },
          "cancellation_rebuttal": {
            "nullable": true,
            "type": "string",
            "maxLength": 20000
          },
          "duplicate_charge_explanation": {
            "nullable": true,
            "type": "string",
            "maxLength": 20000
          },
          "explanation": {
            "nullable": true,
            "type": "string",
            "maxLength": 20000
          }
        },
        "additionalProperties": false
      },
      "DisputeList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DisputeModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "DisputeModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "payment": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "reason": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "amount_held": {
            "type": "integer"
          },
          "fee": {
            "type": "integer"
          },
          "fee_owed": {
            "type": "integer"
          },
          "evidence_due_by": {
            "nullable": true,
            "type": "integer"
          },
          "evidence": {
            "$ref": "#/components/schemas/DisputeEvidenceModel"
          },
          "submitted_at": {
            "nullable": true,
            "type": "integer"
          },
          "evidence_drafted_at": {
            "nullable": true,
            "type": "integer"
          },
          "closed_at": {
            "nullable": true,
            "type": "integer"
          },
          "payment_method_type": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "contestable": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "payment",
          "amount",
          "currency",
          "reason",
          "status",
          "amount_held",
          "fee",
          "fee_owed",
          "evidence_due_by",
          "evidence",
          "submitted_at",
          "evidence_drafted_at",
          "closed_at",
          "payment_method_type",
          "contestable",
          "created"
        ]
      },
      "DobBody": {
        "type": "object",
        "properties": {
          "day": {
            "type": "integer",
            "multipleOf": 1
          },
          "month": {
            "type": "integer",
            "multipleOf": 1
          },
          "year": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "DomainSwitchBody": {
        "type": "object",
        "properties": {
          "domain": {
            "type": "string",
            "maxLength": 300,
            "minLength": 1
          }
        },
        "required": [
          "domain"
        ]
      },
      "DomainSwitchModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "domain": {
            "type": "string",
            "minLength": 1
          },
          "primary_host": {
            "type": "string",
            "minLength": 1
          },
          "registrar": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "dns_host": {
            "type": "string",
            "minLength": 1
          },
          "state": {
            "type": "string",
            "enum": [
              "planned",
              "prevalidating",
              "ready",
              "switching",
              "switched",
              "done",
              "rolled_back"
            ],
            "minLength": 1
          },
          "apex": {
            "type": "string",
            "enum": [
              "primary",
              "flatten",
              "forward",
              "unsupported"
            ],
            "minLength": 1
          },
          "records": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DomainSwitchRecordModel"
            }
          },
          "plan": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DomainSwitchPlanItemModel"
            }
          },
          "validation": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DomainSwitchValidationModel"
            }
          },
          "probes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DomainSwitchProbeModel"
            }
          },
          "failed_probes": {
            "type": "integer",
            "multipleOf": 1
          },
          "checked_at": {
            "nullable": true,
            "type": "integer"
          },
          "switched_at": {
            "nullable": true,
            "type": "integer"
          },
          "done_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "site",
          "domain",
          "primary_host",
          "registrar",
          "dns_host",
          "state",
          "apex",
          "records",
          "plan",
          "validation",
          "probes",
          "failed_probes",
          "checked_at",
          "switched_at",
          "done_at",
          "created"
        ]
      },
      "DomainSwitchPlanItemModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "type": {
            "type": "string",
            "minLength": 1
          },
          "action": {
            "type": "string",
            "enum": [
              "change",
              "keep"
            ],
            "minLength": 1
          },
          "from": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "to": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "why": {
            "type": "string",
            "enum": [
              "store",
              "apex",
              "email",
              "verification"
            ],
            "minLength": 1
          }
        },
        "required": [
          "name",
          "type",
          "action",
          "from",
          "to",
          "why"
        ]
      },
      "DomainSwitchProbeModel": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "minLength": 1
          },
          "ok": {
            "type": "boolean"
          },
          "status": {
            "nullable": true,
            "type": "integer"
          },
          "at": {
            "type": "integer"
          }
        },
        "required": [
          "path",
          "ok",
          "status",
          "at"
        ]
      },
      "DomainSwitchRecordModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "type": {
            "type": "string",
            "minLength": 1
          },
          "values": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "name",
          "type",
          "values"
        ]
      },
      "DomainSwitchValidationModel": {
        "type": "object",
        "properties": {
          "purpose": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "value": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "purpose",
          "name",
          "value"
        ]
      },
      "DoorStockList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DoorStockModel"
            }
          }
        },
        "required": [
          "object",
          "data"
        ]
      },
      "DoorStockModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "product": {
            "type": "string",
            "minLength": 1
          },
          "ticket_type": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "event": {
            "type": "string",
            "minLength": 1
          },
          "date": {
            "type": "string",
            "minLength": 1
          },
          "starts_at": {
            "type": "integer"
          },
          "price": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "left": {
            "nullable": true,
            "type": "integer"
          },
          "offline_allowance": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "object",
          "product",
          "ticket_type",
          "name",
          "event",
          "date",
          "starts_at",
          "price",
          "currency",
          "left",
          "offline_allowance"
        ]
      },
      "DropBody": {
        "type": "object",
        "properties": {
          "site": {
            "type": "string",
            "maxLength": 40
          },
          "name": {
            "type": "string",
            "maxLength": 120
          },
          "products": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "collection": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "starts_at": {
            "type": "integer",
            "multipleOf": 1
          },
          "ends_at": {
            "nullable": true,
            "type": "integer",
            "multipleOf": 1
          },
          "per_customer_limit": {
            "type": "integer",
            "multipleOf": 1
          },
          "per_card_limit": {
            "type": "integer",
            "multipleOf": 1
          },
          "queue_window_seconds": {
            "type": "integer",
            "multipleOf": 1
          },
          "waitlist": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "maxLength": 12
          }
        }
      },
      "DropEventData": {
        "type": "object",
        "description": "What an event carrying a `drop` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/DropModel"
          }
        }
      },
      "DropList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DropModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "DropModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "products": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "collection": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "starts_at": {
            "type": "integer"
          },
          "ends_at": {
            "nullable": true,
            "type": "integer"
          },
          "per_customer_limit": {
            "type": "integer"
          },
          "per_card_limit": {
            "type": "integer"
          },
          "queue_window_seconds": {
            "type": "integer"
          },
          "waitlist": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "cancelled"
            ],
            "minLength": 1
          },
          "state": {
            "type": "string",
            "enum": [
              "upcoming",
              "open",
              "ended",
              "cancelled"
            ],
            "minLength": 1
          },
          "created": {
            "type": "integer"
          },
          "updated": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "site",
          "name",
          "products",
          "collection",
          "starts_at",
          "ends_at",
          "per_customer_limit",
          "per_card_limit",
          "queue_window_seconds",
          "waitlist",
          "status",
          "state",
          "created",
          "updated"
        ],
        "example": {
          "id": "drop_01K7HB8H0K2M4P6R8T0V2X4Z6B",
          "object": "drop",
          "livemode": false,
          "site": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
          "name": "Winter solstice candle",
          "products": [
            "prod_01K7HB2M4N6P8Q0R2S4T6V8W0X"
          ],
          "collection": null,
          "starts_at": 1795251600,
          "ends_at": 1795338000,
          "per_customer_limit": 2,
          "per_card_limit": 2,
          "queue_window_seconds": 600,
          "waitlist": true,
          "status": "active",
          "state": "upcoming",
          "created": 1791720000,
          "updated": 1792310400
        }
      },
      "DropQueueModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "drop": {
            "type": "string",
            "minLength": 1
          },
          "state": {
            "type": "string",
            "enum": [
              "upcoming",
              "open",
              "ended",
              "cancelled"
            ],
            "minLength": 1
          },
          "joined": {
            "type": "integer"
          },
          "drawing": {
            "type": "integer"
          },
          "waiting": {
            "type": "integer"
          },
          "admitted": {
            "type": "integer"
          },
          "turns_over": {
            "type": "integer"
          },
          "sold": {
            "type": "integer"
          },
          "waitlist": {
            "$ref": "#/components/schemas/DropQueueWaitlistModel"
          }
        },
        "required": [
          "object",
          "drop",
          "state",
          "joined",
          "drawing",
          "waiting",
          "admitted",
          "turns_over",
          "sold",
          "waitlist"
        ]
      },
      "DropQueueWaitlistModel": {
        "type": "object",
        "properties": {
          "joined": {
            "type": "integer"
          },
          "notified": {
            "type": "integer"
          },
          "texts": {
            "type": "integer"
          },
          "emails": {
            "type": "integer"
          },
          "text_cost": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "joined",
          "notified",
          "texts",
          "emails",
          "text_cost",
          "currency"
        ]
      },
      "DryRunImportBody": {
        "type": "object",
        "properties": {
          "mapping": {
            "type": "object"
          },
          "date_order": {
            "type": "string",
            "enum": [
              "dmy",
              "mdy"
            ]
          }
        }
      },
      "EReceiptBody": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "maxLength": 320,
            "minLength": 1
          },
          "marketing_consent": {
            "nullable": true,
            "type": "boolean"
          }
        },
        "required": [
          "email"
        ]
      },
      "EffectivePolicyModel": {
        "type": "object",
        "properties": {
          "deposit": {
            "$ref": "#/components/schemas/DepositModel"
          },
          "card_required": {
            "type": "string",
            "enum": [
              "never",
              "new_clients",
              "always",
              "over_amount"
            ],
            "minLength": 1
          },
          "card_required_over_amount": {
            "nullable": true,
            "type": "integer"
          },
          "card_after_no_shows": {
            "nullable": true,
            "type": "integer"
          },
          "cancellation": {
            "$ref": "#/components/schemas/CancellationModel"
          },
          "no_show_fee": {
            "$ref": "#/components/schemas/FeeModel"
          },
          "reschedule_until_hours": {
            "type": "integer"
          },
          "min_notice_minutes": {
            "type": "integer"
          },
          "max_advance_days": {
            "type": "integer"
          },
          "approval_mode": {
            "type": "string",
            "enum": [
              "instant",
              "request"
            ],
            "minLength": 1
          },
          "terms_text": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "deposit",
          "card_required",
          "card_required_over_amount",
          "card_after_no_shows",
          "cancellation",
          "no_show_fee",
          "reschedule_until_hours",
          "min_notice_minutes",
          "max_advance_days",
          "approval_mode",
          "terms_text"
        ]
      },
      "EffectiveRateModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "period": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "volume": {
            "type": "integer"
          },
          "fees": {
            "type": "integer"
          },
          "cashback": {
            "type": "integer"
          },
          "net_cost": {
            "type": "integer"
          },
          "effective_rate_percent": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "provisional": {
            "type": "boolean"
          },
          "accept_earnings": {
            "type": "integer"
          },
          "eligible_spend": {
            "type": "integer"
          },
          "excluded_spend": {
            "type": "integer"
          },
          "rate_bps": {
            "type": "integer"
          }
        },
        "required": [
          "object",
          "period",
          "currency",
          "volume",
          "fees",
          "cashback",
          "net_cost",
          "effective_rate_percent",
          "provisional",
          "accept_earnings",
          "eligible_spend",
          "excluded_spend",
          "rate_bps"
        ]
      },
      "Error": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "$ref": "#/components/schemas/ErrorDetail"
          }
        },
        "example": {
          "error": {
            "type": "invalid_request_error",
            "code": "parameter_invalid",
            "message": "`amount` must be a positive integer.",
            "param": "amount",
            "request_id": "req_01J8ZKF8G0H2J4K6M8N0P2Q4R6"
          }
        }
      },
      "ErrorDetail": {
        "type": "object",
        "required": [
          "type",
          "code",
          "message",
          "request_id"
        ],
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "invalid_request_error",
              "authentication_error",
              "permission_error",
              "rate_limit_error",
              "idempotency_error",
              "card_error",
              "api_error"
            ]
          },
          "code": {
            "type": "string",
            "enum": [
              "invalid_id",
              "parameter_missing",
              "parameter_invalid",
              "resource_missing",
              "resource_limit_reached",
              "amount_too_small",
              "amount_too_large",
              "amount_changed",
              "payment_disputed",
              "dispute_not_open",
              "dispute_not_contestable",
              "dispute_evidence_incomplete",
              "dispute_window_closed",
              "dispute_not_allowed",
              "invalid_api_version",
              "idempotency_key_required",
              "not_implemented",
              "email_taken",
              "email_undeliverable",
              "token_invalid",
              "link_expired",
              "webhook_signature_invalid",
              "invalid_state",
              "version_conflict",
              "drop_requires_hosted_checkout",
              "limit_above_account_maximum",
              "card_details_unavailable",
              "country_pack_not_found",
              "invalid_api_key",
              "insufficient_scope",
              "dispute_submission_needs_person",
              "invalid_agent_proof",
              "agent_proof_required",
              "invalid_agent_signature",
              "agent_signature_replayed",
              "agent_not_allowed",
              "agent_blocked",
              "invalid_credentials",
              "invalid_session",
              "session_expired",
              "ip_not_allowed",
              "permission_denied",
              "origin_not_allowed",
              "storefront_api_off",
              "managed_by_platform",
              "insufficient_role",
              "mfa_required",
              "mfa_enrollment_required",
              "email_unconfirmed",
              "impersonation_ended",
              "impersonation_read_only",
              "assistant_approval_forbidden",
              "mfa_already_enabled",
              "mfa_not_enabled",
              "invalid_mfa_code",
              "live_mode_unavailable",
              "onboarding_incomplete",
              "feature_not_enabled",
              "issuing_not_enabled",
              "payouts_on_hold",
              "payouts_not_approved",
              "payout_unavailable",
              "issuing_card_limit",
              "issuing_cardholder_limit",
              "next_day_unavailable",
              "use_payout_settings",
              "instant_payout_unavailable",
              "topup_unavailable",
              "challenge_invalid",
              "sandbox_not_claimed",
              "sandbox_expired",
              "rate_limited",
              "payment_unavailable",
              "manual_capture_unavailable",
              "ai_setup_limit_reached",
              "support_assistant_limit_reached",
              "idempotency_in_progress",
              "idempotency_key_reuse",
              "card_declined",
              "authentication_required",
              "own_card_not_allowed",
              "insufficient_credits",
              "credit_token_invalid",
              "credit_token_expired",
              "credit_token_limit",
              "balance_insufficient",
              "internal_error",
              "upstream_unavailable",
              "live_mode_paused",
              "test_mode_paused",
              "variant_required",
              "service_unavailable",
              "staff_not_eligible",
              "client_not_eligible",
              "bookings_affected",
              "slot_unavailable",
              "hold_expired",
              "invalid_status",
              "policy_window_closed",
              "class_full",
              "offer_expired",
              "deposit_required",
              "card_required",
              "confirmation_expired",
              "slug_taken",
              "bot_check_failed",
              "code_invalid",
              "domain_taken",
              "fee_window_closed",
              "no_card_on_file",
              "nothing_due",
              "tip_locked",
              "account_invalid",
              "connected_account_not_allowed",
              "connect_live_not_enabled",
              "connect_live_not_ready",
              "max_connected_accounts",
              "country_not_supported",
              "controller_not_supported",
              "balance_not_zero",
              "account_deletion_blocked",
              "account_paused",
              "account_review_pending",
              "account_rejected",
              "bank_account_blocked",
              "account_link_expired",
              "platform_account_required",
              "application_fee_too_large",
              "application_fee_too_high",
              "payment_method_unavailable",
              "direct_debit_ineligible",
              "direct_debit_application_open",
              "direct_debit_not_enabled",
              "direct_debit_paused",
              "direct_debit_limit_exceeded",
              "payment_method_unusable",
              "subject_not_eligible",
              "patch_test_required",
              "client_blocked",
              "url_not_allowed",
              "page_unreadable",
              "undo_window_closed",
              "country_mismatch",
              "pairing_code_gone",
              "invalid_device_token",
              "device_revoked",
              "pin_taken",
              "invalid_pin",
              "pin_locked",
              "staff_session_required",
              "invalid_staff_session",
              "staff_session_expired",
              "approval_required",
              "pins_unavailable",
              "kyc_records_unavailable",
              "region_unavailable",
              "region_mismatch",
              "balance_transfer_unavailable",
              "already_spendable",
              "order_exists",
              "sequence_gap",
              "sequence_conflict",
              "modifier_required",
              "too_many_modifiers",
              "modifier_not_offered",
              "totals_mismatch",
              "already_paid",
              "shift_open",
              "no_open_shift",
              "shift_closed",
              "already_checked_out",
              "tip_not_asked",
              "tip_already_answered",
              "drawer_not_allowed",
              "account_kind_cannot_charge",
              "code_not_found",
              "code_expired",
              "code_campaign_full",
              "code_connected_account",
              "code_partner_account",
              "code_already_used_by_account",
              "code_window_closed",
              "code_own_account",
              "code_region_unavailable",
              "region_locked",
              "accounting_already_connected",
              "accounting_disconnected",
              "accounting_unavailable",
              "accounting_consent_refused",
              "accounting_consent_expired",
              "accounting_repost_refused",
              "change_set_conflict",
              "wrong_item",
              "unknown_barcode",
              "already_packed",
              "label_price_changed",
              "label_refused",
              "postage_limit_reached",
              "carrier_account_failed",
              "return_not_eligible",
              "return_statutory",
              "return_exchanges_off",
              "return_out_of_stock",
              "return_store_credit_unavailable",
              "buyer_email_required",
              "shared_token_expired",
              "shared_token_over_limit",
              "shared_token_currency_mismatch",
              "shared_token_deactivated",
              "shared_token_wrong_seller",
              "agent_mandate_refused",
              "channel_already_connected",
              "tickets_sold_out",
              "ticket_buyer_limit"
            ],
            "description": "Stable: branch on this, not on `message`. Codes are added, never renamed."
          },
          "message": {
            "type": "string",
            "description": "For people. May change."
          },
          "param": {
            "type": "string",
            "description": "The parameter at fault, when there is one."
          },
          "decline_code": {
            "type": "string",
            "description": "The card issuer's reason, for card_error."
          },
          "request_id": {
            "type": "string",
            "description": "Quote it to support: it finds the log."
          },
          "doc_url": {
            "type": "string",
            "description": "The docs page about this refusal."
          },
          "next_steps": {
            "type": "array",
            "description": "What to do next, in order (96-06). On the MCP server's `401`: how to get a key and send it.",
            "items": {
              "type": "object",
              "required": [
                "description"
              ],
              "properties": {
                "description": {
                  "type": "string",
                  "description": "The step, in words."
                },
                "url": {
                  "type": "string",
                  "description": "Where the step is done, when it is a page."
                },
                "command": {
                  "type": "string",
                  "description": "The command that does it, when there is one."
                }
              }
            }
          },
          "balance": {
            "type": "integer",
            "description": "`insufficient_credits`: the customer's credit now, in minor units."
          },
          "required": {
            "type": "integer",
            "description": "`insufficient_credits`: what the usage needed, in minor units."
          },
          "topup_url": {
            "type": "string",
            "description": "`insufficient_credits`: where the customer — or their agent — can buy more."
          },
          "limit": {
            "type": "integer",
            "description": "`direct_debit_limit_exceeded`: the Direct Debit limit agreed in your application that the debit went over (per debit, or over 30 days), in minor units."
          },
          "country": {
            "type": "string",
            "description": "`country_not_supported` / `region_unavailable` at sign-up: the country asked for (ISO 3166-1 alpha-2)."
          },
          "country_label": {
            "type": "string",
            "description": "`country_not_supported` / `region_unavailable`: the country's name, in English."
          },
          "coming_soon": {
            "type": "boolean",
            "description": "`country_not_supported` / `region_unavailable`: whether Tuppence is coming there (it is on the waitlist)."
          },
          "waitlist_url": {
            "type": "string",
            "description": "`country_not_supported` / `region_unavailable`: where to hear when that country opens."
          },
          "reason": {
            "type": "string",
            "description": "`direct_debit_ineligible` / `direct_debit_application_open`: why Direct Debit can't be applied for now — `region`, `not_verified`, `held`, `declined_recently` or `open_application`. `direct_debit_not_enabled` / `direct_debit_paused`: why a Direct Debit was refused — `not_approved`, `off` or `paused`."
          },
          "fix_url": {
            "type": "string",
            "nullable": true,
            "description": "Where to fix what refused the request, deep-linked into the dashboard. `application_fee_too_high`: where to ask us for a higher cap (**Settings → Platform**). `manual_capture_unavailable`, `issuing_card_limit`, `issuing_cardholder_limit`, `max_connected_accounts`: *Contact us*, a conversation with our team. `direct_debit_ineligible` / `direct_debit_application_open` / `direct_debit_not_enabled` / `direct_debit_paused`: the page that resolves it (null when nothing you change helps, e.g. `region`)."
          },
          "increase_url": {
            "type": "string",
            "description": "`direct_debit_limit_exceeded`: where to ask us for higher Direct Debit limits, in the dashboard."
          },
          "period": {
            "type": "string",
            "enum": [
              "debit",
              "30_days"
            ],
            "description": "`direct_debit_limit_exceeded`: which limit — `debit` (one debit over the per-debit limit) or `30_days` (the rolling 30 days' debits over the monthly limit)."
          },
          "remaining": {
            "type": "integer",
            "description": "`direct_debit_limit_exceeded`: the most a Direct Debit could be now, in minor units of `currency`."
          },
          "currency": {
            "type": "string",
            "description": "`direct_debit_limit_exceeded`: the currency of `limit` and `remaining`."
          },
          "max_fee_bps": {
            "type": "integer",
            "description": "`application_fee_too_high` (60-10): the most an application fee may be, in basis points of the payment — 2000 (20%) unless we raised your platform's cap."
          },
          "max_fee_amount": {
            "type": "integer",
            "description": "`application_fee_too_high` on a payment, or a link with an `amount`: the most the fee may be on it, in minor units (the cap, rounded down)."
          },
          "available_from": {
            "type": "integer",
            "nullable": true,
            "description": "Unix seconds from when it can go ahead. `next_day_unavailable`: when next-day payouts open by themselves, where they do. `connect_live_not_ready`: when waiting is all live Connect still needs."
          },
          "permission": {
            "type": "string",
            "description": "`approval_required`: the till permission the action needs (`refund_up_to`, `void_after_payment`, …)."
          },
          "needs": {
            "type": "string",
            "enum": [
              "approval"
            ],
            "description": "`approval_required`: a second person's PIN on the same device covers it — send their session as `Tuppence-Approval`."
          },
          "retry_after": {
            "type": "integer",
            "description": "`pin_locked`: seconds until the device's PIN pad takes a PIN again."
          },
          "last_client_seq": {
            "type": "integer",
            "description": "`sequence_gap` / `sequence_conflict`: the last event sequence held for the device (0 for none) — resend from the one after it."
          },
          "totals": {
            "type": "object",
            "additionalProperties": true,
            "description": "`totals_mismatch`: the order's totals as the server priced them — the figures that will be billed and reported (the shape of an order's `totals`)."
          },
          "mismatched": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "`totals_mismatch`: the fields of the till's `totals` that disagreed."
          },
          "catalogue_version": {
            "type": "integer",
            "nullable": true,
            "description": "`totals_mismatch`: the catalogue's version now — a till behind it fetches the change (`GET /v1/pos/catalogue?since=`)."
          },
          "missing_evidence": {
            "type": "array",
            "description": "`dispute_evidence_incomplete`: what the card dispute's reason still needs before it can be submitted — each evidence field, and what to give in plain words.",
            "items": {
              "type": "object",
              "required": [
                "field",
                "label"
              ],
              "properties": {
                "field": {
                  "type": "string",
                  "description": "The evidence field: `expected_at` …"
                },
                "label": {
                  "type": "string",
                  "description": "What to give, in plain words."
                }
              }
            }
          },
          "available_at": {
            "type": "integer",
            "description": "`dispute_not_allowed`: unix seconds from which the card dispute can be submitted (the networks reject a cancellation dispute within 15 days of cancelling)."
          },
          "dispute_by": {
            "type": "integer",
            "description": "`dispute_window_closed`: the card dispute's \"dispute by\" date, unix seconds — the network's deadline, less 5 days."
          },
          "bookings": {
            "type": "array",
            "description": "`bookings_affected`: the bookings a change to the hours would strand, earliest first — move each one, or send the change again with `keep_bookings`.",
            "items": {
              "type": "object",
              "required": [
                "id",
                "starts_at",
                "ends_at",
                "staff_member"
              ],
              "properties": {
                "id": {
                  "type": "string"
                },
                "starts_at": {
                  "type": "string",
                  "description": "ISO-8601 in the booking's zone."
                },
                "ends_at": {
                  "type": "string"
                },
                "staff_member": {
                  "type": "string",
                  "nullable": true,
                  "description": "Whose hours strand it; null for a closure's."
                }
              }
            }
          }
        }
      },
      "EstimatedWeightList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EstimatedWeightModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "EstimatedWeightModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "product": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "weight_grams": {
            "type": "integer"
          },
          "weight_class": {
            "type": "string",
            "minLength": 1
          },
          "estimated": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "product",
          "name",
          "weight_grams",
          "weight_class",
          "estimated"
        ]
      },
      "EuFundingDetailsModel": {
        "type": "object",
        "properties": {
          "account_holder_name": {
            "type": "string",
            "minLength": 1
          },
          "iban": {
            "type": "string",
            "minLength": 1
          },
          "bic": {
            "type": "string",
            "minLength": 1
          },
          "country": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "account_holder_name",
          "iban",
          "bic",
          "country"
        ]
      },
      "EventActorModel": {
        "type": "object",
        "properties": {
          "staff_member": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "device": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "approved_by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "by": {
            "type": "string"
          },
          "staff_member_name": {
            "nullable": true,
            "type": "string"
          },
          "approved_by_name": {
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "staff_member",
          "device",
          "approved_by"
        ]
      },
      "EventCancelledEvent": {
        "type": "object",
        "description": "The `event.cancelled` event (Tuppence Events' events events): `data.object` is the `ticketing.event`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "event.cancelled"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/TicketingEventEventData"
          }
        }
      },
      "EventData": {
        "type": "object",
        "properties": {
          "object": {
            "type": "object"
          }
        },
        "required": [
          "object"
        ]
      },
      "EventDateBody": {
        "type": "object",
        "properties": {
          "starts_at": {
            "type": "string",
            "minLength": 1
          },
          "ends_at": {
            "type": "string"
          },
          "doors_at": {
            "nullable": true,
            "type": "string"
          },
          "capacity": {
            "nullable": true,
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          }
        },
        "required": [
          "starts_at"
        ]
      },
      "EventDateModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "starts_at": {
            "type": "string",
            "minLength": 1
          },
          "ends_at": {
            "type": "string",
            "minLength": 1
          },
          "doors_at": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "capacity": {
            "nullable": true,
            "type": "integer"
          },
          "status": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "object",
          "starts_at",
          "ends_at",
          "doors_at",
          "capacity",
          "status"
        ]
      },
      "EventDateUpdateBody": {
        "type": "object",
        "properties": {
          "starts_at": {
            "type": "string"
          },
          "ends_at": {
            "type": "string"
          },
          "doors_at": {
            "nullable": true,
            "type": "string"
          },
          "capacity": {
            "nullable": true,
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          }
        }
      },
      "EventDatesBody": {
        "type": "object",
        "properties": {
          "starts_at": {
            "type": "string"
          },
          "ends_at": {
            "type": "string"
          },
          "doors_at": {
            "nullable": true,
            "type": "string"
          },
          "capacity": {
            "nullable": true,
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          },
          "dates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EventDateBody"
            },
            "maxItems": 104,
            "minItems": 1
          },
          "repeat": {
            "$ref": "#/components/schemas/RepeatRuleBody"
          }
        }
      },
      "EventList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EventModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "EventMessageAudienceModel": {
        "type": "object",
        "properties": {
          "buyers": {
            "type": "integer"
          },
          "email": {
            "type": "integer"
          },
          "sms": {
            "type": "integer"
          },
          "whatsapp": {
            "type": "integer"
          }
        },
        "required": [
          "buyers",
          "email",
          "sms",
          "whatsapp"
        ]
      },
      "EventMessageBody": {
        "type": "object",
        "properties": {
          "subject": {
            "type": "string",
            "maxLength": 140,
            "minLength": 1
          },
          "body": {
            "type": "string",
            "maxLength": 1600,
            "minLength": 1
          },
          "channels": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "send_at": {
            "nullable": true,
            "type": "string"
          },
          "segment": {
            "$ref": "#/components/schemas/EventMessageSegmentBody"
          }
        },
        "required": [
          "subject",
          "body"
        ]
      },
      "EventMessageDeliveredModel": {
        "type": "object",
        "properties": {
          "email": {
            "type": "integer"
          },
          "sms": {
            "type": "integer"
          },
          "whatsapp": {
            "type": "integer"
          },
          "failed": {
            "type": "integer"
          },
          "refused": {
            "type": "integer"
          }
        },
        "required": [
          "email",
          "sms",
          "whatsapp",
          "failed",
          "refused"
        ]
      },
      "EventMessageList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EventMessageModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "EventMessageModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "event": {
            "type": "string",
            "minLength": 1
          },
          "channels": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "subject": {
            "type": "string",
            "minLength": 1
          },
          "body": {
            "type": "string",
            "minLength": 1
          },
          "segment": {
            "$ref": "#/components/schemas/EventMessageSegmentModel"
          },
          "send_at": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "sent_at": {
            "nullable": true,
            "type": "integer"
          },
          "audience": {
            "$ref": "#/components/schemas/EventMessageAudienceModel"
          },
          "delivered": {
            "$ref": "#/components/schemas/EventMessageDeliveredModel"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "event",
          "channels",
          "subject",
          "body",
          "segment",
          "send_at",
          "status",
          "sent_at",
          "audience",
          "delivered",
          "created"
        ]
      },
      "EventMessageSegmentBody": {
        "type": "object",
        "properties": {
          "ticket_types": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "date": {
            "nullable": true,
            "type": "string"
          },
          "checked_in": {
            "type": "string",
            "enum": [
              "any",
              "yes",
              "no"
            ]
          }
        }
      },
      "EventMessageSegmentModel": {
        "type": "object",
        "properties": {
          "ticket_types": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "date": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "checked_in": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "ticket_types",
          "date",
          "checked_in"
        ]
      },
      "EventModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/EventData"
          }
        },
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ]
      },
      "EventPixelsModel": {
        "type": "object",
        "properties": {
          "meta": {
            "nullable": true,
            "type": "string"
          },
          "tiktok": {
            "nullable": true,
            "type": "string"
          },
          "ga4": {
            "nullable": true,
            "type": "string"
          }
        }
      },
      "EventPublishedEvent": {
        "type": "object",
        "description": "The `event.published` event (Tuppence Events' events events): `data.object` is the `ticketing.event`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "event.published"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/TicketingEventEventData"
          }
        }
      },
      "EventTypeGroupModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "`store`: the events the store sends; `events`: Tuppence Events' (tickets).",
            "minLength": 1
          },
          "sections": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EventTypeSectionModel"
            }
          }
        },
        "required": [
          "name",
          "sections"
        ]
      },
      "EventTypeList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "groups": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EventTypeGroupModel"
            }
          }
        },
        "required": [
          "object",
          "data",
          "groups"
        ]
      },
      "EventTypeSectionModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "`orders`, `delivery`, `returns`, `funds` and so on.",
            "minLength": 1
          },
          "types": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "name",
          "types"
        ]
      },
      "EventUnpublishedEvent": {
        "type": "object",
        "description": "The `event.unpublished` event (Tuppence Events' events events): `data.object` is the `ticketing.event`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "event.unpublished"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/TicketingEventEventData"
          }
        }
      },
      "EventWaitlistEntryModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "event": {
            "type": "string",
            "minLength": 1
          },
          "date": {
            "type": "string",
            "minLength": 1
          },
          "ticket_type": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "email": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "order": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "offered_at": {
            "nullable": true,
            "type": "integer"
          },
          "offer_expires_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "event",
          "date",
          "ticket_type",
          "name",
          "email",
          "status",
          "order",
          "offered_at",
          "offer_expires_at",
          "created"
        ]
      },
      "EventWaitlistList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EventWaitlistEntryModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "EvidenceBody": {
        "type": "object",
        "properties": {
          "explanation": {
            "nullable": true,
            "type": "string",
            "maxLength": 2000
          },
          "product_type": {
            "nullable": true,
            "type": "string"
          },
          "product_description": {
            "nullable": true,
            "type": "string",
            "maxLength": 2000
          },
          "expected_at": {
            "nullable": true,
            "type": "integer"
          },
          "received_at": {
            "nullable": true,
            "type": "integer"
          },
          "canceled_at": {
            "nullable": true,
            "type": "integer"
          },
          "cancellation_policy_provided": {
            "nullable": true,
            "type": "boolean"
          },
          "cancellation_reason": {
            "nullable": true,
            "type": "string",
            "maxLength": 2000
          },
          "return_status": {
            "nullable": true,
            "type": "string"
          },
          "returned_at": {
            "nullable": true,
            "type": "integer"
          },
          "return_description": {
            "nullable": true,
            "type": "string",
            "maxLength": 2000
          },
          "original_transaction": {
            "nullable": true,
            "type": "string"
          }
        }
      },
      "ExemptReasonModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "reference_label": {
            "type": "string"
          },
          "unverified": {
            "type": "boolean"
          },
          "notes": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name"
        ]
      },
      "ExpiredHoldsModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "expired": {
            "type": "integer"
          },
          "bookings": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "object",
          "livemode",
          "expired",
          "bookings"
        ]
      },
      "ExportFileModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "form_response": {
            "type": "string",
            "minLength": 1
          },
          "content_type": {
            "type": "string",
            "minLength": 1
          },
          "filename": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "kind",
          "form_response",
          "content_type",
          "filename",
          "data"
        ]
      },
      "ExportFormModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "name",
          "kind"
        ]
      },
      "ExportNameModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "name"
        ]
      },
      "ExternalAccountDeletedModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "deleted": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "object",
          "deleted"
        ]
      },
      "ExternalAccountDetailsBody": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": [
              "bank_account"
            ],
            "minLength": 1
          },
          "country": {
            "type": "string",
            "pattern": "^[A-Z]{2}$",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "pattern": "^[a-z]{3}$",
            "minLength": 1
          },
          "account_holder_name": {
            "type": "string",
            "maxLength": 100
          },
          "account_holder_type": {
            "type": "string",
            "enum": [
              "individual",
              "company"
            ]
          },
          "routing_number": {
            "type": "string",
            "pattern": "^[0-9 -]{6,12}$"
          },
          "account_number": {
            "type": "string",
            "description": "The account number: digits in the UK and the US; the IBAN in the eurozone (spaces allowed), which must be the connected account's country's, of its length and with the right check digits.",
            "pattern": "^[A-Za-z0-9 -]{4,42}$",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "country",
          "currency",
          "account_number"
        ]
      },
      "ExternalAccountList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ExternalAccountModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ExternalAccountModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string",
            "minLength": 1
          },
          "bank_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "country": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "default_for_currency": {
            "type": "boolean"
          },
          "last4": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "account",
          "bank_name",
          "country",
          "currency",
          "default_for_currency",
          "last4",
          "status",
          "created"
        ]
      },
      "ExternalEventBody": {
        "type": "object",
        "properties": {
          "staff_member": {
            "type": "string"
          },
          "summary": {
            "nullable": true,
            "type": "string"
          },
          "starts_at": {
            "nullable": true,
            "type": "string"
          },
          "ends_at": {
            "nullable": true,
            "type": "string"
          },
          "date": {
            "nullable": true,
            "type": "string"
          },
          "end_date": {
            "nullable": true,
            "type": "string"
          },
          "transparency": {
            "nullable": true,
            "type": "string"
          }
        }
      },
      "ExternalEventModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "summary": {
            "nullable": true,
            "type": "string"
          },
          "start": {
            "type": "object"
          },
          "end": {
            "type": "object"
          },
          "tuppence_booking": {
            "nullable": true,
            "type": "string"
          }
        }
      },
      "ExternalEventPatchBody": {
        "type": "object",
        "properties": {
          "staff_member": {
            "type": "string"
          },
          "summary": {
            "nullable": true,
            "type": "string"
          },
          "starts_at": {
            "nullable": true,
            "type": "string"
          },
          "ends_at": {
            "nullable": true,
            "type": "string"
          },
          "status": {
            "nullable": true,
            "type": "string"
          }
        }
      },
      "ExternalEventsModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string"
          },
          "account": {
            "type": "string"
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ExternalEventModel"
            }
          }
        }
      },
      "FactRegionModel": {
        "type": "object",
        "properties": {
          "x": {
            "type": "integer"
          },
          "y": {
            "type": "integer"
          },
          "w": {
            "type": "integer"
          },
          "h": {
            "type": "integer"
          }
        },
        "required": [
          "x",
          "y",
          "w",
          "h"
        ]
      },
      "FeeBreakdownModel": {
        "type": "object",
        "properties": {
          "schedule_version": {
            "type": "string",
            "minLength": 1
          },
          "tier": {
            "type": "string",
            "minLength": 1
          },
          "bps": {
            "type": "integer"
          },
          "surcharge": {
            "type": "boolean"
          },
          "min_applied": {
            "type": "boolean"
          },
          "method": {
            "type": "string",
            "minLength": 1
          },
          "cap_applied": {
            "type": "boolean"
          },
          "parts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FeePartModel"
            }
          },
          "next_day_bps": {
            "type": "integer"
          },
          "next_day_unavailable": {
            "type": "string",
            "enum": [
              "non_uk_card",
              "currency",
              "method"
            ]
          }
        },
        "required": [
          "schedule_version",
          "tier",
          "bps",
          "surcharge",
          "min_applied",
          "method",
          "cap_applied",
          "parts"
        ]
      },
      "FeeDetailModel": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "type",
          "amount"
        ]
      },
      "FeeModel": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "none",
              "fixed",
              "percent"
            ],
            "minLength": 1
          },
          "value": {
            "type": "integer"
          }
        },
        "required": [
          "type",
          "value"
        ]
      },
      "FeePartModel": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "minLength": 1
          },
          "bps": {
            "type": "integer"
          },
          "fixed": {
            "type": "integer"
          }
        },
        "required": [
          "label",
          "bps"
        ]
      },
      "FeeRefundBody": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          },
          "metadata": {
            "type": "object"
          }
        }
      },
      "FeeRefundList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FeeRefundModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "FeeRefundModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "fee": {
            "type": "string",
            "minLength": 1
          },
          "refund": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "metadata": {
            "type": "object"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "amount",
          "currency",
          "fee",
          "refund",
          "metadata",
          "created"
        ]
      },
      "FeeTierHistoryModel": {
        "type": "object",
        "properties": {
          "tier": {
            "type": "string",
            "enum": [
              "standard",
              "card_held"
            ],
            "minLength": 1
          },
          "previous": {
            "type": "string",
            "enum": [
              "standard",
              "card_held"
            ],
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "tier",
          "previous",
          "created"
        ]
      },
      "FeeTierModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "tier": {
            "type": "string",
            "enum": [
              "standard",
              "card_held"
            ],
            "minLength": 1
          },
          "rate": {
            "type": "string",
            "minLength": 1
          },
          "rates": {
            "$ref": "#/components/schemas/FeeTierRatesModel"
          },
          "since": {
            "nullable": true,
            "type": "integer"
          },
          "history": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FeeTierHistoryModel"
            }
          },
          "month": {
            "$ref": "#/components/schemas/FeeTierMonthModel"
          }
        },
        "required": [
          "object",
          "livemode",
          "tier",
          "rate",
          "rates",
          "since",
          "history",
          "month"
        ]
      },
      "FeeTierMonthModel": {
        "type": "object",
        "properties": {
          "payments": {
            "type": "integer"
          },
          "volume": {
            "type": "integer"
          },
          "fees_standard": {
            "type": "integer"
          },
          "fees_card_held": {
            "type": "integer"
          }
        },
        "required": [
          "payments",
          "volume",
          "fees_standard",
          "fees_card_held"
        ]
      },
      "FeeTierRatesModel": {
        "type": "object",
        "properties": {
          "standard": {
            "type": "string",
            "minLength": 1
          },
          "card_held": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "standard",
          "card_held"
        ]
      },
      "FeesBody": {
        "type": "object",
        "properties": {
          "payer": {
            "type": "string",
            "enum": [
              "account",
              "application"
            ]
          }
        }
      },
      "FileModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "purpose": {
            "type": "string",
            "minLength": 1
          },
          "size": {
            "type": "integer"
          },
          "type": {
            "type": "string",
            "minLength": 1
          },
          "filename": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "purpose",
          "size",
          "type",
          "filename",
          "created"
        ]
      },
      "FirstBookingModel": {
        "type": "object",
        "properties": {
          "booking": {
            "type": "string",
            "minLength": 1
          },
          "source": {
            "type": "string",
            "minLength": 1
          },
          "channel": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "booking",
          "source",
          "channel",
          "created"
        ]
      },
      "FiscalAnchorModel": {
        "type": "object",
        "properties": {
          "sequence": {
            "type": "integer"
          },
          "hash": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "sequence",
          "hash"
        ]
      },
      "FiscalArchiveClosureModel": {
        "type": "object",
        "properties": {
          "v": {
            "type": "integer"
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "day",
              "month",
              "year"
            ],
            "minLength": 1
          },
          "period": {
            "type": "string",
            "minLength": 1
          },
          "first_sequence": {
            "nullable": true,
            "type": "integer"
          },
          "last_sequence": {
            "nullable": true,
            "type": "integer"
          },
          "totals": {
            "$ref": "#/components/schemas/FiscalClosureTotalsModel"
          },
          "cumulative": {
            "$ref": "#/components/schemas/FiscalClosureCumulativeModel"
          },
          "closed_at": {
            "type": "string",
            "minLength": 1
          },
          "previous_hash": {
            "type": "string",
            "minLength": 1
          },
          "hash": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "v",
          "location",
          "kind",
          "period",
          "first_sequence",
          "last_sequence",
          "totals",
          "cumulative",
          "closed_at",
          "previous_hash",
          "hash"
        ]
      },
      "FiscalArchiveEntryModel": {
        "type": "object",
        "properties": {
          "sequence": {
            "type": "integer"
          },
          "payload": {
            "type": "object"
          },
          "previous_hash": {
            "type": "string",
            "minLength": 1
          },
          "hash": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "sale",
              "return",
              "void",
              "duplicate"
            ],
            "minLength": 1
          }
        },
        "required": [
          "sequence",
          "payload",
          "previous_hash",
          "hash",
          "kind"
        ]
      },
      "FiscalArchiveModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "from": {
            "type": "string",
            "minLength": 1
          },
          "to": {
            "type": "string",
            "minLength": 1
          },
          "anchor": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/FiscalAnchorModel"
              }
            ],
            "nullable": true
          },
          "receipts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FiscalArchiveEntryModel"
            }
          },
          "closures": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FiscalArchiveClosureModel"
            }
          },
          "closures_before": {
            "$ref": "#/components/schemas/FiscalClosuresBeforeModel"
          }
        },
        "required": [
          "object",
          "location",
          "from",
          "to",
          "anchor",
          "receipts",
          "closures",
          "closures_before"
        ]
      },
      "FiscalChainBreakModel": {
        "type": "object",
        "properties": {
          "sequence": {
            "type": "integer"
          },
          "reason": {
            "type": "string",
            "enum": [
              "gap",
              "previous_hash",
              "hash"
            ],
            "minLength": 1
          }
        },
        "required": [
          "sequence",
          "reason"
        ]
      },
      "FiscalClosureBreakModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "day",
              "month",
              "year"
            ],
            "minLength": 1
          },
          "period": {
            "type": "string",
            "minLength": 1
          },
          "reason": {
            "type": "string",
            "enum": [
              "totals",
              "cumulative",
              "sequence",
              "previous_hash",
              "hash"
            ],
            "minLength": 1
          }
        },
        "required": [
          "kind",
          "period",
          "reason"
        ]
      },
      "FiscalClosureCumulativeModel": {
        "type": "object",
        "properties": {
          "entries": {
            "type": "integer"
          },
          "sales_total": {
            "type": "integer"
          },
          "sales_tax": {
            "type": "integer"
          },
          "returns_total": {
            "type": "integer"
          },
          "returns_tax": {
            "type": "integer"
          },
          "grand_total": {
            "type": "integer"
          }
        },
        "required": [
          "entries",
          "sales_total",
          "sales_tax",
          "returns_total",
          "returns_tax",
          "grand_total"
        ]
      },
      "FiscalClosureList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FiscalClosureModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "FiscalClosureModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "day",
              "month",
              "year"
            ],
            "minLength": 1
          },
          "period": {
            "type": "string",
            "minLength": 1
          },
          "first_sequence": {
            "nullable": true,
            "type": "integer"
          },
          "last_sequence": {
            "nullable": true,
            "type": "integer"
          },
          "totals": {
            "$ref": "#/components/schemas/FiscalClosureTotalsModel"
          },
          "cumulative": {
            "$ref": "#/components/schemas/FiscalClosureCumulativeModel"
          },
          "hash": {
            "type": "string",
            "minLength": 1
          },
          "previous_hash": {
            "type": "string",
            "minLength": 1
          },
          "closed_at": {
            "type": "integer"
          },
          "closed_by": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "location",
          "kind",
          "period",
          "first_sequence",
          "last_sequence",
          "totals",
          "cumulative",
          "hash",
          "previous_hash",
          "closed_at",
          "closed_by",
          "created"
        ]
      },
      "FiscalClosureTotalsModel": {
        "type": "object",
        "properties": {
          "currency": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "entries": {
            "type": "integer"
          },
          "sales": {
            "$ref": "#/components/schemas/FiscalCountTotalTaxModel"
          },
          "returns": {
            "$ref": "#/components/schemas/FiscalCountTotalTaxModel"
          },
          "net": {
            "$ref": "#/components/schemas/FiscalTotalTaxModel"
          },
          "voids": {
            "$ref": "#/components/schemas/FiscalVoidsModel"
          },
          "duplicates": {
            "type": "integer"
          },
          "training": {
            "type": "integer"
          },
          "tips": {
            "type": "integer"
          },
          "cash_rounding": {
            "type": "integer"
          },
          "takings": {
            "type": "integer"
          },
          "by_tender": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FiscalTenderTotalsModel"
            }
          },
          "tax_by_rate": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FiscalTaxByRateModel"
            }
          }
        },
        "required": [
          "currency",
          "entries",
          "sales",
          "returns",
          "net",
          "voids",
          "duplicates",
          "training",
          "tips",
          "cash_rounding",
          "takings",
          "by_tender",
          "tax_by_rate"
        ]
      },
      "FiscalClosuresBeforeModel": {
        "type": "object",
        "properties": {
          "day": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/FiscalArchiveClosureModel"
              }
            ],
            "nullable": true
          },
          "month": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/FiscalArchiveClosureModel"
              }
            ],
            "nullable": true
          },
          "year": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/FiscalArchiveClosureModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "day",
          "month",
          "year"
        ]
      },
      "FiscalClosuresCheckModel": {
        "type": "object",
        "properties": {
          "ok": {
            "type": "boolean"
          },
          "checked": {
            "type": "integer"
          },
          "breaks": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FiscalClosureBreakModel"
            }
          }
        },
        "required": [
          "ok",
          "checked",
          "breaks"
        ]
      },
      "FiscalCountTotalTaxModel": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer"
          },
          "total": {
            "type": "integer"
          },
          "tax": {
            "type": "integer"
          }
        },
        "required": [
          "count",
          "total",
          "tax"
        ]
      },
      "FiscalReceiptsCheckModel": {
        "type": "object",
        "properties": {
          "ok": {
            "type": "boolean"
          },
          "checked": {
            "type": "integer"
          },
          "first_sequence": {
            "nullable": true,
            "type": "integer"
          },
          "last_sequence": {
            "nullable": true,
            "type": "integer"
          },
          "breaks": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FiscalChainBreakModel"
            }
          }
        },
        "required": [
          "ok",
          "checked",
          "first_sequence",
          "last_sequence",
          "breaks"
        ]
      },
      "FiscalTaxByRateModel": {
        "type": "object",
        "properties": {
          "tax_rate": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "rate_ppm": {
            "type": "integer"
          },
          "taxable": {
            "type": "integer"
          },
          "tax": {
            "type": "integer"
          }
        },
        "required": [
          "tax_rate",
          "name",
          "rate_ppm",
          "taxable",
          "tax"
        ]
      },
      "FiscalTenderTotalsModel": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string",
            "minLength": 1
          },
          "count": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "rounding": {
            "type": "integer"
          },
          "total": {
            "type": "integer"
          }
        },
        "required": [
          "method",
          "count",
          "amount",
          "rounding",
          "total"
        ]
      },
      "FiscalTotalTaxModel": {
        "type": "object",
        "properties": {
          "total": {
            "type": "integer"
          },
          "tax": {
            "type": "integer"
          }
        },
        "required": [
          "total",
          "tax"
        ]
      },
      "FiscalVerificationModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "ok": {
            "type": "boolean"
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "from": {
            "type": "string",
            "minLength": 1
          },
          "to": {
            "type": "string",
            "minLength": 1
          },
          "receipts": {
            "$ref": "#/components/schemas/FiscalReceiptsCheckModel"
          },
          "closures": {
            "$ref": "#/components/schemas/FiscalClosuresCheckModel"
          }
        },
        "required": [
          "object",
          "ok",
          "location",
          "from",
          "to",
          "receipts",
          "closures"
        ]
      },
      "FiscalVoidsModel": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "count",
          "amount"
        ]
      },
      "FocalPointBody": {
        "type": "object",
        "properties": {
          "x": {
            "type": "integer"
          },
          "y": {
            "type": "integer"
          }
        },
        "required": [
          "x",
          "y"
        ]
      },
      "FocalPointModel": {
        "type": "object",
        "properties": {
          "x": {
            "type": "integer"
          },
          "y": {
            "type": "integer"
          }
        },
        "required": [
          "x",
          "y"
        ]
      },
      "Forbidden": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "description": "The error name",
            "example": "FORBIDDEN",
            "default": "FORBIDDEN"
          },
          "message": {
            "type": "string",
            "minLength": 1,
            "description": "An error message"
          },
          "status": {
            "type": "integer",
            "description": "The status code of the exception",
            "example": 403,
            "default": 403
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GenericError"
            },
            "description": "A list of related errors"
          },
          "stack": {
            "type": "string",
            "description": "The stack trace (only in development mode)"
          }
        },
        "required": [
          "name",
          "message",
          "status"
        ]
      },
      "FormAttachmentModel": {
        "type": "object",
        "properties": {
          "service": {
            "type": "string",
            "minLength": 1
          },
          "when": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "service",
          "when"
        ]
      },
      "FormList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FormModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "FormModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "version": {
            "type": "integer"
          },
          "questions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FormQuestionModel"
            }
          },
          "versions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FormVersionModel"
            }
          },
          "attachment": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FormAttachmentModel"
            }
          },
          "valid_for_days": {
            "nullable": true,
            "type": "integer"
          },
          "clinical": {
            "type": "boolean"
          },
          "template": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          },
          "updated": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "name",
          "kind",
          "version",
          "questions",
          "versions",
          "attachment",
          "valid_for_days",
          "clinical",
          "template",
          "status",
          "created",
          "updated"
        ],
        "example": {
          "id": "form_01J8ZK1Q9H2B4C6D8E0F2G4H6Q",
          "object": "form",
          "name": "Lash, brow and tint consent",
          "kind": "consent",
          "version": 2,
          "questions": [
            {
              "id": "q1",
              "type": "yes_no",
              "label": "Do you wear contact lenses?",
              "required": true
            },
            {
              "id": "q2",
              "type": "consent",
              "label": "Consent",
              "required": true,
              "statement": "I understand the treatment and its aftercare, and that a reaction can happen even after a clear patch test. I give my consent to the treatment."
            },
            {
              "id": "q3",
              "type": "signature",
              "label": "Your signature",
              "required": true
            }
          ],
          "versions": [
            {
              "version": 1,
              "replaced_at": 1789990000
            },
            {
              "version": 2,
              "replaced_at": null
            }
          ],
          "attachment": [
            {
              "service": "svc_01J8ZK1Q9H2B4C6D8E0F2G4H6K",
              "when": "before_booking"
            }
          ],
          "valid_for_days": null,
          "clinical": true,
          "template": "consent_lash_brow",
          "status": "active",
          "created": 1789980000,
          "updated": 1789990000
        }
      },
      "FormQuestionModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "type": {
            "type": "string",
            "minLength": 1
          },
          "label": {
            "type": "string",
            "minLength": 1
          },
          "required": {
            "type": "boolean"
          },
          "options": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "statement": {
            "type": "string"
          },
          "min": {
            "type": "integer"
          },
          "max": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "type",
          "label",
          "required"
        ]
      },
      "FormResponseList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FormResponseModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "FormResponseModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "form": {
            "type": "string",
            "minLength": 1
          },
          "form_version": {
            "type": "integer"
          },
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "booking": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "questions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FormQuestionModel"
            }
          },
          "answers": {
            "nullable": true
          },
          "sealed": {
            "type": "boolean"
          },
          "signed": {
            "type": "boolean"
          },
          "signer": {
            "$ref": "#/components/schemas/FormSignerModel"
          },
          "result": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "expires_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "form",
          "form_version",
          "customer",
          "booking",
          "questions",
          "answers",
          "sealed",
          "signed",
          "signer",
          "result",
          "expires_at",
          "created"
        ],
        "example": {
          "id": "fresp_01J8ZK1Q9H2B4C6D8E0F2G4H6R",
          "object": "form_response",
          "form": "form_01J8ZK1Q9H2B4C6D8E0F2G4H6Q",
          "form_version": 2,
          "customer": "cus_01J8ZK1Q9H2B4C6D8E0F2G4H6J",
          "booking": "bk_01J8ZK1Q9H2B4C6D8E0F2G4H6K",
          "questions": [
            {
              "id": "q1",
              "type": "yes_no",
              "label": "Do you wear contact lenses?",
              "required": true
            },
            {
              "id": "q2",
              "type": "consent",
              "label": "Consent",
              "required": true,
              "statement": "I understand the treatment and its aftercare, and that a reaction can happen even after a clear patch test. I give my consent to the treatment."
            },
            {
              "id": "q3",
              "type": "signature",
              "label": "Your signature",
              "required": true
            }
          ],
          "answers": null,
          "sealed": true,
          "signed": true,
          "signer": {
            "name": "Sam Patel",
            "via": "page",
            "ip": "203.0.113.7"
          },
          "result": null,
          "expires_at": null,
          "created": 1789990000
        }
      },
      "FormSignerModel": {
        "type": "object",
        "properties": {
          "name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "via": {
            "type": "string",
            "minLength": 1
          },
          "ip": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "name",
          "via",
          "ip"
        ]
      },
      "FormTemplateList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FormTemplateModel"
            }
          }
        },
        "required": [
          "object",
          "data"
        ]
      },
      "FormTemplateModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "description": {
            "type": "string",
            "minLength": 1
          },
          "clinical": {
            "type": "boolean"
          },
          "questions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FormQuestionModel"
            }
          }
        },
        "required": [
          "id",
          "object",
          "name",
          "kind",
          "description",
          "clinical",
          "questions"
        ]
      },
      "FormVersionModel": {
        "type": "object",
        "properties": {
          "version": {
            "type": "integer"
          },
          "replaced_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "version",
          "replaced_at"
        ]
      },
      "FulfilmentDelayedEvent": {
        "type": "object",
        "description": "The `fulfilment.delayed` event (the store's delivery events): `data.object` is the `fulfilment`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "fulfilment.delayed"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/FulfilmentDelayedEventData"
          }
        }
      },
      "FulfilmentDelayedEventData": {
        "type": "object",
        "description": "What an event carrying a `fulfilment` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/FulfilmentEventObject"
          }
        }
      },
      "FulfilmentEventData": {
        "type": "object",
        "description": "What an event carrying a `fulfilment` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/FulfilmentModel"
          }
        }
      },
      "FulfilmentEventObject": {
        "type": "object",
        "description": "A `fulfilment` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "fulfilment"
          }
        },
        "additionalProperties": true
      },
      "FulfilmentHoldModel": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "minLength": 1
          },
          "at": {
            "type": "integer"
          },
          "by": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "reason",
          "at",
          "by"
        ]
      },
      "FulfilmentLineModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "order_line": {
            "type": "string",
            "minLength": 1
          },
          "variant": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "sku": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "category": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "barcodes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "weight_g": {
            "nullable": true,
            "type": "integer"
          },
          "quantity": {
            "type": "string",
            "minLength": 1
          },
          "packed_quantity": {
            "type": "string",
            "minLength": 1
          },
          "scanned": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "object",
          "order_line",
          "variant",
          "name",
          "sku",
          "category",
          "barcodes",
          "weight_g",
          "quantity",
          "packed_quantity",
          "scanned"
        ]
      },
      "FulfilmentList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FulfilmentModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "FulfilmentModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "order": {
            "type": "string",
            "minLength": 1
          },
          "order_number": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "service_code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "promise": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/FulfilmentPromiseModel"
              }
            ],
            "nullable": true
          },
          "needs_stock": {
            "type": "boolean"
          },
          "parcel": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ParcelModel"
              }
            ],
            "nullable": true
          },
          "ship_to": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ShipToModel"
              }
            ],
            "nullable": true
          },
          "lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FulfilmentLineModel"
            }
          },
          "shipment": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/FulfilmentShipmentModel"
              }
            ],
            "nullable": true
          },
          "packed_at": {
            "nullable": true,
            "type": "integer"
          },
          "shipped_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "order",
          "order_number",
          "location",
          "kind",
          "status",
          "service_code",
          "promise",
          "needs_stock",
          "parcel",
          "ship_to",
          "lines",
          "shipment",
          "packed_at",
          "shipped_at",
          "created"
        ],
        "example": {
          "id": "ful_01K7HBTB9E1G3J5L7N9Q1S3V5X",
          "object": "fulfilment",
          "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
          "order_number": "#318",
          "location": "loc_01J8ZK2B4D6F8H0K2M4P6R8T0V",
          "kind": "shipping",
          "status": "shipped",
          "service_code": "royal_mail_tracked_48",
          "promise": {
            "dispatch_by": "2026-10-26",
            "earliest": "2026-10-27",
            "latest": "2026-10-28"
          },
          "needs_stock": false,
          "parcel": {
            "weight_g": 1450,
            "length_mm": 300,
            "width_mm": 200,
            "height_mm": 150,
            "package": null
          },
          "ship_to": {
            "name": "Sam Taylor",
            "line1": "12 Park Row",
            "line2": null,
            "city": "Leeds",
            "region": null,
            "postcode": "LS1 5HD",
            "country": "GB"
          },
          "lines": [
            {
              "id": "fulln_01K7HBJV1W3Y5A7C9E1G3J5L7N",
              "object": "fulfilment_line",
              "order_line": "ordl_01K7HBFR8T0V2X4Z6B8D0F2H4K",
              "variant": null,
              "name": "Sea salt candle",
              "sku": "CND-SEA-200",
              "category": "Candles",
              "barcodes": [
                "5012345678900"
              ],
              "weight_g": 450,
              "quantity": "2",
              "packed_quantity": "2",
              "scanned": true
            }
          ],
          "shipment": {
            "id": "shp_01K7HBKW2X4Z6B8D0F2H4K6M8P",
            "object": "shipment",
            "status": "in_transit",
            "vendor": "fake",
            "carrier": "royal_mail",
            "service_code": "royal_mail_tracked_48",
            "tracking_number": "TT123456785GB",
            "cost_amount": 329,
            "currency": "gbp",
            "paid_by": "tuppence_balance",
            "label_formats": [
              "pdf",
              "zpl"
            ],
            "created": 1792314000
          },
          "packed_at": 1792313400,
          "shipped_at": 1792314000,
          "created": 1792310400
        }
      },
      "FulfilmentPromiseModel": {
        "type": "object",
        "properties": {
          "dispatch_by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "earliest": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "latest": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "dispatch_by",
          "earliest",
          "latest"
        ]
      },
      "FulfilmentShipmentModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "vendor": {
            "type": "string",
            "minLength": 1
          },
          "carrier": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "service_code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "tracking_number": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "cost_amount": {
            "nullable": true,
            "type": "integer"
          },
          "currency": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "paid_by": {
            "type": "string",
            "minLength": 1
          },
          "label_formats": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "status",
          "vendor",
          "carrier",
          "service_code",
          "tracking_number",
          "cost_amount",
          "currency",
          "paid_by",
          "label_formats",
          "created"
        ]
      },
      "FulfilmentShippedEvent": {
        "type": "object",
        "description": "The `fulfilment.shipped` event (the store's delivery events): `data.object` is the `fulfilment`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "fulfilment.shipped"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/FulfilmentEventData"
          }
        }
      },
      "FundingInstructionsModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "type": {
            "type": "string",
            "enum": [
              "gb_bank_transfer",
              "us_bank_transfer",
              "eu_bank_transfer"
            ],
            "minLength": 1
          },
          "available": {
            "type": "boolean"
          },
          "reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "message": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "gb": {
            "$ref": "#/components/schemas/GbFundingDetailsModel"
          },
          "us": {
            "$ref": "#/components/schemas/UsFundingDetailsModel"
          },
          "eu": {
            "$ref": "#/components/schemas/EuFundingDetailsModel"
          },
          "balance_transfer": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/BalanceTransferRouteModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "object",
          "currency",
          "type",
          "available",
          "reason",
          "message",
          "balance_transfer"
        ]
      },
      "GbFundingDetailsModel": {
        "type": "object",
        "properties": {
          "account_holder_name": {
            "type": "string",
            "minLength": 1
          },
          "sort_code": {
            "type": "string",
            "minLength": 1
          },
          "account_number": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "account_holder_name",
          "sort_code",
          "account_number"
        ]
      },
      "GenerateBody": {
        "type": "object",
        "properties": {
          "site": {
            "type": "string",
            "maxLength": 40
          }
        }
      },
      "GenericError": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "description": "The error name"
          },
          "message": {
            "type": "string",
            "minLength": 1,
            "description": "An error message"
          }
        },
        "additionalProperties": true,
        "required": [
          "name",
          "message"
        ]
      },
      "Gone": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "description": "The error name",
            "example": "GONE",
            "default": "GONE"
          },
          "message": {
            "type": "string",
            "minLength": 1,
            "description": "An error message"
          },
          "status": {
            "type": "integer",
            "description": "The status code of the exception",
            "example": 410,
            "default": 410
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GenericError"
            },
            "description": "A list of related errors"
          },
          "stack": {
            "type": "string",
            "description": "The stack trace (only in development mode)"
          }
        },
        "required": [
          "name",
          "message",
          "status"
        ]
      },
      "GoogleBusinessModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "can_connect": {
            "type": "boolean"
          },
          "can_read_maps_links": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "enum": [
              "not_connected",
              "connected",
              "reauthorise",
              "maps_link"
            ],
            "minLength": 1
          },
          "email": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "listing": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/GoogleChosenListingModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "object",
          "can_connect",
          "can_read_maps_links",
          "status",
          "email",
          "listing"
        ]
      },
      "GoogleChosenListingModel": {
        "type": "object",
        "properties": {
          "location": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "title": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "address": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "place_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "maps_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "categories": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "read_at": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "location",
          "title",
          "address",
          "place_id",
          "maps_url",
          "categories",
          "read_at"
        ]
      },
      "GoogleListingList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GoogleListingModel"
            }
          }
        },
        "required": [
          "object",
          "data"
        ]
      },
      "GoogleListingModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "source": {
            "type": "string",
            "enum": [
              "profile",
              "maps_link"
            ],
            "minLength": 1
          },
          "location": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "address": {
            "nullable": true
          },
          "phone": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "opening_hours": {
            "nullable": true
          },
          "categories": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "place_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "maps_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "photos": {
            "type": "integer",
            "multipleOf": 1
          },
          "cover_photo": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "source",
          "location",
          "title",
          "address",
          "phone",
          "opening_hours",
          "categories",
          "place_id",
          "maps_url",
          "photos",
          "cover_photo"
        ]
      },
      "GooglePhotoImportModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "cover": {
            "type": "boolean"
          },
          "added": {
            "type": "integer",
            "multipleOf": 1
          },
          "skipped": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "object",
          "cover",
          "added",
          "skipped"
        ]
      },
      "GpsrAddressModel": {
        "type": "object",
        "properties": {
          "line1": {
            "type": "string",
            "minLength": 1
          },
          "line2": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "city": {
            "type": "string",
            "minLength": 1
          },
          "postal_code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "country": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "line1",
          "line2",
          "city",
          "postal_code",
          "country"
        ]
      },
      "GpsrIdentifierModel": {
        "type": "object",
        "properties": {
          "gtin": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "model": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "batch": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "gtin",
          "model",
          "batch"
        ]
      },
      "GpsrManufacturerModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "postal_address": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/GpsrAddressModel"
              }
            ],
            "nullable": true
          },
          "email_or_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "name",
          "postal_address",
          "email_or_url"
        ]
      },
      "GpsrModel": {
        "type": "object",
        "properties": {
          "manufacturer": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/GpsrManufacturerModel"
              }
            ],
            "nullable": true
          },
          "eu_responsible_person": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/GpsrResponsiblePersonModel"
              }
            ],
            "nullable": true
          },
          "warnings": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GpsrWarningModel"
            }
          },
          "identifier": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/GpsrIdentifierModel"
              }
            ],
            "nullable": true
          },
          "safety_documents": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "label_image": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "manufacturer",
          "eu_responsible_person",
          "warnings",
          "identifier",
          "safety_documents",
          "label_image"
        ]
      },
      "GpsrResponsiblePersonModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "postal_address": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/GpsrAddressModel"
              }
            ],
            "nullable": true
          },
          "email": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "name",
          "postal_address",
          "email"
        ]
      },
      "GpsrWarningModel": {
        "type": "object",
        "properties": {
          "language": {
            "type": "string",
            "minLength": 1
          },
          "text": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "language",
          "text"
        ]
      },
      "IcsFeedBody": {
        "type": "object",
        "properties": {
          "staff_member": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "location": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          }
        }
      },
      "IcsFeedList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IcsFeedModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "IcsFeedModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "id": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "location": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "webcal_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "rotated": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "object",
          "id",
          "livemode",
          "staff_member",
          "location",
          "url",
          "webcal_url",
          "rotated",
          "created"
        ]
      },
      "ImageEditBody": {
        "type": "object",
        "properties": {
          "media": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "edit": {
            "type": "string",
            "enum": [
              "clean",
              "studio",
              "relight",
              "scene"
            ],
            "minLength": 1
          },
          "background": {
            "type": "string",
            "maxLength": 64
          },
          "preset": {
            "type": "string",
            "enum": [
              "soft",
              "bright",
              "warm"
            ]
          },
          "words": {
            "type": "string",
            "maxLength": 300
          }
        },
        "required": [
          "media",
          "edit"
        ]
      },
      "ImageEditModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "edited",
              "kept_original",
              "unavailable"
            ],
            "minLength": 1
          },
          "original": {
            "type": "string",
            "minLength": 1
          },
          "media": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/MediaAssetModel"
              }
            ],
            "nullable": true
          },
          "message": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "status",
          "original",
          "media",
          "message"
        ]
      },
      "ImageStudioModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "available": {
            "type": "boolean"
          },
          "message": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "edits": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StudioEditOptionModel"
            }
          },
          "backgrounds": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StudioBackdropModel"
            }
          },
          "scenes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ScenePresetModel"
            }
          },
          "ai_allowance": {
            "$ref": "#/components/schemas/StoreAiAllowanceModel"
          }
        },
        "required": [
          "object",
          "available",
          "message",
          "edits",
          "backgrounds",
          "scenes",
          "ai_allowance"
        ]
      },
      "ImportBody": {
        "type": "object",
        "properties": {
          "file": {
            "nullable": true
          }
        },
        "required": [
          "file"
        ]
      },
      "ImportColumnModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "samples": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "field": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "name",
          "samples",
          "field"
        ]
      },
      "ImportFieldModel": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "minLength": 1
          },
          "label": {
            "type": "string",
            "minLength": 1
          },
          "hint": {
            "type": "string",
            "minLength": 1
          },
          "column": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "field",
          "label",
          "hint",
          "column"
        ]
      },
      "ImportFormatMissingModel": {
        "type": "object",
        "properties": {
          "column": {
            "type": "string",
            "minLength": 1
          },
          "field": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "instead": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "column",
          "field",
          "instead"
        ]
      },
      "ImportFormatModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "found": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "missing": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ImportFormatMissingModel"
            }
          }
        },
        "required": [
          "name",
          "found",
          "missing"
        ]
      },
      "ImportIssueModel": {
        "type": "object",
        "properties": {
          "row": {
            "type": "integer",
            "multipleOf": 1
          },
          "outcome": {
            "type": "string",
            "enum": [
              "duplicate",
              "skipped",
              "failed"
            ],
            "minLength": 1
          },
          "code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "field": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "message": {
            "type": "string",
            "minLength": 1
          },
          "existing": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "row",
          "outcome",
          "code",
          "field",
          "message",
          "existing"
        ]
      },
      "ImportKeptModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "id": {
            "type": "string",
            "minLength": 1
          },
          "used_by": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "id",
          "used_by"
        ]
      },
      "ImportList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ImportModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ImportModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "kind": {
            "type": "string",
            "enum": [
              "services",
              "clients",
              "bookings",
              "staff",
              "time_off"
            ],
            "minLength": 1
          },
          "source": {
            "type": "string",
            "enum": [
              "csv",
              "fresha",
              "booksy",
              "square",
              "vagaro",
              "treatwell"
            ],
            "minLength": 1
          },
          "format": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ImportFormatModel"
              }
            ],
            "nullable": true
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "ready",
              "completed",
              "undone"
            ],
            "minLength": 1
          },
          "filename": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "rows": {
            "type": "integer",
            "multipleOf": 1
          },
          "columns": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ImportColumnModel"
            }
          },
          "fields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ImportFieldModel"
            }
          },
          "mapping": {
            "type": "object"
          },
          "refused": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ImportRefusedColumnModel"
            }
          },
          "problems": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ImportProblemModel"
            }
          },
          "date_order": {
            "type": "string",
            "enum": [
              "dmy",
              "mdy"
            ],
            "minLength": 1
          },
          "dry_run": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ImportReportModel"
              }
            ],
            "nullable": true
          },
          "result": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ImportReportModel"
              }
            ],
            "nullable": true
          },
          "ran_at": {
            "nullable": true,
            "type": "integer"
          },
          "undo_until": {
            "nullable": true,
            "type": "integer"
          },
          "undone_at": {
            "nullable": true,
            "type": "integer"
          },
          "undo": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ImportUndoModel"
              }
            ],
            "nullable": true
          },
          "created_by": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "kind",
          "source",
          "format",
          "status",
          "filename",
          "rows",
          "columns",
          "fields",
          "mapping",
          "refused",
          "problems",
          "date_order",
          "dry_run",
          "result",
          "ran_at",
          "undo_until",
          "undone_at",
          "undo",
          "created_by",
          "created"
        ]
      },
      "ImportObjectsModel": {
        "type": "object",
        "properties": {
          "customers": {
            "type": "integer",
            "multipleOf": 1
          },
          "services": {
            "type": "integer",
            "multipleOf": 1
          },
          "service_categories": {
            "type": "integer",
            "multipleOf": 1
          },
          "staff_members": {
            "type": "integer",
            "multipleOf": 1
          },
          "time_off": {
            "type": "integer",
            "multipleOf": 1
          },
          "bookings": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "customers",
          "services",
          "service_categories",
          "staff_members",
          "time_off",
          "bookings"
        ]
      },
      "ImportProblemModel": {
        "type": "object",
        "properties": {
          "field": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "message": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "field",
          "message"
        ]
      },
      "ImportRefusedColumnModel": {
        "type": "object",
        "properties": {
          "column": {
            "type": "string",
            "minLength": 1
          },
          "reason": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "column",
          "reason"
        ]
      },
      "ImportReportModel": {
        "type": "object",
        "properties": {
          "at": {
            "type": "integer",
            "multipleOf": 1
          },
          "rows": {
            "type": "integer",
            "multipleOf": 1
          },
          "created": {
            "type": "integer",
            "multipleOf": 1
          },
          "duplicates": {
            "type": "integer",
            "multipleOf": 1
          },
          "skipped": {
            "type": "integer",
            "multipleOf": 1
          },
          "failed": {
            "type": "integer",
            "multipleOf": 1
          },
          "conflicts": {
            "type": "integer",
            "multipleOf": 1
          },
          "objects": {
            "$ref": "#/components/schemas/ImportObjectsModel"
          },
          "issues": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ImportIssueModel"
            }
          }
        },
        "required": [
          "at",
          "rows",
          "created",
          "duplicates",
          "skipped",
          "failed",
          "conflicts",
          "objects",
          "issues"
        ]
      },
      "ImportUndoModel": {
        "type": "object",
        "properties": {
          "removed": {
            "$ref": "#/components/schemas/ImportObjectsModel"
          },
          "kept": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ImportKeptModel"
            }
          }
        },
        "required": [
          "removed",
          "kept"
        ]
      },
      "ImportedCodeSectionModel": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "minLength": 1
          },
          "code_section": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "key",
          "code_section"
        ]
      },
      "ImportedPageModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "slug": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "page": {
            "type": "string",
            "minLength": 1
          },
          "dropped_blocks": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "kind",
          "slug",
          "page",
          "dropped_blocks"
        ]
      },
      "ImportedSectionModel": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "minLength": 1
          },
          "section": {
            "type": "string",
            "minLength": 1
          },
          "version": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "key",
          "section",
          "version"
        ]
      },
      "InboxRequestModel": {
        "type": "object",
        "properties": {
          "received_at": {
            "type": "integer"
          },
          "endpoint": {
            "type": "string",
            "minLength": 1
          },
          "event_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "delivery_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "event_type": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "signature": {
            "type": "string",
            "minLength": 1
          },
          "body": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "received_at",
          "endpoint",
          "event_id",
          "delivery_id",
          "event_type",
          "signature",
          "body"
        ]
      },
      "IndividualBody": {
        "type": "object",
        "properties": {
          "first_name": {
            "type": "string",
            "maxLength": 100
          },
          "last_name": {
            "type": "string",
            "maxLength": 100
          },
          "dob": {
            "$ref": "#/components/schemas/DobBody"
          },
          "terms_acceptance": {
            "$ref": "#/components/schemas/TermsAcceptanceBody"
          }
        }
      },
      "IndividualModel": {
        "type": "object",
        "properties": {
          "first_name": {
            "type": "string",
            "minLength": 1
          },
          "last_name": {
            "type": "string",
            "minLength": 1
          },
          "terms_accepted_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "first_name",
          "last_name",
          "terms_accepted_at"
        ]
      },
      "InstantDestinationModel": {
        "type": "object",
        "properties": {
          "available": {
            "type": "boolean",
            "description": "Can you move money instantly to this destination right now?"
          },
          "reason": {
            "description": "Why not, when it isn't available; null when it is. `payouts_disabled` · `not_priced` · `flag_off` · `territory` · `currency` · `held` · `not_approved` · `not_available_yet` (not open on your account yet; `available_from` says when, where we know) · `no_instant_destination` (bank) · `cards_off` · `card_balance_not_instant` · `float_low` (card balance). `territory`, `currency`, `not_priced`, `flag_off`, `float_low` and `payouts_disabled` are nothing you can act on, and the dashboard doesn't show them.",
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "message": {
            "description": "The reason in words, to show as it is; null when available.",
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "fix_url": {
            "description": "Where the business fixes `reason` itself — a dashboard page (`cards_off` the Cards page, `no_instant_destination` the bank details) or, for `held`, the help article that explains it. Null when there is nothing to fix, or only to wait.",
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "available_from": {
            "description": "For `not_available_yet`: when it opens (Unix seconds), where we know; null otherwise.",
            "nullable": true,
            "type": "integer"
          },
          "largest_amount": {
            "type": "integer",
            "description": "The most you could ask to move there right now, in minor units (the fee comes out of it); 0 when unavailable."
          }
        },
        "required": [
          "available",
          "reason",
          "message",
          "fix_url",
          "available_from",
          "largest_amount"
        ]
      },
      "InstantDestinationsModel": {
        "type": "object",
        "properties": {
          "bank": {
            "$ref": "#/components/schemas/InstantDestinationModel"
          },
          "card_balance": {
            "$ref": "#/components/schemas/InstantDestinationModel"
          }
        },
        "description": "Each destination's own answer. `bank`: an instant payout to your bank account, within 30 minutes. `card_balance`: pending money onto your cards' balance (UK only), usually within minutes — described before it can be used: until it opens, `available` is false and `reason` says why.",
        "required": [
          "bank",
          "card_balance"
        ]
      },
      "InstantPayoutQuoteModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "destination": {
            "type": "string",
            "description": "Where it would go: `bank` (the default) or `card_balance` — the `destination` you asked about.",
            "enum": [
              "bank",
              "card_balance"
            ],
            "minLength": 1
          },
          "arrives": {
            "type": "string",
            "description": "How soon it arrives there, in words: \"within 30 minutes\" (bank), \"usually within minutes\" (card balance).",
            "minLength": 1
          },
          "available": {
            "type": "boolean",
            "description": "Can you make this move now? When false the amounts are what it would cost, and `reason`, `message` and `fix_url` say why not and where to fix it."
          },
          "reason": {
            "description": "Why not, when it isn't available; null when it is. `payouts_disabled` · `not_priced` · `flag_off` · `territory` · `currency` · `held` · `not_approved` · `not_available_yet` (not open on your account yet; `available_from` says when, where we know) · `no_instant_destination` (bank) · `cards_off` · `card_balance_not_instant` · `float_low` (card balance). `territory`, `currency`, `not_priced`, `flag_off`, `float_low` and `payouts_disabled` are nothing you can act on, and the dashboard doesn't show them.",
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "message": {
            "description": "The reason in words, to show as it is; null when available.",
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "fix_url": {
            "description": "Where the business fixes `reason` itself — a dashboard page (`cards_off` the Cards page, `no_instant_destination` the bank details) or, for `held`, the help article that explains it. Null when there is nothing to fix, or only to wait.",
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "available_from": {
            "description": "For `not_available_yet`: when it opens (Unix seconds), where we know; null otherwise.",
            "nullable": true,
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "fee_amount": {
            "type": "integer"
          },
          "fee_bps": {
            "nullable": true,
            "type": "integer"
          },
          "total_amount": {
            "type": "integer"
          },
          "minimum_amount": {
            "type": "integer"
          },
          "maximum_amount": {
            "type": "integer"
          },
          "largest_amount": {
            "type": "integer"
          }
        },
        "required": [
          "object",
          "livemode",
          "currency",
          "destination",
          "arrives",
          "available",
          "reason",
          "message",
          "fix_url",
          "available_from",
          "amount",
          "fee_amount",
          "fee_bps",
          "total_amount",
          "minimum_amount",
          "maximum_amount",
          "largest_amount"
        ],
        "example": {
          "object": "instant_payout_quote",
          "livemode": false,
          "currency": "gbp",
          "destination": "bank",
          "arrives": "within 30 minutes",
          "available": true,
          "reason": null,
          "message": null,
          "fix_url": null,
          "available_from": null,
          "amount": 5813,
          "fee_amount": 59,
          "fee_bps": 99,
          "total_amount": 5872,
          "minimum_amount": 101,
          "maximum_amount": 1009899,
          "largest_amount": 5872
        }
      },
      "InstantPayoutsModel": {
        "type": "object",
        "properties": {
          "available": {
            "type": "boolean",
            "description": "Can you move money instantly right now — to your bank or your card balance (either)? When not, `reason` says why; `destinations` says so for each."
          },
          "reason": {
            "description": "Why neither destination can be used (the bank's reason) — see `destinations` for each. `payouts_disabled` · `not_priced` · `flag_off` · `territory` · `currency` · `held` · `not_approved` · `not_available_yet` (not open on your account yet; `available_from` says when, where we know) · `no_instant_destination` (bank) · `cards_off` · `card_balance_not_instant` · `float_low` (card balance). `territory`, `currency`, `not_priced`, `flag_off`, `float_low` and `payouts_disabled` are nothing you can act on, and the dashboard doesn't show them.",
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "message": {
            "description": "The reason in words, to show as it is; null when available.",
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "fix_url": {
            "description": "Where the business fixes `reason` itself — a dashboard page (`cards_off` the Cards page, `no_instant_destination` the bank details) or, for `held`, the help article that explains it. Null when there is nothing to fix, or only to wait.",
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "available_from": {
            "description": "For `not_available_yet`: when it opens (Unix seconds), where we know; null otherwise.",
            "nullable": true,
            "type": "integer"
          },
          "destinations": {
            "$ref": "#/components/schemas/InstantDestinationsModel"
          },
          "fee_bps": {
            "nullable": true,
            "type": "integer"
          },
          "minimum_amount": {
            "type": "integer"
          },
          "maximum_amount": {
            "type": "integer"
          },
          "largest_amount": {
            "type": "integer"
          }
        },
        "required": [
          "available",
          "reason",
          "message",
          "fix_url",
          "available_from",
          "destinations",
          "fee_bps",
          "minimum_amount",
          "maximum_amount",
          "largest_amount"
        ],
        "example": {
          "available": true,
          "reason": null,
          "message": null,
          "fix_url": null,
          "available_from": null,
          "destinations": {
            "bank": {
              "available": true,
              "reason": null,
              "message": null,
              "fix_url": null,
              "available_from": null,
              "largest_amount": 5872
            },
            "card_balance": {
              "available": false,
              "reason": "card_balance_not_instant",
              "message": "Adding pending money to your card balance isn't available on your account yet.",
              "fix_url": null,
              "available_from": null,
              "largest_amount": 0
            }
          },
          "fee_bps": 99,
          "minimum_amount": 101,
          "maximum_amount": 1009899,
          "largest_amount": 5872
        }
      },
      "InvoiceBody": {
        "type": "object",
        "properties": {
          "customer": {
            "nullable": true
          },
          "lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InvoiceLineBody"
            }
          },
          "currency": {
            "type": "string",
            "maxLength": 3
          },
          "due_in_days": {
            "nullable": true,
            "type": "integer",
            "minimum": 0,
            "maximum": 365
          },
          "due_date": {
            "nullable": true,
            "type": "string",
            "maxLength": 10
          },
          "notes": {
            "nullable": true,
            "type": "string",
            "maxLength": 2000
          },
          "footer": {
            "nullable": true,
            "type": "string",
            "maxLength": 500
          }
        }
      },
      "InvoiceLineBody": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "maxLength": 500,
            "minLength": 1
          },
          "quantity": {
            "type": "integer",
            "maximum": 100000,
            "minimum": 1,
            "multipleOf": 1
          },
          "unit_amount": {
            "type": "integer",
            "minimum": 0,
            "multipleOf": 1
          },
          "tax_rate": {
            "nullable": true,
            "type": "integer",
            "minimum": 0,
            "maximum": 100
          }
        },
        "required": [
          "description",
          "unit_amount"
        ]
      },
      "InvoiceLineModel": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "quantity": {
            "type": "integer",
            "multipleOf": 1
          },
          "unit_amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "tax_rate": {
            "type": "integer"
          },
          "tax": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "description",
          "amount"
        ]
      },
      "InvoiceList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InvoiceModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "InvoiceModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "number": {
            "nullable": true,
            "type": "integer"
          },
          "number_label": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "subscription": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "customer_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "customer_email": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "first",
              "renewal",
              "change",
              "one_off"
            ],
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "open",
              "processing",
              "paid",
              "uncollectible",
              "void"
            ],
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InvoiceLineModel"
            }
          },
          "subtotal": {
            "type": "integer"
          },
          "discount": {
            "type": "integer"
          },
          "credit": {
            "type": "integer"
          },
          "tax": {
            "type": "integer"
          },
          "tax_lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InvoiceTaxLineModel"
            }
          },
          "total": {
            "type": "integer"
          },
          "payment": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "period_start": {
            "nullable": true,
            "type": "integer"
          },
          "period_end": {
            "nullable": true,
            "type": "integer"
          },
          "paid_at": {
            "nullable": true,
            "type": "integer"
          },
          "due_date": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "overdue": {
            "type": "boolean"
          },
          "notes": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "footer": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "sent_at": {
            "nullable": true,
            "type": "integer"
          },
          "voided_at": {
            "nullable": true,
            "type": "integer"
          },
          "pay_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "hosted_invoice_url": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "number",
          "number_label",
          "subscription",
          "customer",
          "customer_name",
          "customer_email",
          "kind",
          "status",
          "currency",
          "lines",
          "subtotal",
          "discount",
          "credit",
          "tax",
          "tax_lines",
          "total",
          "payment",
          "period_start",
          "period_end",
          "paid_at",
          "due_date",
          "overdue",
          "notes",
          "footer",
          "sent_at",
          "voided_at",
          "pay_url",
          "hosted_invoice_url",
          "created"
        ]
      },
      "InvoiceTaxLineModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "rate": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "name",
          "rate",
          "amount"
        ]
      },
      "IssuingAutoTopupBody": {
        "type": "object",
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "threshold": {
            "type": "integer",
            "multipleOf": 1
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "method": {
            "type": "string",
            "enum": [
              "card",
              "balance"
            ]
          },
          "payment_method": {
            "nullable": true,
            "type": "string"
          },
          "speed": {
            "type": "string",
            "enum": [
              "standard",
              "instant"
            ]
          },
          "max_per_day": {
            "type": "integer",
            "multipleOf": 1
          },
          "max_per_month": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "IssuingAutoTopupCardModel": {
        "type": "object",
        "properties": {
          "brand": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "last4": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "words": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "brand",
          "last4",
          "status",
          "words"
        ]
      },
      "IssuingAutoTopupFailureModel": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "minLength": 1
          },
          "message": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "code",
          "message",
          "at"
        ]
      },
      "IssuingAutoTopupModel": {
        "type": "object",
        "properties": {
          "id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "enabled": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "enum": [
              "off",
              "active",
              "paused"
            ],
            "minLength": 1
          },
          "threshold": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "method": {
            "type": "string",
            "enum": [
              "card",
              "balance"
            ],
            "minLength": 1
          },
          "payment_method": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "payment_method_card": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/IssuingAutoTopupCardModel"
              }
            ],
            "nullable": true
          },
          "speed": {
            "type": "string",
            "enum": [
              "standard",
              "instant"
            ],
            "minLength": 1
          },
          "max_per_day": {
            "type": "integer"
          },
          "max_per_month": {
            "type": "integer"
          },
          "made_today": {
            "type": "integer"
          },
          "made_this_month": {
            "type": "integer"
          },
          "paused_until": {
            "nullable": true,
            "type": "integer"
          },
          "last_failure": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/IssuingAutoTopupFailureModel"
              }
            ],
            "nullable": true
          },
          "last_triggered_at": {
            "nullable": true,
            "type": "integer"
          },
          "last_run": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/IssuingAutoTopupRunModel"
              }
            ],
            "nullable": true
          },
          "fix_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "updated": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "enabled",
          "status",
          "threshold",
          "amount",
          "currency",
          "method",
          "payment_method",
          "payment_method_card",
          "speed",
          "max_per_day",
          "max_per_month",
          "made_today",
          "made_this_month",
          "paused_until",
          "last_failure",
          "last_triggered_at",
          "last_run",
          "fix_url",
          "updated"
        ],
        "example": {
          "id": "atu_01J8ZKF3A5B7C9D1E3F5G7H9J2",
          "object": "issuing_auto_topup",
          "livemode": false,
          "enabled": true,
          "status": "active",
          "threshold": 20000,
          "amount": 50000,
          "currency": "gbp",
          "method": "card",
          "payment_method": "tpm_01J8ZKF3A5B7C9D1E3F5G7H9J3",
          "payment_method_card": {
            "brand": "visa",
            "last4": "4242",
            "status": "active",
            "words": "Visa ••••4242"
          },
          "speed": "standard",
          "max_per_day": 3,
          "max_per_month": 30,
          "made_today": 0,
          "made_this_month": 2,
          "paused_until": null,
          "last_failure": null,
          "last_triggered_at": 1789900000,
          "last_run": null,
          "fix_url": null,
          "updated": 1789800000
        }
      },
      "IssuingAutoTopupRunModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "sequence": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "made",
              "failed"
            ],
            "minLength": 1
          },
          "cause": {
            "type": "string",
            "minLength": 1
          },
          "topup": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "failure_code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "failure_message": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "sequence",
          "status",
          "cause",
          "topup",
          "failure_code",
          "failure_message",
          "created"
        ]
      },
      "IssuingBalanceModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "spendable": {
            "type": "integer"
          },
          "earned": {
            "type": "integer"
          },
          "on_hold": {
            "type": "integer"
          },
          "spends_from": {
            "type": "string",
            "enum": [
              "issuing_balance",
              "payments_balance"
            ],
            "minLength": 1
          },
          "limited_by": {
            "nullable": true,
            "type": "string",
            "minLength": 1,
            "enum": [
              "payouts_not_approved",
              "payouts_on_hold",
              "cleared",
              "not_available_yet"
            ]
          },
          "available_from": {
            "nullable": true,
            "type": "integer"
          },
          "message": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "pending_topups": {
            "$ref": "#/components/schemas/PendingTopupsModel"
          },
          "next_available_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "object",
          "currency",
          "spendable",
          "earned",
          "on_hold",
          "spends_from",
          "limited_by",
          "available_from",
          "message",
          "pending_topups",
          "next_available_at"
        ],
        "example": {
          "object": "issuing_balance",
          "currency": "usd",
          "spendable": 25000,
          "earned": 142350,
          "on_hold": 0,
          "spends_from": "payments_balance",
          "limited_by": "cleared",
          "available_from": 1789977200,
          "message": "$1,173.50 more becomes spendable when your latest payments clear.",
          "pending_topups": {
            "amount": 0,
            "count": 0,
            "awaiting": {
              "amount": 0,
              "count": 0
            }
          },
          "next_available_at": null
        }
      },
      "IssuingFundingList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IssuingFundingModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "IssuingFundingModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "source": {
            "type": "string",
            "enum": [
              "push",
              "balance_transfer"
            ],
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "available",
              "failed"
            ],
            "minLength": 1
          },
          "available_at": {
            "nullable": true,
            "type": "integer"
          },
          "expected_available_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "amount",
          "currency",
          "source",
          "status",
          "available_at",
          "expected_available_at",
          "created"
        ]
      },
      "IssuingLimitModel": {
        "type": "object",
        "properties": {
          "value": {
            "nullable": true,
            "type": "integer"
          },
          "used": {
            "nullable": true,
            "type": "integer"
          },
          "reached": {
            "type": "boolean"
          },
          "resets_at": {
            "nullable": true,
            "type": "integer"
          },
          "expires_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "value",
          "used",
          "reached",
          "resets_at",
          "expires_at"
        ]
      },
      "IssuingLimitValuesModel": {
        "type": "object",
        "properties": {
          "issuing_cards_active": {
            "$ref": "#/components/schemas/IssuingLimitModel"
          },
          "issuing_cards_daily": {
            "$ref": "#/components/schemas/IssuingLimitModel"
          },
          "issuing_cards_30d": {
            "$ref": "#/components/schemas/IssuingLimitModel"
          },
          "issuing_cardholders": {
            "$ref": "#/components/schemas/IssuingLimitModel"
          },
          "issuing_physical_cards": {
            "$ref": "#/components/schemas/IssuingLimitModel"
          },
          "issuing_replacements_90d": {
            "$ref": "#/components/schemas/IssuingLimitModel"
          },
          "issuing_spend_daily": {
            "$ref": "#/components/schemas/IssuingLimitModel"
          },
          "issuing_spend_30d": {
            "$ref": "#/components/schemas/IssuingLimitModel"
          },
          "issuing_max_authorization": {
            "$ref": "#/components/schemas/IssuingLimitModel"
          },
          "issuing_quasi_cash": {
            "$ref": "#/components/schemas/IssuingLimitModel"
          },
          "issuing_provisional_credit": {
            "$ref": "#/components/schemas/IssuingLimitModel"
          }
        },
        "required": [
          "issuing_cards_active",
          "issuing_cards_daily",
          "issuing_cards_30d",
          "issuing_cardholders",
          "issuing_physical_cards",
          "issuing_replacements_90d",
          "issuing_spend_daily",
          "issuing_spend_30d",
          "issuing_max_authorization",
          "issuing_quasi_cash",
          "issuing_provisional_credit"
        ]
      },
      "IssuingLimitsModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "restricted": {
            "type": "boolean"
          },
          "trial": {
            "type": "boolean"
          },
          "enforced": {
            "type": "boolean"
          },
          "increase_url": {
            "type": "string",
            "minLength": 1
          },
          "limits": {
            "$ref": "#/components/schemas/IssuingLimitValuesModel"
          }
        },
        "required": [
          "object",
          "livemode",
          "restricted",
          "trial",
          "enforced",
          "increase_url",
          "limits"
        ],
        "example": {
          "object": "issuing_limits",
          "livemode": false,
          "restricted": false,
          "trial": true,
          "enforced": true,
          "increase_url": "https://dashboard.tuppence.ai/acct_01J8ZKC5D7E9F1G3H5J7K9M1N3/test/support/new",
          "limits": {
            "issuing_cards_active": {
              "value": null,
              "used": null,
              "reached": false,
              "resets_at": null,
              "expires_at": null
            },
            "issuing_cards_daily": {
              "value": null,
              "used": null,
              "reached": true,
              "resets_at": null,
              "expires_at": null
            },
            "issuing_cards_30d": {
              "value": null,
              "used": null,
              "reached": false,
              "resets_at": null,
              "expires_at": null
            },
            "issuing_cardholders": {
              "value": null,
              "used": null,
              "reached": false,
              "resets_at": null,
              "expires_at": null
            },
            "issuing_physical_cards": {
              "value": null,
              "used": null,
              "reached": false,
              "resets_at": null,
              "expires_at": null
            },
            "issuing_replacements_90d": {
              "value": null,
              "used": null,
              "reached": false,
              "resets_at": null,
              "expires_at": null
            },
            "issuing_spend_daily": {
              "value": null,
              "used": null,
              "reached": false,
              "resets_at": null,
              "expires_at": null
            },
            "issuing_spend_30d": {
              "value": null,
              "used": null,
              "reached": false,
              "resets_at": null,
              "expires_at": null
            },
            "issuing_max_authorization": {
              "value": null,
              "used": null,
              "reached": false,
              "resets_at": null,
              "expires_at": null
            },
            "issuing_quasi_cash": {
              "value": null,
              "used": null,
              "reached": false,
              "resets_at": null,
              "expires_at": null
            },
            "issuing_provisional_credit": {
              "value": null,
              "used": null,
              "reached": false,
              "resets_at": null,
              "expires_at": null
            }
          }
        }
      },
      "IssuingTopupBody": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string",
            "enum": [
              "bank_transfer",
              "card",
              "balance",
              "platform",
              "instant_from_balance"
            ],
            "minLength": 1
          },
          "speed": {
            "type": "string",
            "enum": [
              "standard",
              "instant"
            ]
          },
          "amount_type": {
            "type": "string",
            "enum": [
              "receive",
              "pay"
            ]
          },
          "confirmation_token": {
            "type": "string"
          },
          "payment_method": {
            "type": "string"
          },
          "save_payment_method": {
            "type": "boolean"
          },
          "return_url": {
            "type": "string"
          },
          "business_funds": {
            "type": "boolean"
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "method"
        ]
      },
      "IssuingTopupCardDetailsModel": {
        "type": "object",
        "properties": {
          "brand": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "last4": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "exp_month": {
            "nullable": true,
            "type": "integer"
          },
          "exp_year": {
            "nullable": true,
            "type": "integer"
          },
          "country": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "funding": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "brand",
          "last4",
          "exp_month",
          "exp_year",
          "country",
          "funding"
        ]
      },
      "IssuingTopupDelayModel": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "enum": [
              "awaiting_transfer",
              "bank_processing",
              "outside_banking_hours",
              "clearing",
              "moving_to_card_balance",
              "first_transfers_reviewed",
              "under_review",
              "held"
            ],
            "minLength": 1
          },
          "message": {
            "type": "string",
            "minLength": 1
          },
          "until": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "code",
          "message",
          "until"
        ]
      },
      "IssuingTopupFeeModel": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer"
          },
          "rate_bps": {
            "type": "integer"
          },
          "category": {
            "type": "string",
            "enum": [
              "instant",
              "card",
              "bank_transfer",
              "none"
            ],
            "minLength": 1
          },
          "fixed": {
            "type": "integer"
          },
          "surcharges": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "instant_bps": {
            "type": "integer"
          },
          "instant_amount": {
            "type": "integer"
          },
          "pricing_version": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "platform_fee": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/TopupPlatformFeeModel"
              }
            ],
            "nullable": true
          },
          "paid_by": {
            "type": "string",
            "enum": [
              "account",
              "platform"
            ],
            "minLength": 1
          }
        },
        "required": [
          "amount",
          "rate_bps",
          "category",
          "pricing_version",
          "platform_fee",
          "paid_by"
        ]
      },
      "IssuingTopupLinkModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "return_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "open",
              "used",
              "expired"
            ],
            "minLength": 1
          },
          "topup": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "expires_at": {
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "url",
          "amount",
          "currency",
          "return_url",
          "status",
          "topup",
          "expires_at",
          "created"
        ],
        "example": {
          "id": "itul_01J8ZKF3A5B7C9D1E3F5G7H9J1",
          "object": "issuing_topup_link",
          "livemode": false,
          "url": "https://pay.tuppence.ai/card-topup/7H9J1X5G7H9J1X5G7H9J1X5G7H9J1X",
          "amount": 10000,
          "currency": "gbp",
          "return_url": "https://groomly.example.com/cards",
          "status": "open",
          "topup": null,
          "expires_at": 1790056400,
          "created": 1789970000
        }
      },
      "IssuingTopupList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IssuingTopupModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "IssuingTopupMandateModel": {
        "type": "object",
        "properties": {
          "text": {
            "type": "string",
            "minLength": 1
          },
          "accepted_at": {
            "nullable": true,
            "type": "integer"
          },
          "accepted_by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "text",
          "accepted_at",
          "accepted_by"
        ]
      },
      "IssuingTopupModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "total": {
            "type": "integer"
          },
          "amount_type": {
            "type": "string",
            "enum": [
              "receive",
              "pay"
            ],
            "minLength": 1
          },
          "method": {
            "type": "string",
            "enum": [
              "bank_transfer",
              "card",
              "balance",
              "platform"
            ],
            "minLength": 1
          },
          "speed": {
            "type": "string",
            "enum": [
              "standard",
              "instant"
            ],
            "minLength": 1
          },
          "trigger": {
            "type": "string",
            "enum": [
              "manual",
              "auto",
              "incoming"
            ],
            "minLength": 1
          },
          "route": {
            "type": "string",
            "enum": [
              "debit_and_issuing_transfer",
              "issuing_push",
              "balance_transfer",
              "customer_balance",
              "card_payment",
              "card_payment_and_balance_transfer",
              "card_payment_and_issuing_transfer",
              "platform_transfer",
              "platform_transfer_and_balance_transfer"
            ],
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "requires_action",
              "processing",
              "in_transit",
              "available",
              "failed",
              "canceled",
              "reversed"
            ],
            "minLength": 1
          },
          "fee": {
            "$ref": "#/components/schemas/IssuingTopupFeeModel"
          },
          "next_action": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/IssuingTopupNextActionModel"
              }
            ],
            "nullable": true
          },
          "delay": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/IssuingTopupDelayModel"
              }
            ],
            "nullable": true
          },
          "payment_method": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "funding_mandate": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "failure_code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "failure_message": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "expected_available_at": {
            "nullable": true,
            "type": "integer"
          },
          "available_at": {
            "nullable": true,
            "type": "integer"
          },
          "canceled_at": {
            "nullable": true,
            "type": "integer"
          },
          "spendable_after": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          },
          "client_secret": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "amount",
          "currency",
          "total",
          "amount_type",
          "method",
          "speed",
          "trigger",
          "route",
          "status",
          "fee",
          "next_action",
          "delay",
          "payment_method",
          "funding_mandate",
          "failure_code",
          "failure_message",
          "expected_available_at",
          "available_at",
          "canceled_at",
          "spendable_after",
          "created"
        ],
        "example": {
          "id": "itu_01J8ZKF3A5B7C9D1E3F5G7H9J1",
          "object": "issuing_topup",
          "livemode": false,
          "amount": 10000,
          "currency": "gbp",
          "total": 10000,
          "amount_type": "receive",
          "method": "bank_transfer",
          "speed": "standard",
          "trigger": "manual",
          "route": "issuing_push",
          "status": "requires_action",
          "fee": {
            "amount": 0,
            "rate_bps": 0,
            "category": "none",
            "pricing_version": null,
            "platform_fee": null,
            "paid_by": "account"
          },
          "next_action": {
            "type": "bank_transfer_instructions",
            "bank_transfer": {
              "reference": "TOPUP 5G7H9J1X",
              "account_holder_name": "Bella's Salon Ltd",
              "account_number": "00012345",
              "sort_code": "000000",
              "routing_number": null,
              "bank_name": null
            }
          },
          "delay": {
            "code": "awaiting_transfer",
            "message": "Waiting for your bank transfer. Faster Payments usually arrive within two hours while banks are open.",
            "until": 1789977200
          },
          "payment_method": null,
          "funding_mandate": null,
          "failure_code": null,
          "failure_message": null,
          "expected_available_at": 1789977200,
          "available_at": null,
          "canceled_at": null,
          "spendable_after": null,
          "created": 1789970000
        }
      },
      "IssuingTopupNextActionModel": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "bank_transfer_instructions",
              "confirm_payment"
            ],
            "minLength": 1
          },
          "bank_transfer": {
            "$ref": "#/components/schemas/TopupBankTransferModel"
          },
          "confirm_payment": {
            "$ref": "#/components/schemas/TopupConfirmPaymentModel"
          }
        },
        "required": [
          "type"
        ]
      },
      "IssuingTopupOptionModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "method": {
            "type": "string",
            "enum": [
              "bank_transfer",
              "card",
              "balance",
              "platform"
            ],
            "minLength": 1
          },
          "speed": {
            "type": "string",
            "enum": [
              "standard",
              "instant"
            ],
            "minLength": 1
          },
          "available": {
            "type": "boolean"
          },
          "reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "message": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "fix_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "amount_type": {
            "type": "string",
            "enum": [
              "receive",
              "pay"
            ],
            "minLength": 1
          },
          "fee": {
            "$ref": "#/components/schemas/TopupOptionFeeModel"
          },
          "total": {
            "nullable": true,
            "type": "integer"
          },
          "minimum": {
            "nullable": true,
            "type": "integer"
          },
          "maximum": {
            "nullable": true,
            "type": "integer"
          },
          "expected_available_at": {
            "nullable": true,
            "type": "integer"
          },
          "delay": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/IssuingTopupDelayModel"
              }
            ],
            "nullable": true
          },
          "bank_transfer": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/TopupOptionBankDetailsModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "object",
          "method",
          "speed",
          "available",
          "reason",
          "message",
          "fix_url",
          "amount_type",
          "fee",
          "total",
          "minimum",
          "maximum",
          "expected_available_at",
          "delay",
          "bank_transfer"
        ]
      },
      "IssuingTopupOptionsList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IssuingTopupOptionModel"
            }
          }
        },
        "required": [
          "object",
          "currency",
          "amount",
          "data"
        ],
        "example": {
          "object": "list",
          "currency": "gbp",
          "amount": 10000,
          "data": [
            {
              "object": "issuing_topup_option",
              "method": "bank_transfer",
              "speed": "standard",
              "available": true,
              "reason": null,
              "message": null,
              "fix_url": null,
              "amount_type": "receive",
              "fee": {
                "amount": 0,
                "rate_bps": 0,
                "fixed": 0,
                "cap": null,
                "platform_fee": null,
                "paid_by": "account"
              },
              "total": 10000,
              "minimum": null,
              "maximum": null,
              "expected_available_at": 1789984800,
              "delay": {
                "code": "awaiting_transfer",
                "message": "Waiting for your bank transfer. Faster Payments usually arrive within two hours while banks are open.",
                "until": 1789984800
              },
              "bank_transfer": {
                "account_holder_name": "Bella's Salon Ltd",
                "account_number": "00012345",
                "sort_code": "108800",
                "routing_number": null,
                "bank_name": null
              }
            },
            {
              "object": "issuing_topup_option",
              "method": "balance",
              "speed": "standard",
              "available": false,
              "reason": "not_open_yet",
              "message": "Moving your cleared earnings onto your cards at the standard speed is coming soon. Top up by bank transfer (free), or move pending money onto your cards now with `speed: instant`.",
              "fix_url": "https://dashboard.tuppence.ai/acct_01J8ZKF3A5B7C9D1E3F5G7H9J1/test/cards",
              "amount_type": "receive",
              "fee": {
                "amount": 0,
                "rate_bps": 0,
                "fixed": 0,
                "cap": null,
                "platform_fee": null,
                "paid_by": "account"
              },
              "total": null,
              "minimum": null,
              "maximum": null,
              "expected_available_at": null,
              "delay": null,
              "bank_transfer": null
            },
            {
              "object": "issuing_topup_option",
              "method": "balance",
              "speed": "instant",
              "available": true,
              "reason": null,
              "message": null,
              "fix_url": null,
              "amount_type": "pay",
              "fee": {
                "amount": 100,
                "rate_bps": 99,
                "fixed": 0,
                "cap": null,
                "platform_fee": null,
                "paid_by": "account"
              },
              "total": 10100,
              "minimum": 102,
              "maximum": 50000,
              "expected_available_at": 1789977600,
              "delay": {
                "code": "moving_to_card_balance",
                "message": "Moved from your pending money onto your card balance, usually within minutes.",
                "until": 1789977600
              },
              "bank_transfer": null
            }
          ]
        }
      },
      "IssuingTopupPaymentMethodList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IssuingTopupPaymentMethodModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "IssuingTopupPaymentMethodModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "type": {
            "type": "string",
            "enum": [
              "card"
            ],
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "active",
              "removed"
            ],
            "minLength": 1
          },
          "card": {
            "$ref": "#/components/schemas/IssuingTopupCardDetailsModel"
          },
          "mandate": {
            "$ref": "#/components/schemas/IssuingTopupMandateModel"
          },
          "saved_by_topup": {
            "type": "string",
            "minLength": 1
          },
          "removed_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "type",
          "status",
          "card",
          "mandate",
          "saved_by_topup",
          "removed_at",
          "created"
        ]
      },
      "ItemActionBody": {
        "type": "object",
        "properties": {
          "action": {
            "type": "string",
            "maxLength": 16,
            "minLength": 1
          },
          "payload": {
            "nullable": true
          },
          "field": {
            "type": "string",
            "maxLength": 80
          }
        },
        "required": [
          "action"
        ]
      },
      "JobReadModel": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "minLength": 1
          },
          "id": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "type",
          "id"
        ]
      },
      "JobRunEventData": {
        "type": "object",
        "description": "What an event carrying a `job_run` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/JobRunEventObject"
          }
        }
      },
      "JobRunEventObject": {
        "type": "object",
        "description": "A `job_run` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "job_run"
          }
        },
        "additionalProperties": true
      },
      "JobRunFinishedEvent": {
        "type": "object",
        "description": "The `job_run.finished` event (the store's assistant events): `data.object` is the `job_run`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "job_run.finished"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/JobRunEventData"
          }
        }
      },
      "JobScheduleModel": {
        "type": "object",
        "properties": {
          "days": {
            "type": "array",
            "items": {
              "type": "integer"
            }
          },
          "at": {
            "type": "string",
            "minLength": 1
          },
          "first_of_month": {
            "type": "boolean"
          }
        },
        "required": [
          "days",
          "at",
          "first_of_month"
        ]
      },
      "JwkModel": {
        "type": "object",
        "properties": {
          "kty": {
            "type": "string",
            "minLength": 1
          },
          "crv": {
            "type": "string",
            "minLength": 1
          },
          "x": {
            "type": "string",
            "minLength": 1
          },
          "kid": {
            "type": "string",
            "minLength": 1
          },
          "use": {
            "type": "string",
            "minLength": 1
          },
          "alg": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "kty",
          "crv",
          "x",
          "kid",
          "use",
          "alg"
        ]
      },
      "JwksModel": {
        "type": "object",
        "properties": {
          "keys": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/JwkModel"
            }
          }
        },
        "required": [
          "keys"
        ]
      },
      "LabelBatchBody": {
        "type": "object",
        "properties": {
          "fulfilments": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "minItems": 1,
            "maxItems": 50
          }
        }
      },
      "LabelBatchErrorModel": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "minLength": 1
          },
          "message": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "code",
          "message"
        ]
      },
      "LabelBatchModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "bought": {
            "type": "integer"
          },
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LabelBatchResultModel"
            }
          }
        },
        "required": [
          "object",
          "bought",
          "results"
        ]
      },
      "LabelBatchResultModel": {
        "type": "object",
        "properties": {
          "fulfilment": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/FulfilmentModel"
              }
            ],
            "nullable": true
          },
          "error": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/LabelBatchErrorModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "fulfilment",
          "status",
          "object",
          "error"
        ]
      },
      "LabelBody": {
        "type": "object",
        "properties": {
          "service": {
            "type": "string",
            "maxLength": 40
          },
          "confirm_amount": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "LabelRateList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LabelRateModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "LabelRateModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "service_code": {
            "type": "string",
            "minLength": 1
          },
          "carrier": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "expected_amount": {
            "nullable": true,
            "type": "integer"
          },
          "min_days": {
            "nullable": true,
            "type": "integer"
          },
          "max_days": {
            "nullable": true,
            "type": "integer"
          },
          "chosen": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "service_code",
          "carrier",
          "name",
          "amount",
          "currency",
          "expected_amount",
          "min_days",
          "max_days",
          "chosen"
        ]
      },
      "LateCancellationRateModel": {
        "type": "object",
        "properties": {
          "bookings": {
            "type": "integer"
          },
          "late_cancellations": {
            "type": "integer"
          },
          "rate": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "bookings",
          "late_cancellations",
          "rate"
        ]
      },
      "LateCancellationSplitModel": {
        "type": "object",
        "properties": {
          "all": {
            "$ref": "#/components/schemas/LateCancellationRateModel"
          },
          "card_on_file": {
            "$ref": "#/components/schemas/LateCancellationRateModel"
          },
          "no_card_on_file": {
            "$ref": "#/components/schemas/LateCancellationRateModel"
          },
          "reminded": {
            "$ref": "#/components/schemas/LateCancellationRateModel"
          },
          "not_reminded": {
            "$ref": "#/components/schemas/LateCancellationRateModel"
          }
        },
        "required": [
          "all",
          "card_on_file",
          "no_card_on_file",
          "reminded",
          "not_reminded"
        ]
      },
      "LayoutPageBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "tiles": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LayoutTileBody"
            }
          }
        },
        "required": [
          "name",
          "tiles"
        ]
      },
      "LayoutPageModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "tiles": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LayoutTileModel"
            }
          }
        },
        "required": [
          "name",
          "tiles"
        ]
      },
      "LayoutTileBody": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "product",
              "variant",
              "category",
              "discount",
              "action"
            ],
            "minLength": 1
          },
          "id": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "colour": {
            "nullable": true,
            "type": "string",
            "maxLength": 7
          },
          "size": {
            "nullable": true,
            "type": "string",
            "maxLength": 3
          }
        },
        "required": [
          "kind",
          "id"
        ]
      },
      "LayoutTileModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "product",
              "variant",
              "category",
              "discount",
              "action"
            ],
            "minLength": 1
          },
          "id": {
            "type": "string",
            "minLength": 1
          },
          "colour": {
            "type": "string"
          },
          "size": {
            "type": "string"
          }
        },
        "required": [
          "kind",
          "id"
        ]
      },
      "LeadTimeModel": {
        "type": "object",
        "properties": {
          "bookings": {
            "type": "integer"
          },
          "average_minutes": {
            "nullable": true,
            "type": "integer"
          },
          "median_minutes": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "bookings",
          "average_minutes",
          "median_minutes"
        ]
      },
      "LicenceKeyPoolModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "product": {
            "type": "string",
            "minLength": 1
          },
          "available": {
            "type": "integer"
          },
          "assigned": {
            "type": "integer"
          },
          "waiting": {
            "type": "integer"
          },
          "added": {
            "type": "integer"
          },
          "duplicates": {
            "type": "integer"
          }
        },
        "required": [
          "object",
          "product",
          "available",
          "assigned",
          "waiting"
        ]
      },
      "LicenceKeysBody": {
        "type": "object",
        "properties": {
          "keys": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "keys"
        ]
      },
      "LimitsBody": {
        "type": "object",
        "properties": {
          "per_authorization": {
            "nullable": true,
            "type": "integer",
            "multipleOf": 1
          },
          "daily": {
            "nullable": true,
            "type": "integer",
            "multipleOf": 1
          },
          "weekly": {
            "nullable": true,
            "type": "integer",
            "multipleOf": 1
          },
          "monthly": {
            "nullable": true,
            "type": "integer",
            "multipleOf": 1
          },
          "all_time": {
            "nullable": true,
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "LineDiscountBody": {
        "type": "object",
        "properties": {
          "discount": {
            "type": "string",
            "maxLength": 40
          },
          "kind": {
            "type": "string",
            "enum": [
              "percent",
              "fixed"
            ]
          },
          "value": {
            "type": "integer"
          },
          "reason": {
            "type": "string",
            "maxLength": 200
          }
        }
      },
      "LineModifierModel": {
        "type": "object",
        "properties": {
          "modifier": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "modifier",
          "name",
          "amount"
        ]
      },
      "LineTaxModel": {
        "type": "object",
        "properties": {
          "tax_rate": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "rate_ppm": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "inclusive": {
            "type": "boolean"
          }
        },
        "required": [
          "tax_rate",
          "name",
          "rate_ppm",
          "amount",
          "inclusive"
        ]
      },
      "LineVoidModel": {
        "type": "object",
        "properties": {
          "at": {
            "type": "integer"
          },
          "by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "at",
          "by",
          "reason"
        ]
      },
      "ListingBody": {
        "type": "object",
        "properties": {
          "location": {
            "type": "string",
            "maxLength": 200
          },
          "maps_link": {
            "type": "string",
            "maxLength": 2048
          }
        }
      },
      "ListingEventData": {
        "type": "object",
        "description": "What an event carrying a `listing` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/ListingEventObject"
          }
        }
      },
      "ListingEventObject": {
        "type": "object",
        "description": "A `listing` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "listing"
          }
        },
        "additionalProperties": true
      },
      "ListingIssueModel": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "minLength": 1
          },
          "severity": {
            "type": "string",
            "enum": [
              "error",
              "warning"
            ],
            "minLength": 1
          },
          "attribute": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "channel_message": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "message": {
            "type": "string",
            "minLength": 1
          },
          "fix_field": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "fix_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "auto_fixable": {
            "type": "boolean"
          }
        },
        "required": [
          "code",
          "severity",
          "attribute",
          "channel_message",
          "message",
          "fix_field",
          "fix_url",
          "auto_fixable"
        ]
      },
      "ListingList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ListingModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ListingLiveEvent": {
        "type": "object",
        "description": "The `listing.live` event (the store's channels events): `data.object` is the `listing`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "listing.live"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ListingEventData"
          }
        }
      },
      "ListingModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "sales_channel": {
            "type": "string",
            "minLength": 1
          },
          "product": {
            "type": "string",
            "minLength": 1
          },
          "variant": {
            "type": "string",
            "minLength": 1
          },
          "state": {
            "type": "string",
            "enum": [
              "pending",
              "live",
              "rejected",
              "excluded",
              "removed"
            ],
            "minLength": 1
          },
          "excluded_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1,
            "enum": [
              "business",
              "not_online",
              "restricted",
              "age_restricted",
              "kind",
              "policy",
              "not_shippable"
            ]
          },
          "retailer_id": {
            "type": "string",
            "minLength": 1
          },
          "external_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "sent_amount": {
            "nullable": true,
            "type": "integer"
          },
          "sent_currency": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "sent_quantity": {
            "nullable": true,
            "type": "integer"
          },
          "sent_at": {
            "nullable": true,
            "type": "integer"
          },
          "acknowledged_at": {
            "nullable": true,
            "type": "integer"
          },
          "issues": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ListingIssueModel"
            }
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "sales_channel",
          "product",
          "variant",
          "state",
          "excluded_reason",
          "retailer_id",
          "external_id",
          "sent_amount",
          "sent_currency",
          "sent_quantity",
          "sent_at",
          "acknowledged_at",
          "issues",
          "livemode",
          "created"
        ]
      },
      "ListingRejectedEvent": {
        "type": "object",
        "description": "The `listing.rejected` event (the store's channels events): `data.object` is the `listing`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "listing.rejected"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ListingEventData"
          }
        }
      },
      "ListingRemovedEvent": {
        "type": "object",
        "description": "The `listing.removed` event (the store's channels events): `data.object` is the `listing`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "listing.removed"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ListingEventData"
          }
        }
      },
      "ListingRestrictedEvent": {
        "type": "object",
        "description": "The `listing.restricted` event (the store's channels events): `data.object` is the `product_screen`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "listing.restricted"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ProductScreenEventData"
          }
        }
      },
      "LiveConnectConditionModel": {
        "type": "object",
        "properties": {
          "condition": {
            "type": "string",
            "enum": [
              "payouts_approved",
              "live_30_days",
              "platform_agreement"
            ],
            "minLength": 1
          },
          "met": {
            "type": "boolean"
          },
          "message": {
            "type": "string",
            "minLength": 1
          },
          "available_from": {
            "nullable": true,
            "type": "integer"
          },
          "fix_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "condition",
          "met",
          "message",
          "available_from",
          "fix_url"
        ]
      },
      "LiveConnectModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "enabled": {
            "type": "boolean"
          },
          "ready": {
            "type": "boolean"
          },
          "missing": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "conditions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LiveConnectConditionModel"
            }
          },
          "agreement": {
            "$ref": "#/components/schemas/PlatformAgreementModel"
          }
        },
        "required": [
          "object",
          "enabled",
          "ready",
          "missing",
          "conditions",
          "agreement"
        ]
      },
      "LocationAddressBody": {
        "type": "object",
        "properties": {
          "line1": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          },
          "line2": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          },
          "city": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          },
          "state": {
            "nullable": true,
            "type": "string",
            "maxLength": 100
          },
          "postal_code": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          },
          "country": {
            "nullable": true,
            "type": "string",
            "maxLength": 2
          }
        }
      },
      "LocationAddressModel": {
        "type": "object",
        "properties": {
          "line1": {
            "nullable": true,
            "type": "string"
          },
          "line2": {
            "nullable": true,
            "type": "string"
          },
          "city": {
            "nullable": true,
            "type": "string"
          },
          "state": {
            "nullable": true,
            "type": "string"
          },
          "postal_code": {
            "nullable": true,
            "type": "string"
          },
          "country": {
            "nullable": true,
            "type": "string"
          }
        }
      },
      "LocationBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 120
          },
          "kind": {
            "type": "string",
            "enum": [
              "premises",
              "mobile",
              "online"
            ]
          },
          "timezone": {
            "type": "string",
            "maxLength": 64
          },
          "address": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/LocationAddressBody"
              }
            ],
            "nullable": true
          },
          "phone": {
            "nullable": true,
            "type": "string",
            "maxLength": 32
          },
          "opening_hours": {
            "type": "object"
          },
          "service_area": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ServiceAreaBody"
              }
            ],
            "nullable": true
          },
          "meeting_url_template": {
            "nullable": true,
            "type": "string",
            "maxLength": 500
          },
          "travel_buffer_minutes": {
            "type": "integer",
            "multipleOf": 1
          },
          "sort": {
            "type": "integer",
            "multipleOf": 1
          },
          "country": {
            "type": "string",
            "maxLength": 2
          },
          "currency": {
            "type": "string",
            "maxLength": 3
          },
          "sender_name": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "reply_to": {
            "nullable": true,
            "type": "string",
            "maxLength": 320
          },
          "locale": {
            "type": "string",
            "maxLength": 35
          },
          "units": {
            "type": "string",
            "enum": [
              "metric",
              "imperial"
            ]
          }
        }
      },
      "LocationCollectionBody": {
        "type": "object",
        "properties": {
          "slots": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CollectionSlotsBody"
              }
            ],
            "nullable": true
          },
          "ready_within_hours": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "LocationCollectionModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "slots": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CollectionSlotsSettingsModel"
              }
            ],
            "nullable": true
          },
          "ready_within_hours": {
            "type": "integer"
          },
          "upcoming": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CollectionSlotModel"
            }
          }
        },
        "required": [
          "object",
          "location",
          "slots",
          "ready_within_hours",
          "upcoming"
        ]
      },
      "LocationList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LocationModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "LocationModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "premises",
              "mobile",
              "online"
            ],
            "minLength": 1
          },
          "timezone": {
            "type": "string",
            "minLength": 1
          },
          "address": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/LocationAddressModel"
              }
            ],
            "nullable": true
          },
          "phone": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "opening_hours": {
            "type": "object"
          },
          "service_area": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ServiceAreaModel"
              }
            ],
            "nullable": true
          },
          "meeting_url_template": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "travel_buffer_minutes": {
            "type": "integer"
          },
          "sort": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ],
            "minLength": 1
          },
          "country": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "locale": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "units": {
            "nullable": true,
            "type": "string",
            "minLength": 1,
            "enum": [
              "metric",
              "imperial"
            ]
          },
          "week_start": {
            "nullable": true,
            "type": "integer"
          },
          "day_cutoff": {
            "type": "string",
            "minLength": 1
          },
          "fiscal_regime": {
            "type": "string",
            "enum": [
              "none",
              "nf525",
              "tse",
              "corrispettivi",
              "verifactu",
              "gks",
              "web_srm"
            ],
            "minLength": 1
          },
          "tax": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/LocationTaxModel"
              }
            ],
            "nullable": true
          },
          "sender_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "reply_to": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "name",
          "kind",
          "timezone",
          "address",
          "phone",
          "opening_hours",
          "service_area",
          "meeting_url_template",
          "travel_buffer_minutes",
          "sort",
          "status",
          "country",
          "currency",
          "locale",
          "units",
          "week_start",
          "day_cutoff",
          "fiscal_regime",
          "tax",
          "sender_name",
          "reply_to",
          "created"
        ]
      },
      "LocationTaxBody": {
        "type": "object",
        "properties": {
          "prices_include_tax": {
            "type": "boolean"
          },
          "rounding": {
            "type": "string",
            "enum": [
              "per_line",
              "per_total"
            ]
          },
          "rounding_mode": {
            "type": "string",
            "enum": [
              "half_up",
              "half_even",
              "down"
            ]
          },
          "cash_rounding": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CashRoundingBody"
              }
            ],
            "nullable": true
          },
          "default_tax_class_id": {
            "type": "string",
            "maxLength": 40
          },
          "registrations": {
            "type": "object"
          },
          "exempt_reasons": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "automatic": {
            "type": "string",
            "enum": [
              "none",
              "stripe_tax"
            ]
          },
          "region": {
            "type": "string",
            "maxLength": 3
          }
        }
      },
      "LocationTaxDefaultsModel": {
        "type": "object",
        "properties": {
          "prices_include_tax": {
            "type": "boolean"
          },
          "rounding": {
            "type": "string",
            "minLength": 1
          },
          "rounding_mode": {
            "type": "string",
            "minLength": 1
          },
          "cash_rounding": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PackCashRoundingModel"
              }
            ],
            "nullable": true
          },
          "default_tax_class": {
            "type": "string",
            "minLength": 1
          },
          "registrations": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RegistrationFieldModel"
            }
          },
          "exempt_reasons": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ExemptReasonModel"
            }
          },
          "automatic": {
            "type": "string",
            "minLength": 1
          },
          "stripe_tax_supported": {
            "type": "boolean"
          },
          "unverified": {
            "type": "boolean"
          },
          "notes": {
            "type": "string"
          }
        },
        "required": [
          "prices_include_tax",
          "rounding",
          "rounding_mode",
          "cash_rounding",
          "default_tax_class",
          "registrations",
          "exempt_reasons",
          "automatic",
          "stripe_tax_supported"
        ]
      },
      "LocationTaxModel": {
        "type": "object",
        "properties": {
          "prices_include_tax": {
            "type": "boolean"
          },
          "rounding": {
            "type": "string",
            "enum": [
              "per_line",
              "per_total"
            ],
            "minLength": 1
          },
          "rounding_mode": {
            "type": "string",
            "enum": [
              "half_up",
              "half_even",
              "down"
            ],
            "minLength": 1
          },
          "cash_rounding": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CashRoundingModel"
              }
            ],
            "nullable": true
          },
          "default_tax_class_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "registrations": {
            "type": "object"
          },
          "exempt_reasons": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "automatic": {
            "type": "string",
            "enum": [
              "none",
              "stripe_tax"
            ],
            "minLength": 1
          },
          "region": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "prices_include_tax",
          "rounding",
          "rounding_mode",
          "cash_rounding",
          "default_tax_class_id",
          "registrations",
          "exempt_reasons",
          "automatic",
          "region"
        ]
      },
      "LocationTaxSettingsModel": {
        "type": "object",
        "properties": {
          "prices_include_tax": {
            "type": "boolean"
          },
          "rounding": {
            "type": "string",
            "enum": [
              "per_line",
              "per_total"
            ],
            "minLength": 1
          },
          "rounding_mode": {
            "type": "string",
            "enum": [
              "half_up",
              "half_even",
              "down"
            ],
            "minLength": 1
          },
          "cash_rounding": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CashRoundingModel"
              }
            ],
            "nullable": true
          },
          "default_tax_class_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "registrations": {
            "type": "object"
          },
          "exempt_reasons": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "automatic": {
            "type": "string",
            "enum": [
              "none",
              "stripe_tax"
            ],
            "minLength": 1
          },
          "region": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "prices_include_tax",
          "rounding",
          "rounding_mode",
          "cash_rounding",
          "default_tax_class_id",
          "registrations",
          "exempt_reasons",
          "automatic",
          "region",
          "object",
          "location"
        ]
      },
      "LogoBody": {
        "type": "object",
        "properties": {
          "image": {
            "type": "string",
            "maxLength": 1000000,
            "minLength": 1
          }
        },
        "required": [
          "image"
        ]
      },
      "LossesBody": {
        "type": "object",
        "properties": {
          "payments": {
            "type": "string",
            "enum": [
              "application",
              "stripe"
            ]
          }
        }
      },
      "MadeModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string"
          }
        }
      },
      "MandateLimitsBody": {
        "type": "object",
        "properties": {
          "max_amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "currency": {
            "type": "string",
            "maxLength": 3,
            "minLength": 1
          },
          "max_uses": {
            "type": "integer",
            "multipleOf": 1
          },
          "merchants": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "max_amount",
          "currency"
        ]
      },
      "MandateLimitsModel": {
        "type": "object",
        "properties": {
          "max_amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "max_uses": {
            "type": "integer"
          },
          "merchants": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "max_amount",
          "currency",
          "max_uses",
          "merchants"
        ]
      },
      "MandateModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "description": {
            "type": "string",
            "minLength": 1
          },
          "max_amount": {
            "nullable": true,
            "type": "integer"
          },
          "source": {
            "type": "string",
            "minLength": 1
          },
          "accepted_at": {
            "nullable": true,
            "type": "integer"
          },
          "ip": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "user_agent": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "reference": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "description",
          "max_amount",
          "source",
          "accepted_at",
          "ip",
          "user_agent",
          "status",
          "reference"
        ]
      },
      "MandateTermsBody": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "maxLength": 500
          },
          "max_amount": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "ManifestDateModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "starts_at": {
            "type": "integer"
          },
          "ends_at": {
            "type": "integer"
          },
          "doors_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "starts_at",
          "ends_at",
          "doors_at"
        ]
      },
      "ManifestTicketModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "short_code": {
            "type": "string",
            "minLength": 1
          },
          "holder_name": {
            "type": "string",
            "minLength": 1
          },
          "ticket_type": {
            "type": "string",
            "minLength": 1
          },
          "date": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "checked_in_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "short_code",
          "holder_name",
          "ticket_type",
          "date",
          "status",
          "checked_in_at"
        ]
      },
      "ManifestTypeModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "hand_over": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "name",
          "hand_over"
        ]
      },
      "ManifestUnavailableModel": {
        "type": "object",
        "properties": {
          "carrier": {
            "type": "string",
            "minLength": 1
          },
          "labels": {
            "type": "integer"
          }
        },
        "required": [
          "carrier",
          "labels"
        ]
      },
      "MarketingCampaignList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MarketingCampaignModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "MarketingCampaignModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "subject": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "heading": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "body": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "segment": {
            "$ref": "#/components/schemas/CampaignSegmentModel"
          },
          "slot": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CampaignSlotModel"
              }
            ],
            "nullable": true
          },
          "cap": {
            "type": "integer",
            "multipleOf": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "recipients": {
            "type": "integer",
            "multipleOf": 1
          },
          "sent_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "kind",
          "name",
          "subject",
          "heading",
          "body",
          "segment",
          "slot",
          "cap",
          "status",
          "recipients",
          "sent_at",
          "created"
        ]
      },
      "MarketingCampaignPreviewModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "matching": {
            "type": "integer",
            "multipleOf": 1
          },
          "recipients": {
            "type": "integer",
            "multipleOf": 1
          },
          "sample": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "message": {
            "$ref": "#/components/schemas/CampaignMessageModel"
          }
        },
        "required": [
          "object",
          "matching",
          "recipients",
          "sample",
          "message"
        ]
      },
      "MarketingConsentModel": {
        "type": "object",
        "properties": {
          "granted": {
            "type": "boolean"
          },
          "at": {
            "type": "integer"
          },
          "source": {
            "type": "string",
            "minLength": 1
          },
          "wording": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "wording_version": {
            "nullable": true,
            "type": "integer"
          },
          "register": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "granted",
          "at",
          "source",
          "wording",
          "wording_version",
          "register",
          "staff_member"
        ]
      },
      "MarketingSettingsModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "monthly_cap": {
            "type": "integer",
            "multipleOf": 1
          },
          "texts": {
            "type": "boolean"
          },
          "rebooking": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RebookingRuleModel"
            }
          },
          "birthday": {
            "$ref": "#/components/schemas/BirthdayModel"
          }
        },
        "required": [
          "object",
          "livemode",
          "monthly_cap",
          "texts",
          "rebooking",
          "birthday"
        ]
      },
      "MediaAssetList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MediaAssetModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "MediaAssetModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "kind": {
            "type": "string",
            "enum": [
              "image",
              "video",
              "document"
            ],
            "minLength": 1
          },
          "content_type": {
            "type": "string",
            "minLength": 1
          },
          "size_bytes": {
            "type": "integer"
          },
          "width": {
            "nullable": true,
            "type": "integer"
          },
          "height": {
            "nullable": true,
            "type": "integer"
          },
          "duration_ms": {
            "nullable": true,
            "type": "integer"
          },
          "sha256": {
            "type": "string",
            "minLength": 1
          },
          "path": {
            "type": "string",
            "minLength": 1
          },
          "url": {
            "type": "string",
            "minLength": 1
          },
          "poster_media_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "alt_text": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "focal_point": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/FocalPointModel"
              }
            ],
            "nullable": true
          },
          "provenance": {
            "$ref": "#/components/schemas/ProvenanceModel"
          },
          "stored_in": {
            "type": "string",
            "enum": [
              "bucket",
              "database"
            ],
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "processing",
              "ready",
              "failed"
            ],
            "minLength": 1
          },
          "video_tags": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/VideoTagModel"
            }
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "kind",
          "content_type",
          "size_bytes",
          "width",
          "height",
          "duration_ms",
          "sha256",
          "path",
          "url",
          "poster_media_id",
          "alt_text",
          "focal_point",
          "provenance",
          "stored_in",
          "status",
          "video_tags",
          "created"
        ],
        "example": {
          "id": "med_01K7HB3A5C7E9G1J3L5N7Q9S1U",
          "object": "media_asset",
          "livemode": false,
          "kind": "image",
          "content_type": "image/jpeg",
          "size_bytes": 482113,
          "width": 2000,
          "height": 2000,
          "duration_ms": null,
          "sha256": "3b7d9f1a3c5e7b9d1f3a5c7e9b1d3f5a7c9e1b3d5f7a9c1e3b5d7f9a1c3e5b7d",
          "path": "media/sea-salt-candle.jpg",
          "url": "https://media.tuppence.ai/med_01K7HB3A5C7E9G1J3L5N7Q9S1U/sea-salt-candle.jpg",
          "poster_media_id": null,
          "alt_text": "A sea salt candle in a white jar on driftwood",
          "focal_point": {
            "x": 50,
            "y": 40
          },
          "provenance": {
            "origin": "upload",
            "edited_from": null,
            "vendor": null,
            "operations": [],
            "iptc_digital_source_type": null
          },
          "stored_in": "bucket",
          "status": "ready",
          "video_tags": [],
          "created": 1791720000
        }
      },
      "MediaUpdateBody": {
        "type": "object",
        "properties": {
          "alt_text": {
            "nullable": true,
            "type": "string",
            "maxLength": 400
          },
          "focal_point": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/FocalPointBody"
              }
            ],
            "nullable": true
          }
        }
      },
      "MediaUploadBody": {
        "type": "object",
        "properties": {
          "data": {
            "type": "string",
            "maxLength": 14000000
          },
          "upload": {
            "nullable": true,
            "type": "string",
            "maxLength": 64
          },
          "alt_text": {
            "nullable": true,
            "type": "string",
            "maxLength": 400
          },
          "focal_point": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/FocalPointBody"
              }
            ],
            "nullable": true
          },
          "origin": {
            "type": "string",
            "maxLength": 12
          },
          "poster_media_id": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          }
        }
      },
      "MediaUploadModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "upload": {
            "type": "string",
            "minLength": 1
          },
          "upload_url": {
            "type": "string",
            "minLength": 1
          },
          "method": {
            "type": "string",
            "minLength": 1
          },
          "size_bytes": {
            "type": "integer"
          }
        },
        "required": [
          "object",
          "upload",
          "upload_url",
          "method",
          "size_bytes"
        ]
      },
      "MediaUploadStartBody": {
        "type": "object",
        "properties": {
          "size_bytes": {
            "type": "integer",
            "multipleOf": 1
          },
          "content_type": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          }
        },
        "required": [
          "size_bytes",
          "content_type"
        ]
      },
      "MerchantLockModel": {
        "type": "object",
        "properties": {
          "network_id": {
            "nullable": true,
            "type": "string"
          },
          "name": {
            "nullable": true,
            "type": "string"
          }
        }
      },
      "MerchantSendingDomainBody": {
        "type": "object",
        "properties": {
          "domain": {
            "type": "string",
            "maxLength": 253
          }
        },
        "additionalProperties": false
      },
      "MerchantSendingDomainEventData": {
        "type": "object",
        "description": "What an event carrying a `merchant_sending_domain` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/MerchantSendingDomainEventObject"
          }
        }
      },
      "MerchantSendingDomainEventObject": {
        "type": "object",
        "description": "A `merchant_sending_domain` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "merchant_sending_domain"
          }
        },
        "additionalProperties": true
      },
      "MerchantSendingDomainList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MerchantSendingDomainModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "MerchantSendingDomainModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "domain": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "from_address": {
            "type": "string",
            "minLength": 1
          },
          "records": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MerchantSendingRecordModel"
            }
          },
          "dmarc_found": {
            "type": "boolean"
          },
          "failure": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "daily_limit": {
            "nullable": true,
            "type": "integer"
          },
          "checked_at": {
            "nullable": true,
            "type": "integer"
          },
          "verified_at": {
            "nullable": true,
            "type": "integer"
          },
          "check_until": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "domain",
          "status",
          "from_address",
          "records",
          "dmarc_found",
          "failure",
          "daily_limit",
          "checked_at",
          "verified_at",
          "check_until",
          "created"
        ]
      },
      "MerchantSendingDomainSuggestion": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "domain": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "domain"
        ]
      },
      "MerchantSendingDomainVerifiedEvent": {
        "type": "object",
        "description": "The `merchant_sending_domain.verified` event (the store's site events): `data.object` is the `merchant_sending_domain`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "merchant_sending_domain.verified"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/MerchantSendingDomainEventData"
          }
        }
      },
      "MerchantSendingRecordModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "type": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "value": {
            "type": "string",
            "minLength": 1
          },
          "priority": {
            "nullable": true,
            "type": "integer"
          },
          "status": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "kind",
          "type",
          "name",
          "value",
          "priority",
          "status"
        ]
      },
      "MessagingChargesModel": {
        "type": "object",
        "properties": {
          "sms": {
            "$ref": "#/components/schemas/MessagingLineModel"
          },
          "whatsapp": {
            "$ref": "#/components/schemas/MessagingLineModel"
          },
          "total": {
            "type": "integer"
          }
        },
        "required": [
          "sms",
          "whatsapp",
          "total"
        ]
      },
      "MessagingLineModel": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "count",
          "amount"
        ]
      },
      "MessagingPreferencesModel": {
        "type": "object",
        "properties": {
          "reminders": {
            "type": "boolean"
          },
          "sms": {
            "type": "boolean"
          },
          "whatsapp": {
            "type": "boolean"
          }
        }
      },
      "MessagingSettingsModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "reminders": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReminderRuleModel"
            }
          },
          "sender_name": {
            "type": "string",
            "minLength": 1
          },
          "templates": {
            "type": "object"
          },
          "quiet_hours": {
            "$ref": "#/components/schemas/QuietHoursModel"
          },
          "daily_sms_cap": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "object",
          "livemode",
          "reminders",
          "sender_name",
          "templates",
          "quiet_hours",
          "daily_sms_cap"
        ]
      },
      "MessagingUsageLineModel": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "multipleOf": 1
          },
          "cost_minor": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "count",
          "cost_minor"
        ]
      },
      "MessagingUsageModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "month": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "period_start": {
            "type": "integer",
            "multipleOf": 1
          },
          "period_end": {
            "type": "integer",
            "multipleOf": 1
          },
          "sms": {
            "$ref": "#/components/schemas/MessagingUsageLineModel"
          },
          "whatsapp": {
            "$ref": "#/components/schemas/MessagingUsageLineModel"
          },
          "email": {
            "$ref": "#/components/schemas/MessagingUsageLineModel"
          },
          "total_minor": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "object",
          "livemode",
          "month",
          "currency",
          "period_start",
          "period_end",
          "sms",
          "whatsapp",
          "email",
          "total_minor"
        ],
        "example": {
          "object": "messaging_usage",
          "livemode": false,
          "month": "2026-09",
          "currency": "gbp",
          "period_start": 1782864000,
          "period_end": 1785456000,
          "sms": {
            "count": 42,
            "cost_minor": 252
          },
          "whatsapp": {
            "count": 10,
            "cost_minor": 30
          },
          "email": {
            "count": 120,
            "cost_minor": 0
          },
          "total_minor": 282
        }
      },
      "MeterEventModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "identifier": {
            "type": "string",
            "minLength": 1
          },
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "meter": {
            "type": "string",
            "minLength": 1
          },
          "quantity": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "balance": {
            "type": "integer"
          },
          "replayed": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "identifier",
          "customer",
          "meter",
          "quantity",
          "amount",
          "balance",
          "replayed",
          "created"
        ]
      },
      "MeterList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MeterModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "MeterModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "description": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "unit_amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "name",
          "description",
          "unit_amount",
          "currency",
          "status",
          "created"
        ]
      },
      "MethodPriceModel": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "The payment method, e.g. `bacs_debit`.",
            "minLength": 1
          },
          "bps": {
            "type": "integer",
            "description": "Basis points of the amount."
          },
          "fixed": {
            "type": "integer",
            "description": "Added after the percentage, in minor units."
          },
          "cap": {
            "description": "The most one payment's fee can be, in minor units; null for no cap.",
            "nullable": true,
            "type": "integer"
          },
          "subscription_addon_bps": {
            "description": "Added on a subscription renewal, in basis points; null when nothing is.",
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "type",
          "bps",
          "fixed",
          "cap",
          "subscription_addon_bps"
        ]
      },
      "MissingForOnlineModel": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "minLength": 1
          },
          "message": {
            "type": "string",
            "minLength": 1
          },
          "fix_url": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "field",
          "message",
          "fix_url"
        ]
      },
      "ModifierBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 80
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "default": {
            "type": "boolean"
          },
          "kitchen_only": {
            "type": "boolean"
          },
          "sort": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "ModifierGroupBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 80
          },
          "min": {
            "type": "integer",
            "multipleOf": 1
          },
          "max": {
            "nullable": true,
            "type": "integer"
          },
          "sort": {
            "type": "integer",
            "multipleOf": 1
          },
          "modifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ModifierBody"
            }
          }
        }
      },
      "ModifierGroupList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ModifierGroupModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ModifierGroupModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "min": {
            "type": "integer"
          },
          "max": {
            "nullable": true,
            "type": "integer"
          },
          "sort": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ],
            "minLength": 1
          },
          "modifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ModifierModel"
            }
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "name",
          "min",
          "max",
          "sort",
          "status",
          "modifiers",
          "created"
        ]
      },
      "ModifierList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ModifierModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ModifierModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "group": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "default": {
            "type": "boolean"
          },
          "kitchen_only": {
            "type": "boolean"
          },
          "sort": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ],
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "group",
          "name",
          "amount",
          "default",
          "kitchen_only",
          "sort",
          "status",
          "created"
        ]
      },
      "ModifierUpdateBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 80
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "default": {
            "type": "boolean"
          },
          "kitchen_only": {
            "type": "boolean"
          },
          "sort": {
            "type": "integer",
            "multipleOf": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ]
          }
        }
      },
      "NeedsReviewModel": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "minLength": 1
          },
          "at": {
            "type": "integer"
          },
          "actors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EventActorModel"
            }
          }
        },
        "required": [
          "reason",
          "at",
          "actors"
        ]
      },
      "NextActionModel": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "minLength": 1
          },
          "stripe_client_secret": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "type",
          "stripe_client_secret"
        ]
      },
      "NextDayEndedModel": {
        "type": "object",
        "properties": {
          "at": {
            "type": "integer"
          },
          "cause": {
            "description": "`switched_off` (you switched them off) · `suspended` (we paused them: payouts on hold, a review, or 90 days without a payment — switch on again once that has cleared) · `revoked` (we switched them off; `note` says why) · `ended` (an agreed period ended).",
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "note": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "at",
          "cause",
          "note"
        ]
      },
      "NextDayModel": {
        "type": "object",
        "properties": {
          "available": {
            "type": "boolean",
            "description": "Can you switch next-day payouts on now (`POST /v1/payout_settings/next_day`)? False while they're on already."
          },
          "reason": {
            "description": "Why not: `region` (UK only) · `flag_off` · `not_yet` · `already_next_day` · `not_available_yet` · `not_approved` · `held` · `negative_balance` · `connect_hold` · `timing_unconfirmed`. Before next-day has first opened for you every reason comes with no message, and `region`, `flag_off` and `not_yet` never have one: there is nothing to show.",
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "message": {
            "description": "The reason in words, to show as it is; null when available or nothing is shown.",
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "fix_url": {
            "description": "Where you fix the reason yourself (a dashboard page); null when it's only a wait.",
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "available_from": {
            "description": "When the reason clears by itself (Unix seconds), where it does.",
            "nullable": true,
            "type": "integer"
          },
          "enabled": {
            "type": "boolean",
            "description": "Next-day payouts are on."
          },
          "source": {
            "description": "Who switched them on: `upgrade` (you) · `staff` (agreed with Tuppence) · `request` (the old free request). Null while off.",
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "fee_bps": {
            "description": "The next-day part of the fee, in basis points on each payment (20 = 0.2%): locked while on; otherwise what switching on now would lock. Null where nothing is shown.",
            "nullable": true,
            "type": "integer"
          },
          "since": {
            "description": "When they came on (Unix seconds); null while off.",
            "nullable": true,
            "type": "integer"
          },
          "ends_at": {
            "description": "When an agreed period ends by itself (Unix seconds); null: it doesn't.",
            "nullable": true,
            "type": "integer"
          },
          "agreed_message": {
            "description": "What we said when we switched them on for you; null otherwise.",
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "ended": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/NextDayEndedModel"
              }
            ],
            "nullable": true
          },
          "typical_amount": {
            "description": "Your typical payment, in minor units: the median of the last 30 days' payments (50.00 with fewer than five). Null where nothing is shown.",
            "nullable": true,
            "type": "integer"
          },
          "typical_fee": {
            "description": "The next-day fee on your typical payment, in minor units (rounded up).",
            "nullable": true,
            "type": "integer"
          },
          "eligible": {
            "type": "boolean",
            "description": "Deprecated: read `available`."
          },
          "request": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/SettlementRequestModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "available",
          "reason",
          "message",
          "fix_url",
          "available_from",
          "enabled",
          "source",
          "fee_bps",
          "since",
          "ends_at",
          "agreed_message",
          "ended",
          "typical_amount",
          "typical_fee",
          "eligible",
          "request"
        ]
      },
      "NextPayoutModel": {
        "type": "object",
        "properties": {
          "date": {
            "type": "integer"
          },
          "runs": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "estimated_amount": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "date",
          "runs",
          "estimated_amount"
        ]
      },
      "NexusStateList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/NexusStateModel"
            }
          }
        },
        "required": [
          "object",
          "data"
        ]
      },
      "NexusStateModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "state": {
            "type": "string",
            "minLength": 1
          },
          "state_name": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "below",
              "near",
              "over"
            ],
            "minLength": 1
          },
          "ratio_ppm": {
            "type": "integer",
            "multipleOf": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "period_start": {
            "type": "string",
            "minLength": 1
          },
          "period_end": {
            "type": "string",
            "minLength": 1
          },
          "period_label": {
            "type": "string",
            "minLength": 1
          },
          "sales_amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "orders": {
            "type": "integer",
            "multipleOf": 1
          },
          "marketplace_sales_amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "marketplace_orders": {
            "type": "integer",
            "multipleOf": 1
          },
          "counted_sales_amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "counted_orders": {
            "type": "integer",
            "multipleOf": 1
          },
          "threshold": {
            "$ref": "#/components/schemas/NexusThresholdModel"
          },
          "registered": {
            "type": "boolean"
          },
          "registration": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/TaxRegistrationModel"
              }
            ],
            "nullable": true
          },
          "message": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "computed_at": {
            "nullable": true,
            "type": "integer"
          },
          "livemode": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "state",
          "state_name",
          "status",
          "ratio_ppm",
          "currency",
          "period_start",
          "period_end",
          "period_label",
          "sales_amount",
          "orders",
          "marketplace_sales_amount",
          "marketplace_orders",
          "counted_sales_amount",
          "counted_orders",
          "threshold",
          "registered",
          "registration",
          "message",
          "computed_at",
          "livemode"
        ]
      },
      "NexusThresholdModel": {
        "type": "object",
        "properties": {
          "sales_amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "transactions": {
            "nullable": true,
            "type": "integer"
          },
          "test": {
            "type": "string",
            "enum": [
              "either",
              "both"
            ],
            "minLength": 1
          },
          "window": {
            "type": "string",
            "enum": [
              "previous_or_current_year",
              "previous_year",
              "trailing_12_months",
              "previous_four_quarters",
              "twelve_months_to_september"
            ],
            "minLength": 1
          },
          "counts": {
            "type": "string",
            "enum": [
              "gross",
              "retail",
              "taxable"
            ],
            "minLength": 1
          },
          "includes_marketplace_sales": {
            "type": "boolean"
          },
          "source": {
            "type": "string",
            "minLength": 1
          },
          "checked": {
            "type": "string",
            "minLength": 1
          },
          "effective_from": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "note": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "sales_amount",
          "transactions",
          "test",
          "window",
          "counts",
          "includes_marketplace_sales",
          "source",
          "checked",
          "effective_from",
          "note"
        ]
      },
      "NoShowRateModel": {
        "type": "object",
        "properties": {
          "visits": {
            "type": "integer"
          },
          "no_shows": {
            "type": "integer"
          },
          "rate": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "visits",
          "no_shows",
          "rate"
        ]
      },
      "NoShowSplitModel": {
        "type": "object",
        "properties": {
          "all": {
            "$ref": "#/components/schemas/NoShowRateModel"
          },
          "card_on_file": {
            "$ref": "#/components/schemas/NoShowRateModel"
          },
          "no_card_on_file": {
            "$ref": "#/components/schemas/NoShowRateModel"
          },
          "reminded": {
            "$ref": "#/components/schemas/NoShowRateModel"
          },
          "not_reminded": {
            "$ref": "#/components/schemas/NoShowRateModel"
          }
        },
        "required": [
          "all",
          "card_on_file",
          "no_card_on_file",
          "reminded",
          "not_reminded"
        ]
      },
      "NotFound": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "description": "The error name",
            "example": "NOT_FOUND",
            "default": "NOT_FOUND"
          },
          "message": {
            "type": "string",
            "minLength": 1,
            "description": "An error message"
          },
          "status": {
            "type": "integer",
            "description": "The status code of the exception",
            "example": 404,
            "default": 404
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GenericError"
            },
            "description": "A list of related errors"
          },
          "stack": {
            "type": "string",
            "description": "The stack trace (only in development mode)"
          }
        },
        "required": [
          "name",
          "message",
          "status"
        ]
      },
      "NotFoundSuggestionModel": {
        "type": "object",
        "properties": {
          "to_path": {
            "type": "string",
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "to_path",
          "title",
          "object"
        ]
      },
      "NoteAuthorModel": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "minLength": 1
          },
          "id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "type",
          "id"
        ]
      },
      "NotificationSettingsBody": {
        "type": "object",
        "properties": {
          "email_connected_accounts": {
            "type": "boolean"
          }
        }
      },
      "OnboardingModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "charges_enabled": {
            "type": "boolean"
          },
          "payouts_enabled": {
            "type": "boolean"
          },
          "details_submitted": {
            "type": "boolean"
          },
          "requirements": {
            "$ref": "#/components/schemas/OnboardingRequirements"
          },
          "next_steps": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "capabilities": {
            "type": "object"
          }
        },
        "required": [
          "object",
          "status",
          "charges_enabled",
          "payouts_enabled",
          "details_submitted",
          "requirements",
          "next_steps",
          "capabilities"
        ]
      },
      "OnboardingRequirementError": {
        "type": "object",
        "properties": {
          "requirement": {
            "type": "string",
            "minLength": 1
          },
          "message": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "requirement",
          "message"
        ]
      },
      "OnboardingRequirements": {
        "type": "object",
        "properties": {
          "currently_due": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "past_due": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "pending_verification": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "deadline": {
            "nullable": true,
            "type": "integer"
          },
          "disabled_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OnboardingRequirementError"
            }
          }
        },
        "required": [
          "currently_due",
          "past_due",
          "pending_verification",
          "deadline",
          "disabled_reason",
          "errors"
        ]
      },
      "OnlineChecklistModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "product": {
            "type": "string",
            "minLength": 1
          },
          "ready": {
            "type": "boolean"
          },
          "online": {
            "type": "boolean"
          },
          "missing": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MissingForOnlineModel"
            }
          }
        },
        "required": [
          "object",
          "product",
          "ready",
          "online",
          "missing"
        ]
      },
      "OpenShiftBody": {
        "type": "object",
        "properties": {
          "register": {
            "type": "string",
            "maxLength": 40
          },
          "float_amount": {
            "type": "integer"
          }
        }
      },
      "OrderAddressBody": {
        "type": "object",
        "properties": {
          "name": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          },
          "line1": {
            "type": "string",
            "maxLength": 200
          },
          "line2": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          },
          "city": {
            "type": "string",
            "maxLength": 200
          },
          "region": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          },
          "postcode": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          },
          "country": {
            "type": "string",
            "maxLength": 2
          }
        }
      },
      "OrderAddressChangedModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "order": {
            "$ref": "#/components/schemas/OrderModel"
          },
          "fulfilment": {
            "$ref": "#/components/schemas/OrderFulfilmentModel"
          }
        },
        "required": [
          "object",
          "order",
          "fulfilment"
        ]
      },
      "OrderByReceiptBody": {
        "type": "object",
        "properties": {
          "receipt": {
            "type": "string",
            "maxLength": 500,
            "minLength": 1
          }
        },
        "required": [
          "receipt"
        ]
      },
      "OrderChannelModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "external_order_id": {
            "type": "string",
            "minLength": 1
          },
          "print_label_at": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "kind",
          "external_order_id",
          "print_label_at"
        ]
      },
      "OrderCompletedEvent": {
        "type": "object",
        "description": "The `order.completed` event (the store's orders events): `data.object` is the `order`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "order.completed"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/OrderEventData"
          }
        }
      },
      "OrderConfirmationSentModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "order": {
            "type": "string",
            "minLength": 1
          },
          "email": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "order",
          "email"
        ]
      },
      "OrderCreatedEvent": {
        "type": "object",
        "description": "The `order.created` event (the store's orders events): `data.object` is the `order`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "order.created"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/OrderEventData"
          }
        }
      },
      "OrderCustomerBody": {
        "type": "object",
        "properties": {
          "customer": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "name": {
            "type": "string",
            "maxLength": 120
          },
          "phone": {
            "type": "string",
            "maxLength": 32
          },
          "totals": {
            "$ref": "#/components/schemas/TotalsBody"
          }
        }
      },
      "OrderCustomerModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "email": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "phone": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "name",
          "email",
          "phone"
        ]
      },
      "OrderDeliveryAddressBody": {
        "type": "object",
        "properties": {
          "address": {
            "$ref": "#/components/schemas/OrderAddressBody"
          }
        }
      },
      "OrderDeliveryModel": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "earliest": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "latest": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "key",
          "name",
          "amount",
          "earliest",
          "latest"
        ]
      },
      "OrderDeliveryPartModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "promise": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/OrderPromiseModel"
              }
            ],
            "nullable": true
          },
          "carrier": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "tracking_number": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "shipment_status": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "status",
          "kind",
          "location",
          "promise",
          "carrier",
          "tracking_number",
          "shipment_status"
        ]
      },
      "OrderDetailsModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "order": {
            "type": "string",
            "minLength": 1
          },
          "customer": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/OrderCustomerModel"
              }
            ],
            "nullable": true
          },
          "fulfilment": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/OrderFulfilmentModel"
              }
            ],
            "nullable": true
          },
          "snapshot": {
            "nullable": true
          },
          "editable": {
            "type": "boolean"
          },
          "left": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OrderLineLeftModel"
            }
          },
          "timeline": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OrderTimelineEntryModel"
            }
          },
          "deliveries": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OrderDeliveryPartModel"
            }
          }
        },
        "required": [
          "object",
          "order",
          "customer",
          "fulfilment",
          "snapshot",
          "editable",
          "left",
          "timeline",
          "deliveries"
        ]
      },
      "OrderEReceiptModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "order": {
            "type": "string",
            "minLength": 1
          },
          "email": {
            "type": "string",
            "minLength": 1
          },
          "customer": {
            "$ref": "#/components/schemas/CustomerModel"
          }
        },
        "required": [
          "object",
          "order",
          "email",
          "customer"
        ]
      },
      "OrderEventBody": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "maxLength": 40
          },
          "client_seq": {
            "type": "integer"
          },
          "kind": {
            "type": "string",
            "maxLength": 32
          },
          "at": {
            "type": "integer"
          },
          "line": {
            "$ref": "#/components/schemas/OrderLineBody"
          },
          "order_type": {
            "type": "string",
            "enum": [
              "eat_in",
              "takeaway",
              "delivery",
              "collection"
            ]
          },
          "reason": {
            "type": "string",
            "maxLength": 500
          },
          "discount": {
            "type": "object"
          },
          "amount": {
            "type": "integer"
          },
          "customer": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "tax_exemption": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/TaxExemptionBody"
              }
            ],
            "nullable": true
          },
          "tender": {
            "$ref": "#/components/schemas/TenderBody"
          },
          "receipt": {
            "type": "string",
            "enum": [
              "print",
              "email",
              "sms",
              "qr",
              "none"
            ]
          }
        }
      },
      "OrderEventData": {
        "type": "object",
        "description": "What an event carrying a `order` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/OrderModel"
          }
        }
      },
      "OrderEventList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OrderEventModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "OrderEventModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "order": {
            "type": "string",
            "minLength": 1
          },
          "sequence": {
            "type": "integer"
          },
          "device": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "client_seq": {
            "nullable": true,
            "type": "integer"
          },
          "kind": {
            "type": "string",
            "enum": [
              "created",
              "line_added",
              "line_updated",
              "line_voided",
              "discount_applied",
              "discount_removed",
              "order_type_changed",
              "tax_exemption_changed",
              "customer_changed",
              "service_charge_changed",
              "tip_set",
              "held",
              "resumed",
              "sent_to_kitchen",
              "tender_added",
              "tender_failed",
              "completed",
              "voided",
              "returned",
              "receipt_sent",
              "reprinted",
              "kept_for_review"
            ],
            "minLength": 1
          },
          "payload": {
            "type": "object"
          },
          "actor": {
            "$ref": "#/components/schemas/EventActorModel"
          },
          "at": {
            "type": "integer"
          },
          "received_at": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "order",
          "sequence",
          "device",
          "client_seq",
          "kind",
          "payload",
          "actor",
          "at",
          "received_at"
        ]
      },
      "OrderEventObject": {
        "type": "object",
        "description": "A `order` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "order"
          }
        },
        "additionalProperties": true
      },
      "OrderEventsBody": {
        "type": "object",
        "properties": {
          "events": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OrderEventBody"
            }
          },
          "totals": {
            "$ref": "#/components/schemas/TotalsBody"
          },
          "catalogue_version": {
            "type": "string",
            "maxLength": 40
          },
          "sent_at": {
            "type": "integer"
          },
          "sold_offline": {
            "type": "boolean"
          }
        }
      },
      "OrderFulfilmentModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "address": {
            "nullable": true
          },
          "delivery": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/OrderDeliveryModel"
              }
            ],
            "nullable": true
          },
          "instructions": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "channel": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/OrderChannelModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "kind",
          "address",
          "delivery",
          "instructions",
          "channel"
        ]
      },
      "OrderLineBody": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "maxLength": 40
          },
          "product": {
            "type": "string",
            "maxLength": 40
          },
          "variant": {
            "type": "string",
            "maxLength": 40
          },
          "quantity": {
            "type": "string",
            "maxLength": 16
          },
          "unit": {
            "nullable": true,
            "type": "string",
            "maxLength": 8
          },
          "unit_amount": {
            "nullable": true,
            "type": "integer"
          },
          "modifiers": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "notes": {
            "nullable": true,
            "type": "string",
            "maxLength": 500
          },
          "seat": {
            "nullable": true,
            "type": "integer"
          },
          "line_discount": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/LineDiscountBody"
              }
            ],
            "nullable": true
          },
          "ticket": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/OrderLineTicketBody"
              }
            ],
            "nullable": true
          }
        }
      },
      "OrderLineLeftModel": {
        "type": "object",
        "properties": {
          "line": {
            "type": "string",
            "minLength": 1
          },
          "quantity": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "line",
          "quantity"
        ]
      },
      "OrderLineModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "order": {
            "type": "string",
            "minLength": 1
          },
          "product": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "variant": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "service": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "category": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "tax_class": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "sold_by": {
            "type": "string",
            "enum": [
              "each",
              "weight",
              "open"
            ],
            "minLength": 1
          },
          "unit": {
            "nullable": true,
            "type": "string",
            "minLength": 1,
            "enum": [
              "kg",
              "g",
              "l",
              "ml",
              "lb",
              "oz",
              "fl_oz"
            ]
          },
          "quantity": {
            "type": "string",
            "minLength": 1
          },
          "unit_amount": {
            "type": "integer"
          },
          "modifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LineModifierModel"
            }
          },
          "gross_amount": {
            "type": "integer"
          },
          "line_discount": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/AppliedDiscountModel"
              }
            ],
            "nullable": true
          },
          "discount_amount": {
            "type": "integer"
          },
          "taxes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LineTaxModel"
            }
          },
          "tax_amount": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "cost_amount": {
            "nullable": true,
            "type": "integer"
          },
          "notes": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "seat": {
            "nullable": true,
            "type": "integer"
          },
          "course": {
            "nullable": true,
            "type": "integer"
          },
          "kitchen_station": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "sent_to_kitchen_at": {
            "nullable": true,
            "type": "integer"
          },
          "voided": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/LineVoidModel"
              }
            ],
            "nullable": true
          },
          "sort": {
            "type": "integer"
          },
          "ticket": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/OrderLineTicketModel"
              }
            ],
            "nullable": true
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "order",
          "product",
          "variant",
          "service",
          "staff_member",
          "category",
          "tax_class",
          "name",
          "sold_by",
          "unit",
          "quantity",
          "unit_amount",
          "modifiers",
          "gross_amount",
          "line_discount",
          "discount_amount",
          "taxes",
          "tax_amount",
          "amount",
          "cost_amount",
          "notes",
          "seat",
          "course",
          "kitchen_station",
          "sent_to_kitchen_at",
          "voided",
          "sort",
          "ticket",
          "created"
        ]
      },
      "OrderLineTicketBody": {
        "type": "object",
        "properties": {
          "ticket_type": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "date": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          }
        }
      },
      "OrderLineTicketModel": {
        "type": "object",
        "properties": {
          "ticket_type": {
            "type": "string",
            "minLength": 1
          },
          "date": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "ticket_type",
          "date"
        ]
      },
      "OrderList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OrderModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "OrderModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "number": {
            "type": "integer"
          },
          "business_day": {
            "type": "string",
            "minLength": 1
          },
          "register": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "device": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "open",
              "held",
              "paid",
              "completed",
              "voided"
            ],
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "sale",
              "return"
            ],
            "minLength": 1
          },
          "refunds_order": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "order_type": {
            "type": "string",
            "enum": [
              "eat_in",
              "takeaway",
              "delivery",
              "collection"
            ],
            "minLength": 1
          },
          "source": {
            "type": "string",
            "enum": [
              "till",
              "api",
              "agent",
              "online",
              "table_qr",
              "booking",
              "kiosk",
              "import",
              "subscription"
            ],
            "minLength": 1
          },
          "store_number": {
            "nullable": true,
            "type": "integer"
          },
          "fulfilment_status": {
            "nullable": true,
            "type": "string",
            "minLength": 1,
            "enum": [
              "unfulfilled",
              "partially_fulfilled",
              "fulfilled",
              "delivered",
              "partially_returned",
              "returned",
              "cancelled"
            ]
          },
          "customer": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "booking": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "table": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "covers": {
            "nullable": true,
            "type": "integer"
          },
          "tab_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OrderLineModel"
            }
          },
          "tenders": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TenderModel"
            }
          },
          "discounts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AppliedDiscountModel"
            }
          },
          "service_charge": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ServiceChargeModel"
              }
            ],
            "nullable": true
          },
          "tax_exemption": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/TaxExemptionModel"
              }
            ],
            "nullable": true
          },
          "tip_amount": {
            "type": "integer"
          },
          "tip_shares": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TipShareModel"
            }
          },
          "totals": {
            "$ref": "#/components/schemas/OrderTotalsModel"
          },
          "catalogue_version": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "notes": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "needs_review": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/NeedsReviewModel"
              }
            ],
            "nullable": true
          },
          "fulfilment_hold": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/FulfilmentHoldModel"
              }
            ],
            "nullable": true
          },
          "client_created_at": {
            "nullable": true,
            "type": "integer"
          },
          "created_offline": {
            "type": "boolean"
          },
          "synced_at": {
            "nullable": true,
            "type": "integer"
          },
          "completed_at": {
            "nullable": true,
            "type": "integer"
          },
          "voided": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/OrderVoidModel"
              }
            ],
            "nullable": true
          },
          "metadata": {
            "type": "object"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "number",
          "business_day",
          "register",
          "device",
          "location",
          "staff_member",
          "status",
          "kind",
          "refunds_order",
          "order_type",
          "source",
          "store_number",
          "fulfilment_status",
          "customer",
          "booking",
          "table",
          "covers",
          "tab_name",
          "currency",
          "lines",
          "tenders",
          "discounts",
          "service_charge",
          "tax_exemption",
          "tip_amount",
          "tip_shares",
          "totals",
          "catalogue_version",
          "notes",
          "needs_review",
          "fulfilment_hold",
          "client_created_at",
          "created_offline",
          "synced_at",
          "completed_at",
          "voided",
          "metadata",
          "created"
        ],
        "example": {
          "id": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
          "object": "order",
          "livemode": false,
          "number": 1042,
          "business_day": "2026-10-24",
          "register": null,
          "device": null,
          "location": "loc_01J8ZK2B4D6F8H0K2M4P6R8T0V",
          "staff_member": null,
          "status": "completed",
          "kind": "sale",
          "refunds_order": null,
          "order_type": "delivery",
          "source": "online",
          "store_number": 318,
          "fulfilment_status": "fulfilled",
          "customer": "cus_01J8ZK1Q9H2B4C6D8E0F2G4H6J",
          "booking": null,
          "table": null,
          "covers": null,
          "tab_name": null,
          "currency": "gbp",
          "lines": [
            {
              "id": "ordl_01K7HBFR8T0V2X4Z6B8D0F2H4K",
              "object": "order_line",
              "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
              "product": "prod_01K7HB2M4N6P8Q0R2S4T6V8W0X",
              "variant": null,
              "service": null,
              "staff_member": null,
              "category": "Gifts",
              "tax_class": "standard",
              "name": "Sea salt candle",
              "sold_by": "each",
              "unit": null,
              "quantity": "2",
              "unit_amount": 1200,
              "modifiers": [],
              "gross_amount": 2400,
              "line_discount": null,
              "discount_amount": 0,
              "taxes": [
                {
                  "tax_rate": "taxr_01J8ZK5E7G9J1L3N5Q7S9U1W3Y",
                  "name": "VAT 20%",
                  "rate_ppm": 200000,
                  "amount": 400,
                  "inclusive": true
                }
              ],
              "tax_amount": 400,
              "amount": 2400,
              "cost_amount": null,
              "notes": null,
              "seat": null,
              "course": null,
              "kitchen_station": null,
              "sent_to_kitchen_at": null,
              "voided": null,
              "sort": 0,
              "ticket": null,
              "created": 1792310400
            },
            {
              "id": "ordl_01K7HBFR8T0V2X4Z6B8D0F2H4M",
              "object": "order_line",
              "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
              "product": "prod_01K7HB2M4N6P8Q0R2S4T6V8W0Y",
              "variant": null,
              "service": null,
              "staff_member": null,
              "category": "Gifts",
              "tax_class": "standard",
              "name": "Harbour mug",
              "sold_by": "each",
              "unit": null,
              "quantity": "1",
              "unit_amount": 695,
              "modifiers": [],
              "gross_amount": 695,
              "line_discount": null,
              "discount_amount": 0,
              "taxes": [
                {
                  "tax_rate": "taxr_01J8ZK5E7G9J1L3N5Q7S9U1W3Y",
                  "name": "VAT 20%",
                  "rate_ppm": 200000,
                  "amount": 116,
                  "inclusive": true
                }
              ],
              "tax_amount": 116,
              "amount": 695,
              "cost_amount": null,
              "notes": null,
              "seat": null,
              "course": null,
              "kitchen_station": null,
              "sent_to_kitchen_at": null,
              "voided": null,
              "sort": 1,
              "ticket": null,
              "created": 1792310400
            },
            {
              "id": "ordl_01K7HBFR8T0V2X4Z6B8D0F2H4N",
              "object": "order_line",
              "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
              "product": null,
              "variant": null,
              "service": null,
              "staff_member": null,
              "category": null,
              "tax_class": "standard",
              "name": "Royal Mail Tracked 48",
              "sold_by": "open",
              "unit": null,
              "quantity": "1",
              "unit_amount": 355,
              "modifiers": [],
              "gross_amount": 355,
              "line_discount": null,
              "discount_amount": 0,
              "taxes": [
                {
                  "tax_rate": "taxr_01J8ZK5E7G9J1L3N5Q7S9U1W3Y",
                  "name": "VAT 20%",
                  "rate_ppm": 200000,
                  "amount": 59,
                  "inclusive": true
                }
              ],
              "tax_amount": 59,
              "amount": 355,
              "cost_amount": null,
              "notes": null,
              "seat": null,
              "course": null,
              "kitchen_station": null,
              "sent_to_kitchen_at": null,
              "voided": null,
              "sort": 2,
              "ticket": null,
              "created": 1792310400
            }
          ],
          "tenders": [
            {
              "id": "tndr_01K7HBGS9U1W3Y5A7C9E1G3J5L",
              "object": "tender",
              "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
              "method": "card",
              "external_kind": null,
              "payment": "pay_01K7HBHT0V2X4Z6B8D0F2H4K6M",
              "voucher_redemption": null,
              "amount": 3450,
              "currency": "gbp",
              "tip_amount": 0,
              "tendered": null,
              "change": 0,
              "rounding_amount": 0,
              "network": null,
              "status": "succeeded",
              "refunded_amount": 0,
              "staff_member": null,
              "device": null,
              "reader": null,
              "client_created_at": null,
              "created_offline": false,
              "sort": 0,
              "shift": null,
              "created": 1792310400
            }
          ],
          "discounts": [],
          "service_charge": null,
          "tax_exemption": null,
          "tip_amount": 0,
          "tip_shares": [],
          "totals": {
            "subtotal": 3450,
            "discount": 0,
            "service_charge": 0,
            "tax_by_rate": [
              {
                "tax_rate": "taxr_01J8ZK5E7G9J1L3N5Q7S9U1W3Y",
                "name": "VAT 20%",
                "rate_ppm": 200000,
                "taxable": 3450,
                "tax": 575,
                "inclusive": true
              }
            ],
            "tax": 575,
            "tip": 0,
            "total": 3450,
            "cash_rounding": 0,
            "paid": 3450,
            "due": 0,
            "change": 0
          },
          "catalogue_version": null,
          "notes": null,
          "needs_review": null,
          "fulfilment_hold": null,
          "client_created_at": null,
          "created_offline": false,
          "synced_at": null,
          "completed_at": 1792310400,
          "voided": null,
          "metadata": {},
          "created": 1792310400
        }
      },
      "OrderPaidEvent": {
        "type": "object",
        "description": "The `order.paid` event (the store's orders events): `data.object` is the `order`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "order.paid"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/OrderEventData"
          }
        }
      },
      "OrderPromiseModel": {
        "type": "object",
        "properties": {
          "dispatch_by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "earliest": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "latest": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "dispatch_by",
          "earliest",
          "latest"
        ]
      },
      "OrderReceiptModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "order": {
            "type": "string",
            "minLength": 1
          },
          "receipt": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PosReceiptModel"
              }
            ],
            "nullable": true
          },
          "url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "document": {
            "$ref": "#/components/schemas/PosReceiptDocumentModel"
          },
          "text": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "object",
          "order",
          "receipt",
          "url",
          "document",
          "text"
        ]
      },
      "OrderReceiptSendBody": {
        "type": "object",
        "properties": {
          "channel": {
            "type": "string",
            "enum": [
              "print",
              "email",
              "sms",
              "qr",
              "none"
            ],
            "minLength": 1
          },
          "recipient": {
            "type": "string",
            "maxLength": 320
          },
          "customer_details": {
            "$ref": "#/components/schemas/ReceiptCustomerDetailsBody"
          }
        },
        "required": [
          "channel"
        ]
      },
      "OrderReturnModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "order": {
            "$ref": "#/components/schemas/OrderModel"
          },
          "return_order": {
            "$ref": "#/components/schemas/OrderModel"
          },
          "refunds": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RefundModel"
            }
          }
        },
        "required": [
          "object",
          "order",
          "return_order",
          "refunds"
        ]
      },
      "OrderSyncModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "order": {
            "$ref": "#/components/schemas/OrderModel"
          },
          "applied": {
            "type": "integer"
          },
          "kept": {
            "type": "integer"
          },
          "replayed": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "last_client_seq": {
            "nullable": true,
            "type": "integer"
          },
          "clock_skew_seconds": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "object",
          "order",
          "applied",
          "kept",
          "replayed",
          "last_client_seq",
          "clock_skew_seconds"
        ]
      },
      "OrderTenderModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "tender": {
            "$ref": "#/components/schemas/TenderModel"
          },
          "order": {
            "$ref": "#/components/schemas/OrderModel"
          },
          "next_action": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/TenderNextActionModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "object",
          "tender",
          "order",
          "next_action"
        ]
      },
      "OrderTimelineEntryModel": {
        "type": "object",
        "properties": {
          "at": {
            "type": "integer"
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "detail": {
            "type": "object"
          }
        },
        "required": [
          "at",
          "kind",
          "by",
          "amount",
          "detail"
        ]
      },
      "OrderTotalsModel": {
        "type": "object",
        "properties": {
          "subtotal": {
            "type": "integer"
          },
          "discount": {
            "type": "integer"
          },
          "service_charge": {
            "type": "integer"
          },
          "tax_by_rate": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TaxByRateModel"
            }
          },
          "tax": {
            "type": "integer"
          },
          "tip": {
            "type": "integer"
          },
          "total": {
            "type": "integer"
          },
          "cash_rounding": {
            "type": "integer"
          },
          "paid": {
            "type": "integer"
          },
          "due": {
            "type": "integer"
          },
          "change": {
            "type": "integer"
          }
        },
        "required": [
          "subtotal",
          "discount",
          "service_charge",
          "tax_by_rate",
          "tax",
          "tip",
          "total",
          "cash_rounding",
          "paid",
          "due",
          "change"
        ]
      },
      "OrderTypeBody": {
        "type": "object",
        "properties": {
          "order_type": {
            "type": "string",
            "enum": [
              "eat_in",
              "takeaway",
              "delivery",
              "collection"
            ]
          },
          "totals": {
            "$ref": "#/components/schemas/TotalsBody"
          }
        }
      },
      "OrderUpdatedEvent": {
        "type": "object",
        "description": "The `order.updated` event (the store's orders events): `data.object` is the `order`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "order.updated"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/OrderEventData"
          }
        }
      },
      "OrderVoidModel": {
        "type": "object",
        "properties": {
          "at": {
            "type": "integer"
          },
          "by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "reason": {
            "type": "string",
            "minLength": 1
          },
          "approved_by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "at",
          "by",
          "reason",
          "approved_by"
        ]
      },
      "OwnAccountSettingsModel": {
        "type": "object",
        "properties": {
          "notifications": {
            "$ref": "#/components/schemas/AccountNotificationSettingsModel"
          },
          "card_payments": {
            "$ref": "#/components/schemas/OwnCardPaymentsSettingsModel"
          },
          "payments": {
            "$ref": "#/components/schemas/OwnStatementLineModel"
          },
          "payouts": {
            "$ref": "#/components/schemas/OwnStatementLineModel"
          },
          "statement_descriptors": {
            "$ref": "#/components/schemas/StatementDescriptorsModel"
          },
          "connect": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PlatformConnectSettingsModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "notifications",
          "card_payments",
          "payments",
          "payouts",
          "statement_descriptors",
          "connect"
        ]
      },
      "OwnCardPaymentsSettingsBody": {
        "type": "object",
        "properties": {
          "statement_descriptor_prefix": {
            "nullable": true,
            "type": "string",
            "maxLength": 10
          },
          "statement_descriptor_suffix": {
            "nullable": true,
            "type": "string",
            "maxLength": 22
          }
        }
      },
      "OwnCardPaymentsSettingsModel": {
        "type": "object",
        "properties": {
          "statement_descriptor_prefix": {
            "type": "string",
            "minLength": 1
          },
          "statement_descriptor_suffix": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "statement_descriptor_prefix",
          "statement_descriptor_suffix"
        ]
      },
      "OwnStatementLineBody": {
        "type": "object",
        "properties": {
          "statement_descriptor": {
            "nullable": true,
            "type": "string",
            "maxLength": 22
          }
        }
      },
      "OwnStatementLineModel": {
        "type": "object",
        "properties": {
          "statement_descriptor": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "statement_descriptor"
        ]
      },
      "OwnWordsBody": {
        "type": "object",
        "properties": {
          "paragraphs": {
            "type": "array",
            "items": {
              "nullable": true
            }
          }
        }
      },
      "PackBody": {
        "type": "object",
        "properties": {
          "scans": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ScanStep"
            }
          },
          "package": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "weight_g": {
            "nullable": true,
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "PackCashRoundingModel": {
        "type": "object",
        "properties": {
          "increment": {
            "type": "integer",
            "multipleOf": 1
          },
          "mode": {
            "type": "string",
            "minLength": 1
          },
          "half": {
            "type": "string"
          },
          "mandatory": {
            "type": "boolean"
          },
          "effective": {
            "type": "string"
          },
          "unverified": {
            "type": "boolean"
          },
          "notes": {
            "type": "string"
          }
        },
        "required": [
          "increment",
          "mode",
          "mandatory"
        ]
      },
      "PackTaxClassModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "rules": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PackTaxRuleModel"
            }
          },
          "unverified": {
            "type": "boolean"
          },
          "notes": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "rules"
        ]
      },
      "PackTaxJurisdictionModel": {
        "type": "object",
        "properties": {
          "country": {
            "type": "string",
            "minLength": 1
          },
          "region": {
            "type": "string"
          },
          "level": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "country",
          "level"
        ]
      },
      "PackTaxRateModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "rate_ppm": {
            "type": "integer",
            "multipleOf": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "jurisdiction": {
            "$ref": "#/components/schemas/PackTaxJurisdictionModel"
          },
          "registration_label": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "unverified": {
            "type": "boolean"
          },
          "notes": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "rate_ppm",
          "kind",
          "jurisdiction",
          "registration_label"
        ]
      },
      "PackTaxRuleModel": {
        "type": "object",
        "properties": {
          "when": {
            "$ref": "#/components/schemas/PackTaxRuleWhenModel"
          },
          "rates": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "rates"
        ]
      },
      "PackTaxRuleWhenModel": {
        "type": "object",
        "properties": {
          "order_type": {
            "type": "string"
          }
        }
      },
      "PackageBalanceList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PackageBalanceModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "PackageBalanceModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "package": {
            "type": "string",
            "minLength": 1
          },
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "service": {
            "type": "string",
            "minLength": 1
          },
          "sessions": {
            "type": "integer"
          },
          "remaining": {
            "type": "integer"
          },
          "held": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "balance": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "active",
              "used_up",
              "refunded",
              "expired"
            ],
            "minLength": 1
          },
          "expires_at": {
            "nullable": true,
            "type": "integer"
          },
          "purchase_payment": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "activated_at": {
            "nullable": true,
            "type": "integer"
          },
          "refunded_at": {
            "nullable": true,
            "type": "integer"
          },
          "refunded_amount": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          },
          "approval_url": {
            "type": "string"
          },
          "client_secret": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "package",
          "customer",
          "service",
          "sessions",
          "remaining",
          "held",
          "amount",
          "currency",
          "balance",
          "status",
          "expires_at",
          "purchase_payment",
          "activated_at",
          "refunded_at",
          "created"
        ],
        "example": {
          "id": "pkgb_01K6AB3C5D7E9F1G3H5J7K9M2C",
          "object": "package_balance",
          "livemode": false,
          "package": "pkg_01K6AB3C5D7E9F1G3H5J7K9M2A",
          "customer": "cus_01J8ZK1Q9H2B4C6D8E0F2G4H6J",
          "service": "svc_01K6AB3C5D7E9F1G3H5J7K9M2B",
          "sessions": 10,
          "remaining": 7,
          "held": 1,
          "amount": 10000,
          "currency": "gbp",
          "balance": 7000,
          "status": "active",
          "expires_at": 1790500000,
          "purchase_payment": "pay_01K6AB3C5D7E9F1G3H5J7K9M2D",
          "activated_at": 1758964000,
          "refunded_at": null,
          "created": 1758963900
        }
      },
      "PackageBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 60
          },
          "length_mm": {
            "type": "integer",
            "multipleOf": 1
          },
          "width_mm": {
            "type": "integer",
            "multipleOf": 1
          },
          "height_mm": {
            "type": "integer",
            "multipleOf": 1
          },
          "weight_g": {
            "type": "integer",
            "multipleOf": 1
          },
          "is_default": {
            "type": "boolean"
          }
        }
      },
      "PackageList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PackageModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "PackageModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "service": {
            "type": "string",
            "minLength": 1
          },
          "sessions": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "validity_days": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ],
            "minLength": 1
          },
          "offer_on_page": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "name",
          "service",
          "sessions",
          "amount",
          "currency",
          "validity_days",
          "status",
          "offer_on_page",
          "created"
        ],
        "example": {
          "id": "pkg_01K6AB3C5D7E9F1G3H5J7K9M2A",
          "object": "package",
          "livemode": false,
          "name": "Ten washes",
          "service": "svc_01K6AB3C5D7E9F1G3H5J7K9M2B",
          "sessions": 10,
          "amount": 10000,
          "currency": "gbp",
          "validity_days": 365,
          "status": "active",
          "offer_on_page": true,
          "created": 1758963900
        }
      },
      "PackingSlipLineModel": {
        "type": "object",
        "properties": {
          "quantity": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "sku": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "quantity",
          "name",
          "sku"
        ]
      },
      "PackingSlipModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "fulfilment": {
            "type": "string",
            "minLength": 1
          },
          "order_number": {
            "type": "string",
            "minLength": 1
          },
          "business": {
            "type": "string",
            "minLength": 1
          },
          "heading": {
            "type": "string",
            "minLength": 1
          },
          "ordered": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "qr": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "ship_to": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PackingSlipLineModel"
            }
          },
          "gift_note": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "returns_line": {
            "type": "string",
            "minLength": 1
          },
          "marking": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "fulfilment",
          "order_number",
          "business",
          "heading",
          "ordered",
          "qr",
          "ship_to",
          "lines",
          "gift_note",
          "returns_line",
          "marking"
        ]
      },
      "PageAfterBookingBody": {
        "type": "object",
        "properties": {
          "message": {
            "nullable": true,
            "type": "string",
            "maxLength": 500
          },
          "redirect_url": {
            "nullable": true,
            "type": "string",
            "maxLength": 500
          }
        }
      },
      "PageAfterBookingModel": {
        "type": "object",
        "properties": {
          "message": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "redirect_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "message",
          "redirect_url"
        ]
      },
      "PageContentBody": {
        "type": "object",
        "properties": {
          "about": {
            "nullable": true,
            "type": "string",
            "maxLength": 2000
          },
          "amenities": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "socials": {
            "nullable": true
          }
        }
      },
      "PageContentModel": {
        "type": "object",
        "properties": {
          "about": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "amenities": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "socials": {
            "nullable": true
          }
        },
        "required": [
          "about",
          "amenities",
          "socials"
        ]
      },
      "PageFlowBody": {
        "type": "object",
        "properties": {
          "step_order": {
            "type": "string",
            "maxLength": 24
          },
          "staff_choice": {
            "type": "string",
            "maxLength": 12
          },
          "show_prices": {
            "type": "boolean"
          },
          "show_durations": {
            "type": "boolean"
          },
          "show_from_prices": {
            "type": "boolean"
          },
          "phone_required": {
            "type": "boolean"
          },
          "agents_instant_for_returning": {
            "type": "boolean"
          },
          "max_group_size": {
            "type": "integer",
            "multipleOf": 1
          },
          "marketing_consent_text": {
            "nullable": true,
            "type": "string",
            "maxLength": 300
          },
          "after_booking": {
            "$ref": "#/components/schemas/PageAfterBookingBody"
          },
          "questions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PageQuestionBody"
            }
          },
          "wallets": {
            "type": "boolean"
          }
        }
      },
      "PageFlowModel": {
        "type": "object",
        "properties": {
          "step_order": {
            "type": "string",
            "enum": [
              "service_staff_time",
              "staff_service_time",
              "time_service"
            ],
            "minLength": 1
          },
          "staff_choice": {
            "type": "string",
            "enum": [
              "any_or_pick",
              "pick",
              "hidden"
            ],
            "minLength": 1
          },
          "show_prices": {
            "type": "boolean"
          },
          "show_durations": {
            "type": "boolean"
          },
          "show_from_prices": {
            "type": "boolean"
          },
          "phone_required": {
            "type": "boolean"
          },
          "agents_instant_for_returning": {
            "type": "boolean"
          },
          "max_group_size": {
            "type": "integer"
          },
          "marketing_consent_text": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "after_booking": {
            "$ref": "#/components/schemas/PageAfterBookingModel"
          },
          "questions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PageQuestionModel"
            }
          },
          "wallets": {
            "type": "boolean"
          }
        },
        "required": [
          "step_order",
          "staff_choice",
          "show_prices",
          "show_durations",
          "show_from_prices",
          "phone_required",
          "agents_instant_for_returning",
          "max_group_size",
          "marketing_consent_text",
          "after_booking",
          "questions",
          "wallets"
        ]
      },
      "PageImageBody": {
        "type": "object",
        "properties": {
          "image": {
            "type": "string",
            "maxLength": 1000000,
            "minLength": 1
          }
        },
        "required": [
          "image"
        ]
      },
      "PageImageModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "url": {
            "type": "string",
            "minLength": 1
          },
          "width": {
            "type": "integer"
          },
          "height": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "url",
          "width",
          "height"
        ]
      },
      "PageQuestionBody": {
        "type": "object",
        "properties": {
          "id": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "label": {
            "type": "string",
            "maxLength": 120,
            "minLength": 1
          },
          "type": {
            "type": "string",
            "maxLength": 20,
            "minLength": 1
          },
          "required": {
            "type": "boolean"
          },
          "options": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "services": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "label",
          "type"
        ]
      },
      "PageQuestionModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "label": {
            "type": "string",
            "minLength": 1
          },
          "type": {
            "type": "string",
            "enum": [
              "short_text",
              "long_text",
              "single_choice",
              "multiple_choice",
              "yes_no",
              "date"
            ],
            "minLength": 1
          },
          "required": {
            "type": "boolean"
          },
          "options": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "services": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "id",
          "label",
          "type",
          "required",
          "options",
          "services"
        ]
      },
      "PageReviewsBody": {
        "type": "object",
        "properties": {
          "show": {
            "type": "boolean"
          },
          "google_review_url": {
            "nullable": true,
            "type": "string",
            "maxLength": 300
          }
        }
      },
      "PageReviewsModel": {
        "type": "object",
        "properties": {
          "show": {
            "type": "boolean"
          },
          "google_review_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "show",
          "google_review_url"
        ]
      },
      "PageSeoBody": {
        "type": "object",
        "properties": {
          "title": {
            "nullable": true,
            "type": "string",
            "maxLength": 70
          },
          "description": {
            "nullable": true,
            "type": "string",
            "maxLength": 160
          },
          "business_type": {
            "type": "string",
            "maxLength": 40
          }
        }
      },
      "PageSeoModel": {
        "type": "object",
        "properties": {
          "title": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "description": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "business_type": {
            "type": "string",
            "enum": [
              "LocalBusiness",
              "HairSalon",
              "BeautySalon",
              "NailSalon",
              "DaySpa",
              "HealthAndBeautyBusiness",
              "TattooParlor",
              "SportsActivityLocation",
              "ExerciseGym",
              "HealthClub",
              "MedicalBusiness",
              "Dentist",
              "Physiotherapy",
              "VeterinaryCare",
              "PetStore",
              "ChildCare",
              "AutoRepair",
              "ProfessionalService",
              "EducationalOrganization"
            ],
            "minLength": 1
          }
        },
        "required": [
          "title",
          "description",
          "business_type"
        ]
      },
      "PageThemeBody": {
        "type": "object",
        "properties": {
          "accent_color": {
            "nullable": true,
            "type": "string",
            "maxLength": 7
          },
          "font_pair": {
            "type": "string",
            "maxLength": 12
          },
          "corner_radius": {
            "type": "string",
            "maxLength": 12
          },
          "logo_placement": {
            "type": "string",
            "maxLength": 12
          },
          "cover_image": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          }
        }
      },
      "PageThemeModel": {
        "type": "object",
        "properties": {
          "accent_color": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "font_pair": {
            "type": "string",
            "enum": [
              "modern",
              "classic",
              "friendly",
              "editorial"
            ],
            "minLength": 1
          },
          "corner_radius": {
            "type": "string",
            "enum": [
              "none",
              "small",
              "medium",
              "large",
              "pill"
            ],
            "minLength": 1
          },
          "logo_placement": {
            "type": "string",
            "enum": [
              "left",
              "centre",
              "hidden"
            ],
            "minLength": 1
          },
          "cover_image": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "cover_image_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "accent_color",
          "font_pair",
          "corner_radius",
          "logo_placement",
          "cover_image",
          "cover_image_url"
        ]
      },
      "PairingCodeModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "register": {
            "type": "string",
            "minLength": 1
          },
          "code": {
            "type": "string",
            "minLength": 1
          },
          "expires_at": {
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "register",
          "code",
          "expires_at",
          "created"
        ]
      },
      "ParcelModel": {
        "type": "object",
        "properties": {
          "weight_g": {
            "type": "integer"
          },
          "length_mm": {
            "nullable": true,
            "type": "integer"
          },
          "width_mm": {
            "nullable": true,
            "type": "integer"
          },
          "height_mm": {
            "nullable": true,
            "type": "integer"
          },
          "package": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "weight_g",
          "length_mm",
          "width_mm",
          "height_mm",
          "package"
        ]
      },
      "PauseSubscriptionBody": {
        "type": "object",
        "properties": {
          "resumes_at": {
            "type": "integer"
          }
        }
      },
      "PaymentBacsDebitModel": {
        "type": "object",
        "properties": {
          "sort_code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "last4": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "mandate_reference": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "sort_code",
          "last4",
          "mandate_reference"
        ]
      },
      "PaymentCardModel": {
        "type": "object",
        "properties": {
          "brand": {
            "type": "string",
            "minLength": 1
          },
          "country": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "funding": {
            "type": "string",
            "minLength": 1
          },
          "last4": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "brand",
          "country",
          "funding",
          "last4"
        ]
      },
      "PaymentErrorModel": {
        "type": "object",
        "properties": {
          "code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "decline_code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "message": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "code",
          "decline_code",
          "message"
        ]
      },
      "PaymentLinkBody": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          },
          "description": {
            "type": "string",
            "maxLength": 500,
            "nullable": true
          },
          "name": {
            "type": "string",
            "maxLength": 120
          },
          "min_amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "max_amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "reusable": {
            "type": "boolean"
          },
          "max_payments": {
            "nullable": true,
            "type": "integer"
          },
          "expires_at": {
            "nullable": true,
            "type": "integer"
          },
          "completion_message": {
            "nullable": true,
            "type": "string",
            "maxLength": 500
          },
          "redirect_url": {
            "nullable": true,
            "type": "string",
            "maxLength": 2048
          },
          "metadata": {
            "type": "object"
          },
          "preview_price": {
            "nullable": true,
            "type": "boolean"
          },
          "mode": {
            "type": "string",
            "enum": [
              "payment",
              "subscription"
            ]
          },
          "plan": {
            "type": "string",
            "maxLength": 40
          },
          "application_fee_amount": {
            "type": "integer",
            "description": "The platform's fee on a link with a fixed `amount`, in minor units, set as its connected account: at most 20% of the amount, rounded down, unless Tuppence raised the platform's cap — over it is refused when the link is made (`400 application_fee_too_high`).",
            "minimum": 0,
            "multipleOf": 1
          },
          "application_fee_percent": {
            "type": "string",
            "description": "The platform's percentage of each payment, as a decimal string (`\"2.5\"`), set as its connected account: at most 20% unless Tuppence raised the platform's cap — over it is refused when it is set (`400 application_fee_too_high`)."
          }
        }
      },
      "PaymentLinkImageBody": {
        "type": "object",
        "properties": {
          "image": {
            "type": "string",
            "maxLength": 1000000,
            "minLength": 1
          }
        },
        "required": [
          "image"
        ]
      },
      "PaymentLinkList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PaymentLinkModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "PaymentLinkModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "url": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "description": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "amount_type": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "min_amount": {
            "nullable": true,
            "type": "integer"
          },
          "max_amount": {
            "nullable": true,
            "type": "integer"
          },
          "reusable": {
            "type": "boolean"
          },
          "max_payments": {
            "nullable": true,
            "type": "integer"
          },
          "payments_count": {
            "type": "integer"
          },
          "amount_collected": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "expires_at": {
            "nullable": true,
            "type": "integer"
          },
          "paused_at": {
            "nullable": true,
            "type": "integer"
          },
          "paused_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "completion_message": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "redirect_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "metadata": {
            "type": "object"
          },
          "preview_price": {
            "nullable": true,
            "type": "boolean"
          },
          "image_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "share_image_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "mode": {
            "type": "string",
            "minLength": 1
          },
          "plan": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "application_fee_amount": {
            "nullable": true,
            "type": "integer"
          },
          "application_fee_percent": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "url",
          "name",
          "description",
          "currency",
          "amount_type",
          "amount",
          "min_amount",
          "max_amount",
          "reusable",
          "max_payments",
          "payments_count",
          "amount_collected",
          "status",
          "expires_at",
          "paused_at",
          "paused_reason",
          "completion_message",
          "redirect_url",
          "metadata",
          "preview_price",
          "image_url",
          "share_image_url",
          "mode",
          "plan",
          "application_fee_amount",
          "application_fee_percent",
          "created"
        ],
        "example": {
          "id": "link_01J8ZK9P3Q5R7S9T1V3W5X7Y9Z",
          "object": "payment_link",
          "livemode": false,
          "url": "https://pay.tuppence.ai/l/Xq7Kp2Vw9LmN3bT5yZ8cA1",
          "name": "Research report",
          "description": "One report, delivered by email.",
          "currency": "gbp",
          "amount_type": "fixed",
          "amount": 2000,
          "min_amount": null,
          "max_amount": null,
          "reusable": true,
          "max_payments": null,
          "payments_count": 3,
          "amount_collected": 6000,
          "status": "active",
          "expires_at": null,
          "paused_at": null,
          "paused_reason": null,
          "completion_message": "Thanks — it's on its way.",
          "redirect_url": null,
          "metadata": {},
          "preview_price": null,
          "image_url": null,
          "share_image_url": null,
          "mode": "payment",
          "plan": null,
          "application_fee_amount": null,
          "application_fee_percent": null,
          "created": 1789980000
        }
      },
      "PaymentList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PaymentModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "PaymentMethodDetailsModel": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "minLength": 1
          },
          "card": {
            "$ref": "#/components/schemas/PaymentCardModel"
          },
          "bacs_debit": {
            "$ref": "#/components/schemas/PaymentBacsDebitModel"
          },
          "sepa_debit": {
            "$ref": "#/components/schemas/PaymentSepaDebitModel"
          }
        },
        "required": [
          "type"
        ]
      },
      "PaymentMethodDomainBody": {
        "type": "object",
        "properties": {
          "domain_name": {
            "type": "string",
            "maxLength": 253
          }
        }
      },
      "PaymentMethodDomainList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PaymentMethodDomainModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "PaymentMethodDomainModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "domain_name": {
            "type": "string",
            "minLength": 1
          },
          "apple_pay": {
            "$ref": "#/components/schemas/PaymentMethodDomainWallet"
          },
          "google_pay": {
            "$ref": "#/components/schemas/PaymentMethodDomainWallet"
          },
          "error": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "checked_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "domain_name",
          "apple_pay",
          "google_pay",
          "error",
          "checked_at",
          "created"
        ]
      },
      "PaymentMethodDomainWallet": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "active",
              "inactive",
              "pending"
            ],
            "minLength": 1
          }
        },
        "required": [
          "status"
        ]
      },
      "PaymentMethodPriceModel": {
        "type": "object",
        "properties": {
          "bps": {
            "type": "integer",
            "multipleOf": 1
          },
          "fixed": {
            "type": "integer",
            "multipleOf": 1
          },
          "cap": {
            "nullable": true,
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "bps",
          "fixed",
          "cap",
          "currency"
        ]
      },
      "PaymentMethodSettingModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "type": {
            "type": "string",
            "minLength": 1
          },
          "label": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "enabled": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "enum": [
              "on",
              "pending",
              "off",
              "coming_soon",
              "price_to_be_set"
            ],
            "minLength": 1
          },
          "reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "price": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PaymentMethodPriceModel"
              }
            ],
            "nullable": true
          },
          "delayed": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "type",
          "label",
          "kind",
          "enabled",
          "status",
          "reason",
          "price",
          "delayed"
        ]
      },
      "PaymentMethodSettingsListModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PaymentMethodSettingModel"
            }
          }
        },
        "required": [
          "object",
          "data"
        ]
      },
      "PaymentModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "capture_method": {
            "type": "string",
            "minLength": 1
          },
          "customer": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "description": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "payment_link": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "statement_descriptor_suffix": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "metadata": {
            "type": "object"
          },
          "amount_received": {
            "type": "integer"
          },
          "amount_refunded": {
            "type": "integer"
          },
          "fee": {
            "nullable": true,
            "type": "integer"
          },
          "fee_refunded": {
            "type": "integer"
          },
          "fee_breakdown": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/FeeBreakdownModel"
              }
            ],
            "nullable": true
          },
          "settlement_days": {
            "nullable": true,
            "type": "integer"
          },
          "net": {
            "nullable": true,
            "type": "integer"
          },
          "application_fee_amount": {
            "nullable": true,
            "type": "integer"
          },
          "application_fee": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "fee_payer": {
            "type": "string",
            "minLength": 1
          },
          "source": {
            "type": "string",
            "minLength": 1
          },
          "booking": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "order": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "tip_amount": {
            "type": "integer"
          },
          "tip_shares": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TipShareModel"
            }
          },
          "agent": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "api_key": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "off_session": {
            "type": "boolean"
          },
          "payment_method": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "receipt_email": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "receipt_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "dispute": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "card": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PaymentCardModel"
              }
            ],
            "nullable": true
          },
          "payment_method_details": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PaymentMethodDetailsModel"
              }
            ],
            "nullable": true
          },
          "last_error": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PaymentErrorModel"
              }
            ],
            "nullable": true
          },
          "processing": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PaymentProcessingModel"
              }
            ],
            "nullable": true
          },
          "next_action": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/NextActionModel"
              }
            ],
            "nullable": true
          },
          "unusual": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "step_up": {
            "type": "boolean"
          },
          "approval_url": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          },
          "succeeded_at": {
            "nullable": true,
            "type": "integer"
          },
          "canceled_at": {
            "nullable": true,
            "type": "integer"
          },
          "cancellation_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "amount_capturable": {
            "type": "integer"
          },
          "capture_before": {
            "nullable": true,
            "type": "integer"
          },
          "resource": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "receipt_token": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "client_secret": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "amount",
          "currency",
          "status",
          "capture_method",
          "customer",
          "description",
          "payment_link",
          "statement_descriptor_suffix",
          "metadata",
          "amount_received",
          "amount_refunded",
          "fee",
          "fee_refunded",
          "fee_breakdown",
          "settlement_days",
          "net",
          "application_fee_amount",
          "application_fee",
          "fee_payer",
          "source",
          "booking",
          "order",
          "kind",
          "tip_amount",
          "tip_shares",
          "agent",
          "api_key",
          "off_session",
          "payment_method",
          "receipt_email",
          "receipt_url",
          "dispute",
          "card",
          "payment_method_details",
          "last_error",
          "processing",
          "next_action",
          "unusual",
          "step_up",
          "approval_url",
          "created",
          "succeeded_at",
          "canceled_at",
          "cancellation_reason",
          "amount_capturable",
          "capture_before",
          "resource",
          "receipt_token"
        ],
        "example": {
          "id": "pay_01J8ZK3V5M7Q2N4R6T8W0XYZAB",
          "object": "payment",
          "livemode": false,
          "amount": 2000,
          "currency": "gbp",
          "status": "succeeded",
          "capture_method": "automatic",
          "customer": "cus_01J8ZK1Q9H2B4C6D8E0F2G4H6J",
          "description": "Research report",
          "payment_link": null,
          "statement_descriptor_suffix": null,
          "metadata": {
            "order": "1042"
          },
          "amount_received": 2000,
          "amount_refunded": 0,
          "fee": 16,
          "fee_refunded": 0,
          "fee_breakdown": {
            "schedule_version": "v2",
            "tier": "standard",
            "bps": 79,
            "surcharge": false,
            "min_applied": false,
            "method": "card",
            "cap_applied": false,
            "parts": [
              {
                "label": "accept.base",
                "bps": 79
              }
            ]
          },
          "settlement_days": 3,
          "net": 1984,
          "application_fee_amount": null,
          "application_fee": null,
          "fee_payer": "account",
          "source": "api",
          "booking": null,
          "order": null,
          "kind": null,
          "tip_amount": 0,
          "tip_shares": [],
          "off_session": false,
          "payment_method": "pm_card_gb",
          "receipt_email": "payer@example.com",
          "receipt_url": "https://pay.tuppence.ai/r/7QpK2xVw9LmN3bT5yZ8cA1",
          "dispute": null,
          "card": {
            "brand": "visa",
            "country": "GB",
            "funding": "debit",
            "last4": "0005"
          },
          "payment_method_details": {
            "type": "card",
            "card": {
              "brand": "visa",
              "country": "GB",
              "funding": "debit",
              "last4": "0005"
            }
          },
          "last_error": null,
          "processing": null,
          "next_action": null,
          "agent": null,
          "api_key": "key_example",
          "unusual": [],
          "step_up": false,
          "approval_url": "https://pay.tuppence.ai/pay/pay_01J8ZK3V5M7Q2N4R6T8W0XYZAB",
          "created": 1790000000,
          "succeeded_at": 1790000004,
          "canceled_at": null,
          "cancellation_reason": null,
          "amount_capturable": 0,
          "capture_before": null,
          "resource": null,
          "receipt_token": null
        }
      },
      "PaymentProcessingModel": {
        "type": "object",
        "properties": {
          "expected_debit_date": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "expected_debit_date"
        ]
      },
      "PaymentRecordBody": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string",
            "enum": [
              "cash",
              "other_terminal",
              "bank_transfer",
              "other"
            ],
            "minLength": 1
          },
          "amount": {
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          },
          "tip_amount": {
            "type": "integer",
            "minimum": 0,
            "multipleOf": 1
          },
          "note": {
            "type": "string",
            "maxLength": 500
          }
        },
        "required": [
          "method",
          "amount"
        ]
      },
      "PaymentSepaDebitModel": {
        "type": "object",
        "properties": {
          "country": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "last4": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "country",
          "last4"
        ]
      },
      "PaymentSettingsBody": {
        "type": "object",
        "properties": {
          "statement_descriptor": {
            "type": "string",
            "pattern": "^[A-Za-z0-9 .,\\-&/#]{5,22}$"
          }
        }
      },
      "PayoutHoldModel": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "minLength": 1
          },
          "since": {
            "type": "integer"
          },
          "kind": {
            "type": "string",
            "enum": [
              "review",
              "cooling_off",
              "account"
            ],
            "minLength": 1
          },
          "ends_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "reason",
          "since",
          "kind",
          "ends_at"
        ]
      },
      "PayoutList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PayoutModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "PayoutModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "trigger": {
            "type": "string",
            "minLength": 1
          },
          "arrival_date": {
            "nullable": true,
            "type": "integer"
          },
          "statement_descriptor": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "failure_code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          },
          "paid_at": {
            "nullable": true,
            "type": "integer"
          },
          "method": {
            "type": "string",
            "minLength": 1
          },
          "fee_amount": {
            "type": "integer"
          },
          "total_amount": {
            "type": "integer"
          },
          "destination_type": {
            "type": "string",
            "description": "Where it went: `bank` (your bank account) or `card_balance` (your cards' balance). Every payout today is `bank`.",
            "enum": [
              "bank",
              "card_balance"
            ],
            "minLength": 1
          },
          "destination": {
            "description": "The external account it was paid to (`ba_…`); null on payouts made before 7 Oct 2026.",
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "amount",
          "currency",
          "status",
          "trigger",
          "arrival_date",
          "statement_descriptor",
          "failure_code",
          "created",
          "paid_at",
          "method",
          "fee_amount",
          "total_amount",
          "destination_type",
          "destination"
        ],
        "example": {
          "id": "po_01J8ZKB4C6D8E0F2G4H6J8K0M2",
          "object": "payout",
          "livemode": false,
          "amount": 9872,
          "currency": "gbp",
          "status": "paid",
          "trigger": "daily",
          "arrival_date": 1790172800,
          "failure_code": null,
          "created": 1790000000,
          "paid_at": 1790172800,
          "method": "standard",
          "fee_amount": 0,
          "total_amount": 9872,
          "destination_type": "bank",
          "destination": "ba_1PxYz2AbCdEfGhIjKlMnOpQr",
          "statement_descriptor": "TUPPENCE"
        }
      },
      "PayoutPricesModel": {
        "type": "object",
        "properties": {
          "minimum": {
            "type": "integer",
            "description": "The least a payout pays, in minor units. Standard payouts cost nothing."
          },
          "instant_bps": {
            "description": "An instant payout, in basis points of the amount; null where not offered.",
            "nullable": true,
            "type": "integer"
          },
          "next_day_bps": {
            "description": "Next-day payouts, added to the card rate of each payment while on, in basis points; null where not offered.",
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "minimum",
          "instant_bps",
          "next_day_bps"
        ]
      },
      "PayoutReconciliationModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "payout": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "since": {
            "nullable": true,
            "type": "integer"
          },
          "opening_balance": {
            "type": "integer"
          },
          "activity_count": {
            "type": "integer"
          },
          "activity_amount": {
            "type": "integer"
          },
          "activity_fee": {
            "type": "integer"
          },
          "activity_net": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "closing_balance": {
            "type": "integer"
          }
        },
        "required": [
          "object",
          "payout",
          "currency",
          "since",
          "opening_balance",
          "activity_count",
          "activity_amount",
          "activity_fee",
          "activity_net",
          "amount",
          "closing_balance"
        ]
      },
      "PayoutReserveModel": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "reason",
          "amount"
        ]
      },
      "PayoutScheduleBody": {
        "type": "object",
        "properties": {
          "interval": {
            "type": "string",
            "enum": [
              "daily",
              "weekly",
              "monthly",
              "manual"
            ]
          },
          "delay_days": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "string"
              }
            ]
          },
          "weekly_anchor": {
            "type": "string",
            "enum": [
              "monday",
              "tuesday",
              "wednesday",
              "thursday",
              "friday",
              "saturday",
              "sunday"
            ]
          },
          "monthly_anchor": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "PayoutScheduleModel": {
        "type": "object",
        "properties": {
          "interval": {
            "type": "string",
            "minLength": 1
          },
          "weekly_anchor": {
            "type": "string",
            "minLength": 1
          },
          "monthly_anchor": {
            "nullable": true,
            "type": "integer"
          },
          "delay_days": {
            "nullable": true,
            "type": "integer"
          },
          "minimum_amount": {
            "type": "integer"
          },
          "month_end_minimum_amount": {
            "type": "integer"
          }
        },
        "required": [
          "interval",
          "weekly_anchor",
          "monthly_anchor",
          "delay_days",
          "minimum_amount",
          "month_end_minimum_amount"
        ]
      },
      "PayoutSettingsBody": {
        "type": "object",
        "properties": {
          "schedule": {
            "$ref": "#/components/schemas/PayoutScheduleBody"
          },
          "statement_descriptor": {
            "nullable": true,
            "type": "string",
            "maxLength": 22
          }
        }
      },
      "PayoutSettingsModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "payouts_enabled": {
            "type": "boolean"
          },
          "schedule": {
            "$ref": "#/components/schemas/PayoutScheduleModel"
          },
          "minimum_payout_amount": {
            "type": "integer"
          },
          "settlement_days": {
            "nullable": true,
            "type": "integer"
          },
          "next_day": {
            "$ref": "#/components/schemas/NextDayModel"
          },
          "review": {
            "type": "string",
            "enum": [
              "pending",
              "complete"
            ],
            "minLength": 1
          },
          "cleared_amount": {
            "type": "integer"
          },
          "payable_amount": {
            "type": "integer"
          },
          "instant_payouts": {
            "$ref": "#/components/schemas/InstantPayoutsModel"
          },
          "next_payout": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/NextPayoutModel"
              }
            ],
            "nullable": true
          },
          "bank_account": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/BankAccountModel"
              }
            ],
            "nullable": true
          },
          "hold": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PayoutHoldModel"
              }
            ],
            "nullable": true
          },
          "reserve": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PayoutReserveModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "object",
          "livemode",
          "currency",
          "payouts_enabled",
          "schedule",
          "minimum_payout_amount",
          "settlement_days",
          "next_day",
          "review",
          "cleared_amount",
          "payable_amount",
          "instant_payouts",
          "next_payout",
          "bank_account",
          "hold",
          "reserve"
        ]
      },
      "PendingTopupsModel": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer"
          },
          "count": {
            "type": "integer"
          },
          "awaiting": {
            "$ref": "#/components/schemas/AwaitingTopupsModel"
          }
        },
        "required": [
          "amount",
          "count",
          "awaiting"
        ]
      },
      "PersonAddressBody": {
        "type": "object",
        "properties": {
          "line1": {
            "type": "string",
            "maxLength": 200,
            "minLength": 1
          },
          "line2": {
            "type": "string",
            "maxLength": 200
          },
          "city": {
            "type": "string",
            "maxLength": 100,
            "minLength": 1
          },
          "state": {
            "type": "string",
            "maxLength": 100
          },
          "postal_code": {
            "type": "string",
            "maxLength": 20,
            "minLength": 1
          },
          "country": {
            "type": "string",
            "pattern": "^[A-Z]{2}$",
            "minLength": 1
          }
        },
        "required": [
          "line1",
          "city",
          "postal_code",
          "country"
        ]
      },
      "PersonBody": {
        "type": "object",
        "properties": {
          "first_name": {
            "type": "string",
            "maxLength": 100
          },
          "last_name": {
            "type": "string",
            "maxLength": 100
          },
          "email": {
            "type": "string",
            "maxLength": 320
          },
          "phone": {
            "type": "string",
            "pattern": "^\\+?[0-9 ()-]{6,20}$"
          },
          "dob": {
            "$ref": "#/components/schemas/PersonDobBody"
          },
          "address": {
            "$ref": "#/components/schemas/PersonAddressBody"
          },
          "id_number": {
            "type": "string",
            "maxLength": 40
          },
          "ssn_last_4": {
            "type": "string",
            "pattern": "^\\d{4}$"
          },
          "nationality": {
            "type": "string",
            "pattern": "^[A-Z]{2}$"
          },
          "political_exposure": {
            "type": "string",
            "enum": [
              "none",
              "existing"
            ]
          },
          "relationship": {
            "$ref": "#/components/schemas/PersonRelationshipBody"
          },
          "verification": {
            "$ref": "#/components/schemas/PersonVerificationBody"
          }
        }
      },
      "PersonDeletedModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "deleted": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "object",
          "deleted"
        ]
      },
      "PersonDobBody": {
        "type": "object",
        "properties": {
          "day": {
            "type": "integer",
            "maximum": 31,
            "minimum": 1,
            "multipleOf": 1
          },
          "month": {
            "type": "integer",
            "maximum": 12,
            "minimum": 1,
            "multipleOf": 1
          },
          "year": {
            "type": "integer",
            "maximum": 2100,
            "minimum": 1900,
            "multipleOf": 1
          }
        },
        "required": [
          "day",
          "month",
          "year"
        ]
      },
      "PersonDocumentBody": {
        "type": "object",
        "properties": {
          "front": {
            "type": "string",
            "pattern": "^file_[A-Za-z0-9]+$"
          },
          "back": {
            "type": "string",
            "pattern": "^file_[A-Za-z0-9]+$"
          }
        }
      },
      "PersonIdentityCheckModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "verification_session": {
            "type": "string",
            "minLength": 1
          },
          "client_secret": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "person": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "verification_session",
          "client_secret",
          "status",
          "person"
        ]
      },
      "PersonList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PersonModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "PersonModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          },
          "first_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "last_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "relationship": {
            "$ref": "#/components/schemas/PersonRelationshipModel"
          },
          "requirements": {
            "$ref": "#/components/schemas/PersonRequirementsModel"
          },
          "verification": {
            "$ref": "#/components/schemas/PersonVerificationModel"
          },
          "address_provided": {
            "type": "boolean"
          },
          "dob_provided": {
            "type": "boolean"
          },
          "email_provided": {
            "type": "boolean"
          },
          "id_number_provided": {
            "type": "boolean"
          },
          "phone_provided": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "object",
          "account",
          "created",
          "first_name",
          "last_name",
          "relationship",
          "requirements",
          "verification",
          "address_provided",
          "dob_provided",
          "email_provided",
          "id_number_provided",
          "phone_provided"
        ]
      },
      "PersonRelationshipBody": {
        "type": "object",
        "properties": {
          "representative": {
            "type": "boolean"
          },
          "owner": {
            "type": "boolean"
          },
          "director": {
            "type": "boolean"
          },
          "executive": {
            "type": "boolean"
          },
          "authorizer": {
            "type": "boolean"
          },
          "title": {
            "type": "string",
            "maxLength": 100
          },
          "percent_ownership": {
            "type": "integer",
            "maximum": 100,
            "minimum": 0
          }
        }
      },
      "PersonRelationshipModel": {
        "type": "object",
        "properties": {
          "representative": {
            "type": "boolean"
          },
          "owner": {
            "type": "boolean"
          },
          "director": {
            "type": "boolean"
          },
          "executive": {
            "type": "boolean"
          },
          "title": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "percent_ownership": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "representative",
          "owner",
          "director",
          "executive",
          "title",
          "percent_ownership"
        ]
      },
      "PersonRequirementErrorModel": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "minLength": 1
          },
          "reason": {
            "type": "string",
            "minLength": 1
          },
          "requirement": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "code",
          "reason",
          "requirement"
        ]
      },
      "PersonRequirementsModel": {
        "type": "object",
        "properties": {
          "currently_due": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "eventually_due": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "past_due": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "pending_verification": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PersonRequirementErrorModel"
            }
          }
        },
        "required": [
          "currently_due",
          "eventually_due",
          "past_due",
          "pending_verification",
          "errors"
        ]
      },
      "PersonVerificationBody": {
        "type": "object",
        "properties": {
          "document": {
            "$ref": "#/components/schemas/PersonDocumentBody"
          },
          "additional_document": {
            "$ref": "#/components/schemas/PersonDocumentBody"
          }
        }
      },
      "PersonVerificationModel": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "status"
        ]
      },
      "PickupBody": {
        "type": "object",
        "properties": {
          "location": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "date": {
            "nullable": true,
            "type": "string",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
          },
          "carrier": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "instructions": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          }
        }
      },
      "PlanEntitlementsModel": {
        "type": "object",
        "properties": {
          "services": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "per_period": {
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          }
        },
        "required": [
          "services",
          "per_period"
        ]
      },
      "PlanEventEntitlementsBody": {
        "type": "object",
        "properties": {
          "events": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "per_period": {
            "nullable": true,
            "type": "integer"
          }
        }
      },
      "PlanEventEntitlementsModel": {
        "type": "object",
        "properties": {
          "events": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "per_period": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "events",
          "per_period"
        ]
      },
      "PlanList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PlanModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "PlanModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "interval": {
            "type": "string",
            "enum": [
              "day",
              "week",
              "month",
              "year"
            ],
            "minLength": 1
          },
          "interval_count": {
            "type": "integer"
          },
          "trial_days": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ],
            "minLength": 1
          },
          "metadata": {
            "type": "object"
          },
          "entitlements": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PlanEntitlementsModel"
              }
            ],
            "nullable": true
          },
          "event_entitlements": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PlanEventEntitlementsModel"
              }
            ],
            "nullable": true
          },
          "offer_on_page": {
            "type": "boolean"
          },
          "application_fee_percent": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "name",
          "amount",
          "currency",
          "interval",
          "interval_count",
          "trial_days",
          "status",
          "metadata",
          "entitlements",
          "event_entitlements",
          "offer_on_page",
          "application_fee_percent",
          "created"
        ]
      },
      "PlatformAgreementAcceptedModel": {
        "type": "object",
        "properties": {
          "version": {
            "type": "string",
            "minLength": 1
          },
          "accepted_at": {
            "type": "integer"
          },
          "user": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "version",
          "accepted_at",
          "user"
        ]
      },
      "PlatformAgreementModel": {
        "type": "object",
        "properties": {
          "version": {
            "type": "string",
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "terms": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "accepted": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PlatformAgreementAcceptedModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "version",
          "title",
          "terms",
          "accepted"
        ]
      },
      "PlatformApplicationFeesBody": {
        "type": "object",
        "properties": {
          "percent": {
            "type": "string",
            "description": "The percentage of each payment (`\"1.5\"`), rounded up, plus `fixed_amount`: at most 20% unless Tuppence raised your platform's cap — over it is refused when it is set (`400 application_fee_too_high`)."
          },
          "fixed_amount": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "PlatformApplicationFeesModel": {
        "type": "object",
        "properties": {
          "percent": {
            "type": "string",
            "minLength": 1
          },
          "fixed_amount": {
            "type": "integer"
          }
        },
        "required": [
          "percent",
          "fixed_amount"
        ]
      },
      "PlatformCardTopupsBody": {
        "type": "object",
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "methods": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true
          },
          "platform_fee": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PlatformTopupFeeBody"
              }
            ],
            "nullable": true
          },
          "limits": {
            "$ref": "#/components/schemas/PlatformTopupLimitsBody"
          },
          "auto_topup_allowed": {
            "type": "boolean"
          }
        }
      },
      "PlatformCardTopupsModel": {
        "type": "object",
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "methods": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true
          },
          "platform_fee": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PlatformTopupFeeModel"
              }
            ],
            "nullable": true
          },
          "limits": {
            "$ref": "#/components/schemas/PlatformTopupLimitsModel"
          },
          "auto_topup_allowed": {
            "type": "boolean"
          }
        },
        "required": [
          "enabled",
          "methods",
          "platform_fee",
          "limits",
          "auto_topup_allowed"
        ]
      },
      "PlatformConnectDefaultsBody": {
        "type": "object",
        "properties": {
          "fees_payer": {
            "type": "string",
            "enum": [
              "account",
              "application"
            ]
          },
          "application_fees": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PlatformApplicationFeesBody"
              }
            ],
            "nullable": true
          },
          "payout_schedule": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PlatformPayoutScheduleBody"
              }
            ],
            "nullable": true
          },
          "cashback_share": {
            "nullable": true,
            "type": "string"
          },
          "statement_descriptor_prefix": {
            "nullable": true,
            "type": "string",
            "maxLength": 10
          },
          "payout_statement_descriptor": {
            "nullable": true,
            "type": "string",
            "maxLength": 22
          },
          "statement_descriptors_locked": {
            "type": "boolean"
          },
          "store_application_fee": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PlatformApplicationFeesBody"
              }
            ],
            "nullable": true
          },
          "store": {
            "$ref": "#/components/schemas/PlatformStoreDefaultsBody"
          }
        }
      },
      "PlatformConnectDefaultsModel": {
        "type": "object",
        "properties": {
          "fees_payer": {
            "type": "string",
            "minLength": 1
          },
          "application_fees": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PlatformApplicationFeesModel"
              }
            ],
            "nullable": true
          },
          "payout_schedule": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PlatformPayoutScheduleModel"
              }
            ],
            "nullable": true
          },
          "cashback_share": {
            "type": "string",
            "minLength": 1
          },
          "statement_descriptor_prefix": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "payout_statement_descriptor": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "statement_descriptors_locked": {
            "type": "boolean"
          },
          "store_application_fee": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PlatformApplicationFeesModel"
              }
            ],
            "nullable": true
          },
          "store": {
            "$ref": "#/components/schemas/PlatformStoreDefaultsModel"
          }
        },
        "required": [
          "fees_payer",
          "application_fees",
          "payout_schedule",
          "cashback_share",
          "statement_descriptor_prefix",
          "payout_statement_descriptor",
          "statement_descriptors_locked",
          "store_application_fee",
          "store"
        ]
      },
      "PlatformConnectSettingsBody": {
        "type": "object",
        "properties": {
          "card_topups": {
            "$ref": "#/components/schemas/PlatformCardTopupsBody"
          },
          "terms_url": {
            "nullable": true,
            "type": "string"
          },
          "privacy_url": {
            "nullable": true,
            "type": "string"
          },
          "defaults": {
            "$ref": "#/components/schemas/PlatformConnectDefaultsBody"
          },
          "store_domain": {
            "nullable": true,
            "type": "string",
            "maxLength": 253
          }
        }
      },
      "PlatformConnectSettingsModel": {
        "type": "object",
        "properties": {
          "terms_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "privacy_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "defaults": {
            "$ref": "#/components/schemas/PlatformConnectDefaultsModel"
          },
          "card_topups": {
            "$ref": "#/components/schemas/PlatformCardTopupsModel"
          },
          "store_domain": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PlatformStoreDomainModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "terms_url",
          "privacy_url",
          "defaults",
          "card_topups",
          "store_domain"
        ]
      },
      "PlatformPayoutScheduleBody": {
        "type": "object",
        "properties": {
          "interval": {
            "type": "string",
            "enum": [
              "daily",
              "weekly",
              "monthly",
              "manual"
            ]
          },
          "weekly_anchor": {
            "type": "string"
          },
          "monthly_anchor": {
            "type": "integer",
            "multipleOf": 1
          },
          "delay_days": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "string"
              }
            ]
          }
        }
      },
      "PlatformPayoutScheduleModel": {
        "type": "object",
        "properties": {
          "interval": {
            "type": "string",
            "minLength": 1
          },
          "weekly_anchor": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "monthly_anchor": {
            "nullable": true,
            "type": "integer"
          },
          "delay_days": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "interval",
          "weekly_anchor",
          "monthly_anchor",
          "delay_days"
        ]
      },
      "PlatformStoreDefaultsBody": {
        "type": "object",
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "agent_native_checkout": {
            "type": "boolean"
          }
        }
      },
      "PlatformStoreDefaultsModel": {
        "type": "object",
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "agent_native_checkout": {
            "type": "boolean"
          }
        },
        "required": [
          "enabled",
          "agent_native_checkout"
        ]
      },
      "PlatformStoreDomainModel": {
        "type": "object",
        "properties": {
          "domain": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "verified",
              "failed"
            ],
            "minLength": 1
          },
          "records": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PlatformStoreDomainRecordModel"
            }
          },
          "error": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "checked": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "domain",
          "status",
          "records",
          "error",
          "checked"
        ]
      },
      "PlatformStoreDomainRecordModel": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "value": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "type",
          "name",
          "value"
        ]
      },
      "PlatformTopupFeeBody": {
        "type": "object",
        "properties": {
          "rate_bps": {
            "type": "integer",
            "multipleOf": 1
          },
          "fixed": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "PlatformTopupFeeModel": {
        "type": "object",
        "properties": {
          "rate_bps": {
            "type": "integer"
          },
          "fixed": {
            "type": "integer"
          }
        },
        "required": [
          "rate_bps",
          "fixed"
        ]
      },
      "PlatformTopupLimitsBody": {
        "type": "object",
        "properties": {
          "per_topup": {
            "nullable": true,
            "type": "integer",
            "multipleOf": 1
          },
          "per_30_days": {
            "nullable": true,
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "PlatformTopupLimitsModel": {
        "type": "object",
        "properties": {
          "per_topup": {
            "nullable": true,
            "type": "integer"
          },
          "per_30_days": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "per_topup",
          "per_30_days"
        ]
      },
      "PolicyBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 100
          },
          "limits": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/LimitsBody"
              }
            ],
            "nullable": true
          },
          "allowed_mccs": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "nullable": true
          },
          "allowed_merchant_kinds": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "software",
                "advertising",
                "travel",
                "food",
                "office",
                "telecoms",
                "professional",
                "shipping"
              ]
            },
            "nullable": true
          },
          "blocked_mccs": {
            "type": "array",
            "items": {
              "type": "integer"
            }
          },
          "allowed_countries": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true
          },
          "merchant_locks": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MerchantLockModel"
            }
          },
          "approval_threshold": {
            "nullable": true,
            "type": "integer",
            "multipleOf": 1
          },
          "unusual_activity": {
            "type": "string",
            "enum": [
              "ask",
              "flag",
              "off"
            ]
          },
          "version": {
            "type": "integer",
            "multipleOf": 1
          },
          "metadata": {
            "type": "object"
          }
        }
      },
      "PolicyRenderBody": {
        "type": "object",
        "properties": {
          "service": {
            "type": "string",
            "maxLength": 40
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "draft": {
            "nullable": true
          }
        }
      },
      "PolicyRenderModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "version": {
            "type": "integer"
          },
          "service": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "policy": {
            "$ref": "#/components/schemas/EffectivePolicyModel"
          },
          "text": {
            "type": "string",
            "minLength": 1
          },
          "mandate_description": {
            "type": "string",
            "minLength": 1
          },
          "deposit_amount": {
            "nullable": true,
            "type": "integer"
          },
          "late_fee_amount": {
            "nullable": true,
            "type": "integer"
          },
          "no_show_fee_amount": {
            "nullable": true,
            "type": "integer"
          },
          "balance_after_line": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "snapshot": {
            "nullable": true
          }
        },
        "required": [
          "object",
          "version",
          "service",
          "amount",
          "currency",
          "policy",
          "text",
          "mandate_description",
          "deposit_amount",
          "late_fee_amount",
          "no_show_fee_amount",
          "balance_after_line"
        ]
      },
      "PolicyVersionDraftedEvent": {
        "type": "object",
        "description": "The `policy.version_drafted` event (the store's rules events): `data.object` is the `site_policy_version`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "policy.version_drafted"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/SitePolicyVersionEventData"
          }
        }
      },
      "PolicyVersionPublishedEvent": {
        "type": "object",
        "description": "The `policy.version_published` event (the store's rules events): `data.object` is the `site_policy_version`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "policy.version_published"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/SitePolicyVersionEventData"
          }
        }
      },
      "PortalSessionModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "url": {
            "type": "string",
            "minLength": 1
          },
          "return_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "allowed_actions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "expires_at": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "customer",
          "url",
          "return_url",
          "allowed_actions",
          "expires_at"
        ]
      },
      "PosCatalogueModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "version": {
            "type": "integer"
          },
          "since": {
            "nullable": true,
            "type": "integer"
          },
          "tax": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/LocationTaxSettingsModel"
              }
            ],
            "nullable": true
          },
          "tax_rates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TaxRateModel"
            }
          },
          "tax_classes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TaxClassModel"
            }
          },
          "product_categories": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProductCategoryModel"
            }
          },
          "products": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProductModel"
            }
          },
          "modifier_groups": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ModifierGroupModel"
            }
          },
          "discounts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DiscountModel"
            }
          },
          "pos_layouts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PosLayoutModel"
            }
          },
          "removed": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PosCatalogueTombstoneModel"
            }
          }
        },
        "required": [
          "object",
          "livemode",
          "version",
          "since",
          "tax",
          "tax_rates",
          "tax_classes",
          "product_categories",
          "products",
          "modifier_groups",
          "discounts",
          "pos_layouts",
          "removed"
        ]
      },
      "PosCatalogueTombstoneModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": [
              "tax_rate",
              "tax_class",
              "product_category",
              "product",
              "modifier_group",
              "discount",
              "pos_layout"
            ],
            "minLength": 1
          },
          "id": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "id"
        ]
      },
      "PosDeviceBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 120
          },
          "dedicated": {
            "type": "boolean"
          }
        }
      },
      "PosDeviceList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PosDeviceModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "PosDeviceModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "register": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "ios",
              "android",
              "web",
              "reader"
            ],
            "minLength": 1
          },
          "role": {
            "type": "string",
            "enum": [
              "till",
              "display"
            ],
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "dedicated": {
            "type": "boolean"
          },
          "app_version": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "offline_queue_depth": {
            "type": "integer"
          },
          "paired_by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "paired_at": {
            "type": "integer"
          },
          "last_seen_at": {
            "nullable": true,
            "type": "integer"
          },
          "revoked": {
            "type": "boolean"
          },
          "revoked_at": {
            "nullable": true,
            "type": "integer"
          },
          "revoked_by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "metadata": {
            "type": "object"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "register",
          "location",
          "kind",
          "role",
          "name",
          "dedicated",
          "app_version",
          "offline_queue_depth",
          "paired_by",
          "paired_at",
          "last_seen_at",
          "revoked",
          "revoked_at",
          "revoked_by",
          "metadata",
          "created"
        ]
      },
      "PosLayoutBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 80
          },
          "pages": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LayoutPageBody"
            }
          },
          "template": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          }
        }
      },
      "PosLayoutList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PosLayoutModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "PosLayoutModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "pages": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LayoutPageModel"
            }
          },
          "template": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ],
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "name",
          "pages",
          "template",
          "status",
          "created"
        ]
      },
      "PosPairCodeBody": {
        "type": "object",
        "properties": {
          "register": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          }
        }
      },
      "PosReceiptBusinessModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "address": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "registrations": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "name",
          "address",
          "registrations"
        ]
      },
      "PosReceiptDocumentModel": {
        "type": "object",
        "properties": {
          "locale": {
            "type": "string",
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "invoice": {
            "type": "string",
            "minLength": 1
          },
          "copy": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "business": {
            "$ref": "#/components/schemas/PosReceiptBusinessModel"
          },
          "header": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "meta": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PosReceiptItemModel"
            }
          },
          "totals": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PosReceiptRowModel"
            }
          },
          "tax": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PosReceiptTaxModel"
              }
            ],
            "nullable": true
          },
          "tenders": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PosReceiptRowModel"
            }
          },
          "customer": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "footer": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "fiscal": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "locale",
          "title",
          "invoice",
          "copy",
          "business",
          "header",
          "meta",
          "items",
          "totals",
          "tax",
          "tenders",
          "customer",
          "footer",
          "fiscal"
        ]
      },
      "PosReceiptItemModel": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "minLength": 1
          },
          "value": {
            "type": "string",
            "minLength": 1
          },
          "details": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PosReceiptRowModel"
            }
          }
        },
        "required": [
          "label",
          "value",
          "details"
        ]
      },
      "PosReceiptModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "order": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "channel": {
            "type": "string",
            "enum": [
              "print",
              "email",
              "sms",
              "qr",
              "none"
            ],
            "minLength": 1
          },
          "recipient": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "full_invoice": {
            "type": "boolean"
          },
          "customer_details": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ReceiptCustomerDetailsModel"
              }
            ],
            "nullable": true
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "sent",
              "failed"
            ],
            "minLength": 1
          },
          "locale": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "sequence": {
            "nullable": true,
            "type": "integer"
          },
          "kind": {
            "nullable": true,
            "type": "string",
            "minLength": 1,
            "enum": [
              "sale",
              "return",
              "void",
              "duplicate"
            ]
          },
          "business_day": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "hash": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "duplicate_of": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "training": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "order",
          "location",
          "channel",
          "recipient",
          "full_invoice",
          "customer_details",
          "status",
          "locale",
          "sequence",
          "kind",
          "business_day",
          "hash",
          "duplicate_of",
          "training",
          "created"
        ]
      },
      "PosReceiptRowModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "label": {
            "type": "string",
            "minLength": 1
          },
          "value": {
            "type": "string",
            "minLength": 1
          },
          "strong": {
            "type": "boolean"
          }
        },
        "required": [
          "kind",
          "label",
          "value",
          "strong"
        ]
      },
      "PosReceiptTaxBandModel": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "minLength": 1
          },
          "rate": {
            "type": "string",
            "minLength": 1
          },
          "net": {
            "type": "string",
            "minLength": 1
          },
          "tax": {
            "type": "string",
            "minLength": 1
          },
          "gross": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "label",
          "rate",
          "net",
          "tax",
          "gross"
        ]
      },
      "PosReceiptTaxColumnsModel": {
        "type": "object",
        "properties": {
          "rate": {
            "type": "string",
            "minLength": 1
          },
          "net": {
            "type": "string",
            "minLength": 1
          },
          "tax": {
            "type": "string",
            "minLength": 1
          },
          "gross": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "rate",
          "net",
          "tax",
          "gross"
        ]
      },
      "PosReceiptTaxModel": {
        "type": "object",
        "properties": {
          "columns": {
            "$ref": "#/components/schemas/PosReceiptTaxColumnsModel"
          },
          "bands": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PosReceiptTaxBandModel"
            }
          }
        },
        "required": [
          "columns",
          "bands"
        ]
      },
      "PosRegisterBody": {
        "type": "object",
        "properties": {
          "location": {
            "type": "string",
            "maxLength": 40
          },
          "name": {
            "type": "string",
            "maxLength": 120
          },
          "layout": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "receipt_settings": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ReceiptSettingsBody"
              }
            ],
            "nullable": true
          },
          "default_order_type": {
            "type": "string",
            "maxLength": 12
          },
          "tipping": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/TippingBody"
              }
            ],
            "nullable": true
          },
          "float_default": {
            "type": "integer"
          },
          "printer_ids": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "cash_drawer": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CashDrawerBody"
              }
            ],
            "nullable": true
          },
          "idle_timeout_seconds": {
            "type": "integer"
          },
          "training_mode": {
            "type": "boolean"
          },
          "metadata": {
            "type": "object"
          }
        }
      },
      "PosSalesCategoryModel": {
        "type": "object",
        "properties": {
          "category": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "quantity": {
            "type": "integer"
          },
          "net": {
            "type": "integer"
          },
          "tax": {
            "type": "integer"
          }
        },
        "required": [
          "category",
          "name",
          "quantity",
          "net",
          "tax"
        ]
      },
      "PosSalesDayModel": {
        "type": "object",
        "properties": {
          "location": {
            "type": "string",
            "minLength": 1
          },
          "business_day": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "location",
          "business_day"
        ]
      },
      "PosSalesHourModel": {
        "type": "object",
        "properties": {
          "hour": {
            "type": "integer"
          },
          "transactions": {
            "type": "integer"
          },
          "net": {
            "type": "integer"
          }
        },
        "required": [
          "hour",
          "transactions",
          "net"
        ]
      },
      "PosSalesItemModel": {
        "type": "object",
        "properties": {
          "product": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "variant": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "category": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "category_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "quantity": {
            "type": "integer"
          },
          "gross": {
            "type": "integer"
          },
          "discounts": {
            "type": "integer"
          },
          "net": {
            "type": "integer"
          },
          "tax": {
            "type": "integer"
          }
        },
        "required": [
          "product",
          "variant",
          "name",
          "category",
          "category_name",
          "quantity",
          "gross",
          "discounts",
          "net",
          "tax"
        ]
      },
      "PosSalesRegisterModel": {
        "type": "object",
        "properties": {
          "register": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "transactions": {
            "type": "integer"
          },
          "net": {
            "type": "integer"
          }
        },
        "required": [
          "register",
          "name",
          "transactions",
          "net"
        ]
      },
      "PosSalesReportModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "from": {
            "type": "string",
            "minLength": 1
          },
          "to": {
            "type": "string",
            "minLength": 1
          },
          "today": {
            "type": "boolean"
          },
          "business_days": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PosSalesDayModel"
            }
          },
          "location": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "register": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "summary": {
            "$ref": "#/components/schemas/PosSalesSummaryModel"
          },
          "tax_by_rate": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PosSalesTaxModel"
            }
          },
          "by_tender": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PosSalesTenderModel"
            }
          },
          "by_item": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PosSalesItemModel"
            }
          },
          "by_category": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PosSalesCategoryModel"
            }
          },
          "by_staff": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PosSalesStaffModel"
            }
          },
          "by_hour": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PosSalesHourModel"
            }
          },
          "by_register": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PosSalesRegisterModel"
            }
          },
          "shifts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PosSalesShiftModel"
            }
          }
        },
        "required": [
          "object",
          "livemode",
          "currency",
          "from",
          "to",
          "today",
          "business_days",
          "location",
          "register",
          "staff_member",
          "summary",
          "tax_by_rate",
          "by_tender",
          "by_item",
          "by_category",
          "by_staff",
          "by_hour",
          "by_register",
          "shifts"
        ]
      },
      "PosSalesShiftModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "register": {
            "type": "string",
            "minLength": 1
          },
          "register_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "business_day": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "float_amount": {
            "type": "integer"
          },
          "expected": {
            "nullable": true,
            "type": "integer"
          },
          "counted": {
            "nullable": true,
            "type": "integer"
          },
          "variance": {
            "nullable": true,
            "type": "integer"
          },
          "variance_note": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "auto_closed": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "register",
          "register_name",
          "business_day",
          "status",
          "float_amount",
          "expected",
          "counted",
          "variance",
          "variance_note",
          "auto_closed"
        ]
      },
      "PosSalesStaffModel": {
        "type": "object",
        "properties": {
          "staff_member": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "transactions": {
            "type": "integer"
          },
          "net": {
            "type": "integer"
          }
        },
        "required": [
          "staff_member",
          "name",
          "transactions",
          "net"
        ]
      },
      "PosSalesSummaryModel": {
        "type": "object",
        "properties": {
          "gross": {
            "type": "integer"
          },
          "discounts": {
            "type": "integer"
          },
          "refunds": {
            "type": "integer"
          },
          "net": {
            "type": "integer"
          },
          "tax": {
            "type": "integer"
          },
          "service_charge": {
            "type": "integer"
          },
          "tips": {
            "type": "integer"
          },
          "cash_rounding": {
            "type": "integer"
          },
          "total": {
            "type": "integer"
          },
          "transactions": {
            "type": "integer"
          },
          "returns": {
            "type": "integer"
          },
          "average": {
            "type": "integer"
          },
          "voids": {
            "$ref": "#/components/schemas/PosSalesVoidsModel"
          }
        },
        "required": [
          "gross",
          "discounts",
          "refunds",
          "net",
          "tax",
          "service_charge",
          "tips",
          "cash_rounding",
          "total",
          "transactions",
          "returns",
          "average",
          "voids"
        ]
      },
      "PosSalesTaxModel": {
        "type": "object",
        "properties": {
          "tax_rate": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "rate_ppm": {
            "type": "integer"
          },
          "taxable": {
            "type": "integer"
          },
          "tax": {
            "type": "integer"
          }
        },
        "required": [
          "tax_rate",
          "name",
          "rate_ppm",
          "taxable",
          "tax"
        ]
      },
      "PosSalesTenderModel": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string",
            "minLength": 1
          },
          "external_kind": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "count": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "tips": {
            "type": "integer"
          },
          "rounding": {
            "type": "integer"
          },
          "total": {
            "type": "integer"
          }
        },
        "required": [
          "method",
          "external_kind",
          "count",
          "amount",
          "tips",
          "rounding",
          "total"
        ]
      },
      "PosSalesVoidsModel": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "count",
          "amount"
        ]
      },
      "PosSeedBody": {
        "type": "object",
        "properties": {
          "business_type": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "location": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "orders": {
            "nullable": true,
            "type": "boolean"
          }
        }
      },
      "PosSeedModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "business_type": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "boolean"
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "register": {
            "type": "string",
            "minLength": 1
          },
          "layout": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "categories": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "products": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "modifier_groups": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "day": {
            "type": "string",
            "minLength": 1
          },
          "shift": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "orders_created": {
            "type": "integer"
          },
          "orders": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "object",
          "livemode",
          "business_type",
          "created",
          "location",
          "register",
          "layout",
          "categories",
          "products",
          "modifier_groups",
          "day",
          "shift",
          "orders_created",
          "orders"
        ]
      },
      "PosTestDeviceBody": {
        "type": "object",
        "properties": {
          "register": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "name": {
            "nullable": true,
            "type": "string",
            "maxLength": 80
          },
          "platform": {
            "nullable": true,
            "type": "string",
            "maxLength": 12
          }
        }
      },
      "PostageModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "owed": {
            "type": "integer"
          },
          "owed_count": {
            "type": "integer"
          },
          "limit": {
            "type": "integer"
          },
          "room": {
            "type": "integer"
          }
        },
        "required": [
          "object",
          "currency",
          "owed",
          "owed_count",
          "limit",
          "room"
        ]
      },
      "PriceListModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": [
              "price_list"
            ],
            "minLength": 1
          },
          "region": {
            "type": "string",
            "enum": [
              "gb",
              "us",
              "eu"
            ],
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "description": "Three-letter ISO code, lower case.",
            "minLength": 1
          },
          "schedule_version": {
            "type": "string",
            "description": "The price list's version, e.g. `v3`. A payment records the one it was priced under.",
            "minLength": 1
          },
          "effective_from": {
            "type": "string",
            "description": "The day this price list applies from, `YYYY-MM-DD` (UTC).",
            "minLength": 1
          },
          "card": {
            "$ref": "#/components/schemas/CardRateModel"
          },
          "surcharges": {
            "$ref": "#/components/schemas/SurchargesModel"
          },
          "methods": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MethodPriceModel"
            },
            "description": "Payment methods that are not cards. Wallets that pay with a card cost the card rate."
          },
          "cashback_bps": {
            "type": "integer",
            "description": "Cashback on spending with a Tuppence card, in basis points."
          },
          "payouts": {
            "$ref": "#/components/schemas/PayoutPricesModel"
          },
          "min_payment": {
            "type": "integer",
            "description": "The smallest payment a card can be charged, in minor units."
          },
          "dispute_fee": {
            "type": "integer",
            "description": "Charged only when a dispute is lost, in minor units."
          }
        },
        "required": [
          "object",
          "region",
          "currency",
          "schedule_version",
          "effective_from",
          "card",
          "surcharges",
          "methods",
          "cashback_bps",
          "payouts",
          "min_payment",
          "dispute_fee"
        ]
      },
      "PriceListsModel": {
        "type": "object",
        "properties": {
          "gb": {
            "$ref": "#/components/schemas/PriceListModel"
          },
          "us": {
            "$ref": "#/components/schemas/PriceListModel"
          },
          "eu": {
            "$ref": "#/components/schemas/PriceListModel"
          }
        },
        "required": [
          "gb",
          "us",
          "eu"
        ]
      },
      "PricingAgreementModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "id": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "scheduled",
              "active",
              "ended"
            ],
            "minLength": 1
          },
          "effective_from": {
            "type": "integer"
          },
          "ends_at": {
            "nullable": true,
            "type": "integer"
          },
          "replaced_by": {
            "description": "The agreement that takes over when this one ends, when new prices were agreed.",
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "accept_bps": {
            "nullable": true,
            "type": "integer"
          },
          "accept_fixed": {
            "nullable": true,
            "type": "integer"
          },
          "surcharge_amex_bps": {
            "nullable": true,
            "type": "integer"
          },
          "surcharge_commercial_bps": {
            "nullable": true,
            "type": "integer"
          },
          "surcharge_foreign_bps": {
            "nullable": true,
            "type": "integer"
          },
          "next_day_bps": {
            "nullable": true,
            "type": "integer"
          },
          "instant_bps": {
            "nullable": true,
            "type": "integer"
          },
          "dispute_fee": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "object",
          "id",
          "account",
          "currency",
          "status",
          "effective_from",
          "ends_at",
          "replaced_by",
          "accept_bps",
          "accept_fixed",
          "surcharge_amex_bps",
          "surcharge_commercial_bps",
          "surcharge_foreign_bps",
          "next_day_bps",
          "instant_bps",
          "dispute_fee"
        ]
      },
      "PricingEstimateModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": [
              "pricing_estimate"
            ],
            "minLength": 1
          },
          "region": {
            "type": "string",
            "enum": [
              "gb",
              "us",
              "eu"
            ],
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "schedule_version": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer",
            "description": "One payment, in minor units."
          },
          "count": {
            "type": "integer",
            "description": "How many such payments."
          },
          "card": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The kinds of card asked about (`card`), in the order the fee lists them."
          },
          "surcharges": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The surcharges charged: those that cost something here, and only the dearest where they do not stack."
          },
          "bps": {
            "type": "integer",
            "description": "The combined rate, in basis points."
          },
          "fixed": {
            "type": "integer",
            "description": "The fixed part, in minor units."
          },
          "fee": {
            "type": "integer",
            "description": "The fee on one payment, in minor units."
          },
          "net": {
            "type": "integer",
            "description": "What one payment leaves after the fee."
          },
          "total_amount": {
            "type": "integer"
          },
          "total_fee": {
            "type": "integer"
          },
          "total_net": {
            "type": "integer"
          },
          "rounding": {
            "type": "string",
            "description": "How the fee is rounded.",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "region",
          "currency",
          "schedule_version",
          "amount",
          "count",
          "card",
          "surcharges",
          "bps",
          "fixed",
          "fee",
          "net",
          "total_amount",
          "total_fee",
          "total_net",
          "rounding"
        ]
      },
      "PricingModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": [
              "pricing"
            ],
            "minLength": 1
          },
          "regions": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PriceListsModel"
              },
              {
                "type": "object",
                "description": "The price list in force today in each region: the UK, the US and the eurozone."
              }
            ]
          }
        },
        "required": [
          "object",
          "regions"
        ]
      },
      "PrintJobBody": {
        "type": "object",
        "properties": {
          "printer": {
            "type": "string",
            "maxLength": 40
          },
          "register": {
            "type": "string",
            "maxLength": 40
          },
          "source": {
            "type": "string",
            "maxLength": 12
          },
          "order": {
            "type": "string",
            "maxLength": 40
          },
          "receipt": {
            "type": "string",
            "maxLength": 40
          },
          "cash_movement": {
            "type": "string",
            "maxLength": 40
          },
          "open_drawer": {
            "type": "boolean"
          }
        }
      },
      "PrintJobList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PrintJobModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "PrintJobModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "printer": {
            "type": "string",
            "minLength": 1
          },
          "source": {
            "type": "string",
            "enum": [
              "receipt",
              "report",
              "test",
              "kitchen",
              "drawer",
              "packing_slip"
            ],
            "minLength": 1
          },
          "order": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "receipt": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "register": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "queued",
              "printing",
              "printed",
              "failed",
              "cancelled"
            ],
            "minLength": 1
          },
          "attempts": {
            "type": "integer"
          },
          "open_drawer": {
            "type": "boolean"
          },
          "last_error": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "content_type": {
            "type": "string",
            "minLength": 1
          },
          "printed_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "printer",
          "source",
          "order",
          "receipt",
          "register",
          "status",
          "attempts",
          "open_drawer",
          "last_error",
          "content_type",
          "printed_at",
          "created"
        ]
      },
      "PrinterBody": {
        "type": "object",
        "properties": {
          "location": {
            "type": "string",
            "maxLength": 40
          },
          "name": {
            "type": "string",
            "maxLength": 120
          },
          "kind": {
            "type": "string",
            "maxLength": 12
          },
          "brand": {
            "type": "string",
            "maxLength": 12
          },
          "model": {
            "nullable": true,
            "type": "string",
            "maxLength": 80
          },
          "connection": {
            "type": "string",
            "maxLength": 24
          },
          "paper_width": {
            "type": "integer",
            "multipleOf": 1
          },
          "code_page": {
            "type": "string",
            "maxLength": 12
          },
          "address": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          },
          "drawer": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PrinterDrawerBody"
              }
            ],
            "nullable": true
          },
          "capabilities": {
            "$ref": "#/components/schemas/PrinterCapabilitiesBody"
          },
          "metadata": {
            "type": "object"
          }
        }
      },
      "PrinterCapabilitiesBody": {
        "type": "object",
        "properties": {
          "text": {
            "type": "boolean"
          },
          "accents": {
            "type": "boolean"
          },
          "qr": {
            "type": "boolean"
          },
          "image": {
            "type": "boolean"
          },
          "barcode": {
            "type": "boolean"
          },
          "cut": {
            "type": "boolean"
          },
          "drawer": {
            "type": "boolean"
          }
        }
      },
      "PrinterCapabilitiesModel": {
        "type": "object",
        "properties": {
          "text": {
            "type": "boolean"
          },
          "accents": {
            "type": "boolean"
          },
          "qr": {
            "type": "boolean"
          },
          "image": {
            "type": "boolean"
          },
          "barcode": {
            "type": "boolean"
          },
          "cut": {
            "type": "boolean"
          },
          "drawer": {
            "type": "boolean"
          }
        }
      },
      "PrinterDrawerBody": {
        "type": "object",
        "properties": {
          "pin": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "PrinterDrawerModel": {
        "type": "object",
        "properties": {
          "pin": {
            "type": "integer",
            "enum": [
              2,
              5
            ]
          }
        },
        "required": [
          "pin"
        ]
      },
      "PrinterList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PrinterModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "PrinterModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "receipt",
              "kitchen",
              "label"
            ],
            "minLength": 1
          },
          "brand": {
            "type": "string",
            "enum": [
              "star",
              "epson",
              "generic"
            ],
            "minLength": 1
          },
          "model": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "dialect": {
            "type": "string",
            "minLength": 1
          },
          "connection": {
            "type": "string",
            "enum": [
              "lan",
              "bluetooth",
              "ble",
              "usb",
              "cloudprnt",
              "server_direct_print",
              "system"
            ],
            "minLength": 1
          },
          "paper_width": {
            "type": "integer",
            "enum": [
              58,
              80,
              102
            ]
          },
          "code_page": {
            "type": "string",
            "minLength": 1
          },
          "address": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "capabilities": {
            "$ref": "#/components/schemas/PrinterCapabilitiesModel"
          },
          "drawer": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PrinterDrawerModel"
              }
            ],
            "nullable": true
          },
          "status": {
            "type": "string",
            "enum": [
              "unknown",
              "ok",
              "paper_low",
              "paper_out",
              "cover_open",
              "offline",
              "error"
            ],
            "minLength": 1
          },
          "status_detail": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "last_seen_at": {
            "nullable": true,
            "type": "integer"
          },
          "archived": {
            "type": "boolean"
          },
          "secret": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "setup": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PrinterSetupModel"
              }
            ],
            "nullable": true
          },
          "metadata": {
            "type": "object"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "location",
          "name",
          "kind",
          "brand",
          "model",
          "dialect",
          "connection",
          "paper_width",
          "code_page",
          "address",
          "capabilities",
          "drawer",
          "status",
          "status_detail",
          "last_seen_at",
          "archived",
          "secret",
          "setup",
          "metadata",
          "created"
        ]
      },
      "PrinterSetupModel": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "minLength": 1
          },
          "username": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "url",
          "username"
        ]
      },
      "PrinterStatusBody": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "unknown",
              "ok",
              "paper_low",
              "paper_out",
              "cover_open",
              "offline",
              "error"
            ]
          },
          "detail": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          }
        }
      },
      "PrivacySettingsBody": {
        "type": "object",
        "properties": {
          "clinical_retention_years": {
            "type": "integer",
            "multipleOf": 1
          },
          "other_retention_years": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "PrivacySettingsModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "clinical_retention_years": {
            "type": "integer",
            "multipleOf": 1
          },
          "other_retention_years": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "object",
          "livemode",
          "clinical_retention_years",
          "other_retention_years"
        ]
      },
      "ProcessingBody": {
        "type": "object",
        "properties": {
          "start_offset_minutes": {
            "type": "integer",
            "multipleOf": 1
          },
          "minutes": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "minutes"
        ]
      },
      "ProcessingModel": {
        "type": "object",
        "properties": {
          "start_offset_minutes": {
            "type": "integer"
          },
          "minutes": {
            "type": "integer"
          }
        },
        "required": [
          "start_offset_minutes",
          "minutes"
        ]
      },
      "ProductArchivedEvent": {
        "type": "object",
        "description": "The `product.archived` event (the store's catalogue events): `data.object` is the `product`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "product.archived"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ProductEventData"
          }
        }
      },
      "ProductAvailableBody": {
        "type": "object",
        "properties": {
          "available": {
            "type": "boolean"
          }
        },
        "required": [
          "available"
        ]
      },
      "ProductBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 120
          },
          "short_name": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "description": {
            "nullable": true,
            "type": "string",
            "maxLength": 2000
          },
          "category": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "kind": {
            "type": "string",
            "maxLength": 12
          },
          "service": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "sold_by": {
            "type": "string",
            "maxLength": 8
          },
          "unit": {
            "nullable": true,
            "type": "string",
            "maxLength": 8
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "maxLength": 3
          },
          "min_amount": {
            "nullable": true,
            "type": "integer"
          },
          "max_amount": {
            "nullable": true,
            "type": "integer"
          },
          "cost_amount": {
            "nullable": true,
            "type": "integer"
          },
          "tax_class": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "track_stock": {
            "type": "boolean"
          },
          "sku": {
            "nullable": true,
            "type": "string",
            "maxLength": 64
          },
          "barcodes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "age_restricted": {
            "type": "boolean"
          },
          "age_rule": {
            "nullable": true,
            "type": "string",
            "maxLength": 16
          },
          "allergens": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "colour": {
            "nullable": true,
            "type": "string",
            "maxLength": 7
          },
          "emoji": {
            "nullable": true,
            "type": "string",
            "maxLength": 16
          },
          "tile_label": {
            "nullable": true,
            "type": "string",
            "maxLength": 24
          },
          "options": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProductOptionBody"
            }
          },
          "modifier_groups": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "available": {
            "type": "boolean"
          },
          "channels": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "prep_minutes": {
            "nullable": true,
            "type": "integer"
          },
          "deposit_amount": {
            "nullable": true,
            "type": "integer"
          },
          "deposit_scheme": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "sort": {
            "type": "integer",
            "multipleOf": 1
          },
          "metadata": {
            "type": "object"
          },
          "status": {
            "type": "string",
            "maxLength": 12
          },
          "slug": {
            "nullable": true,
            "type": "string",
            "maxLength": 120
          },
          "web_path": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          },
          "web_title": {
            "nullable": true,
            "type": "string",
            "maxLength": 150
          },
          "web_description": {
            "nullable": true
          },
          "brand": {
            "nullable": true,
            "type": "string",
            "maxLength": 80
          },
          "product_type": {
            "nullable": true,
            "type": "integer"
          },
          "attributes": {
            "nullable": true
          },
          "facts": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "weight_grams": {
            "nullable": true,
            "type": "integer"
          },
          "dimensions_mm": {
            "nullable": true
          },
          "hs_code": {
            "nullable": true,
            "type": "string",
            "maxLength": 20
          },
          "origin_country": {
            "nullable": true,
            "type": "string",
            "maxLength": 2
          },
          "gpsr": {
            "nullable": true
          },
          "seo": {
            "nullable": true
          },
          "media": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "inventory_policy": {
            "type": "string",
            "maxLength": 10
          },
          "preorder_ships_on": {
            "nullable": true,
            "type": "string",
            "maxLength": 10
          },
          "preorder_cap": {
            "nullable": true,
            "type": "integer",
            "multipleOf": 1
          },
          "bundle_parts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BundlePartBody"
            }
          },
          "subscription_plan": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "compare_at_amount": {
            "nullable": true,
            "type": "integer"
          }
        }
      },
      "ProductBulkBody": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProductBulkItemBody"
            }
          }
        },
        "required": [
          "items"
        ]
      },
      "ProductBulkItemBody": {
        "type": "object",
        "properties": {
          "product": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "variant": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "cost_amount": {
            "nullable": true,
            "type": "integer"
          }
        }
      },
      "ProductBulkUpdateModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "updated": {
            "type": "integer"
          },
          "products": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "object",
          "updated",
          "products"
        ]
      },
      "ProductCategoryBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 80
          },
          "colour": {
            "nullable": true,
            "type": "string",
            "maxLength": 7
          },
          "sort": {
            "type": "integer",
            "multipleOf": 1
          },
          "parent": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "modifier_groups": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "ProductCategoryList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProductCategoryModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ProductCategoryModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "colour": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "sort": {
            "type": "integer"
          },
          "parent": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "modifier_groups": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ],
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "name",
          "colour",
          "sort",
          "parent",
          "modifier_groups",
          "status",
          "created"
        ]
      },
      "ProductCreatedEvent": {
        "type": "object",
        "description": "The `product.created` event (the store's catalogue events): `data.object` is the `product`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "product.created"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ProductEventData"
          }
        }
      },
      "ProductEventData": {
        "type": "object",
        "description": "What an event carrying a `product` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/ProductModel"
          }
        }
      },
      "ProductFactModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "material",
              "ingredient",
              "dimension",
              "weight",
              "capacity",
              "colour",
              "origin",
              "maker",
              "certification",
              "compatibility",
              "care",
              "allergen",
              "age_suitability",
              "safety_warning",
              "other"
            ],
            "minLength": 1
          },
          "statement": {
            "type": "string",
            "minLength": 1
          },
          "value": {
            "nullable": true
          },
          "unit": {
            "type": "string"
          },
          "source": {
            "$ref": "#/components/schemas/ProductFactSourceModel"
          },
          "confirmed": {
            "type": "boolean"
          },
          "added_by": {
            "type": "string",
            "minLength": 1
          },
          "added_at": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "kind",
          "statement",
          "source",
          "confirmed",
          "added_by",
          "added_at"
        ]
      },
      "ProductFactSourceModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "merchant",
              "document",
              "supplier",
              "photo",
              "website",
              "open_database",
              "import",
              "till"
            ],
            "minLength": 1
          },
          "ref": {
            "type": "string"
          },
          "quote": {
            "type": "string"
          },
          "page": {
            "type": "integer"
          },
          "region": {
            "$ref": "#/components/schemas/FactRegionModel"
          },
          "attribution": {
            "type": "string"
          }
        },
        "required": [
          "kind"
        ]
      },
      "ProductImageBody": {
        "type": "object",
        "properties": {
          "image": {
            "type": "string",
            "maxLength": 1000000,
            "minLength": 1
          }
        },
        "required": [
          "image"
        ]
      },
      "ProductList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProductModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ProductLookupModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "matched": {
            "type": "string",
            "enum": [
              "barcode",
              "sku"
            ],
            "minLength": 1
          },
          "code": {
            "type": "string",
            "minLength": 1
          },
          "product": {
            "$ref": "#/components/schemas/ProductModel"
          },
          "variant": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ProductVariantModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "object",
          "matched",
          "code",
          "product",
          "variant"
        ]
      },
      "ProductModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "short_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "description": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "category": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "retail",
              "food",
              "drink",
              "service",
              "fee",
              "ingredient",
              "digital",
              "gift_card",
              "subscription",
              "bundle",
              "ticket"
            ],
            "minLength": 1
          },
          "service": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "sold_by": {
            "type": "string",
            "enum": [
              "each",
              "weight",
              "open"
            ],
            "minLength": 1
          },
          "unit": {
            "nullable": true,
            "type": "string",
            "minLength": 1,
            "enum": [
              "kg",
              "g",
              "l",
              "ml",
              "lb",
              "oz",
              "fl_oz"
            ]
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "min_amount": {
            "nullable": true,
            "type": "integer"
          },
          "max_amount": {
            "nullable": true,
            "type": "integer"
          },
          "cost_amount": {
            "nullable": true,
            "type": "integer"
          },
          "tax_class": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "track_stock": {
            "type": "boolean"
          },
          "sku": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "barcodes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "age_restricted": {
            "type": "boolean"
          },
          "age_rule": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "allergens": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "image_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "colour": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "emoji": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "tile_label": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "options": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProductOptionModel"
            }
          },
          "modifier_groups": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "available": {
            "type": "boolean"
          },
          "channels": {
            "type": "array",
            "items": {
              "enum": [
                "till",
                "online",
                "booking_page"
              ],
              "type": "string"
            }
          },
          "prep_minutes": {
            "nullable": true,
            "type": "integer"
          },
          "deposit_amount": {
            "nullable": true,
            "type": "integer"
          },
          "deposit_scheme": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "sort": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "draft",
              "archived"
            ],
            "minLength": 1
          },
          "slug": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "web_path": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "web_title": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "web_description": {
            "nullable": true
          },
          "brand": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "product_type": {
            "nullable": true,
            "type": "integer"
          },
          "attributes": {
            "type": "object"
          },
          "facts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProductFactModel"
            }
          },
          "weight_grams": {
            "nullable": true,
            "type": "integer"
          },
          "dimensions_mm": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/DimensionsModel"
              }
            ],
            "nullable": true
          },
          "hs_code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "origin_country": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "gpsr": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/GpsrModel"
              }
            ],
            "nullable": true
          },
          "seo": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ProductSeoModel"
              }
            ],
            "nullable": true
          },
          "media": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "inventory_policy": {
            "type": "string",
            "enum": [
              "deny",
              "continue",
              "preorder"
            ],
            "minLength": 1
          },
          "preorder_ships_on": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "preorder_cap": {
            "nullable": true,
            "type": "integer"
          },
          "bundle_parts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BundlePartModel"
            }
          },
          "subscription_plan": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "web_published_at": {
            "nullable": true,
            "type": "integer"
          },
          "web_status": {
            "type": "string",
            "enum": [
              "published",
              "not_published",
              "off"
            ],
            "minLength": 1
          },
          "web_publish_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "claims_check": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ClaimsCheckModel"
              }
            ],
            "nullable": true
          },
          "compare_at_amount": {
            "nullable": true,
            "type": "integer"
          },
          "variants": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProductVariantModel"
            }
          },
          "metadata": {
            "nullable": true
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "name",
          "short_name",
          "description",
          "category",
          "kind",
          "service",
          "sold_by",
          "unit",
          "amount",
          "currency",
          "min_amount",
          "max_amount",
          "cost_amount",
          "tax_class",
          "track_stock",
          "sku",
          "barcodes",
          "age_restricted",
          "age_rule",
          "allergens",
          "image_url",
          "colour",
          "emoji",
          "tile_label",
          "options",
          "modifier_groups",
          "available",
          "channels",
          "prep_minutes",
          "deposit_amount",
          "deposit_scheme",
          "sort",
          "status",
          "slug",
          "web_path",
          "web_title",
          "web_description",
          "brand",
          "product_type",
          "attributes",
          "facts",
          "weight_grams",
          "dimensions_mm",
          "hs_code",
          "origin_country",
          "gpsr",
          "seo",
          "media",
          "inventory_policy",
          "preorder_ships_on",
          "preorder_cap",
          "bundle_parts",
          "subscription_plan",
          "web_published_at",
          "web_status",
          "web_publish_url",
          "claims_check",
          "compare_at_amount",
          "variants",
          "created"
        ],
        "example": {
          "id": "prod_01K7HB2M4N6P8Q0R2S4T6V8W0X",
          "object": "product",
          "livemode": false,
          "name": "Sea salt candle",
          "short_name": "Sea salt",
          "description": "Soy wax with sea salt and driftwood, in a reusable glass jar. Burns for 40 hours.",
          "category": "pcat_01K7HBUC0F2H4K6M8P0R2T4W6Y",
          "kind": "retail",
          "service": null,
          "sold_by": "each",
          "unit": null,
          "amount": 1200,
          "currency": "gbp",
          "min_amount": null,
          "max_amount": null,
          "cost_amount": 410,
          "tax_class": "standard",
          "track_stock": true,
          "sku": "CND-SEA-200",
          "barcodes": [
            "5012345678900"
          ],
          "age_restricted": false,
          "age_rule": null,
          "allergens": [],
          "image_url": "https://media.tuppence.ai/med_01K7HB3A5C7E9G1J3L5N7Q9S1U/sea-salt-candle.jpg",
          "colour": null,
          "emoji": null,
          "tile_label": null,
          "options": [],
          "modifier_groups": [],
          "available": true,
          "channels": [
            "till",
            "online"
          ],
          "prep_minutes": null,
          "deposit_amount": null,
          "deposit_scheme": null,
          "sort": 0,
          "status": "active",
          "slug": "sea-salt-candle",
          "web_path": "/products/sea-salt-candle",
          "web_title": "Sea salt candle, 200 g",
          "web_description": "Hand-poured in Whitby. Soy wax, cotton wick, about 40 hours of burning.",
          "brand": "Harbour Gifts",
          "product_type": 4651,
          "attributes": {},
          "facts": [],
          "weight_grams": 450,
          "dimensions_mm": {
            "l": 85,
            "w": 85,
            "h": 100
          },
          "hs_code": "340600",
          "origin_country": "GB",
          "gpsr": null,
          "seo": {
            "title": "Sea salt candle",
            "description": "A hand-poured soy candle from Whitby."
          },
          "media": [
            "med_01K7HB3A5C7E9G1J3L5N7Q9S1U"
          ],
          "inventory_policy": "deny",
          "preorder_ships_on": null,
          "preorder_cap": null,
          "bundle_parts": [],
          "subscription_plan": null,
          "web_published_at": 1791806400,
          "web_status": "published",
          "web_publish_url": "https://shop.tuppence.ai/test/harbourgifts/products/sea-salt-candle",
          "claims_check": null,
          "compare_at_amount": null,
          "variants": [],
          "metadata": null,
          "created": 1791720000
        }
      },
      "ProductOptionBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "values": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "name",
          "values"
        ]
      },
      "ProductOptionModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "values": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "name",
          "values"
        ]
      },
      "ProductReviewCountsModel": {
        "type": "object",
        "properties": {
          "requested": {
            "type": "integer",
            "multipleOf": 1
          },
          "pending": {
            "type": "integer",
            "multipleOf": 1
          },
          "published": {
            "type": "integer",
            "multipleOf": 1
          },
          "rejected": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "requested",
          "pending",
          "published",
          "rejected"
        ]
      },
      "ProductReviewCreateBody": {
        "type": "object",
        "properties": {
          "product": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "order_line": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "rating": {
            "type": "integer",
            "multipleOf": 1
          },
          "title": {
            "nullable": true,
            "type": "string",
            "maxLength": 120
          },
          "body": {
            "nullable": true,
            "type": "string",
            "maxLength": 3000
          },
          "author": {
            "nullable": true,
            "type": "string",
            "maxLength": 120
          },
          "attributes": {
            "type": "object"
          }
        },
        "required": [
          "product",
          "rating"
        ]
      },
      "ProductReviewEventData": {
        "type": "object",
        "description": "What an event carrying a `product_review` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/ProductReviewEventObject"
          }
        }
      },
      "ProductReviewEventObject": {
        "type": "object",
        "description": "A `product_review` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "product_review"
          }
        },
        "additionalProperties": true
      },
      "ProductReviewIncentiveModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "discount",
              "gift",
              "other"
            ],
            "minLength": 1
          },
          "description": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "kind",
          "description"
        ]
      },
      "ProductReviewList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProductReviewModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ProductReviewModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "product": {
            "type": "string",
            "minLength": 1
          },
          "variant": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "order": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "order_line": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "customer": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "requested",
              "pending",
              "published",
              "rejected",
              "deleted"
            ],
            "minLength": 1
          },
          "rating": {
            "nullable": true,
            "type": "integer"
          },
          "title": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "body": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "media": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "attributes": {
            "type": "object"
          },
          "verified": {
            "type": "boolean"
          },
          "incentive": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ProductReviewIncentiveModel"
              }
            ],
            "nullable": true
          },
          "incentive_label": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "source": {
            "type": "string",
            "minLength": 1
          },
          "author": {
            "type": "string",
            "minLength": 1
          },
          "moderation": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ProductReviewModerationModel"
              }
            ],
            "nullable": true
          },
          "reply": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "replied_at": {
            "nullable": true,
            "type": "integer"
          },
          "requested_at": {
            "nullable": true,
            "type": "integer"
          },
          "submitted_at": {
            "nullable": true,
            "type": "integer"
          },
          "publishes_at": {
            "nullable": true,
            "type": "integer"
          },
          "published_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "product",
          "variant",
          "order",
          "order_line",
          "customer",
          "status",
          "rating",
          "title",
          "body",
          "media",
          "attributes",
          "verified",
          "incentive",
          "incentive_label",
          "source",
          "author",
          "moderation",
          "reply",
          "replied_at",
          "requested_at",
          "submitted_at",
          "publishes_at",
          "published_at",
          "created"
        ]
      },
      "ProductReviewModerationModel": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "enum": [
              "unlawful",
              "personal_data",
              "abusive",
              "spam",
              "conflict_of_interest",
              "unverified"
            ],
            "minLength": 1
          },
          "rule": {
            "type": "string",
            "minLength": 1
          },
          "note": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "by": {
            "type": "string",
            "minLength": 1
          },
          "at": {
            "type": "integer"
          }
        },
        "required": [
          "reason",
          "rule",
          "note",
          "by",
          "at"
        ]
      },
      "ProductReviewPublishedEvent": {
        "type": "object",
        "description": "The `product_review.published` event (the store's shoppers events): `data.object` is the `product_review`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "product_review.published"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ProductReviewEventData"
          }
        }
      },
      "ProductReviewRejectBody": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "enum": [
              "unlawful",
              "personal_data",
              "abusive",
              "spam",
              "conflict_of_interest",
              "unverified"
            ],
            "minLength": 1
          },
          "note": {
            "nullable": true,
            "type": "string",
            "maxLength": 500
          }
        },
        "required": [
          "reason"
        ]
      },
      "ProductReviewRejectedEvent": {
        "type": "object",
        "description": "The `product_review.rejected` event (the store's shoppers events): `data.object` is the `product_review`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "product_review.rejected"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ProductReviewEventData"
          }
        }
      },
      "ProductReviewReplyBody": {
        "type": "object",
        "properties": {
          "body": {
            "type": "string",
            "maxLength": 1000,
            "minLength": 1
          }
        },
        "required": [
          "body"
        ]
      },
      "ProductReviewRequestedEvent": {
        "type": "object",
        "description": "The `product_review.requested` event (the store's shoppers events): `data.object` is the `product_review`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "product_review.requested"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ProductReviewEventData"
          }
        }
      },
      "ProductReviewSettingsBody": {
        "type": "object",
        "properties": {
          "requests": {
            "type": "boolean"
          },
          "delay_days": {
            "nullable": true,
            "type": "integer",
            "multipleOf": 1
          },
          "require_verified": {
            "type": "boolean"
          },
          "incentive": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ProductReviewIncentiveModel"
              }
            ],
            "nullable": true
          }
        }
      },
      "ProductReviewSummaryModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "counts": {
            "$ref": "#/components/schemas/ProductReviewCountsModel"
          },
          "rejected_share_bps": {
            "type": "integer",
            "multipleOf": 1
          },
          "average_rating": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "object",
          "counts",
          "rejected_share_bps",
          "average_rating"
        ]
      },
      "ProductScreenEventData": {
        "type": "object",
        "description": "What an event carrying a `product_screen` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/ProductScreenEventObject"
          }
        }
      },
      "ProductScreenEventObject": {
        "type": "object",
        "description": "A `product_screen` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "product_screen"
          }
        },
        "additionalProperties": true
      },
      "ProductSeoModel": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          },
          "description": {
            "type": "string"
          }
        }
      },
      "ProductUpdatedEvent": {
        "type": "object",
        "description": "The `product.updated` event (the store's catalogue events): `data.object` is the `product`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "product.updated"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ProductEventData"
          }
        }
      },
      "ProductVariantBody": {
        "type": "object",
        "properties": {
          "sku": {
            "nullable": true,
            "type": "string",
            "maxLength": 64
          },
          "barcodes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "cost_amount": {
            "nullable": true,
            "type": "integer"
          },
          "weight_grams": {
            "nullable": true,
            "type": "integer"
          },
          "gtin": {
            "nullable": true,
            "type": "string",
            "maxLength": 14
          },
          "media": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "compare_at_amount": {
            "nullable": true,
            "type": "integer"
          }
        }
      },
      "ProductVariantList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProductVariantModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ProductVariantModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "product": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "option_values": {
            "type": "object"
          },
          "sku": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "barcodes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "cost_amount": {
            "nullable": true,
            "type": "integer"
          },
          "image_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "sort": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ],
            "minLength": 1
          },
          "compare_at_amount": {
            "nullable": true,
            "type": "integer"
          },
          "weight_grams": {
            "nullable": true,
            "type": "integer"
          },
          "gtin": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "media": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "product",
          "name",
          "option_values",
          "sku",
          "barcodes",
          "amount",
          "cost_amount",
          "image_url",
          "sort",
          "status",
          "compare_at_amount",
          "weight_grams",
          "gtin",
          "media",
          "created"
        ]
      },
      "ProfileBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 80
          },
          "is_default": {
            "type": "boolean"
          },
          "confirmed": {
            "type": "boolean"
          }
        }
      },
      "ProfileProductsBody": {
        "type": "object",
        "properties": {
          "products": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "PromoCodeList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PromoCodeModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "PromoCodeModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "code": {
            "type": "string",
            "minLength": 1
          },
          "coupon": {
            "type": "string",
            "minLength": 1
          },
          "active": {
            "type": "boolean"
          },
          "max_redemptions": {
            "nullable": true,
            "type": "integer"
          },
          "times_redeemed": {
            "type": "integer"
          },
          "expires_at": {
            "nullable": true,
            "type": "integer"
          },
          "first_time_only": {
            "type": "boolean"
          },
          "created": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "code",
          "coupon",
          "active",
          "max_redemptions",
          "times_redeemed",
          "expires_at",
          "first_time_only",
          "created"
        ]
      },
      "ProposalBody": {
        "type": "object",
        "properties": {
          "sentence": {
            "type": "string",
            "maxLength": 1000
          },
          "use_till_catalogue": {
            "type": "boolean"
          },
          "website": {
            "type": "string",
            "maxLength": 300
          },
          "instagram": {
            "type": "string",
            "maxLength": 200
          },
          "tiktok": {
            "type": "string",
            "maxLength": 200
          },
          "media": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "logo": {
            "type": "string",
            "maxLength": 40
          },
          "files": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProposalFileUpload"
            }
          }
        }
      },
      "ProposalCountsModel": {
        "type": "object",
        "properties": {
          "total": {
            "type": "integer",
            "multipleOf": 1
          },
          "undecided": {
            "type": "integer",
            "multipleOf": 1
          },
          "with_guesses": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "total",
          "undecided",
          "with_guesses"
        ]
      },
      "ProposalFileModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "kind",
          "name"
        ]
      },
      "ProposalFileUpload": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "maxLength": 8,
            "minLength": 1
          },
          "name": {
            "type": "string",
            "maxLength": 200
          },
          "data": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "kind",
          "data"
        ]
      },
      "ProposalGuessModel": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "minLength": 1
          },
          "value": {
            "nullable": true
          },
          "reason": {
            "type": "string",
            "minLength": 1
          },
          "source": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "field",
          "value",
          "reason",
          "source"
        ]
      },
      "ProposalInputsModel": {
        "type": "object",
        "properties": {
          "sentence": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "use_till_catalogue": {
            "type": "boolean"
          },
          "website": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "instagram": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "tiktok": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "media": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "logo": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "files": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProposalFileModel"
            }
          }
        },
        "required": [
          "sentence",
          "use_till_catalogue",
          "website",
          "instagram",
          "tiktok",
          "media",
          "logo",
          "files"
        ]
      },
      "ProposalItemList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProposalItemModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ProposalItemModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "proposal": {
            "type": "string",
            "minLength": 1
          },
          "group": {
            "type": "string",
            "minLength": 1
          },
          "key": {
            "type": "string",
            "minLength": 1
          },
          "target": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "payload": {
            "type": "object"
          },
          "context": {
            "type": "object"
          },
          "guesses": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProposalGuessModel"
            }
          },
          "state": {
            "type": "string",
            "minLength": 1
          },
          "redo_count": {
            "type": "integer",
            "multipleOf": 1
          },
          "decided_by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "decided_at": {
            "nullable": true,
            "type": "integer"
          },
          "applied_ref": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "updated": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "proposal",
          "group",
          "key",
          "target",
          "payload",
          "context",
          "guesses",
          "state",
          "redo_count",
          "decided_by",
          "decided_at",
          "applied_ref",
          "updated"
        ]
      },
      "ProposalPreviewModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "token": {
            "type": "string",
            "minLength": 1
          },
          "url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "path": {
            "type": "string",
            "minLength": 1
          },
          "expires_at": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "object",
          "token",
          "url",
          "path",
          "expires_at"
        ]
      },
      "ProposalStageModel": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "minLength": 1
          },
          "started_at": {
            "nullable": true,
            "type": "integer"
          },
          "finished_at": {
            "nullable": true,
            "type": "integer"
          },
          "items": {
            "type": "integer",
            "multipleOf": 1
          },
          "error": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "note": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "status",
          "started_at",
          "finished_at",
          "items",
          "error",
          "note"
        ]
      },
      "ProposalStagesModel": {
        "type": "object",
        "properties": {
          "gather": {
            "$ref": "#/components/schemas/ProposalStageModel"
          },
          "understand": {
            "$ref": "#/components/schemas/ProposalStageModel"
          },
          "products": {
            "$ref": "#/components/schemas/ProposalStageModel"
          },
          "photos": {
            "$ref": "#/components/schemas/ProposalStageModel"
          },
          "brand": {
            "$ref": "#/components/schemas/ProposalStageModel"
          },
          "pages": {
            "$ref": "#/components/schemas/ProposalStageModel"
          },
          "setup": {
            "$ref": "#/components/schemas/ProposalStageModel"
          }
        },
        "required": [
          "gather",
          "understand",
          "products",
          "photos",
          "brand",
          "pages",
          "setup"
        ]
      },
      "ProposedServiceModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "category": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "description": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "duration_minutes": {
            "nullable": true,
            "type": "integer"
          },
          "duration_estimated": {
            "type": "boolean"
          },
          "price_type": {
            "type": "string",
            "enum": [
              "fixed",
              "from",
              "on_request",
              "free"
            ],
            "minLength": 1
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "variants": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProposedVariantModel"
            }
          }
        },
        "required": [
          "name",
          "category",
          "description",
          "duration_minutes",
          "duration_estimated",
          "price_type",
          "amount",
          "variants"
        ]
      },
      "ProposedVariantModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "duration_minutes": {
            "nullable": true,
            "type": "integer"
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "name",
          "duration_minutes",
          "amount"
        ]
      },
      "ProrationLineModel": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "description",
          "amount"
        ]
      },
      "ProrationPreviewModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "subscription": {
            "type": "string",
            "minLength": 1
          },
          "from": {
            "type": "string",
            "minLength": 1
          },
          "to": {
            "type": "string",
            "minLength": 1
          },
          "credit": {
            "type": "integer"
          },
          "charge": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "proration_at": {
            "type": "integer"
          },
          "at_period_end": {
            "type": "boolean"
          },
          "lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProrationLineModel"
            }
          }
        },
        "required": [
          "object",
          "subscription",
          "from",
          "to",
          "credit",
          "charge",
          "amount",
          "currency",
          "proration_at",
          "at_period_end",
          "lines"
        ]
      },
      "ProvenanceModel": {
        "type": "object",
        "properties": {
          "origin": {
            "type": "string",
            "minLength": 1
          },
          "edited_from": {
            "nullable": true,
            "type": "string"
          },
          "vendor": {
            "nullable": true,
            "type": "string"
          },
          "operations": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "iptc_digital_source_type": {
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "origin",
          "operations"
        ]
      },
      "PublicJwkModel": {
        "type": "object",
        "properties": {
          "kty": {
            "type": "string",
            "minLength": 1
          },
          "crv": {
            "type": "string",
            "minLength": 1
          },
          "x": {
            "type": "string",
            "minLength": 1
          },
          "kid": {
            "type": "string",
            "minLength": 1
          },
          "alg": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "kty",
          "crv",
          "x",
          "kid",
          "alg"
        ]
      },
      "PublicPaymentErrorModel": {
        "type": "object",
        "properties": {
          "code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "decline_code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "message": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "code",
          "decline_code",
          "message"
        ]
      },
      "PublishBody": {
        "type": "object",
        "properties": {
          "confirm": {
            "type": "boolean"
          }
        }
      },
      "PublishModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "proposal": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "applied": {
            "type": "integer",
            "multipleOf": 1
          },
          "skipped": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PublishSkippedModel"
            }
          },
          "change_set": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "site_version": {
            "type": "string",
            "minLength": 1
          },
          "online": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PublishOnlineModel"
            }
          },
          "not_online": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PublishNotOnlineModel"
            }
          },
          "pages_left": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PublishPageLeftModel"
            }
          },
          "store": {
            "$ref": "#/components/schemas/PublishStoreModel"
          },
          "message": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "proposal",
          "status",
          "applied",
          "skipped",
          "change_set",
          "site_version",
          "online",
          "not_online",
          "pages_left",
          "store",
          "message"
        ]
      },
      "PublishNeedModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "why": {
            "type": "string",
            "minLength": 1
          },
          "fix_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "title",
          "why",
          "fix_url"
        ]
      },
      "PublishNotOnlineModel": {
        "type": "object",
        "properties": {
          "product": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "message": {
            "type": "string",
            "minLength": 1
          },
          "fix_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "product",
          "name",
          "message",
          "fix_url"
        ]
      },
      "PublishOnlineModel": {
        "type": "object",
        "properties": {
          "product": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "product",
          "name"
        ]
      },
      "PublishPageLeftModel": {
        "type": "object",
        "properties": {
          "item": {
            "type": "string",
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "message": {
            "type": "string",
            "minLength": 1
          },
          "fix_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "item",
          "title",
          "message",
          "fix_url"
        ]
      },
      "PublishSkippedModel": {
        "type": "object",
        "properties": {
          "item": {
            "type": "string",
            "minLength": 1
          },
          "group": {
            "type": "string",
            "minLength": 1
          },
          "why": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "item",
          "group",
          "why"
        ]
      },
      "PublishStoreModel": {
        "type": "object",
        "properties": {
          "open": {
            "type": "boolean"
          },
          "address": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "needs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PublishNeedModel"
            }
          }
        },
        "required": [
          "open",
          "address",
          "needs"
        ]
      },
      "PurchaseOrderLineModel": {
        "type": "object",
        "properties": {
          "variant_id": {
            "type": "string",
            "minLength": 1
          },
          "product_id": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "quantity": {
            "type": "integer"
          },
          "case_size": {
            "type": "integer"
          },
          "unit_cost": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "variant_id",
          "product_id",
          "name",
          "quantity",
          "case_size",
          "unit_cost"
        ]
      },
      "PurchaseOrderList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PurchaseOrderModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "PurchaseOrderModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "supplier": {
            "type": "string",
            "minLength": 1
          },
          "supplier_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "sent",
              "cancelled"
            ],
            "minLength": 1
          },
          "lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PurchaseOrderLineModel"
            }
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "total_cost": {
            "nullable": true,
            "type": "integer"
          },
          "note": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "sent_at": {
            "nullable": true,
            "type": "integer"
          },
          "sent_to": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "supplier",
          "supplier_name",
          "status",
          "lines",
          "currency",
          "total_cost",
          "note",
          "sent_at",
          "sent_to",
          "created"
        ]
      },
      "QuietHoursModel": {
        "type": "object",
        "properties": {
          "start": {
            "type": "string",
            "minLength": 1
          },
          "end": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "start",
          "end"
        ]
      },
      "RateBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 80
          },
          "kind": {
            "type": "string",
            "maxLength": 20
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "bands": {
            "nullable": true
          },
          "free_over": {
            "nullable": true,
            "type": "integer"
          },
          "service_code": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "fallback_amount": {
            "nullable": true,
            "type": "integer"
          },
          "markup": {
            "nullable": true
          },
          "location": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "min_order": {
            "nullable": true,
            "type": "integer"
          },
          "max_weight_g": {
            "nullable": true,
            "type": "integer"
          },
          "transit_days": {
            "nullable": true
          },
          "delivery_days": {
            "nullable": true
          },
          "sort": {
            "type": "integer",
            "multipleOf": 1
          },
          "enabled": {
            "type": "boolean"
          }
        }
      },
      "RatingCountModel": {
        "type": "object",
        "properties": {
          "rating": {
            "type": "integer"
          },
          "count": {
            "type": "integer"
          }
        },
        "required": [
          "rating",
          "count"
        ]
      },
      "ReasonBody": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "maxLength": 500
          },
          "totals": {
            "$ref": "#/components/schemas/TotalsBody"
          }
        }
      },
      "RebookingModel": {
        "type": "object",
        "properties": {
          "visits": {
            "type": "integer"
          },
          "rebooked": {
            "type": "integer"
          },
          "rate": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "within_days": {
            "type": "integer"
          }
        },
        "required": [
          "visits",
          "rebooked",
          "rate",
          "within_days"
        ]
      },
      "RebookingRuleModel": {
        "type": "object",
        "properties": {
          "service": {
            "type": "string",
            "minLength": 1
          },
          "after_weeks": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "service",
          "after_weeks"
        ]
      },
      "ReceiptCustomerDetailsBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 200,
            "minLength": 1
          },
          "address": {
            "nullable": true,
            "type": "string",
            "maxLength": 500
          },
          "tax_number": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          }
        },
        "required": [
          "name"
        ]
      },
      "ReceiptCustomerDetailsModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "address": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "tax_number": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "name",
          "address",
          "tax_number"
        ]
      },
      "ReceiptSettingsBody": {
        "type": "object",
        "properties": {
          "header": {
            "nullable": true,
            "type": "string",
            "maxLength": 500
          },
          "footer": {
            "nullable": true,
            "type": "string",
            "maxLength": 500
          },
          "logo_asset_id": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "show_tax_number": {
            "type": "boolean"
          },
          "default_action": {
            "type": "string",
            "maxLength": 10
          },
          "paper_width": {
            "type": "integer"
          }
        }
      },
      "ReceiptSettingsModel": {
        "type": "object",
        "properties": {
          "header": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "footer": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "logo_asset_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "show_tax_number": {
            "type": "boolean"
          },
          "default_action": {
            "type": "string",
            "enum": [
              "print",
              "email",
              "ask",
              "none"
            ],
            "minLength": 1
          },
          "paper_width": {
            "type": "integer",
            "enum": [
              58,
              80
            ]
          }
        },
        "required": [
          "header",
          "footer",
          "logo_asset_id",
          "show_tax_number",
          "default_action",
          "paper_width"
        ]
      },
      "RecommendationRuleBody": {
        "type": "object",
        "properties": {
          "product": {
            "type": "string",
            "maxLength": 40
          },
          "collection": {
            "type": "string",
            "maxLength": 40
          },
          "kind": {
            "type": "string",
            "maxLength": 20
          },
          "pinned": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "excluded": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "RecommendationRuleList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RecommendationRuleModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "RecommendationRuleModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "product": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "collection": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "bought_together",
              "similar",
              "complete_the_look"
            ],
            "minLength": 1
          },
          "pinned": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "excluded": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "created": {
            "type": "integer"
          },
          "updated": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "product",
          "collection",
          "kind",
          "pinned",
          "excluded",
          "created",
          "updated"
        ]
      },
      "RedoBody": {
        "type": "object",
        "properties": {
          "instruction": {
            "type": "string",
            "maxLength": 300,
            "minLength": 1
          }
        },
        "required": [
          "instruction"
        ]
      },
      "RefundList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RefundModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "RefundModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "payment": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "fee_returned": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "succeeded",
              "failed"
            ],
            "minLength": 1
          },
          "reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "failure_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "metadata": {
            "type": "object"
          },
          "application_fee_refund": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "payment",
          "amount",
          "currency",
          "fee_returned",
          "status",
          "reason",
          "failure_reason",
          "metadata",
          "application_fee_refund",
          "created"
        ],
        "example": {
          "id": "rfnd_01J8ZK7C2D4E6F8G0H2J4K6M8N",
          "object": "refund",
          "livemode": false,
          "payment": "pay_01J8ZK3V5M7Q2N4R6T8W0XYZAB",
          "amount": 500,
          "currency": "gbp",
          "fee_returned": 0,
          "status": "succeeded",
          "reason": "requested_by_customer",
          "failure_reason": null,
          "metadata": {},
          "application_fee_refund": null,
          "created": 1790003600
        }
      },
      "RegisterList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RegisterModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "RegisterModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "layout": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "receipt_settings": {
            "$ref": "#/components/schemas/ReceiptSettingsModel"
          },
          "default_order_type": {
            "type": "string",
            "enum": [
              "eat_in",
              "takeaway",
              "delivery",
              "collection"
            ],
            "minLength": 1
          },
          "tipping": {
            "$ref": "#/components/schemas/TippingModel"
          },
          "service_charge_default": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "float_default": {
            "type": "integer"
          },
          "printer_ids": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "cash_drawer": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CashDrawerModel"
              }
            ],
            "nullable": true
          },
          "reader": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "idle_timeout_seconds": {
            "type": "integer"
          },
          "training_mode": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ],
            "minLength": 1
          },
          "metadata": {
            "type": "object"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "location",
          "name",
          "layout",
          "receipt_settings",
          "default_order_type",
          "tipping",
          "service_charge_default",
          "float_default",
          "printer_ids",
          "cash_drawer",
          "reader",
          "idle_timeout_seconds",
          "training_mode",
          "status",
          "metadata",
          "created"
        ]
      },
      "RegistrationFieldModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "label": {
            "type": "string",
            "minLength": 1
          },
          "format": {
            "type": "string"
          },
          "required": {
            "type": "boolean"
          },
          "unverified": {
            "type": "boolean"
          },
          "notes": {
            "type": "string"
          }
        },
        "required": [
          "kind",
          "label",
          "required"
        ]
      },
      "RejectConnectAccountBody": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "enum": [
              "fraud",
              "terms_of_service",
              "other"
            ],
            "minLength": 1
          }
        },
        "required": [
          "reason"
        ]
      },
      "ReminderRuleModel": {
        "type": "object",
        "properties": {
          "offset_minutes": {
            "type": "integer",
            "multipleOf": 1
          },
          "channels": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "offset_minutes",
          "channels"
        ]
      },
      "RenameSectionBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 60,
            "minLength": 1
          }
        },
        "required": [
          "name"
        ]
      },
      "ReorderPointBody": {
        "type": "object",
        "properties": {
          "variant": {
            "type": "string",
            "maxLength": 40
          },
          "location": {
            "type": "string",
            "maxLength": 40
          },
          "reorder_point": {
            "nullable": true,
            "type": "string"
          }
        }
      },
      "RepeatRuleBody": {
        "type": "object",
        "properties": {
          "every": {
            "type": "string",
            "enum": [
              "week",
              "month"
            ],
            "minLength": 1
          },
          "interval": {
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          },
          "count": {
            "nullable": true,
            "type": "integer",
            "minimum": 2,
            "multipleOf": 1
          },
          "until": {
            "nullable": true,
            "type": "string"
          },
          "on": {
            "nullable": true,
            "type": "string",
            "enum": [
              "weekday",
              "day"
            ]
          }
        },
        "required": [
          "every"
        ]
      },
      "RepeatRuleModel": {
        "type": "object",
        "properties": {
          "every": {
            "type": "string",
            "minLength": 1
          },
          "interval": {
            "type": "integer"
          },
          "count": {
            "nullable": true,
            "type": "integer"
          },
          "until": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "on": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "every",
          "interval",
          "count",
          "until",
          "on"
        ]
      },
      "ReplaceCardBody": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "enum": [
              "lost",
              "stolen",
              "damaged",
              "expired"
            ]
          }
        }
      },
      "ReportDay": {
        "type": "object",
        "properties": {
          "gross": {
            "type": "integer"
          },
          "fees": {
            "type": "integer"
          },
          "next_day_fees": {
            "type": "integer"
          },
          "refunds": {
            "type": "integer"
          },
          "disputes": {
            "type": "integer"
          },
          "dispute_fees": {
            "type": "integer"
          },
          "net": {
            "type": "integer"
          },
          "credits_sold": {
            "type": "integer"
          },
          "credits_used": {
            "type": "integer"
          },
          "tips": {
            "type": "integer"
          },
          "payments": {
            "type": "integer"
          },
          "refund_count": {
            "type": "integer"
          },
          "dispute_count": {
            "type": "integer"
          },
          "date": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "gross",
          "fees",
          "next_day_fees",
          "refunds",
          "disputes",
          "dispute_fees",
          "net",
          "credits_sold",
          "credits_used",
          "tips",
          "payments",
          "refund_count",
          "dispute_count",
          "date"
        ]
      },
      "ReportModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "from": {
            "type": "string",
            "minLength": 1
          },
          "to": {
            "type": "string",
            "minLength": 1
          },
          "totals": {
            "$ref": "#/components/schemas/ReportTotals"
          },
          "sources": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReportSource"
            }
          },
          "effective_rate": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "days": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReportDay"
            }
          }
        },
        "required": [
          "object",
          "livemode",
          "currency",
          "from",
          "to",
          "totals",
          "sources",
          "effective_rate",
          "days"
        ]
      },
      "ReportSource": {
        "type": "object",
        "properties": {
          "source": {
            "type": "string",
            "minLength": 1
          },
          "payments": {
            "type": "integer"
          },
          "gross": {
            "type": "integer"
          },
          "fees": {
            "type": "integer"
          },
          "refunds": {
            "type": "integer"
          },
          "refund_count": {
            "type": "integer"
          },
          "net": {
            "type": "integer"
          }
        },
        "required": [
          "source",
          "payments",
          "gross",
          "fees",
          "refunds",
          "refund_count",
          "net"
        ]
      },
      "ReportTotals": {
        "type": "object",
        "properties": {
          "gross": {
            "type": "integer"
          },
          "fees": {
            "type": "integer"
          },
          "next_day_fees": {
            "type": "integer"
          },
          "refunds": {
            "type": "integer"
          },
          "disputes": {
            "type": "integer"
          },
          "dispute_fees": {
            "type": "integer"
          },
          "net": {
            "type": "integer"
          },
          "credits_sold": {
            "type": "integer"
          },
          "credits_used": {
            "type": "integer"
          },
          "tips": {
            "type": "integer"
          },
          "payments": {
            "type": "integer"
          },
          "refund_count": {
            "type": "integer"
          },
          "dispute_count": {
            "type": "integer"
          }
        },
        "required": [
          "gross",
          "fees",
          "next_day_fees",
          "refunds",
          "disputes",
          "dispute_fees",
          "net",
          "credits_sold",
          "credits_used",
          "tips",
          "payments",
          "refund_count",
          "dispute_count"
        ]
      },
      "RequestApprovalBody": {
        "type": "object",
        "properties": {
          "card": {
            "type": "string"
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "merchant": {
            "$ref": "#/components/schemas/RequestMerchantBody"
          },
          "description": {
            "nullable": true,
            "type": "string",
            "maxLength": 500
          }
        }
      },
      "RequestLogList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RequestLogModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "RequestLogModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "request_id": {
            "type": "string",
            "minLength": 1
          },
          "method": {
            "type": "string",
            "minLength": 1
          },
          "path": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "integer"
          },
          "duration_ms": {
            "type": "integer"
          },
          "source": {
            "type": "string",
            "minLength": 1
          },
          "api_key": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "idempotency_key": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "ip": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "user_agent": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "api_version": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "client": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "account": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          },
          "query": {
            "nullable": true
          },
          "request_body": {
            "nullable": true
          },
          "response_body": {
            "nullable": true
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "request_id",
          "method",
          "path",
          "status",
          "duration_ms",
          "source",
          "api_key",
          "idempotency_key",
          "ip",
          "user_agent",
          "api_version",
          "client",
          "account",
          "created"
        ]
      },
      "RequestMerchantBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 200
          },
          "network_id": {
            "nullable": true,
            "type": "string",
            "maxLength": 60
          }
        }
      },
      "RequirementAlternativeModel": {
        "type": "object",
        "properties": {
          "alternative_fields_due": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "original_fields_due": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "alternative_fields_due",
          "original_fields_due"
        ]
      },
      "RequirementErrorModel": {
        "type": "object",
        "properties": {
          "requirement": {
            "type": "string",
            "minLength": 1
          },
          "code": {
            "type": "string",
            "minLength": 1
          },
          "reason": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "requirement",
          "code",
          "reason"
        ]
      },
      "RequirementsModel": {
        "type": "object",
        "properties": {
          "disabled_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "past_due": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "disabled_reason",
          "past_due"
        ]
      },
      "RescheduleBookingBody": {
        "type": "object",
        "properties": {
          "starts_at": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "by": {
            "nullable": true,
            "type": "string",
            "maxLength": 10
          },
          "reason": {
            "nullable": true,
            "type": "string",
            "maxLength": 300
          },
          "consented": {
            "type": "boolean"
          },
          "notify": {
            "type": "boolean"
          }
        },
        "required": [
          "starts_at"
        ]
      },
      "ResendBody": {
        "type": "object",
        "properties": {
          "webhook_endpoint": {
            "type": "string"
          },
          "account": {
            "type": "string"
          }
        }
      },
      "ResourceBody": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "maxLength": 40
          },
          "name": {
            "type": "string",
            "maxLength": 120
          },
          "capacity": {
            "type": "integer",
            "multipleOf": 1
          },
          "location": {
            "type": "string",
            "maxLength": 40
          },
          "sort": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "ResourceCheckBody": {
        "type": "object",
        "properties": {
          "location": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "service": {
            "type": "string",
            "maxLength": 40
          },
          "requirements": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResourceRequirementBody"
            }
          },
          "starts_at": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "ends_at": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          }
        },
        "required": [
          "location",
          "starts_at",
          "ends_at"
        ]
      },
      "ResourceCheckModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "starts_at": {
            "type": "string",
            "minLength": 1
          },
          "ends_at": {
            "type": "string",
            "minLength": 1
          },
          "ok": {
            "type": "boolean"
          },
          "units": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AllocatedUnitModel"
            }
          },
          "short": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ResourceShortfallModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "object",
          "location",
          "starts_at",
          "ends_at",
          "ok",
          "units",
          "short"
        ]
      },
      "ResourceList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResourceModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ResourceModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "capacity": {
            "type": "integer"
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "sort": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ],
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "kind",
          "name",
          "capacity",
          "location",
          "sort",
          "status",
          "created"
        ]
      },
      "ResourceRequirementBody": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "count": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "kind"
        ]
      },
      "ResourceShortfallModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "needed": {
            "type": "integer"
          },
          "free": {
            "type": "integer"
          }
        },
        "required": [
          "kind",
          "needed",
          "free"
        ]
      },
      "RespondToDirectDebitBody": {
        "type": "object",
        "properties": {
          "note": {
            "type": "string",
            "maxLength": 2000,
            "minLength": 1
          }
        },
        "required": [
          "note"
        ]
      },
      "RestoreSectionBody": {
        "type": "object",
        "properties": {
          "version": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          }
        },
        "required": [
          "version"
        ]
      },
      "ReturnApproveBody": {
        "type": "object",
        "properties": {
          "exception": {
            "type": "boolean"
          }
        }
      },
      "ReturnApprovedEvent": {
        "type": "object",
        "description": "The `return.approved` event (the store's returns events): `data.object` is the `return`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "return.approved"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ReturnEventData"
          }
        }
      },
      "ReturnBody": {
        "type": "object",
        "properties": {
          "lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReturnLineBody"
            }
          },
          "all": {
            "type": "boolean"
          },
          "restock": {
            "type": "boolean"
          },
          "restock_location": {
            "type": "string",
            "maxLength": 40
          },
          "reason": {
            "type": "string",
            "maxLength": 500
          }
        }
      },
      "ReturnClosedEvent": {
        "type": "object",
        "description": "The `return.closed` event (the store's returns events): `data.object` is the `return`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "return.closed"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ReturnEventData"
          }
        }
      },
      "ReturnCreateBody": {
        "type": "object",
        "properties": {
          "order": {
            "type": "string",
            "maxLength": 40
          },
          "kind": {
            "type": "string",
            "maxLength": 12
          },
          "method": {
            "type": "string",
            "maxLength": 12
          },
          "exchange": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReturnExchangeLineBody"
            }
          },
          "requested_via": {
            "type": "string",
            "maxLength": 12
          },
          "lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreReturnLineBody"
            }
          }
        },
        "example": {
          "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
          "kind": "return",
          "method": "refund",
          "requested_via": "dashboard",
          "lines": [
            {
              "line": "ordl_01K7HBFR8T0V2X4Z6B8D0F2H4M",
              "quantity": "1",
              "reason": "changed_mind",
              "reason_text": "Bought two by mistake."
            }
          ]
        }
      },
      "ReturnCreditModel": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "bonus": {
            "type": "integer",
            "multipleOf": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "voucher": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "amount",
          "bonus",
          "currency",
          "voucher"
        ]
      },
      "ReturnDecisionLineModel": {
        "type": "object",
        "properties": {
          "line": {
            "type": "string",
            "minLength": 1
          },
          "eligible": {
            "type": "boolean"
          },
          "basis": {
            "type": "string",
            "enum": [
              "statutory_cancellation",
              "faulty",
              "business_policy",
              "not_eligible"
            ],
            "minLength": 1
          },
          "remedy": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "window_ends_on": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "postage_payer": {
            "type": "string",
            "enum": [
              "business",
              "shopper"
            ],
            "minLength": 1
          },
          "restocking_fee_bps": {
            "type": "integer"
          },
          "message": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "line",
          "eligible",
          "basis",
          "remedy",
          "window_ends_on",
          "postage_payer",
          "restocking_fee_bps",
          "message"
        ]
      },
      "ReturnDecisionModel": {
        "type": "object",
        "properties": {
          "lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReturnDecisionLineModel"
            }
          },
          "whole_order": {
            "type": "boolean"
          },
          "postage_payer": {
            "type": "string",
            "enum": [
              "business",
              "shopper"
            ],
            "minLength": 1
          },
          "refund_delivery": {
            "type": "string",
            "enum": [
              "none",
              "cheapest_standard",
              "full"
            ],
            "minLength": 1
          },
          "delivery_refund_amount": {
            "type": "integer"
          },
          "delivered_on": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "decided_on": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "lines",
          "whole_order",
          "postage_payer",
          "refund_delivery",
          "delivery_refund_amount",
          "delivered_on",
          "decided_on"
        ]
      },
      "ReturnDeductionModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "return_label",
              "restocking_fee"
            ],
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "kind",
          "name",
          "amount"
        ]
      },
      "ReturnDropOffModel": {
        "type": "object",
        "properties": {
          "carrier": {
            "type": "string",
            "minLength": 1
          },
          "code": {
            "type": "string",
            "minLength": 1
          },
          "qr": {
            "type": "string",
            "minLength": 1
          },
          "expires_at": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "carrier",
          "code",
          "qr",
          "expires_at"
        ]
      },
      "ReturnEventData": {
        "type": "object",
        "description": "What an event carrying a `return` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/ReturnEventObject"
          }
        }
      },
      "ReturnEventObject": {
        "type": "object",
        "description": "A `return` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "return"
          }
        },
        "additionalProperties": true
      },
      "ReturnExchangeLineBody": {
        "type": "object",
        "properties": {
          "line": {
            "type": "string",
            "maxLength": 40
          },
          "variant": {
            "type": "string",
            "maxLength": 40
          },
          "quantity": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "ReturnExchangeLineModel": {
        "type": "object",
        "properties": {
          "line": {
            "type": "string",
            "minLength": 1
          },
          "variant": {
            "type": "string",
            "minLength": 1
          },
          "product": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "quantity": {
            "type": "integer",
            "multipleOf": 1
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "line",
          "variant",
          "product",
          "name",
          "quantity",
          "amount"
        ]
      },
      "ReturnExchangeModel": {
        "type": "object",
        "properties": {
          "lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReturnExchangeLineModel"
            }
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "returned_value": {
            "type": "integer",
            "multipleOf": 1
          },
          "new_value": {
            "type": "integer",
            "multipleOf": 1
          },
          "difference": {
            "type": "integer",
            "multipleOf": 1
          },
          "payment": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "paid": {
            "nullable": true,
            "type": "integer"
          },
          "ships": {
            "type": "string",
            "enum": [
              "in_transit",
              "now"
            ],
            "minLength": 1
          },
          "order": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "lines",
          "currency",
          "returned_value",
          "new_value",
          "difference",
          "payment",
          "paid",
          "ships",
          "order"
        ]
      },
      "ReturnInsightList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReturnInsightModel"
            }
          }
        },
        "required": [
          "object",
          "data"
        ]
      },
      "ReturnInsightModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "product": {
            "type": "string",
            "minLength": 1
          },
          "variant": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "reason": {
            "type": "string",
            "minLength": 1
          },
          "count": {
            "type": "integer"
          },
          "of": {
            "type": "integer"
          },
          "summary": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "product",
          "variant",
          "reason",
          "count",
          "of",
          "summary"
        ]
      },
      "ReturnLineBody": {
        "type": "object",
        "properties": {
          "line": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "quantity": {
            "type": "string",
            "maxLength": 16
          }
        },
        "required": [
          "line"
        ]
      },
      "ReturnLineModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "line": {
            "type": "string",
            "minLength": 1
          },
          "quantity": {
            "type": "string",
            "minLength": 1
          },
          "reason": {
            "type": "string",
            "minLength": 1
          },
          "reason_text": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "condition": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "restock": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "line",
          "quantity",
          "reason",
          "reason_text",
          "condition",
          "restock"
        ]
      },
      "ReturnList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReturnModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ReturnModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "order": {
            "type": "string",
            "minLength": 1
          },
          "site": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "return",
              "cancellation",
              "exchange"
            ],
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "method": {
            "type": "string",
            "enum": [
              "refund",
              "store_credit",
              "exchange"
            ],
            "minLength": 1
          },
          "requested_via": {
            "type": "string",
            "minLength": 1
          },
          "decision": {
            "$ref": "#/components/schemas/ReturnDecisionModel"
          },
          "exception": {
            "type": "boolean"
          },
          "rejection_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "refund_due_on": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "channel_respond_by": {
            "nullable": true,
            "type": "integer"
          },
          "received": {
            "nullable": true,
            "type": "integer"
          },
          "received_location": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "refund_order": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "refunded": {
            "nullable": true,
            "type": "integer"
          },
          "closed": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          },
          "lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReturnLineModel"
            }
          },
          "exchange": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ReturnExchangeModel"
              }
            ],
            "nullable": true
          },
          "credit": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ReturnCreditModel"
              }
            ],
            "nullable": true
          },
          "way_back": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ReturnWayBackModel"
              }
            ],
            "nullable": true
          },
          "shipment": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "drop_off": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ReturnDropOffModel"
              }
            ],
            "nullable": true
          },
          "deductions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReturnDeductionModel"
            }
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "order",
          "site",
          "kind",
          "status",
          "method",
          "requested_via",
          "decision",
          "exception",
          "rejection_reason",
          "refund_due_on",
          "channel_respond_by",
          "received",
          "received_location",
          "refund_order",
          "refunded",
          "closed",
          "created",
          "lines",
          "exchange",
          "credit",
          "way_back",
          "shipment",
          "drop_off",
          "deductions"
        ],
        "example": {
          "id": "ret_01K7HBMX3Y5A7C9E1G3J5L7N9Q",
          "object": "return",
          "livemode": false,
          "order": "ord_01K7HBSA8D0F2H4K6M8P0R2T4W",
          "site": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
          "kind": "return",
          "status": "approved",
          "method": "refund",
          "requested_via": "portal",
          "decision": {
            "lines": [
              {
                "line": "ordl_01K7HBFR8T0V2X4Z6B8D0F2H4M",
                "eligible": true,
                "basis": "statutory_cancellation",
                "remedy": "refund",
                "window_ends_on": "2026-11-11",
                "postage_payer": "shopper",
                "restocking_fee_bps": 0,
                "message": "You can return this within 14 days of getting it, for a full refund."
              }
            ],
            "whole_order": false,
            "postage_payer": "shopper",
            "refund_delivery": "none",
            "delivery_refund_amount": 0,
            "delivered_on": "2026-10-28",
            "decided_on": "2026-10-30"
          },
          "exception": false,
          "rejection_reason": null,
          "refund_due_on": null,
          "channel_respond_by": null,
          "received": null,
          "received_location": null,
          "refund_order": null,
          "refunded": null,
          "closed": null,
          "created": 1792828800,
          "lines": [
            {
              "id": "retln_01K7HBNY4Z6B8D0F2H4K6M8P0R",
              "line": "ordl_01K7HBFR8T0V2X4Z6B8D0F2H4M",
              "quantity": "1",
              "reason": "changed_mind",
              "reason_text": null,
              "condition": null,
              "restock": true
            }
          ],
          "exchange": null,
          "credit": null,
          "way_back": null,
          "shipment": null,
          "drop_off": null,
          "deductions": []
        }
      },
      "ReturnPolicyBody": {
        "type": "object",
        "properties": {
          "window_days": {
            "type": "integer",
            "multipleOf": 1
          },
          "final_sale_products": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "return_postage": {
            "type": "string",
            "maxLength": 24
          },
          "exchange": {
            "type": "boolean"
          },
          "store_credit_bonus_bps": {
            "type": "integer",
            "multipleOf": 1
          },
          "restocking_fee_bps": {
            "type": "integer",
            "multipleOf": 1
          },
          "refund_on_carrier_delivery": {
            "type": "boolean"
          },
          "exchange_straight_away": {
            "type": "boolean"
          }
        }
      },
      "ReturnPolicyModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "window_days": {
            "type": "integer"
          },
          "final_sale_products": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "return_postage": {
            "type": "string",
            "enum": [
              "shopper_unless_faulty",
              "business"
            ],
            "minLength": 1
          },
          "exchange": {
            "type": "boolean"
          },
          "store_credit_bonus_bps": {
            "type": "integer"
          },
          "restocking_fee_bps": {
            "type": "integer"
          },
          "refund_on_carrier_delivery": {
            "type": "boolean"
          },
          "exchange_straight_away": {
            "type": "boolean"
          },
          "updated": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "object",
          "site",
          "window_days",
          "final_sale_products",
          "return_postage",
          "exchange",
          "store_credit_bonus_bps",
          "restocking_fee_bps",
          "refund_on_carrier_delivery",
          "exchange_straight_away",
          "updated"
        ]
      },
      "ReturnPreviewBody": {
        "type": "object",
        "properties": {
          "lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreReturnLineBody"
            }
          }
        }
      },
      "ReturnPreviewModel": {
        "type": "object",
        "properties": {
          "lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReturnDecisionLineModel"
            }
          },
          "whole_order": {
            "type": "boolean"
          },
          "postage_payer": {
            "type": "string",
            "enum": [
              "business",
              "shopper"
            ],
            "minLength": 1
          },
          "refund_delivery": {
            "type": "string",
            "enum": [
              "none",
              "cheapest_standard",
              "full"
            ],
            "minLength": 1
          },
          "delivery_refund_amount": {
            "type": "integer"
          },
          "delivered_on": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "decided_on": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "order": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "lines",
          "whole_order",
          "postage_payer",
          "refund_delivery",
          "delivery_refund_amount",
          "delivered_on",
          "decided_on",
          "object",
          "order"
        ]
      },
      "ReturnReceiveBody": {
        "type": "object",
        "properties": {
          "location": {
            "type": "string",
            "maxLength": 40
          }
        }
      },
      "ReturnReceivedEvent": {
        "type": "object",
        "description": "The `return.received` event (the store's returns events): `data.object` is the `return`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "return.received"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ReturnEventData"
          }
        }
      },
      "ReturnRefundDueSoonEvent": {
        "type": "object",
        "description": "The `return.refund_due_soon` event (the store's returns events): `data.object` is the `return`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "return.refund_due_soon"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ReturnEventData"
          }
        }
      },
      "ReturnRefundedEvent": {
        "type": "object",
        "description": "The `return.refunded` event (the store's returns events): `data.object` is the `return`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "return.refunded"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ReturnEventData"
          }
        }
      },
      "ReturnRejectBody": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "maxLength": 500
          }
        }
      },
      "ReturnRejectedEvent": {
        "type": "object",
        "description": "The `return.rejected` event (the store's returns events): `data.object` is the `return`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "return.rejected"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ReturnEventData"
          }
        }
      },
      "ReturnRequestedEvent": {
        "type": "object",
        "description": "The `return.requested` event (the store's returns events): `data.object` is the `return`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "return.requested"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ReturnEventData"
          }
        }
      },
      "ReturnScanBody": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "maxLength": 500
          }
        }
      },
      "ReturnScanLineModel": {
        "type": "object",
        "properties": {
          "line": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "quantity": {
            "type": "string",
            "minLength": 1
          },
          "unit_amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "eligible": {
            "type": "boolean"
          },
          "basis": {
            "type": "string",
            "enum": [
              "statutory_cancellation",
              "faulty",
              "business_policy",
              "not_eligible"
            ],
            "minLength": 1
          },
          "window_ends_on": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "message": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "line",
          "name",
          "quantity",
          "unit_amount",
          "eligible",
          "basis",
          "window_ends_on",
          "message"
        ]
      },
      "ReturnScanModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "order": {
            "$ref": "#/components/schemas/ReturnScanOrderModel"
          },
          "return": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ReturnModel"
              }
            ],
            "nullable": true
          },
          "lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReturnScanLineModel"
            }
          },
          "methods": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "object",
          "order",
          "return",
          "lines",
          "methods"
        ]
      },
      "ReturnScanOrderModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "number": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "customer_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "delivered_on": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "number",
          "currency",
          "location",
          "customer_name",
          "delivered_on",
          "created"
        ]
      },
      "ReturnWayBackBody": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "maxLength": 12
          },
          "service": {
            "type": "string",
            "maxLength": 40
          },
          "location": {
            "type": "string",
            "maxLength": 40
          }
        }
      },
      "ReturnWayBackModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "label",
              "drop_off",
              "shop"
            ],
            "minLength": 1
          },
          "service": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "carrier": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "cost": {
            "nullable": true,
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "payer": {
            "type": "string",
            "enum": [
              "business",
              "shopper"
            ],
            "minLength": 1
          },
          "location": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "kind",
          "service",
          "carrier",
          "cost",
          "currency",
          "payer",
          "location"
        ]
      },
      "RevenueByCategoryModel": {
        "type": "object",
        "properties": {
          "category": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "bookings": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "category",
          "name",
          "bookings",
          "amount"
        ]
      },
      "RevenueByServiceModel": {
        "type": "object",
        "properties": {
          "service": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "bookings": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "service",
          "name",
          "bookings",
          "amount"
        ]
      },
      "RevenueByStaffModel": {
        "type": "object",
        "properties": {
          "staff_member": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "bookings": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "staff_member",
          "name",
          "bookings",
          "amount"
        ]
      },
      "ReverseTransferBody": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          },
          "metadata": {
            "type": "object"
          }
        }
      },
      "ReviewCreatedEvent": {
        "type": "object",
        "description": "The `review.created` event (the store's shoppers events): `data.object` is the `review`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "review.created"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ReviewEventData"
          }
        }
      },
      "ReviewEventData": {
        "type": "object",
        "description": "What an event carrying a `review` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/ReviewModel"
          }
        }
      },
      "ReviewLinkModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "booking": {
            "type": "string",
            "minLength": 1
          },
          "url": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "livemode",
          "booking",
          "url"
        ]
      },
      "ReviewList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReviewModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ReviewModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "booking": {
            "type": "string",
            "minLength": 1
          },
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "rating": {
            "type": "integer"
          },
          "body": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "author": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "published",
              "hidden"
            ],
            "minLength": 1
          },
          "reply": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "replied_at": {
            "nullable": true,
            "type": "integer"
          },
          "visited_on": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          },
          "edited": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "booking",
          "customer",
          "staff_member",
          "rating",
          "body",
          "author",
          "status",
          "reply",
          "replied_at",
          "visited_on",
          "created",
          "edited"
        ],
        "example": {
          "id": "rev_01K7HB9J1L3N5Q7S9U1W3Y5A7C",
          "object": "review",
          "livemode": false,
          "booking": "bk_01K7HBAK2M4P6R8T0V2X4Z6B8D",
          "customer": "cus_01J8ZK1Q9H2B4C6D8E0F2G4H6J",
          "staff_member": "stf_01J8ZK4D6F8H0K2M4P6R8T0V2X",
          "rating": 5,
          "body": "A lovely candle-making workshop. We went home with three candles each.",
          "author": "Priya S.",
          "status": "published",
          "reply": "Thank you, Priya. See you at the winter one!",
          "replied_at": 1792310400,
          "visited_on": "2026-10-18",
          "created": 1792224000,
          "edited": null
        }
      },
      "ReviewRepliedEvent": {
        "type": "object",
        "description": "The `review.replied` event (the store's shoppers events): `data.object` is the `review`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "review.replied"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ReviewEventData"
          }
        }
      },
      "ReviewReplyBody": {
        "type": "object",
        "properties": {
          "body": {
            "type": "string",
            "maxLength": 1000,
            "minLength": 1
          }
        },
        "required": [
          "body"
        ]
      },
      "ReviewSettingsModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "requests": {
            "type": "boolean"
          },
          "delay_days": {
            "nullable": true,
            "type": "integer"
          },
          "require_verified": {
            "type": "boolean"
          },
          "incentive": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ProductReviewIncentiveModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "object",
          "requests",
          "delay_days",
          "require_verified",
          "incentive"
        ]
      },
      "ReviewSummaryModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "count": {
            "type": "integer"
          },
          "average": {
            "nullable": true,
            "type": "integer"
          },
          "published": {
            "type": "integer"
          },
          "hidden": {
            "type": "integer"
          },
          "by_rating": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RatingCountModel"
            }
          }
        },
        "required": [
          "object",
          "livemode",
          "count",
          "average",
          "published",
          "hidden",
          "by_rating"
        ]
      },
      "RunStatementBody": {
        "type": "object",
        "properties": {
          "period": {
            "type": "string",
            "maxLength": 7
          }
        }
      },
      "SalesChannelEventData": {
        "type": "object",
        "description": "What an event carrying a `sales_channel` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/SalesChannelEventObject"
          }
        }
      },
      "SalesChannelEventObject": {
        "type": "object",
        "description": "A `sales_channel` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "sales_channel"
          }
        },
        "additionalProperties": true
      },
      "SalesChannelList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SalesChannelModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "SalesChannelModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "google",
              "meta",
              "tiktok_shop",
              "pinterest",
              "snapchat",
              "youtube",
              "ebay",
              "etsy",
              "amazon",
              "onbuy",
              "openai_feed"
            ],
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "role": {
            "type": "string",
            "enum": [
              "listing",
              "mirror"
            ],
            "minLength": 1
          },
          "region": {
            "type": "string",
            "enum": [
              "GB",
              "US"
            ],
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "connecting",
              "active",
              "paused",
              "reauthorise",
              "error",
              "disconnected"
            ],
            "minLength": 1
          },
          "external_account_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "external_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "scopes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "listing_default": {
            "type": "string",
            "enum": [
              "all_online",
              "chosen"
            ],
            "minLength": 1
          },
          "reserve": {
            "nullable": true,
            "type": "integer"
          },
          "price_adjust_bps": {
            "nullable": true,
            "type": "integer"
          },
          "error": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "sandbox": {
            "type": "boolean"
          },
          "livemode": {
            "type": "boolean"
          },
          "last_flush_at": {
            "nullable": true,
            "type": "integer"
          },
          "stale": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "disconnected_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "kind",
          "name",
          "role",
          "region",
          "status",
          "external_account_id",
          "external_name",
          "scopes",
          "listing_default",
          "reserve",
          "price_adjust_bps",
          "error",
          "sandbox",
          "livemode",
          "last_flush_at",
          "stale",
          "created",
          "disconnected_at"
        ]
      },
      "SandboxChallengeModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": [
              "sandbox_challenge"
            ],
            "minLength": 1
          },
          "nonce": {
            "type": "string",
            "minLength": 1
          },
          "difficulty": {
            "type": "integer",
            "multipleOf": 1
          },
          "algorithm": {
            "type": "string",
            "enum": [
              "sha256"
            ],
            "minLength": 1
          },
          "expires_at": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "object",
          "nonce",
          "difficulty",
          "algorithm",
          "expires_at"
        ]
      },
      "SandboxMcpModel": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "minLength": 1
          },
          "token": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "url",
          "token"
        ]
      },
      "SandboxModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "enum": [
              "sandbox"
            ],
            "minLength": 1
          },
          "account": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "secret_key": {
            "type": "string",
            "minLength": 1
          },
          "publishable_key": {
            "type": "string",
            "minLength": 1
          },
          "mcp": {
            "$ref": "#/components/schemas/SandboxMcpModel"
          },
          "claim_url": {
            "type": "string",
            "minLength": 1
          },
          "expires_at": {
            "type": "integer",
            "multipleOf": 1
          },
          "docs_url": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "id",
          "object",
          "account",
          "livemode",
          "secret_key",
          "publishable_key",
          "mcp",
          "claim_url",
          "expires_at",
          "docs_url",
          "created"
        ]
      },
      "SandboxPowBody": {
        "type": "object",
        "properties": {
          "nonce": {
            "type": "string",
            "minLength": 1
          },
          "solution": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "nonce",
          "solution"
        ]
      },
      "SandboxStateModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "enum": [
              "sandbox"
            ],
            "minLength": 1
          },
          "account": {
            "type": "string",
            "minLength": 1
          },
          "claimed": {
            "type": "boolean"
          },
          "claimed_at": {
            "nullable": true,
            "type": "integer"
          },
          "expires_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "id",
          "object",
          "account",
          "claimed",
          "claimed_at",
          "expires_at",
          "created"
        ]
      },
      "SavedBankAccountModel": {
        "type": "object",
        "properties": {
          "sort_code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "last4": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "sort_code",
          "last4"
        ]
      },
      "SavedCardList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SavedCardModel"
            }
          }
        },
        "required": [
          "object",
          "data"
        ]
      },
      "SavedCardModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "type": {
            "type": "string",
            "minLength": 1
          },
          "brand": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "last4": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "country": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "exp_month": {
            "nullable": true,
            "type": "integer"
          },
          "exp_year": {
            "nullable": true,
            "type": "integer"
          },
          "bacs_debit": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/SavedBankAccountModel"
              }
            ],
            "nullable": true
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "saved_by_payment": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "saved_by_setup_session": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "mandate": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/MandateModel"
              }
            ],
            "nullable": true
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "customer",
          "type",
          "brand",
          "last4",
          "country",
          "exp_month",
          "exp_year",
          "bacs_debit",
          "status",
          "saved_by_payment",
          "saved_by_setup_session",
          "mandate",
          "created"
        ]
      },
      "ScanStep": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "maxLength": 64
          },
          "line": {
            "type": "string",
            "maxLength": 40
          },
          "quantity": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "ScenePresetModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "label": {
            "type": "string",
            "minLength": 1
          },
          "words": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "label",
          "words"
        ]
      },
      "ScheduleBody": {
        "type": "object",
        "properties": {
          "location": {
            "type": "string",
            "maxLength": 40
          },
          "pattern": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "effective_from": {
            "type": "string",
            "maxLength": 10
          },
          "effective_to": {
            "nullable": true,
            "type": "string",
            "maxLength": 10
          },
          "keep_bookings": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "ScheduleExceptionBody": {
        "type": "object",
        "properties": {
          "staff_member": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "location": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "kind": {
            "type": "string",
            "enum": [
              "time_off",
              "break",
              "blocked",
              "extra_hours"
            ],
            "minLength": 1
          },
          "starts_at": {
            "type": "string",
            "maxLength": 40
          },
          "ends_at": {
            "type": "string",
            "maxLength": 40
          },
          "all_day": {
            "type": "boolean"
          },
          "date": {
            "type": "string",
            "maxLength": 10
          },
          "end_date": {
            "type": "string",
            "maxLength": 10
          },
          "reason": {
            "nullable": true,
            "type": "string",
            "maxLength": 300
          },
          "keep_bookings": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "kind"
        ]
      },
      "ScheduleExceptionDeleted": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "deleted": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "object",
          "deleted"
        ]
      },
      "ScheduleExceptionList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ScheduleExceptionModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ScheduleExceptionModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "location": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "time_off",
              "break",
              "blocked",
              "extra_hours",
              "calendar_busy"
            ],
            "minLength": 1
          },
          "starts_at": {
            "type": "string",
            "minLength": 1
          },
          "ends_at": {
            "type": "string",
            "minLength": 1
          },
          "all_day": {
            "type": "boolean"
          },
          "reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "source": {
            "type": "string",
            "minLength": 1
          },
          "timezone": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "staff_member",
          "location",
          "kind",
          "starts_at",
          "ends_at",
          "all_day",
          "reason",
          "source",
          "timezone",
          "created"
        ]
      },
      "ScheduleList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ScheduleModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ScheduleModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "staff_member": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "pattern": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "effective_from": {
            "type": "string",
            "minLength": 1
          },
          "effective_to": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "staff_member",
          "location",
          "pattern",
          "effective_from",
          "effective_to",
          "created"
        ]
      },
      "SectionCheckBlockerModel": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "minLength": 1
          },
          "text": {
            "type": "string",
            "minLength": 1
          },
          "message": {
            "type": "string",
            "minLength": 1
          },
          "fix_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "field",
          "text",
          "message",
          "fix_url"
        ]
      },
      "SectionCheckIssueModel": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "minLength": 1
          },
          "message": {
            "type": "string",
            "minLength": 1
          },
          "at": {
            "type": "string",
            "minLength": 1
          },
          "fix_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "code",
          "message",
          "at",
          "fix_url"
        ]
      },
      "SectionCheckModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "issues": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SectionCheckIssueModel"
            }
          },
          "claims_blockers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SectionCheckBlockerModel"
            }
          },
          "external_hosts": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "object",
          "status",
          "issues",
          "claims_blockers",
          "external_hosts"
        ]
      },
      "SeedKeptModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "id": {
            "type": "string",
            "minLength": 1
          },
          "used_by": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "id",
          "used_by"
        ]
      },
      "SeedRemovalModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "removed": {
            "$ref": "#/components/schemas/SeedRemovedModel"
          },
          "kept": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SeedKeptModel"
            }
          }
        },
        "required": [
          "object",
          "livemode",
          "removed",
          "kept"
        ]
      },
      "SeedRemovedModel": {
        "type": "object",
        "properties": {
          "bookings": {
            "type": "integer"
          },
          "customers": {
            "type": "integer"
          }
        },
        "required": [
          "bookings",
          "customers"
        ]
      },
      "SeedWeekBody": {
        "type": "object",
        "properties": {
          "week": {
            "nullable": true,
            "type": "string",
            "maxLength": 10
          },
          "location": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "density": {
            "type": "integer",
            "maximum": 100,
            "minimum": 1,
            "multipleOf": 1
          }
        }
      },
      "SeedWeekModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "week": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          },
          "existing": {
            "type": "integer"
          },
          "bookings": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "clients": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "object",
          "livemode",
          "week",
          "location",
          "created",
          "existing",
          "bookings",
          "clients"
        ]
      },
      "SellPackageBody": {
        "type": "object",
        "properties": {
          "package": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "customer": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          }
        },
        "required": [
          "package",
          "customer"
        ]
      },
      "SellingAbroadModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "groups": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AbroadGroupModel"
            }
          }
        },
        "required": [
          "object",
          "site",
          "groups"
        ]
      },
      "SeriesClassBody": {
        "type": "object",
        "properties": {
          "service": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "capacity": {
            "type": "integer"
          },
          "resource": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          }
        },
        "required": [
          "service"
        ]
      },
      "SeriesClientBody": {
        "type": "object",
        "properties": {
          "name": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          },
          "email": {
            "nullable": true,
            "type": "string",
            "maxLength": 320
          },
          "phone": {
            "nullable": true,
            "type": "string",
            "maxLength": 30
          }
        }
      },
      "SeriesItemBody": {
        "type": "object",
        "properties": {
          "service": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "variant": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "addons": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "service"
        ]
      },
      "ServiceAddonModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "service": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "duration_minutes": {
            "type": "integer"
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "sort": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ],
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "service",
          "name",
          "duration_minutes",
          "amount",
          "sort",
          "status",
          "created"
        ]
      },
      "ServiceAreaBody": {
        "type": "object",
        "properties": {
          "radius_km": {
            "type": "integer"
          },
          "lat": {
            "type": "integer"
          },
          "lng": {
            "type": "integer"
          },
          "outcodes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "ServiceAreaModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "radius",
              "outcodes"
            ],
            "minLength": 1
          },
          "radius_km": {
            "type": "integer"
          },
          "lat": {
            "type": "integer"
          },
          "lng": {
            "type": "integer"
          },
          "outcodes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "kind"
        ]
      },
      "ServiceBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 120
          },
          "description": {
            "nullable": true,
            "type": "string",
            "maxLength": 2000
          },
          "category": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "duration_minutes": {
            "type": "integer",
            "multipleOf": 1
          },
          "processing": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ProcessingBody"
              }
            ],
            "nullable": true
          },
          "buffer_before_minutes": {
            "type": "integer",
            "multipleOf": 1
          },
          "buffer_after_minutes": {
            "type": "integer",
            "multipleOf": 1
          },
          "price_type": {
            "type": "string",
            "enum": [
              "fixed",
              "from",
              "by_variant",
              "by_staff",
              "on_request",
              "free"
            ]
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "maxLength": 3
          },
          "online_bookable": {
            "type": "boolean"
          },
          "first_visit_only": {
            "type": "boolean"
          },
          "returning_only": {
            "type": "boolean"
          },
          "max_group_size": {
            "type": "integer",
            "multipleOf": 1
          },
          "policy_override": {
            "type": "object",
            "additionalProperties": true,
            "nullable": true
          },
          "subject_requirements": {
            "nullable": true,
            "type": "object"
          },
          "colour": {
            "nullable": true,
            "type": "string",
            "maxLength": 7
          },
          "sort": {
            "type": "integer",
            "multipleOf": 1
          },
          "metadata": {
            "type": "object"
          },
          "variants": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceOptionBody"
            }
          },
          "addons": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceOptionBody"
            }
          },
          "resources": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceRequirementBody"
            }
          },
          "staff": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceStaffBody"
            }
          }
        }
      },
      "ServiceCategoryBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 80
          },
          "sort": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "ServiceCategoryList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceCategoryModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ServiceCategoryModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "sort": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ],
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "name",
          "sort",
          "status",
          "created"
        ]
      },
      "ServiceChargeModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "discretionary",
              "compulsory"
            ],
            "minLength": 1
          },
          "bps": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "removed_by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "kind",
          "bps",
          "amount",
          "removed_by"
        ]
      },
      "ServiceImageBody": {
        "type": "object",
        "properties": {
          "image": {
            "type": "string",
            "maxLength": 1000000,
            "minLength": 1
          }
        },
        "required": [
          "image"
        ]
      },
      "ServiceList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ServiceModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "description": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "category": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "duration_minutes": {
            "type": "integer"
          },
          "processing": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ProcessingModel"
              }
            ],
            "nullable": true
          },
          "buffer_before_minutes": {
            "type": "integer"
          },
          "buffer_after_minutes": {
            "type": "integer"
          },
          "price_type": {
            "type": "string",
            "enum": [
              "fixed",
              "from",
              "by_variant",
              "by_staff",
              "on_request",
              "free"
            ],
            "minLength": 1
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "online_bookable": {
            "type": "boolean"
          },
          "first_visit_only": {
            "type": "boolean"
          },
          "returning_only": {
            "type": "boolean"
          },
          "max_group_size": {
            "type": "integer"
          },
          "policy_override": {
            "nullable": true
          },
          "subject_requirements": {
            "nullable": true
          },
          "colour": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "image_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "sort": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ],
            "minLength": 1
          },
          "variants": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceVariantModel"
            }
          },
          "addons": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceAddonModel"
            }
          },
          "resources": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceRequirementModel"
            }
          },
          "staff": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceStaffModel"
            }
          },
          "metadata": {
            "type": "object"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "name",
          "description",
          "category",
          "duration_minutes",
          "processing",
          "buffer_before_minutes",
          "buffer_after_minutes",
          "price_type",
          "amount",
          "currency",
          "online_bookable",
          "first_visit_only",
          "returning_only",
          "max_group_size",
          "colour",
          "image_url",
          "sort",
          "status",
          "variants",
          "addons",
          "resources",
          "staff",
          "metadata",
          "created"
        ]
      },
      "ServiceOptionBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 80
          },
          "duration_minutes": {
            "type": "integer",
            "multipleOf": 1
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "sort": {
            "type": "integer",
            "multipleOf": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ]
          }
        }
      },
      "ServiceQuoteBody": {
        "type": "object",
        "properties": {
          "variant": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "addons": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "group_size": {
            "type": "integer",
            "multipleOf": 1
          },
          "first_visit": {
            "type": "boolean"
          }
        }
      },
      "ServiceQuoteModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "service": {
            "type": "string",
            "minLength": 1
          },
          "variant": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "addons": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "group_size": {
            "type": "integer"
          },
          "duration_minutes": {
            "type": "integer"
          },
          "staff_minutes": {
            "type": "integer"
          },
          "processing": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ProcessingModel"
              }
            ],
            "nullable": true
          },
          "buffer_before_minutes": {
            "type": "integer"
          },
          "buffer_after_minutes": {
            "type": "integer"
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "total_amount": {
            "nullable": true,
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "price_type": {
            "type": "string",
            "enum": [
              "fixed",
              "from",
              "by_variant",
              "by_staff",
              "on_request",
              "free"
            ],
            "minLength": 1
          }
        },
        "required": [
          "object",
          "service",
          "variant",
          "addons",
          "staff_member",
          "group_size",
          "duration_minutes",
          "staff_minutes",
          "processing",
          "buffer_before_minutes",
          "buffer_after_minutes",
          "amount",
          "total_amount",
          "currency",
          "price_type"
        ]
      },
      "ServiceRequirementBody": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "count": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "kind"
        ]
      },
      "ServiceRequirementModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "count": {
            "type": "integer"
          }
        },
        "required": [
          "kind",
          "count"
        ]
      },
      "ServiceResourcesBody": {
        "type": "object",
        "properties": {
          "requirements": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceRequirementBody"
            }
          }
        },
        "required": [
          "requirements"
        ]
      },
      "ServiceStaffBody": {
        "type": "object",
        "properties": {
          "staff_member": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "duration_minutes": {
            "nullable": true,
            "type": "integer"
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "staff_member"
        ]
      },
      "ServiceStaffListBody": {
        "type": "object",
        "properties": {
          "staff": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceStaffBody"
            }
          }
        },
        "required": [
          "staff"
        ]
      },
      "ServiceStaffModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "staff_member": {
            "type": "string",
            "minLength": 1
          },
          "duration_minutes": {
            "nullable": true,
            "type": "integer"
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "object",
          "staff_member",
          "duration_minutes",
          "amount"
        ]
      },
      "ServiceVariantModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "service": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "duration_minutes": {
            "type": "integer"
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "sort": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ],
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "service",
          "name",
          "duration_minutes",
          "amount",
          "sort",
          "status",
          "created"
        ]
      },
      "SetNextDayBody": {
        "type": "object",
        "properties": {
          "enabled": {
            "type": "boolean",
            "description": "`true`: switch next-day payouts on — 0.2% on each payment from then on (UK, once available). `false`: switch them off. Payments already taken keep their speed and fee."
          }
        },
        "required": [
          "enabled"
        ]
      },
      "SetPaymentMethodBody": {
        "type": "object",
        "properties": {
          "enabled": {
            "type": "boolean"
          }
        },
        "required": [
          "enabled"
        ]
      },
      "SetStockMirrorBody": {
        "type": "object",
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "credentials": {
            "nullable": true,
            "type": "string",
            "maxLength": 2000
          }
        },
        "required": [
          "enabled"
        ]
      },
      "SetTaxExemptionBody": {
        "type": "object",
        "properties": {
          "reason": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "reference": {
            "nullable": true,
            "type": "string",
            "maxLength": 100
          },
          "totals": {
            "$ref": "#/components/schemas/TotalsBody"
          }
        }
      },
      "SetUpChannelBody": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "kind": {
            "nullable": true,
            "type": "string",
            "maxLength": 20
          },
          "label": {
            "nullable": true,
            "type": "string",
            "maxLength": 100
          }
        },
        "required": [
          "code"
        ]
      },
      "SettingsBody": {
        "type": "object",
        "properties": {
          "card_payments": {
            "$ref": "#/components/schemas/CardPaymentsSettingsBody"
          },
          "payments": {
            "$ref": "#/components/schemas/PaymentSettingsBody"
          },
          "payouts": {
            "$ref": "#/components/schemas/PayoutSettingsBody"
          },
          "application_fees": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ApplicationFeesBody"
              }
            ],
            "nullable": true
          },
          "cashback_share": {
            "nullable": true,
            "type": "string"
          },
          "store": {
            "$ref": "#/components/schemas/ConnectStoreSettingsBody"
          }
        }
      },
      "SettlePayoutBody": {
        "type": "object",
        "properties": {
          "outcome": {
            "type": "string",
            "enum": [
              "paid",
              "failed"
            ],
            "minLength": 1
          }
        },
        "required": [
          "outcome"
        ]
      },
      "SettlementRequestList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SettlementRequestModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "SettlementRequestModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "settlement_tier": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "note": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          },
          "decided_at": {
            "nullable": true,
            "type": "integer"
          },
          "decision_note": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "revoked_at": {
            "nullable": true,
            "type": "integer"
          },
          "revoke_note": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "settlement_tier",
          "status",
          "note",
          "created",
          "decided_at",
          "decision_note",
          "revoked_at",
          "revoke_note"
        ]
      },
      "SetupDraftBody": {
        "type": "object",
        "properties": {
          "step": {
            "type": "integer",
            "multipleOf": 1
          },
          "template": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          }
        }
      },
      "SetupSessionCardModel": {
        "type": "object",
        "properties": {
          "brand": {
            "type": "string",
            "minLength": 1
          },
          "last4": {
            "type": "string",
            "minLength": 1
          },
          "exp_month": {
            "nullable": true,
            "type": "integer"
          },
          "exp_year": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "brand",
          "last4",
          "exp_month",
          "exp_year"
        ]
      },
      "SetupSessionMandateModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "description": {
            "type": "string",
            "minLength": 1
          },
          "max_amount": {
            "nullable": true,
            "type": "integer"
          },
          "source": {
            "type": "string",
            "minLength": 1
          },
          "accepted_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "description",
          "max_amount",
          "source",
          "accepted_at"
        ]
      },
      "SetupSessionModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "booking": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "payment_method": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "card": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/SetupSessionCardModel"
              }
            ],
            "nullable": true
          },
          "mandate": {
            "$ref": "#/components/schemas/SetupSessionMandateModel"
          },
          "last_error": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PublicPaymentErrorModel"
              }
            ],
            "nullable": true
          },
          "metadata": {
            "type": "object"
          },
          "created": {
            "type": "integer"
          },
          "succeeded_at": {
            "nullable": true,
            "type": "integer"
          },
          "client_secret": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "status",
          "customer",
          "booking",
          "payment_method",
          "card",
          "mandate",
          "last_error",
          "metadata",
          "created",
          "succeeded_at"
        ]
      },
      "ShareImageBody": {
        "type": "object",
        "properties": {
          "image": {
            "type": "string",
            "maxLength": 1000000,
            "minLength": 1
          }
        },
        "required": [
          "image"
        ]
      },
      "ShareMetaLabelModel": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "minLength": 1
          },
          "value": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "label",
          "value"
        ]
      },
      "ShareMetaModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "description": {
            "type": "string",
            "minLength": 1
          },
          "image": {
            "type": "string",
            "minLength": 1
          },
          "image_alt": {
            "type": "string",
            "minLength": 1
          },
          "image_width": {
            "type": "integer"
          },
          "image_height": {
            "type": "integer"
          },
          "image_type": {
            "type": "string",
            "minLength": 1
          },
          "theme_color": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "locale": {
            "type": "string",
            "minLength": 1
          },
          "url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "labels": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShareMetaLabelModel"
            }
          }
        },
        "required": [
          "object",
          "title",
          "description",
          "image",
          "image_alt",
          "image_width",
          "image_height",
          "image_type",
          "theme_color",
          "locale",
          "url",
          "labels"
        ]
      },
      "ShiftCashModel": {
        "type": "object",
        "properties": {
          "float": {
            "type": "integer"
          },
          "sales": {
            "type": "integer"
          },
          "refunds": {
            "type": "integer"
          },
          "pay_ins": {
            "type": "integer"
          },
          "pay_outs": {
            "type": "integer"
          },
          "drops": {
            "type": "integer"
          },
          "tip_outs": {
            "type": "integer"
          },
          "deposit_refunds": {
            "type": "integer"
          },
          "expected": {
            "type": "integer"
          }
        },
        "required": [
          "float",
          "sales",
          "refunds",
          "pay_ins",
          "pay_outs",
          "drops",
          "tip_outs",
          "deposit_refunds",
          "expected"
        ]
      },
      "ShiftCountedModel": {
        "type": "object",
        "properties": {
          "total": {
            "type": "integer"
          },
          "denominations": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DenominationCountModel"
            }
          }
        },
        "required": [
          "total",
          "denominations"
        ]
      },
      "ShiftList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShiftModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ShiftModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "register": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "business_day": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "open",
              "closed"
            ],
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "float_amount": {
            "type": "integer"
          },
          "opened_by": {
            "$ref": "#/components/schemas/EventActorModel"
          },
          "opened_at": {
            "type": "integer"
          },
          "day_ends_at": {
            "type": "integer"
          },
          "across_cutoff": {
            "type": "boolean"
          },
          "auto_close_at": {
            "type": "integer"
          },
          "closed_by": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/EventActorModel"
              }
            ],
            "nullable": true
          },
          "closed_at": {
            "nullable": true,
            "type": "integer"
          },
          "auto_closed": {
            "type": "boolean"
          },
          "expected": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ShiftCashModel"
              }
            ],
            "nullable": true
          },
          "counted": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ShiftCountedModel"
              }
            ],
            "nullable": true
          },
          "variance_amount": {
            "nullable": true,
            "type": "integer"
          },
          "variance_note": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "register",
          "location",
          "business_day",
          "status",
          "currency",
          "float_amount",
          "opened_by",
          "opened_at",
          "day_ends_at",
          "across_cutoff",
          "auto_close_at",
          "closed_by",
          "closed_at",
          "auto_closed",
          "expected",
          "counted",
          "variance_amount",
          "variance_note",
          "created"
        ]
      },
      "ShiftOrderCountsModel": {
        "type": "object",
        "properties": {
          "sales": {
            "type": "integer"
          },
          "returns": {
            "type": "integer"
          },
          "voided": {
            "type": "integer"
          },
          "open": {
            "type": "integer"
          }
        },
        "required": [
          "sales",
          "returns",
          "voided",
          "open"
        ]
      },
      "ShiftReportModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "shift": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "x",
              "z"
            ],
            "minLength": 1
          },
          "at": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "orders": {
            "$ref": "#/components/schemas/ShiftOrderCountsModel"
          },
          "takings": {
            "$ref": "#/components/schemas/ShiftTakingsModel"
          },
          "by_tender": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TenderSummaryModel"
            }
          },
          "by_staff": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StaffSummaryModel"
            }
          },
          "tax_by_rate": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TaxByRateModel"
            }
          },
          "lines_total": {
            "type": "integer"
          },
          "discounts": {
            "type": "integer"
          },
          "refunds": {
            "type": "integer"
          },
          "voids": {
            "$ref": "#/components/schemas/VoidSummaryModel"
          },
          "tips": {
            "type": "integer"
          },
          "service_charge": {
            "type": "integer"
          },
          "no_sales": {
            "type": "integer"
          },
          "cash": {
            "$ref": "#/components/schemas/ShiftCashModel"
          },
          "counted": {
            "nullable": true,
            "type": "integer"
          },
          "variance": {
            "nullable": true,
            "type": "integer"
          },
          "needs_review": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShiftReviewModel"
            }
          }
        },
        "required": [
          "object",
          "shift",
          "kind",
          "at",
          "currency",
          "orders",
          "takings",
          "by_tender",
          "by_staff",
          "tax_by_rate",
          "lines_total",
          "discounts",
          "refunds",
          "voids",
          "tips",
          "service_charge",
          "no_sales",
          "cash",
          "counted",
          "variance",
          "needs_review"
        ]
      },
      "ShiftReviewModel": {
        "type": "object",
        "properties": {
          "order": {
            "type": "string",
            "minLength": 1
          },
          "number": {
            "type": "integer"
          },
          "reason": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "order",
          "number",
          "reason"
        ]
      },
      "ShiftTakingsModel": {
        "type": "object",
        "properties": {
          "by_category": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CategorySummaryModel"
            }
          },
          "service_charge": {
            "type": "integer"
          },
          "tax": {
            "type": "integer"
          },
          "tips": {
            "type": "integer"
          },
          "cash_rounding": {
            "type": "integer"
          },
          "total": {
            "type": "integer"
          }
        },
        "required": [
          "by_category",
          "service_charge",
          "tax",
          "tips",
          "cash_rounding",
          "total"
        ]
      },
      "ShipBody": {
        "type": "object",
        "properties": {
          "tracking_number": {
            "nullable": true,
            "type": "string",
            "maxLength": 60
          },
          "carrier": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          }
        }
      },
      "ShipToModel": {
        "type": "object",
        "properties": {
          "name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "line1": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "line2": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "city": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "region": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "postcode": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "country": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "name",
          "line1",
          "line2",
          "city",
          "region",
          "postcode",
          "country"
        ]
      },
      "ShipmentAvailableForPickupEvent": {
        "type": "object",
        "description": "The `shipment.available_for_pickup` event (the store's delivery events): `data.object` is the `shipment`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "shipment.available_for_pickup"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ShipmentEventData"
          }
        }
      },
      "ShipmentDeliveredEvent": {
        "type": "object",
        "description": "The `shipment.delivered` event (the store's delivery events): `data.object` is the `shipment`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "shipment.delivered"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ShipmentEventData"
          }
        }
      },
      "ShipmentEventData": {
        "type": "object",
        "description": "What an event carrying a `shipment` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/ShipmentEventObject"
          }
        }
      },
      "ShipmentEventObject": {
        "type": "object",
        "description": "A `shipment` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "shipment"
          }
        },
        "additionalProperties": true
      },
      "ShipmentExceptionEvent": {
        "type": "object",
        "description": "The `shipment.exception` event (the store's delivery events): `data.object` is the `shipment`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "shipment.exception"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ShipmentEventData"
          }
        }
      },
      "ShipmentInTransitEvent": {
        "type": "object",
        "description": "The `shipment.in_transit` event (the store's delivery events): `data.object` is the `shipment`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "shipment.in_transit"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ShipmentEventData"
          }
        }
      },
      "ShipmentOutForDeliveryEvent": {
        "type": "object",
        "description": "The `shipment.out_for_delivery` event (the store's delivery events): `data.object` is the `shipment`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "shipment.out_for_delivery"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ShipmentEventData"
          }
        }
      },
      "ShipmentReturnedToSenderEvent": {
        "type": "object",
        "description": "The `shipment.returned_to_sender` event (the store's delivery events): `data.object` is the `shipment`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "shipment.returned_to_sender"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ShipmentEventData"
          }
        }
      },
      "ShipmentUpdatedEvent": {
        "type": "object",
        "description": "The `shipment.updated` event (the store's delivery events): `data.object` is the `shipment`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "shipment.updated"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ShipmentEventData"
          }
        }
      },
      "ShippingAddressBody": {
        "type": "object",
        "properties": {
          "line1": {
            "type": "string",
            "maxLength": 200
          },
          "line2": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          },
          "city": {
            "type": "string",
            "maxLength": 100
          },
          "postal_code": {
            "type": "string",
            "maxLength": 20
          },
          "state": {
            "nullable": true,
            "type": "string",
            "maxLength": 100
          },
          "country": {
            "type": "string",
            "maxLength": 2
          }
        }
      },
      "ShippingAddressModel": {
        "type": "object",
        "properties": {
          "line1": {
            "type": "string",
            "minLength": 1
          },
          "line2": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "city": {
            "type": "string",
            "minLength": 1
          },
          "postal_code": {
            "type": "string",
            "minLength": 1
          },
          "state": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "country": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "line1",
          "line2",
          "city",
          "postal_code",
          "state",
          "country"
        ]
      },
      "ShippingBandModel": {
        "type": "object",
        "properties": {
          "min": {
            "type": "integer"
          },
          "max": {
            "nullable": true,
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "min",
          "max",
          "amount"
        ]
      },
      "ShippingBody": {
        "type": "object",
        "properties": {
          "name": {
            "nullable": true,
            "type": "string",
            "maxLength": 24
          },
          "address": {
            "$ref": "#/components/schemas/ShippingAddressBody"
          },
          "service": {
            "type": "string",
            "enum": [
              "standard",
              "express",
              "priority"
            ]
          }
        }
      },
      "ShippingDeletedModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "deleted": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "object",
          "deleted"
        ]
      },
      "ShippingManifestList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShippingManifestModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ShippingManifestModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "day": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "carrier": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "failure": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "labels": {
            "type": "integer"
          },
          "tracking_numbers": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "location",
          "day",
          "kind",
          "carrier",
          "status",
          "failure",
          "labels",
          "tracking_numbers",
          "created"
        ]
      },
      "ShippingMarkupModel": {
        "type": "object",
        "properties": {
          "bps": {
            "type": "integer"
          },
          "fixed": {
            "type": "integer"
          }
        },
        "required": [
          "bps",
          "fixed"
        ]
      },
      "ShippingPackageList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShippingPackageModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ShippingPackageModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "length_mm": {
            "type": "integer"
          },
          "width_mm": {
            "type": "integer"
          },
          "height_mm": {
            "type": "integer"
          },
          "weight_g": {
            "type": "integer"
          },
          "is_default": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "name",
          "length_mm",
          "width_mm",
          "height_mm",
          "weight_g",
          "is_default"
        ]
      },
      "ShippingProfileList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShippingProfileModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ShippingProfileModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "is_default": {
            "type": "boolean"
          },
          "created_from": {
            "type": "string",
            "minLength": 1
          },
          "confirmed_at": {
            "nullable": true,
            "type": "integer"
          },
          "product_count": {
            "type": "integer"
          },
          "zones": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShippingZoneModel"
            }
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "name",
          "is_default",
          "created_from",
          "confirmed_at",
          "product_count",
          "zones",
          "created"
        ],
        "example": {
          "id": "shpr_01K7HBPZ5A7C9E1G3J5L7N9Q1S",
          "object": "shipping_profile",
          "livemode": false,
          "name": "Standard",
          "is_default": true,
          "created_from": "generated",
          "confirmed_at": 1791720000,
          "product_count": 42,
          "zones": [
            {
              "id": "shz_01K7HBQ06B8D0F2H4K6M8P0R2T",
              "object": "shipping_zone",
              "name": "United Kingdom",
              "countries": [
                "GB"
              ],
              "regions": [],
              "postcodes": [],
              "excluded_postcodes": [],
              "international": false,
              "enabled": true,
              "sort": 0,
              "rates": [
                {
                  "id": "shrt_01K7HBR17C9E1G3J5L7N9Q1S3V",
                  "object": "shipping_rate",
                  "name": "Royal Mail Tracked 48",
                  "kind": "flat",
                  "amount": 355,
                  "currency": "gbp",
                  "bands": [],
                  "free_over": 5000,
                  "service_code": "royal_mail_tracked_48",
                  "fallback_amount": null,
                  "markup": null,
                  "location": null,
                  "min_order": null,
                  "max_weight_g": 20000,
                  "transit_days": {
                    "min": 2,
                    "max": 3
                  },
                  "delivery_days": [
                    "mon",
                    "tue",
                    "wed",
                    "thu",
                    "fri",
                    "sat"
                  ],
                  "sort": 0,
                  "enabled": true
                }
              ]
            }
          ],
          "created": 1791720000
        }
      },
      "ShippingRateModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "bands": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShippingBandModel"
            }
          },
          "free_over": {
            "nullable": true,
            "type": "integer"
          },
          "service_code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "fallback_amount": {
            "nullable": true,
            "type": "integer"
          },
          "markup": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ShippingMarkupModel"
              }
            ],
            "nullable": true
          },
          "location": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "min_order": {
            "nullable": true,
            "type": "integer"
          },
          "max_weight_g": {
            "nullable": true,
            "type": "integer"
          },
          "transit_days": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/TransitDaysModel"
              }
            ],
            "nullable": true
          },
          "delivery_days": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "sort": {
            "type": "integer"
          },
          "enabled": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "object",
          "name",
          "kind",
          "amount",
          "currency",
          "bands",
          "free_over",
          "service_code",
          "fallback_amount",
          "markup",
          "location",
          "min_order",
          "max_weight_g",
          "transit_days",
          "delivery_days",
          "sort",
          "enabled"
        ]
      },
      "ShippingServiceList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShippingServiceModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "ShippingServiceModel": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "carrier": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "country": {
            "type": "string",
            "minLength": 1
          },
          "transit_days": {
            "$ref": "#/components/schemas/TransitDaysModel"
          },
          "delivers_on": {
            "type": "array",
            "items": {
              "type": "integer"
            }
          },
          "max_weight_g": {
            "type": "integer"
          },
          "max_length_mm": {
            "type": "integer"
          },
          "age_verified": {
            "type": "boolean"
          },
          "signature": {
            "type": "boolean"
          },
          "locker": {
            "type": "boolean"
          },
          "international": {
            "type": "boolean"
          },
          "returns": {
            "type": "boolean"
          },
          "voidable": {
            "type": "boolean"
          }
        },
        "required": [
          "code",
          "object",
          "carrier",
          "name",
          "country",
          "transit_days",
          "delivers_on",
          "max_weight_g",
          "max_length_mm",
          "age_verified",
          "signature",
          "locker",
          "international",
          "returns",
          "voidable"
        ]
      },
      "ShippingWebhookReceiptModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "recorded": {
            "type": "integer",
            "multipleOf": 1
          },
          "duplicates": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "object",
          "recorded",
          "duplicates"
        ]
      },
      "ShippingZoneModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "countries": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "regions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "postcodes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "excluded_postcodes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "international": {
            "type": "boolean"
          },
          "enabled": {
            "type": "boolean"
          },
          "sort": {
            "type": "integer"
          },
          "rates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShippingRateModel"
            }
          }
        },
        "required": [
          "id",
          "object",
          "name",
          "countries",
          "regions",
          "postcodes",
          "excluded_postcodes",
          "international",
          "enabled",
          "sort",
          "rates"
        ]
      },
      "ShortLinkBody": {
        "type": "object",
        "properties": {
          "service": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "staff": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "ch": {
            "type": "string",
            "maxLength": 40
          }
        }
      },
      "SimulateDisputeBody": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "enum": [
              "fraudulent",
              "product_not_received",
              "product_unacceptable",
              "duplicate",
              "subscription_canceled",
              "credit_not_processed",
              "unrecognized",
              "general"
            ]
          },
          "inquiry": {
            "type": "boolean"
          }
        }
      },
      "SimulatedFraudRiskBody": {
        "type": "object",
        "properties": {
          "level": {
            "type": "string",
            "enum": [
              "low",
              "normal",
              "elevated",
              "highest",
              "not_assessed",
              "unknown"
            ],
            "minLength": 1
          },
          "score": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "level"
        ]
      },
      "SimulatedLevelBody": {
        "type": "object",
        "properties": {
          "level": {
            "type": "string",
            "enum": [
              "low",
              "normal",
              "elevated",
              "highest",
              "not_assessed",
              "unknown"
            ],
            "minLength": 1
          }
        },
        "required": [
          "level"
        ]
      },
      "SimulatedMerchantBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 100
          },
          "network_id": {
            "nullable": true,
            "type": "string",
            "maxLength": 60
          },
          "mcc": {
            "type": "integer",
            "multipleOf": 1
          },
          "country": {
            "nullable": true,
            "type": "string",
            "maxLength": 2
          }
        }
      },
      "SimulatedPurchaseBody": {
        "type": "object",
        "properties": {
          "card": {
            "type": "string"
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "merchant": {
            "$ref": "#/components/schemas/SimulatedMerchantBody"
          },
          "merchant_currency": {
            "type": "string",
            "maxLength": 3
          },
          "merchant_amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "three_d_secure": {
            "type": "string",
            "enum": [
              "authenticated",
              "attempt_acknowledged",
              "required"
            ]
          },
          "risk_assessment": {
            "$ref": "#/components/schemas/SimulatedRiskAssessmentBody"
          },
          "verification_data": {
            "$ref": "#/components/schemas/SimulatedVerificationBody"
          },
          "verified_by_fraud_challenge": {
            "type": "boolean"
          }
        }
      },
      "SimulatedRiskAssessmentBody": {
        "type": "object",
        "properties": {
          "fraud_risk": {
            "$ref": "#/components/schemas/SimulatedFraudRiskBody"
          },
          "merchant_dispute_risk": {
            "$ref": "#/components/schemas/SimulatedLevelBody"
          },
          "card_testing_risk": {
            "$ref": "#/components/schemas/SimulatedLevelBody"
          }
        }
      },
      "SimulatedVerificationBody": {
        "type": "object",
        "properties": {
          "cvc_check": {
            "type": "string",
            "enum": [
              "match",
              "mismatch",
              "not_provided"
            ]
          },
          "expiry_check": {
            "type": "string",
            "enum": [
              "match",
              "mismatch",
              "not_provided"
            ]
          },
          "address_line1_check": {
            "type": "string",
            "enum": [
              "match",
              "mismatch",
              "not_provided"
            ]
          },
          "address_postal_code_check": {
            "type": "string",
            "enum": [
              "match",
              "mismatch",
              "not_provided"
            ]
          }
        }
      },
      "SiteBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 120
          },
          "brand": {
            "nullable": true
          },
          "navigation": {
            "nullable": true
          },
          "seo": {
            "nullable": true
          },
          "settings": {
            "nullable": true
          },
          "home": {
            "type": "string",
            "maxLength": 12
          },
          "headless_origins": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "headless_enabled": {
            "type": "boolean"
          }
        }
      },
      "SiteCheckoutsPausedModel": {
        "type": "object",
        "properties": {
          "at": {
            "type": "integer"
          },
          "reason": {
            "type": "string",
            "minLength": 1
          },
          "code": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "at",
          "reason",
          "code"
        ]
      },
      "SiteCodeSectionList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SiteCodeSectionModel"
            }
          }
        },
        "required": [
          "object",
          "data"
        ]
      },
      "SiteCodeSectionModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "code": {
            "type": "string",
            "minLength": 1
          },
          "compressed_bytes": {
            "type": "integer"
          },
          "fallback": {
            "nullable": true
          },
          "author": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "site",
          "name",
          "title",
          "code",
          "compressed_bytes",
          "fallback",
          "author",
          "created"
        ]
      },
      "SiteDesignFileModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "format": {
            "type": "integer"
          },
          "tsf_version": {
            "type": "integer"
          },
          "brand": {
            "nullable": true
          },
          "sections": {
            "type": "array",
            "items": {
              "nullable": true
            }
          },
          "code_sections": {
            "type": "array",
            "items": {
              "nullable": true
            }
          },
          "pages": {
            "type": "array",
            "items": {
              "nullable": true
            }
          }
        },
        "required": [
          "object",
          "format",
          "tsf_version",
          "brand",
          "sections",
          "code_sections",
          "pages"
        ]
      },
      "SiteDesignImportModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "sections": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ImportedSectionModel"
            }
          },
          "code_sections": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ImportedCodeSectionModel"
            }
          },
          "pages": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ImportedPageModel"
            }
          },
          "skipped": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SkippedModel"
            }
          },
          "brand": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "sections",
          "code_sections",
          "pages",
          "skipped",
          "brand"
        ]
      },
      "SiteDomainBody": {
        "type": "object",
        "properties": {
          "hostname": {
            "type": "string",
            "maxLength": 300,
            "minLength": 1
          }
        },
        "required": [
          "hostname"
        ]
      },
      "SiteDomainForwardingModel": {
        "type": "object",
        "properties": {
          "from": {
            "type": "string",
            "minLength": 1
          },
          "to": {
            "type": "string",
            "minLength": 1
          },
          "instructions": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "from",
          "to",
          "instructions"
        ]
      },
      "SiteDomainList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SiteDomainModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "SiteDomainModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "hostname": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "role": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "records": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SiteDomainRecordModel"
            }
          },
          "error": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "forwarding": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/SiteDomainForwardingModel"
              }
            ],
            "nullable": true
          },
          "checked": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "site",
          "hostname",
          "kind",
          "role",
          "status",
          "records",
          "error",
          "forwarding",
          "checked",
          "created"
        ]
      },
      "SiteDomainRecordModel": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "value": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "type",
          "name",
          "value"
        ]
      },
      "SiteEventData": {
        "type": "object",
        "description": "What an event carrying a `site` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/SiteModel"
          }
        }
      },
      "SiteFontBody": {
        "type": "object",
        "properties": {
          "source": {
            "type": "string",
            "maxLength": 12,
            "minLength": 1
          },
          "role": {
            "type": "string",
            "maxLength": 12,
            "minLength": 1
          },
          "family": {
            "type": "string",
            "maxLength": 60
          },
          "weights": {
            "type": "array",
            "items": {
              "type": "integer"
            }
          },
          "italic": {
            "type": "boolean"
          },
          "data": {
            "type": "string",
            "maxLength": 1000000
          },
          "category": {
            "type": "string",
            "maxLength": 20
          },
          "licence_confirmed": {
            "type": "boolean"
          }
        },
        "required": [
          "source",
          "role"
        ]
      },
      "SiteFontFileModel": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "minLength": 1
          },
          "weight": {
            "type": "string",
            "minLength": 1
          },
          "style": {
            "type": "string",
            "minLength": 1
          },
          "unicode_range": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "url",
          "weight",
          "style",
          "unicode_range"
        ]
      },
      "SiteFontLicenceModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "confirmed_at": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "kind",
          "confirmed_at"
        ]
      },
      "SiteFontLimitsModel": {
        "type": "object",
        "properties": {
          "families": {
            "type": "integer",
            "multipleOf": 1
          },
          "styles": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "families",
          "styles"
        ]
      },
      "SiteFontModel": {
        "type": "object",
        "properties": {
          "family": {
            "type": "string",
            "minLength": 1
          },
          "source": {
            "type": "string",
            "minLength": 1
          },
          "role": {
            "type": "string",
            "minLength": 1
          },
          "category": {
            "type": "string",
            "minLength": 1
          },
          "files": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SiteFontFileModel"
            }
          },
          "licence": {
            "$ref": "#/components/schemas/SiteFontLicenceModel"
          }
        },
        "required": [
          "family",
          "source",
          "role",
          "category",
          "files",
          "licence"
        ]
      },
      "SiteFontsModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "fonts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SiteFontModel"
            }
          },
          "heading": {
            "type": "string",
            "minLength": 1
          },
          "body": {
            "type": "string",
            "minLength": 1
          },
          "limits": {
            "$ref": "#/components/schemas/SiteFontLimitsModel"
          }
        },
        "required": [
          "object",
          "site",
          "fonts",
          "heading",
          "body",
          "limits"
        ]
      },
      "SiteList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SiteModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "SiteModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "slug": {
            "type": "string",
            "minLength": 1
          },
          "previous_slug": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "slug_redirect_until": {
            "nullable": true,
            "type": "integer"
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "brand": {
            "nullable": true
          },
          "navigation": {
            "nullable": true
          },
          "seo": {
            "nullable": true
          },
          "locale": {
            "type": "string",
            "minLength": 1
          },
          "store_enabled": {
            "type": "boolean"
          },
          "home": {
            "type": "string",
            "minLength": 1
          },
          "published_version": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "scheduled_version": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "scheduled_at": {
            "nullable": true,
            "type": "integer"
          },
          "headless_origins": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "headless_enabled": {
            "type": "boolean"
          },
          "settings": {
            "nullable": true
          },
          "booking_page": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "domains": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SiteDomainModel"
            }
          },
          "free_address": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "subdomain_address": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          },
          "checkouts_paused": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/SiteCheckoutsPausedModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "slug",
          "previous_slug",
          "slug_redirect_until",
          "name",
          "brand",
          "navigation",
          "seo",
          "locale",
          "store_enabled",
          "home",
          "published_version",
          "scheduled_version",
          "scheduled_at",
          "headless_origins",
          "headless_enabled",
          "settings",
          "booking_page",
          "domains",
          "free_address",
          "subdomain_address",
          "created",
          "checkouts_paused"
        ],
        "example": {
          "id": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
          "object": "site",
          "livemode": false,
          "slug": "harbourgifts",
          "previous_slug": null,
          "slug_redirect_until": null,
          "name": "Harbour Gifts",
          "brand": {
            "colours": {
              "primary": "oklch(42% 0.09 230)",
              "surface": "oklch(98% 0.01 90)"
            },
            "type": {
              "pair": "editorial"
            },
            "radius": "soft",
            "logo": {
              "primary": "med_01K7HB3A5C7E9G1J3L5N7Q9S1U",
              "mark": null,
              "on_dark": null
            },
            "seed": {
              "header": {
                "logo_placement": "left"
              },
              "hero": {
                "image": null
              }
            }
          },
          "navigation": {
            "header": [
              {
                "label": "Candles",
                "target": {
                  "kind": "collection",
                  "ref": "coll_01K7HB4D6F8H0K2M4P6R8T0V2X"
                }
              },
              {
                "label": "Book a workshop",
                "target": {
                  "kind": "booking"
                }
              }
            ],
            "footer": [
              {
                "title": "Help",
                "items": [
                  {
                    "label": "Delivery and returns",
                    "target": {
                      "kind": "path",
                      "path": "/delivery"
                    }
                  }
                ]
              }
            ]
          },
          "seo": {
            "title_template": "{page} | {site}",
            "description": "Candles, mugs and gifts made by the sea in Whitby.",
            "social_image": "med_01K7HB3A5C7E9G1J3L5N7Q9S1U",
            "noindex": false
          },
          "locale": "en-GB",
          "store_enabled": true,
          "home": "store",
          "published_version": "sver_01K7HB5E7G9J1L3N5Q7S9U1W3Y",
          "scheduled_version": null,
          "scheduled_at": null,
          "headless_origins": [
            "https://www.harbourgifts.example"
          ],
          "headless_enabled": true,
          "settings": {
            "ship_from_location": "loc_01J8ZK2B4D6F8H0K2M4P6R8T0V",
            "delivery": null,
            "checkout": {
              "note_enabled": true,
              "marketing_text": null
            },
            "trader": {
              "legal_name": "Harbour Gifts Ltd",
              "trading_name": "Harbour Gifts",
              "address": null,
              "email": "hello@harbourgifts.example",
              "phone": null,
              "vat_number": "GB123456789",
              "vat_registered": true
            },
            "ai_training_crawlers": false
          },
          "booking_page": "bpage_01J8ZK3C5E7G9J1L3N5Q7S9U1W",
          "domains": [
            {
              "id": "sitedom_01K7HB6F8H0K2M4P6R8T0V2X4Z",
              "object": "site_domain",
              "livemode": false,
              "site": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
              "hostname": "shop.harbourgifts.example",
              "kind": "custom",
              "role": "primary",
              "status": "active",
              "records": [],
              "error": null,
              "forwarding": null,
              "checked": 1792310400,
              "created": 1791720000
            }
          ],
          "free_address": "https://shop.tuppence.ai/test/harbourgifts",
          "subdomain_address": "https://harbourgifts.tuppence.shop",
          "created": 1791720000,
          "checkouts_paused": null
        }
      },
      "SiteNotFoundList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SiteNotFoundModel"
            }
          }
        },
        "required": [
          "object",
          "data"
        ]
      },
      "SiteNotFoundModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "path": {
            "type": "string",
            "minLength": 1
          },
          "hits": {
            "type": "integer",
            "multipleOf": 1
          },
          "most_in_a_day": {
            "type": "integer",
            "multipleOf": 1
          },
          "last_seen": {
            "type": "string",
            "minLength": 1
          },
          "suggestion": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/NotFoundSuggestionModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "object",
          "path",
          "hits",
          "most_in_a_day",
          "last_seen",
          "suggestion"
        ]
      },
      "SitePageBody": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "maxLength": 24
          },
          "slug": {
            "type": "string",
            "maxLength": 80
          },
          "path": {
            "nullable": true,
            "type": "string"
          },
          "title": {
            "type": "string",
            "maxLength": 120
          },
          "blocks": {
            "type": "array",
            "items": {
              "nullable": true
            }
          },
          "seo": {
            "nullable": true
          }
        }
      },
      "SitePageList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SitePageModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "SitePageModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "slug": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "path": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "blocks": {
            "type": "array",
            "items": {
              "nullable": true
            }
          },
          "seo": {
            "nullable": true
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "claims_status": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "updated_by": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          },
          "updated": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "site",
          "kind",
          "slug",
          "path",
          "title",
          "blocks",
          "seo",
          "status",
          "claims_status",
          "updated_by",
          "created",
          "updated"
        ],
        "example": {
          "id": "spg_01K7HB7G9J1L3N5Q7S9U1W3Y5A",
          "object": "site_page",
          "livemode": false,
          "site": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
          "kind": "page",
          "slug": "our-story",
          "path": "/our-story",
          "title": "Our story",
          "blocks": [
            {
              "id": "blk_01",
              "type": "rich_text",
              "props": {
                "heading": "Made by the sea",
                "body": "We pour every candle in our Whitby workshop."
              }
            }
          ],
          "seo": {
            "title": "Our story",
            "description": "How Harbour Gifts began."
          },
          "status": "draft",
          "claims_status": "passed",
          "updated_by": "usr_01J8ZK0A2C4E6G8J0L2N4Q6S8U",
          "created": 1791720000,
          "updated": 1792310400
        }
      },
      "SitePolicyList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SitePolicyModel"
            }
          }
        },
        "required": [
          "object",
          "data"
        ]
      },
      "SitePolicyModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "terms_of_sale",
              "returns",
              "delivery",
              "privacy",
              "cookies",
              "accessibility",
              "product_safety"
            ],
            "minLength": 1
          },
          "path": {
            "type": "string",
            "minLength": 1
          },
          "live_version": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/SitePolicyVersionModel"
              }
            ],
            "nullable": true
          },
          "draft_version": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/SitePolicyVersionModel"
              }
            ],
            "nullable": true
          },
          "created": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "site",
          "kind",
          "path",
          "live_version",
          "draft_version",
          "created"
        ]
      },
      "SitePolicyVersionEventData": {
        "type": "object",
        "description": "What an event carrying a `site_policy_version` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/SitePolicyVersionEventObject"
          }
        }
      },
      "SitePolicyVersionEventObject": {
        "type": "object",
        "description": "A `site_policy_version` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "site_policy_version"
          }
        },
        "additionalProperties": true
      },
      "SitePolicyVersionList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SitePolicyVersionModel"
            }
          }
        },
        "required": [
          "object",
          "data"
        ]
      },
      "SitePolicyVersionModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "policy": {
            "type": "string",
            "minLength": 1
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "terms_of_sale",
              "returns",
              "delivery",
              "privacy",
              "cookies",
              "accessibility",
              "product_safety"
            ],
            "minLength": 1
          },
          "version": {
            "type": "integer",
            "multipleOf": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "template": {
            "type": "string",
            "minLength": 1
          },
          "template_version": {
            "type": "string",
            "minLength": 1
          },
          "template_reviewed": {
            "type": "boolean"
          },
          "inputs": {
            "nullable": true
          },
          "inputs_digest": {
            "type": "string",
            "minLength": 1
          },
          "body": {
            "type": "array",
            "items": {
              "nullable": true
            }
          },
          "own_words": {
            "nullable": true
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "live",
              "superseded"
            ],
            "minLength": 1
          },
          "approved_by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "approved_at": {
            "nullable": true,
            "type": "integer"
          },
          "published_at": {
            "nullable": true,
            "type": "integer"
          },
          "superseded_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "policy",
          "site",
          "kind",
          "version",
          "title",
          "template",
          "template_version",
          "template_reviewed",
          "inputs",
          "inputs_digest",
          "body",
          "own_words",
          "status",
          "approved_by",
          "approved_at",
          "published_at",
          "superseded_at",
          "created"
        ]
      },
      "SitePreviewTokenModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "token": {
            "type": "string",
            "minLength": 1
          },
          "url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "token",
          "url"
        ]
      },
      "SitePublishBody": {
        "type": "object",
        "properties": {
          "note": {
            "type": "string",
            "maxLength": 200
          }
        }
      },
      "SiteReadinessGapModel": {
        "type": "object",
        "properties": {
          "item": {
            "type": "string",
            "minLength": 1
          },
          "message": {
            "type": "string",
            "minLength": 1
          },
          "fix_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "item",
          "message",
          "fix_url"
        ]
      },
      "SiteReadinessModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "ready": {
            "type": "boolean"
          },
          "sells_online": {
            "type": "boolean"
          },
          "gaps": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SiteReadinessGapModel"
            }
          },
          "warnings": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SiteReadinessWarningModel"
            }
          }
        },
        "required": [
          "object",
          "site",
          "ready",
          "sells_online",
          "gaps",
          "warnings"
        ]
      },
      "SiteReadinessWarningModel": {
        "type": "object",
        "properties": {
          "item": {
            "type": "string",
            "minLength": 1
          },
          "product": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "message": {
            "type": "string",
            "minLength": 1
          },
          "fix_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "item",
          "product",
          "message",
          "fix_url"
        ]
      },
      "SiteRedirectBody": {
        "type": "object",
        "properties": {
          "from_path": {
            "type": "string",
            "maxLength": 1000,
            "minLength": 1
          },
          "to_path": {
            "type": "string",
            "maxLength": 1000,
            "minLength": 1
          }
        },
        "required": [
          "from_path",
          "to_path"
        ]
      },
      "SiteRedirectList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SiteRedirectModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "SiteRedirectModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "from_path": {
            "type": "string",
            "minLength": 1
          },
          "to_path": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "integer",
            "multipleOf": 1
          },
          "source": {
            "type": "string",
            "minLength": 1
          },
          "hits": {
            "type": "integer",
            "multipleOf": 1
          },
          "last_hit_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "site",
          "from_path",
          "to_path",
          "status",
          "source",
          "hits",
          "last_hit_at",
          "created"
        ]
      },
      "SiteRenderContextBody": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "maxLength": 24
          },
          "title": {
            "type": "string",
            "maxLength": 120
          },
          "blocks": {
            "type": "array",
            "items": {
              "nullable": true
            }
          }
        }
      },
      "SiteRenderContextModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "context": {
            "nullable": true
          },
          "sections": {
            "nullable": true
          },
          "section_copy": {
            "nullable": true
          },
          "style_layer": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "context",
          "sections",
          "section_copy",
          "style_layer"
        ]
      },
      "SiteScheduleBody": {
        "type": "object",
        "properties": {
          "at": {
            "type": "integer",
            "multipleOf": 1
          },
          "note": {
            "type": "string",
            "maxLength": 200
          }
        },
        "required": [
          "at"
        ]
      },
      "SiteSectionList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SiteSectionModel"
            }
          }
        },
        "required": [
          "object",
          "data"
        ]
      },
      "SiteSectionModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "current_version": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/SiteSectionVersionModel"
              }
            ],
            "nullable": true
          },
          "used_on": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SiteSectionUseModel"
            }
          },
          "versions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SiteSectionVersionModel"
            }
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "site",
          "name",
          "current_version",
          "used_on",
          "versions",
          "created"
        ]
      },
      "SiteSectionUseModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "title",
          "kind"
        ]
      },
      "SiteSectionVersionModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "section": {
            "type": "string",
            "minLength": 1
          },
          "number": {
            "type": "integer"
          },
          "author": {
            "type": "string",
            "minLength": 1
          },
          "source": {
            "nullable": true
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "section",
          "number",
          "author",
          "source",
          "created"
        ]
      },
      "SiteSectionWriteModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "section": {
            "$ref": "#/components/schemas/SiteSectionModel"
          },
          "checks": {
            "$ref": "#/components/schemas/SectionCheckModel"
          }
        },
        "required": [
          "object",
          "section",
          "checks"
        ]
      },
      "SiteSlugBody": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          }
        },
        "required": [
          "slug"
        ]
      },
      "SiteTranslationLanguageBody": {
        "type": "object",
        "properties": {
          "locale": {
            "type": "string",
            "maxLength": 8,
            "minLength": 1
          }
        },
        "required": [
          "locale"
        ]
      },
      "SiteTranslationList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "languages": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SiteTranslationModel"
            }
          }
        },
        "required": [
          "object",
          "languages",
          "data"
        ]
      },
      "SiteTranslationModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "id": {
            "type": "string",
            "minLength": 1
          },
          "locale": {
            "type": "string",
            "minLength": 1
          },
          "object_type": {
            "type": "string",
            "minLength": 1
          },
          "object_id": {
            "type": "string",
            "minLength": 1
          },
          "field": {
            "type": "string",
            "minLength": 1
          },
          "text": {
            "type": "string",
            "minLength": 1
          },
          "source": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "product_title": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "approved",
              "stale"
            ],
            "minLength": 1
          },
          "approved_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "object",
          "id",
          "locale",
          "object_type",
          "object_id",
          "field",
          "text",
          "source",
          "product_title",
          "status",
          "approved_at"
        ]
      },
      "SiteTranslationResult": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "locale": {
            "type": "string",
            "minLength": 1
          },
          "count": {
            "type": "integer"
          }
        },
        "required": [
          "object",
          "locale",
          "count"
        ]
      },
      "SiteVersionList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SiteVersionModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "SiteVersionModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "number": {
            "type": "integer"
          },
          "live": {
            "type": "boolean"
          },
          "published_at": {
            "nullable": true,
            "type": "integer"
          },
          "scheduled_at": {
            "nullable": true,
            "type": "integer"
          },
          "published_by": {
            "type": "string",
            "minLength": 1
          },
          "source": {
            "type": "string",
            "minLength": 1
          },
          "note": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "snapshot_sha256": {
            "type": "string",
            "minLength": 1
          },
          "snapshot": {
            "nullable": true
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "site",
          "number",
          "live",
          "published_at",
          "scheduled_at",
          "published_by",
          "source",
          "note",
          "snapshot_sha256",
          "snapshot",
          "created"
        ],
        "example": {
          "id": "sver_01K7HB5E7G9J1L3N5Q7S9U1W3Y",
          "object": "site_version",
          "livemode": false,
          "site": "site_01K7HB0GF2ZD7QW3T5V8X9Y1A2",
          "number": 12,
          "live": true,
          "published_at": 1792310400,
          "scheduled_at": null,
          "published_by": "usr_01J8ZK0A2C4E6G8J0L2N4Q6S8U",
          "source": "person",
          "note": "Autumn candles",
          "snapshot_sha256": "9f2c4e6a8b0d2f4a6c8e0b2d4f6a8c0e2b4d6f8a0c2e4b6d8f0a2c4e6b8d0f2a",
          "snapshot": null,
          "created": 1792310400
        }
      },
      "SkippedModel": {
        "type": "object",
        "properties": {
          "what": {
            "type": "string",
            "minLength": 1
          },
          "key": {
            "type": "string",
            "minLength": 1
          },
          "reason": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "what",
          "key",
          "reason"
        ]
      },
      "SmallTicketsModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "days": {
            "type": "integer"
          },
          "threshold": {
            "type": "integer"
          },
          "payments": {
            "type": "integer"
          },
          "small_payments": {
            "type": "integer"
          },
          "small_share": {
            "type": "integer"
          },
          "small_volume": {
            "type": "integer"
          },
          "fees_paid": {
            "type": "integer"
          },
          "fees_as_credit": {
            "type": "integer"
          },
          "saving": {
            "type": "integer"
          },
          "not_steerable": {
            "type": "integer"
          }
        },
        "required": [
          "object",
          "livemode",
          "currency",
          "days",
          "threshold",
          "payments",
          "small_payments",
          "small_share",
          "small_volume",
          "fees_paid",
          "fees_as_credit",
          "saving",
          "not_steerable"
        ]
      },
      "SnapBody": {
        "type": "object",
        "properties": {
          "media": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "note": {
            "type": "string",
            "maxLength": 500
          },
          "barcode": {
            "type": "string",
            "maxLength": 20
          },
          "location": {
            "type": "string",
            "maxLength": 40
          }
        },
        "required": [
          "media"
        ]
      },
      "SnapPhotoBody": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "studio",
              "lifestyle"
            ],
            "minLength": 1
          }
        },
        "required": [
          "kind"
        ]
      },
      "SnapPriceBandModel": {
        "type": "object",
        "properties": {
          "low": {
            "type": "integer",
            "multipleOf": 1
          },
          "high": {
            "type": "integer",
            "multipleOf": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "low",
          "high",
          "currency"
        ]
      },
      "SnapPublishBody": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          },
          "stock": {
            "type": "integer",
            "maximum": 1000000,
            "minimum": 0,
            "multipleOf": 1
          },
          "location": {
            "type": "string",
            "maxLength": 40
          },
          "channels": {
            "type": "array",
            "items": {
              "enum": [
                "till",
                "online",
                "booking_page"
              ],
              "type": "string"
            }
          }
        },
        "required": [
          "amount"
        ]
      },
      "SnapStageModel": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "minLength": 1
          },
          "started_at": {
            "nullable": true,
            "type": "integer"
          },
          "finished_at": {
            "nullable": true,
            "type": "integer"
          },
          "note": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "status",
          "started_at",
          "finished_at",
          "note"
        ]
      },
      "SnapStagesModel": {
        "type": "object",
        "properties": {
          "read": {
            "$ref": "#/components/schemas/SnapStageModel"
          },
          "lookup": {
            "$ref": "#/components/schemas/SnapStageModel"
          },
          "clean": {
            "$ref": "#/components/schemas/SnapStageModel"
          },
          "claims": {
            "$ref": "#/components/schemas/SnapStageModel"
          },
          "lifestyle": {
            "$ref": "#/components/schemas/SnapStageModel"
          },
          "draft": {
            "$ref": "#/components/schemas/SnapStageModel"
          }
        },
        "required": [
          "read",
          "lookup",
          "clean",
          "claims",
          "lifestyle",
          "draft"
        ]
      },
      "SnapWeightModel": {
        "type": "object",
        "properties": {
          "weight_class": {
            "type": "string",
            "minLength": 1
          },
          "label": {
            "type": "string",
            "minLength": 1
          },
          "estimate_g": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "weight_class",
          "label",
          "estimate_g"
        ]
      },
      "SnapshotCancellationModel": {
        "type": "object",
        "properties": {
          "version": {
            "type": "string",
            "minLength": 1
          },
          "days": {
            "type": "integer"
          },
          "text": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "version",
          "days",
          "text"
        ]
      },
      "SnapshotDigitalConsentModel": {
        "type": "object",
        "properties": {
          "text": {
            "type": "string",
            "minLength": 1
          },
          "at": {
            "type": "integer"
          }
        },
        "required": [
          "text",
          "at"
        ]
      },
      "SnapshotDiscountModel": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "free_delivery": {
            "type": "boolean"
          }
        },
        "required": [
          "code",
          "name",
          "amount",
          "free_delivery"
        ]
      },
      "SnapshotGiftCardModel": {
        "type": "object",
        "properties": {
          "last4": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "last4",
          "amount"
        ]
      },
      "SnapshotLineModel": {
        "type": "object",
        "properties": {
          "line": {
            "type": "string",
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "variant": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "unit_amount": {
            "type": "integer"
          },
          "quantity": {
            "type": "integer"
          },
          "discount_amount": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "tax_amount": {
            "type": "integer"
          },
          "ships_on": {
            "type": "string"
          }
        },
        "required": [
          "line",
          "title",
          "variant",
          "unit_amount",
          "quantity",
          "discount_amount",
          "amount",
          "tax_amount"
        ]
      },
      "SnapshotTaxLineModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "rate_ppm": {
            "type": "integer"
          },
          "tax": {
            "type": "integer"
          },
          "inclusive": {
            "type": "boolean"
          }
        },
        "required": [
          "name",
          "rate_ppm",
          "tax",
          "inclusive"
        ]
      },
      "SnapshotTraderModel": {
        "type": "object",
        "properties": {
          "legal_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "trading_name": {
            "type": "string",
            "minLength": 1
          },
          "address": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "email": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "phone": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "vat_number": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "legal_name",
          "trading_name",
          "address",
          "email",
          "phone",
          "vat_number"
        ]
      },
      "SourceBody": {
        "type": "object",
        "properties": {
          "source": {
            "nullable": true
          }
        },
        "required": [
          "source"
        ]
      },
      "SourceRowModel": {
        "type": "object",
        "properties": {
          "source": {
            "type": "string",
            "minLength": 1
          },
          "channel": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "bookings": {
            "type": "integer"
          },
          "completed": {
            "type": "integer"
          },
          "no_shows": {
            "type": "integer"
          },
          "cancelled": {
            "type": "integer"
          },
          "revenue": {
            "type": "integer"
          }
        },
        "required": [
          "source",
          "channel",
          "bookings",
          "completed",
          "no_shows",
          "cancelled",
          "revenue"
        ]
      },
      "SpendPolicyList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SpendPolicyModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "SpendPolicyModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "limits": {
            "$ref": "#/components/schemas/CardLimitsModel"
          },
          "allowed_mccs": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "nullable": true
          },
          "allowed_merchant_kinds": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "software",
                "advertising",
                "travel",
                "food",
                "office",
                "telecoms",
                "professional",
                "shipping"
              ]
            },
            "nullable": true
          },
          "blocked_mccs": {
            "type": "array",
            "items": {
              "type": "integer"
            }
          },
          "allowed_countries": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true
          },
          "merchant_locks": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MerchantLockModel"
            }
          },
          "approval_threshold": {
            "nullable": true,
            "type": "integer"
          },
          "unusual_activity": {
            "type": "string",
            "enum": [
              "ask",
              "flag",
              "off"
            ],
            "minLength": 1
          },
          "summary": {
            "type": "string",
            "minLength": 1
          },
          "version": {
            "type": "integer"
          },
          "metadata": {
            "type": "object"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "name",
          "limits",
          "allowed_mccs",
          "allowed_merchant_kinds",
          "blocked_mccs",
          "allowed_countries",
          "merchant_locks",
          "approval_threshold",
          "unusual_activity",
          "summary",
          "version",
          "metadata",
          "created"
        ]
      },
      "StaffImageBody": {
        "type": "object",
        "properties": {
          "image": {
            "type": "string",
            "maxLength": 1000000,
            "minLength": 1
          }
        },
        "required": [
          "image"
        ]
      },
      "StaffLocationsBody": {
        "type": "object",
        "properties": {
          "locations": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "locations"
        ]
      },
      "StaffMemberBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 120
          },
          "slug": {
            "nullable": true,
            "type": "string",
            "maxLength": 60
          },
          "bio": {
            "nullable": true,
            "type": "string",
            "maxLength": 1000
          },
          "colour": {
            "nullable": true,
            "type": "string",
            "maxLength": 7
          },
          "bookable_online": {
            "type": "boolean"
          },
          "sort": {
            "type": "integer",
            "multipleOf": 1
          },
          "metadata": {
            "type": "object"
          },
          "locations": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "services": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StaffServiceBody"
            }
          }
        }
      },
      "StaffMemberList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StaffMemberModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "StaffMemberModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "slug": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "bio": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "colour": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "photo_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "bookable_online": {
            "type": "boolean"
          },
          "member": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "sort": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ],
            "minLength": 1
          },
          "locations": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "services": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StaffServiceModel"
            }
          },
          "metadata": {
            "type": "object"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "name",
          "slug",
          "bio",
          "colour",
          "photo_url",
          "bookable_online",
          "member",
          "sort",
          "status",
          "locations",
          "services",
          "metadata",
          "created"
        ]
      },
      "StaffPerformanceModel": {
        "type": "object",
        "properties": {
          "staff_member": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "bookings": {
            "type": "integer"
          },
          "revenue": {
            "type": "integer"
          },
          "utilisation": {
            "$ref": "#/components/schemas/UtilisationTotalModel"
          },
          "rebooking": {
            "$ref": "#/components/schemas/StaffRebookingModel"
          },
          "no_shows": {
            "$ref": "#/components/schemas/NoShowRateModel"
          },
          "rating": {
            "$ref": "#/components/schemas/StaffRatingModel"
          }
        },
        "required": [
          "staff_member",
          "name",
          "bookings",
          "revenue",
          "utilisation",
          "rebooking",
          "no_shows",
          "rating"
        ]
      },
      "StaffPinBody": {
        "type": "object",
        "properties": {
          "pin": {
            "type": "string",
            "maxLength": 6
          }
        }
      },
      "StaffPinModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "staff_member": {
            "type": "string",
            "minLength": 1
          },
          "pin_set": {
            "type": "boolean"
          },
          "pin_set_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "object",
          "livemode",
          "staff_member",
          "pin_set",
          "pin_set_at"
        ]
      },
      "StaffRatingModel": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer"
          },
          "average": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "count",
          "average"
        ]
      },
      "StaffRebookingModel": {
        "type": "object",
        "properties": {
          "visits": {
            "type": "integer"
          },
          "rebooked": {
            "type": "integer"
          },
          "rate": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "visits",
          "rebooked",
          "rate"
        ]
      },
      "StaffServiceBody": {
        "type": "object",
        "properties": {
          "service": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "duration_minutes": {
            "nullable": true,
            "type": "integer"
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "service"
        ]
      },
      "StaffServiceModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "service": {
            "type": "string",
            "minLength": 1
          },
          "duration_minutes": {
            "nullable": true,
            "type": "integer"
          },
          "amount": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "object",
          "service",
          "duration_minutes",
          "amount"
        ]
      },
      "StaffServicesBody": {
        "type": "object",
        "properties": {
          "services": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StaffServiceBody"
            }
          }
        },
        "required": [
          "services"
        ]
      },
      "StaffSummaryLineModel": {
        "type": "object",
        "properties": {
          "staff_member": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "revenue": {
            "type": "integer"
          },
          "commission": {
            "type": "integer"
          },
          "tips": {
            "type": "integer"
          }
        },
        "required": [
          "staff_member",
          "name",
          "revenue",
          "commission",
          "tips"
        ]
      },
      "StaffSummaryModel": {
        "type": "object",
        "properties": {
          "staff_member": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "orders": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "staff_member",
          "orders",
          "amount"
        ]
      },
      "StatementConnectAccountModel": {
        "type": "object",
        "properties": {
          "account": {
            "type": "string",
            "minLength": 1
          },
          "application_fees": {
            "type": "integer"
          }
        },
        "required": [
          "account",
          "application_fees"
        ]
      },
      "StatementConnectModel": {
        "type": "object",
        "properties": {
          "opening_balance": {
            "type": "integer"
          },
          "application_fees": {
            "type": "integer"
          },
          "application_fees_refunded": {
            "type": "integer"
          },
          "tuppence_fees_paid": {
            "type": "integer"
          },
          "transfers_out": {
            "type": "integer"
          },
          "transfers_reversed": {
            "type": "integer"
          },
          "swept": {
            "type": "integer"
          },
          "losses": {
            "type": "integer"
          },
          "other": {
            "type": "integer"
          },
          "closing_balance": {
            "type": "integer"
          },
          "by_account": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StatementConnectAccountModel"
            }
          }
        },
        "required": [
          "opening_balance",
          "application_fees",
          "application_fees_refunded",
          "tuppence_fees_paid",
          "transfers_out",
          "transfers_reversed",
          "swept",
          "losses",
          "other",
          "closing_balance",
          "by_account"
        ]
      },
      "StatementCountsModel": {
        "type": "object",
        "properties": {
          "payments": {
            "type": "integer"
          },
          "refunds": {
            "type": "integer"
          },
          "disputes": {
            "type": "integer"
          },
          "payouts": {
            "type": "integer"
          },
          "topups": {
            "type": "integer"
          }
        },
        "required": [
          "payments",
          "refunds",
          "disputes",
          "payouts",
          "topups"
        ]
      },
      "StatementDescriptorsModel": {
        "type": "object",
        "properties": {
          "card_line": {
            "type": "string",
            "minLength": 1
          },
          "prefix": {
            "type": "string",
            "minLength": 1
          },
          "suffix": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "full": {
            "type": "string",
            "minLength": 1
          },
          "payouts": {
            "type": "string",
            "minLength": 1
          },
          "suffix_max": {
            "type": "integer"
          },
          "sources": {
            "$ref": "#/components/schemas/DescriptorSourcesModel"
          },
          "locked": {
            "type": "boolean",
            "description": "True when the account's platform has locked its statement lines."
          },
          "prefix_editable": {
            "type": "boolean"
          }
        },
        "required": [
          "card_line",
          "prefix",
          "suffix",
          "full",
          "payouts",
          "suffix_max",
          "sources",
          "locked",
          "prefix_editable"
        ]
      },
      "StatementLinesModel": {
        "type": "object",
        "properties": {
          "sales": {
            "type": "integer"
          },
          "cashback": {
            "type": "integer"
          },
          "fees": {
            "type": "integer"
          },
          "dispute_fees": {
            "type": "integer"
          },
          "topups_paid_in": {
            "type": "integer"
          },
          "to_card_balance": {
            "type": "integer"
          },
          "topup_bank_transfer_fees": {
            "type": "integer"
          },
          "topup_instant_fees": {
            "type": "integer"
          },
          "refunds": {
            "type": "integer"
          },
          "disputes": {
            "type": "integer"
          },
          "payouts": {
            "type": "integer"
          },
          "application_fees": {
            "type": "integer"
          },
          "transfers_in": {
            "type": "integer"
          },
          "connect_swept": {
            "type": "integer"
          },
          "connect_losses": {
            "type": "integer"
          },
          "postage": {
            "type": "integer"
          },
          "affiliate_commission": {
            "type": "integer"
          },
          "written_off": {
            "type": "integer"
          },
          "other": {
            "type": "integer"
          }
        },
        "required": [
          "sales",
          "cashback",
          "fees",
          "dispute_fees",
          "topups_paid_in",
          "to_card_balance",
          "topup_bank_transfer_fees",
          "topup_instant_fees",
          "refunds",
          "disputes",
          "payouts",
          "application_fees",
          "transfers_in",
          "connect_swept",
          "connect_losses",
          "postage",
          "affiliate_commission",
          "written_off",
          "other"
        ]
      },
      "StatementModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "month": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "period_start": {
            "type": "integer"
          },
          "period_end": {
            "type": "integer"
          },
          "complete": {
            "type": "boolean"
          },
          "opening_balance": {
            "type": "integer"
          },
          "closing_balance": {
            "type": "integer"
          },
          "lines": {
            "$ref": "#/components/schemas/StatementLinesModel"
          },
          "credits_used": {
            "type": "integer"
          },
          "next_day_fees": {
            "type": "integer"
          },
          "card_topup_fees": {
            "type": "integer"
          },
          "counts": {
            "$ref": "#/components/schemas/StatementCountsModel"
          },
          "stripe_balance": {
            "nullable": true,
            "type": "integer"
          },
          "card_fees": {
            "$ref": "#/components/schemas/CardFeesModel"
          },
          "messaging": {
            "$ref": "#/components/schemas/MessagingChargesModel"
          },
          "staff_summary": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StaffSummaryLineModel"
            }
          },
          "processing_fees_paid_by_platform": {
            "type": "integer"
          },
          "connect": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/StatementConnectModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "object",
          "month",
          "currency",
          "livemode",
          "period_start",
          "period_end",
          "complete",
          "opening_balance",
          "closing_balance",
          "lines",
          "credits_used",
          "next_day_fees",
          "card_topup_fees",
          "counts",
          "stripe_balance",
          "card_fees",
          "messaging",
          "staff_summary",
          "processing_fees_paid_by_platform",
          "connect"
        ]
      },
      "StatementMonths": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "object",
          "data"
        ]
      },
      "StockAlertEventData": {
        "type": "object",
        "description": "What an event carrying a `stock_alert` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/StockAlertEventObject"
          }
        }
      },
      "StockAlertEventObject": {
        "type": "object",
        "description": "A `stock_alert` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "stock_alert"
          }
        },
        "additionalProperties": true
      },
      "StockAlertSentEvent": {
        "type": "object",
        "description": "The `stock_alert.sent` event (the store's catalogue events): `data.object` is the `stock_alert`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "stock_alert.sent"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StockAlertEventData"
          }
        }
      },
      "StockAvailabilityEventData": {
        "type": "object",
        "description": "What an event carrying a `stock_availability` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/StockAvailabilityEventObject"
          }
        }
      },
      "StockAvailabilityEventObject": {
        "type": "object",
        "description": "A `stock_availability` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "stock_availability"
          }
        },
        "additionalProperties": true
      },
      "StockAvailableEvent": {
        "type": "object",
        "description": "The `stock.available` event (the store's catalogue events): `data.object` is the `stock_availability`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "stock.available"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StockAvailabilityEventData"
          }
        }
      },
      "StockLevelList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StockLevelModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "StockLevelModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "variant": {
            "type": "string",
            "minLength": 1
          },
          "product": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "quantity": {
            "type": "string",
            "minLength": 1
          },
          "reorder_point": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "below_reorder": {
            "type": "boolean"
          },
          "negative": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "updated": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "variant",
          "product",
          "location",
          "quantity",
          "reorder_point",
          "below_reorder",
          "negative",
          "created",
          "updated"
        ]
      },
      "StockMirrorModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "store_import": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "enum": [
              "off",
              "connecting",
              "active",
              "disconnected"
            ],
            "minLength": 1
          },
          "reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1,
            "enum": [
              "source",
              "files",
              "test_mode",
              "not_completed",
              "undone"
            ]
          },
          "shop": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "location": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "old_location": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "unmapped_locations": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "variants": {
            "type": "integer",
            "multipleOf": 1
          },
          "started_at": {
            "nullable": true,
            "type": "integer"
          },
          "ended_at": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "object",
          "store_import",
          "livemode",
          "status",
          "reason",
          "shop",
          "location",
          "old_location",
          "unmapped_locations",
          "variants",
          "started_at",
          "ended_at"
        ]
      },
      "StockMovementCreatedEvent": {
        "type": "object",
        "description": "The `stock_movement.created` event (the store's catalogue events): `data.object` is the `stock_movement`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "stock_movement.created"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StockMovementEventData"
          }
        }
      },
      "StockMovementEventData": {
        "type": "object",
        "description": "What an event carrying a `stock_movement` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/StockMovementEventObject"
          }
        }
      },
      "StockMovementEventObject": {
        "type": "object",
        "description": "A `stock_movement` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "stock_movement"
          }
        },
        "additionalProperties": true
      },
      "StockMovementList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StockMovementModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "StockMovementModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "variant": {
            "type": "string",
            "minLength": 1
          },
          "product": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "sale",
              "return",
              "adjustment",
              "received",
              "transfer",
              "count",
              "waste"
            ],
            "minLength": 1
          },
          "delta": {
            "type": "string",
            "minLength": 1
          },
          "quantity_after": {
            "type": "string",
            "minLength": 1
          },
          "unit_cost": {
            "nullable": true,
            "type": "integer"
          },
          "currency": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "actor": {
            "$ref": "#/components/schemas/EventActorModel"
          },
          "order": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "reference": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/StockReferenceModel"
              }
            ],
            "nullable": true
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "variant",
          "product",
          "location",
          "kind",
          "delta",
          "quantity_after",
          "unit_cost",
          "currency",
          "reason",
          "actor",
          "order",
          "reference",
          "created"
        ]
      },
      "StockReferenceModel": {
        "type": "object",
        "properties": {
          "refunds_order": {
            "type": "string"
          }
        }
      },
      "StoreAgentBlockEventData": {
        "type": "object",
        "description": "What an event carrying a `store_agent_block` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/StoreAgentBlockEventObject"
          }
        }
      },
      "StoreAgentBlockEventObject": {
        "type": "object",
        "description": "A `store_agent_block` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "store_agent_block"
          }
        },
        "additionalProperties": true
      },
      "StoreAgentBlockedEvent": {
        "type": "object",
        "description": "The `store.agent.blocked` event (the store's agents events): `data.object` is the `store_agent_block`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.agent.blocked"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StoreAgentBlockEventData"
          }
        }
      },
      "StoreAgentSettingsUpdatedEvent": {
        "type": "object",
        "description": "The `store.agent_settings.updated` event (the store's agents events): `data.object` is the `store_ai_channels_change`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.agent_settings.updated"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StoreAiChannelsChangeEventData"
          }
        }
      },
      "StoreAgentUnblockedEvent": {
        "type": "object",
        "description": "The `store.agent.unblocked` event (the store's agents events): `data.object` is the `store_agent_block`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.agent.unblocked"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StoreAgentBlockEventData"
          }
        }
      },
      "StoreAiAllowanceModel": {
        "type": "object",
        "properties": {
          "spent": {
            "type": "integer",
            "multipleOf": 1
          },
          "allowance": {
            "type": "integer",
            "multipleOf": 1
          },
          "paused": {
            "type": "boolean"
          },
          "renews_at": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "spent",
          "allowance",
          "paused",
          "renews_at"
        ]
      },
      "StoreAiChannelsChangeEventData": {
        "type": "object",
        "description": "What an event carrying a `store_ai_channels_change` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/StoreAiChannelsChangeEventObject"
          }
        }
      },
      "StoreAiChannelsChangeEventObject": {
        "type": "object",
        "description": "A `store_ai_channels_change` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "store_ai_channels_change"
          }
        },
        "additionalProperties": true
      },
      "StoreBriefEventData": {
        "type": "object",
        "description": "What an event carrying a `store_brief` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/StoreBriefEventObject"
          }
        }
      },
      "StoreBriefEventObject": {
        "type": "object",
        "description": "A `store_brief` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "store_brief"
          }
        },
        "additionalProperties": true
      },
      "StoreBriefLineModel": {
        "type": "object",
        "properties": {
          "section": {
            "type": "string",
            "enum": [
              "money",
              "today",
              "customers",
              "stock",
              "decisions",
              "assistant",
              "recovered",
              "coming_up",
              "problems",
              "cost",
              "quiet"
            ],
            "minLength": 1
          },
          "text": {
            "type": "string",
            "minLength": 1
          },
          "link": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "written_by": {
            "type": "string",
            "enum": [
              "model",
              "template"
            ],
            "minLength": 1
          }
        },
        "required": [
          "section",
          "text",
          "link",
          "written_by"
        ]
      },
      "StoreBriefList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreBriefModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "StoreBriefModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "daily",
              "weekly"
            ],
            "minLength": 1
          },
          "brief_date": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "ready",
              "failed"
            ],
            "minLength": 1
          },
          "window_from": {
            "type": "integer",
            "multipleOf": 1
          },
          "window_to": {
            "type": "integer",
            "multipleOf": 1
          },
          "facts": {
            "type": "object"
          },
          "words": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreBriefLineModel"
            }
          },
          "created": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "id",
          "object",
          "kind",
          "brief_date",
          "status",
          "window_from",
          "window_to",
          "facts",
          "words",
          "created"
        ]
      },
      "StoreBriefReadyEvent": {
        "type": "object",
        "description": "The `store_brief.ready` event (the store's assistant events): `data.object` is the `store_brief`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store_brief.ready"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StoreBriefEventData"
          }
        }
      },
      "StoreCampaignBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 100
          },
          "subject": {
            "type": "string",
            "maxLength": 150
          },
          "heading": {
            "nullable": true,
            "type": "string",
            "maxLength": 150
          },
          "body": {
            "type": "string",
            "maxLength": 2000
          },
          "action_label": {
            "nullable": true,
            "type": "string",
            "maxLength": 60
          },
          "action_path": {
            "nullable": true,
            "type": "string",
            "maxLength": 300
          },
          "segment": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/StoreSegmentBody"
              }
            ],
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "StoreCampaignList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreCampaignModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "StoreCampaignMessageModel": {
        "type": "object",
        "properties": {
          "subject": {
            "type": "string",
            "minLength": 1
          },
          "heading": {
            "type": "string",
            "minLength": 1
          },
          "body": {
            "type": "string",
            "minLength": 1
          },
          "action_label": {
            "type": "string",
            "minLength": 1
          },
          "action_path": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "subject",
          "heading",
          "body",
          "action_label",
          "action_path"
        ]
      },
      "StoreCampaignModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "subject": {
            "type": "string",
            "minLength": 1
          },
          "heading": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "body": {
            "type": "string",
            "minLength": 1
          },
          "action_label": {
            "type": "string",
            "minLength": 1
          },
          "action_path": {
            "type": "string",
            "minLength": 1
          },
          "segment": {
            "$ref": "#/components/schemas/StoreSegmentModel"
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "send_at": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "timezone": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "scheduled_for": {
            "nullable": true,
            "type": "integer"
          },
          "sent_at": {
            "nullable": true,
            "type": "integer"
          },
          "recipients": {
            "type": "integer",
            "multipleOf": 1
          },
          "test_sent_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "site",
          "name",
          "subject",
          "heading",
          "body",
          "action_label",
          "action_path",
          "segment",
          "status",
          "send_at",
          "timezone",
          "scheduled_for",
          "sent_at",
          "recipients",
          "test_sent_at",
          "created"
        ]
      },
      "StoreCampaignPreviewModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "matching": {
            "type": "integer",
            "multipleOf": 1
          },
          "sample": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "message": {
            "$ref": "#/components/schemas/StoreCampaignMessageModel"
          }
        },
        "required": [
          "object",
          "matching",
          "sample",
          "message"
        ]
      },
      "StoreCampaignResultsModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "recipients": {
            "type": "integer",
            "multipleOf": 1
          },
          "sent": {
            "type": "integer",
            "multipleOf": 1
          },
          "skipped": {
            "type": "integer",
            "multipleOf": 1
          },
          "waiting": {
            "type": "integer",
            "multipleOf": 1
          },
          "clicked": {
            "type": "integer",
            "multipleOf": 1
          },
          "orders": {
            "type": "integer",
            "multipleOf": 1
          },
          "revenue": {
            "type": "integer",
            "multipleOf": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "recipients",
          "sent",
          "skipped",
          "waiting",
          "clicked",
          "orders",
          "revenue",
          "currency"
        ]
      },
      "StoreCampaignScheduleBody": {
        "type": "object",
        "properties": {
          "send_at": {
            "nullable": true,
            "type": "string",
            "maxLength": 16
          }
        },
        "additionalProperties": false
      },
      "StoreCancellationEventData": {
        "type": "object",
        "description": "What an event carrying a `store_cancellation` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/StoreCancellationEventObject"
          }
        }
      },
      "StoreCancellationEventObject": {
        "type": "object",
        "description": "A `store_cancellation` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "store_cancellation"
          }
        },
        "additionalProperties": true
      },
      "StoreCancellationModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "order_number": {
            "type": "string",
            "minLength": 1
          },
          "order": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "email": {
            "type": "string",
            "minLength": 1
          },
          "statement": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "form": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CancellationFormModel"
              }
            ],
            "nullable": true
          },
          "channel": {
            "type": "string",
            "minLength": 1
          },
          "received": {
            "type": "integer"
          },
          "acknowledged": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "site",
          "order_number",
          "order",
          "email",
          "statement",
          "form",
          "channel",
          "received",
          "acknowledged"
        ]
      },
      "StoreCancellationReceivedEvent": {
        "type": "object",
        "description": "The `store.cancellation_received` event (the store's orders events): `data.object` is the `store_cancellation`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.cancellation_received"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StoreCancellationEventData"
          }
        }
      },
      "StoreChangeBody": {
        "type": "object",
        "properties": {
          "sentence": {
            "type": "string",
            "maxLength": 500,
            "minLength": 1
          },
          "page": {
            "type": "string",
            "maxLength": 40
          }
        },
        "required": [
          "sentence"
        ]
      },
      "StoreChangeModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "sentence": {
            "type": "string",
            "minLength": 1
          },
          "route": {
            "type": "string",
            "enum": [
              "edit",
              "design",
              "none"
            ],
            "minLength": 1
          },
          "change_set": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ChangeSetModel"
              }
            ],
            "nullable": true
          },
          "design_run": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "preview": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "operations": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreChangeOperationModel"
            }
          },
          "reply": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "sentence",
          "route",
          "change_set",
          "design_run",
          "preview",
          "operations",
          "reply"
        ]
      },
      "StoreChangeOperationModel": {
        "type": "object",
        "properties": {
          "op": {
            "type": "string",
            "enum": [
              "update_product",
              "set_stock",
              "set_channel",
              "add_to_collection",
              "remove_from_collection",
              "create_collection",
              "add_block",
              "move_block",
              "update_block",
              "remove_block",
              "update_brand",
              "update_navigation"
            ],
            "minLength": 1
          },
          "ok": {
            "type": "boolean"
          },
          "error": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ToolCallSummaryModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "op",
          "ok",
          "error"
        ]
      },
      "StoreChannelConnectedEvent": {
        "type": "object",
        "description": "The `store.channel_connected` event (the store's channels events): `data.object` is the `sales_channel`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.channel_connected"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/SalesChannelEventData"
          }
        }
      },
      "StoreChannelDisconnectedEvent": {
        "type": "object",
        "description": "The `store.channel_disconnected` event (the store's channels events): `data.object` is the `sales_channel`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.channel_disconnected"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/SalesChannelEventData"
          }
        }
      },
      "StoreChannelErrorEvent": {
        "type": "object",
        "description": "The `store.channel_error` event (the store's channels events): `data.object` is the `sales_channel`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.channel_error"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/SalesChannelEventData"
          }
        }
      },
      "StoreChannelUpdatedEvent": {
        "type": "object",
        "description": "The `store.channel_updated` event (the store's channels events): `data.object` is the `sales_channel`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.channel_updated"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/SalesChannelEventData"
          }
        }
      },
      "StoreChecklistItemModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "state": {
            "type": "string",
            "minLength": 1
          },
          "blocks": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "optional": {
            "type": "boolean"
          },
          "why": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "fix_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "title",
          "state",
          "blocks",
          "optional",
          "why",
          "fix_url"
        ]
      },
      "StoreChecklistModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "ready_to_open": {
            "type": "boolean"
          },
          "ready_for_live_orders": {
            "type": "boolean"
          },
          "next": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreChecklistItemModel"
            }
          }
        },
        "required": [
          "object",
          "site",
          "livemode",
          "ready_to_open",
          "ready_for_live_orders",
          "next",
          "items"
        ]
      },
      "StoreCheckoutAbandonedEvent": {
        "type": "object",
        "description": "The `store.checkout_abandoned` event (the store's orders events): `data.object` is the `checkout`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.checkout_abandoned"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/CheckoutEventData"
          }
        }
      },
      "StoreCollectionCreatedEvent": {
        "type": "object",
        "description": "The `store.collection_created` event (the store's catalogue events): `data.object` is the `collection`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.collection_created"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/CollectionEventData"
          }
        }
      },
      "StoreCollectionDeletedEvent": {
        "type": "object",
        "description": "The `store.collection_deleted` event (the store's catalogue events): `data.object` is the `collection`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.collection_deleted"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/CollectionEventData"
          }
        }
      },
      "StoreCollectionUpdatedEvent": {
        "type": "object",
        "description": "The `store.collection_updated` event (the store's catalogue events): `data.object` is the `collection`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.collection_updated"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/CollectionEventData"
          }
        }
      },
      "StoreDomainActiveEvent": {
        "type": "object",
        "description": "The `store.domain_active` event (the store's site events): `data.object` is the `site`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.domain_active"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/SiteEventData"
          }
        }
      },
      "StoreDomainFailedEvent": {
        "type": "object",
        "description": "The `store.domain_failed` event (the store's site events): `data.object` is the `site`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.domain_failed"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/SiteEventData"
          }
        }
      },
      "StoreDomainRemovedEvent": {
        "type": "object",
        "description": "The `store.domain_removed` event (the store's site events): `data.object` is the `site`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.domain_removed"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/SiteEventData"
          }
        }
      },
      "StoreDomainRequestedEvent": {
        "type": "object",
        "description": "The `store.domain_requested` event (the store's site events): `data.object` is the `site`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.domain_requested"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/SiteEventData"
          }
        }
      },
      "StoreDomainSwitchedEvent": {
        "type": "object",
        "description": "The `store.domain_switched` event (the store's site events): `data.object` is the `site`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.domain_switched"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/SiteEventData"
          }
        }
      },
      "StoreDropCreatedEvent": {
        "type": "object",
        "description": "The `store.drop_created` event (the store's catalogue events): `data.object` is the `drop`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.drop_created"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/DropEventData"
          }
        }
      },
      "StoreDropUpdatedEvent": {
        "type": "object",
        "description": "The `store.drop_updated` event (the store's catalogue events): `data.object` is the `drop`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.drop_updated"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/DropEventData"
          }
        }
      },
      "StoreEvent": {
        "description": "Any of the store's events: narrow on `type` and `data.object` is that event's object.",
        "oneOf": [
          {
            "$ref": "#/components/schemas/StoreSiteUpdatedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreSitePublishedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreSiteRevertedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreSiteScheduledEvent"
          },
          {
            "$ref": "#/components/schemas/StoreDomainRequestedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreDomainActiveEvent"
          },
          {
            "$ref": "#/components/schemas/StoreDomainFailedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreDomainRemovedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreDomainSwitchedEvent"
          },
          {
            "$ref": "#/components/schemas/MerchantSendingDomainVerifiedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreProposalStartedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreProposalReadyEvent"
          },
          {
            "$ref": "#/components/schemas/StoreProposalFailedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreProposalPublishedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreSnapStartedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreSnapReadyEvent"
          },
          {
            "$ref": "#/components/schemas/StoreSnapFailedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreSnapPublishedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreImportStartedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreImportCompletedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreImportUndoneEvent"
          },
          {
            "$ref": "#/components/schemas/ProductCreatedEvent"
          },
          {
            "$ref": "#/components/schemas/ProductUpdatedEvent"
          },
          {
            "$ref": "#/components/schemas/ProductArchivedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreProductPublishedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreProductUnpublishedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreCollectionCreatedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreCollectionUpdatedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreCollectionDeletedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreDropCreatedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreDropUpdatedEvent"
          },
          {
            "$ref": "#/components/schemas/StockAvailableEvent"
          },
          {
            "$ref": "#/components/schemas/StockAlertSentEvent"
          },
          {
            "$ref": "#/components/schemas/StockMovementCreatedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreOrderPlacedEvent"
          },
          {
            "$ref": "#/components/schemas/OrderCreatedEvent"
          },
          {
            "$ref": "#/components/schemas/OrderUpdatedEvent"
          },
          {
            "$ref": "#/components/schemas/OrderPaidEvent"
          },
          {
            "$ref": "#/components/schemas/OrderCompletedEvent"
          },
          {
            "$ref": "#/components/schemas/TenderCreatedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreCheckoutAbandonedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreCancellationReceivedEvent"
          },
          {
            "$ref": "#/components/schemas/SubscriptionRenewalSkippedEvent"
          },
          {
            "$ref": "#/components/schemas/SubscriptionRenewalNoticeSentEvent"
          },
          {
            "$ref": "#/components/schemas/FulfilmentShippedEvent"
          },
          {
            "$ref": "#/components/schemas/FulfilmentDelayedEvent"
          },
          {
            "$ref": "#/components/schemas/ShipmentUpdatedEvent"
          },
          {
            "$ref": "#/components/schemas/ShipmentInTransitEvent"
          },
          {
            "$ref": "#/components/schemas/ShipmentOutForDeliveryEvent"
          },
          {
            "$ref": "#/components/schemas/ShipmentAvailableForPickupEvent"
          },
          {
            "$ref": "#/components/schemas/ShipmentDeliveredEvent"
          },
          {
            "$ref": "#/components/schemas/ShipmentExceptionEvent"
          },
          {
            "$ref": "#/components/schemas/ShipmentReturnedToSenderEvent"
          },
          {
            "$ref": "#/components/schemas/ReturnRequestedEvent"
          },
          {
            "$ref": "#/components/schemas/ReturnApprovedEvent"
          },
          {
            "$ref": "#/components/schemas/ReturnRejectedEvent"
          },
          {
            "$ref": "#/components/schemas/ReturnReceivedEvent"
          },
          {
            "$ref": "#/components/schemas/ReturnRefundedEvent"
          },
          {
            "$ref": "#/components/schemas/ReturnClosedEvent"
          },
          {
            "$ref": "#/components/schemas/ReturnRefundDueSoonEvent"
          },
          {
            "$ref": "#/components/schemas/StoreChannelConnectedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreChannelUpdatedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreChannelDisconnectedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreChannelErrorEvent"
          },
          {
            "$ref": "#/components/schemas/ListingLiveEvent"
          },
          {
            "$ref": "#/components/schemas/ListingRejectedEvent"
          },
          {
            "$ref": "#/components/schemas/ListingRemovedEvent"
          },
          {
            "$ref": "#/components/schemas/ListingRestrictedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreAgentSettingsUpdatedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreAgentBlockedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreAgentUnblockedEvent"
          },
          {
            "$ref": "#/components/schemas/ReviewCreatedEvent"
          },
          {
            "$ref": "#/components/schemas/ReviewRepliedEvent"
          },
          {
            "$ref": "#/components/schemas/ProductReviewRequestedEvent"
          },
          {
            "$ref": "#/components/schemas/ProductReviewPublishedEvent"
          },
          {
            "$ref": "#/components/schemas/ProductReviewRejectedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreThreadMessageReceivedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreThreadNeedsYouEvent"
          },
          {
            "$ref": "#/components/schemas/StorePrivacyRequestReceivedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreFlowPausedEvent"
          },
          {
            "$ref": "#/components/schemas/ChangeSetAppliedEvent"
          },
          {
            "$ref": "#/components/schemas/ChangeSetRevertedEvent"
          },
          {
            "$ref": "#/components/schemas/ChangeSetProposedEvent"
          },
          {
            "$ref": "#/components/schemas/ChangeSetDeclinedEvent"
          },
          {
            "$ref": "#/components/schemas/ChangeSetExpiredEvent"
          },
          {
            "$ref": "#/components/schemas/AssistantJobUpdatedEvent"
          },
          {
            "$ref": "#/components/schemas/AssistantJobPausedEvent"
          },
          {
            "$ref": "#/components/schemas/JobRunFinishedEvent"
          },
          {
            "$ref": "#/components/schemas/StoreBriefReadyEvent"
          },
          {
            "$ref": "#/components/schemas/StoreTaxThresholdNearEvent"
          },
          {
            "$ref": "#/components/schemas/StoreTaxThresholdReachedEvent"
          },
          {
            "$ref": "#/components/schemas/TaxRegistrationCreatedEvent"
          },
          {
            "$ref": "#/components/schemas/PolicyVersionDraftedEvent"
          },
          {
            "$ref": "#/components/schemas/PolicyVersionPublishedEvent"
          }
        ],
        "discriminator": {
          "propertyName": "type",
          "mapping": {
            "store.site_updated": "#/components/schemas/StoreSiteUpdatedEvent",
            "store.site_published": "#/components/schemas/StoreSitePublishedEvent",
            "store.site_reverted": "#/components/schemas/StoreSiteRevertedEvent",
            "store.site_scheduled": "#/components/schemas/StoreSiteScheduledEvent",
            "store.domain_requested": "#/components/schemas/StoreDomainRequestedEvent",
            "store.domain_active": "#/components/schemas/StoreDomainActiveEvent",
            "store.domain_failed": "#/components/schemas/StoreDomainFailedEvent",
            "store.domain_removed": "#/components/schemas/StoreDomainRemovedEvent",
            "store.domain_switched": "#/components/schemas/StoreDomainSwitchedEvent",
            "merchant_sending_domain.verified": "#/components/schemas/MerchantSendingDomainVerifiedEvent",
            "store.proposal_started": "#/components/schemas/StoreProposalStartedEvent",
            "store.proposal_ready": "#/components/schemas/StoreProposalReadyEvent",
            "store.proposal_failed": "#/components/schemas/StoreProposalFailedEvent",
            "store.proposal_published": "#/components/schemas/StoreProposalPublishedEvent",
            "store.snap_started": "#/components/schemas/StoreSnapStartedEvent",
            "store.snap_ready": "#/components/schemas/StoreSnapReadyEvent",
            "store.snap_failed": "#/components/schemas/StoreSnapFailedEvent",
            "store.snap_published": "#/components/schemas/StoreSnapPublishedEvent",
            "store.import_started": "#/components/schemas/StoreImportStartedEvent",
            "store.import_completed": "#/components/schemas/StoreImportCompletedEvent",
            "store.import_undone": "#/components/schemas/StoreImportUndoneEvent",
            "product.created": "#/components/schemas/ProductCreatedEvent",
            "product.updated": "#/components/schemas/ProductUpdatedEvent",
            "product.archived": "#/components/schemas/ProductArchivedEvent",
            "store.product_published": "#/components/schemas/StoreProductPublishedEvent",
            "store.product_unpublished": "#/components/schemas/StoreProductUnpublishedEvent",
            "store.collection_created": "#/components/schemas/StoreCollectionCreatedEvent",
            "store.collection_updated": "#/components/schemas/StoreCollectionUpdatedEvent",
            "store.collection_deleted": "#/components/schemas/StoreCollectionDeletedEvent",
            "store.drop_created": "#/components/schemas/StoreDropCreatedEvent",
            "store.drop_updated": "#/components/schemas/StoreDropUpdatedEvent",
            "stock.available": "#/components/schemas/StockAvailableEvent",
            "stock_alert.sent": "#/components/schemas/StockAlertSentEvent",
            "stock_movement.created": "#/components/schemas/StockMovementCreatedEvent",
            "store.order_placed": "#/components/schemas/StoreOrderPlacedEvent",
            "order.created": "#/components/schemas/OrderCreatedEvent",
            "order.updated": "#/components/schemas/OrderUpdatedEvent",
            "order.paid": "#/components/schemas/OrderPaidEvent",
            "order.completed": "#/components/schemas/OrderCompletedEvent",
            "tender.created": "#/components/schemas/TenderCreatedEvent",
            "store.checkout_abandoned": "#/components/schemas/StoreCheckoutAbandonedEvent",
            "store.cancellation_received": "#/components/schemas/StoreCancellationReceivedEvent",
            "subscription.renewal_skipped": "#/components/schemas/SubscriptionRenewalSkippedEvent",
            "subscription.renewal_notice_sent": "#/components/schemas/SubscriptionRenewalNoticeSentEvent",
            "fulfilment.shipped": "#/components/schemas/FulfilmentShippedEvent",
            "fulfilment.delayed": "#/components/schemas/FulfilmentDelayedEvent",
            "shipment.updated": "#/components/schemas/ShipmentUpdatedEvent",
            "shipment.in_transit": "#/components/schemas/ShipmentInTransitEvent",
            "shipment.out_for_delivery": "#/components/schemas/ShipmentOutForDeliveryEvent",
            "shipment.available_for_pickup": "#/components/schemas/ShipmentAvailableForPickupEvent",
            "shipment.delivered": "#/components/schemas/ShipmentDeliveredEvent",
            "shipment.exception": "#/components/schemas/ShipmentExceptionEvent",
            "shipment.returned_to_sender": "#/components/schemas/ShipmentReturnedToSenderEvent",
            "return.requested": "#/components/schemas/ReturnRequestedEvent",
            "return.approved": "#/components/schemas/ReturnApprovedEvent",
            "return.rejected": "#/components/schemas/ReturnRejectedEvent",
            "return.received": "#/components/schemas/ReturnReceivedEvent",
            "return.refunded": "#/components/schemas/ReturnRefundedEvent",
            "return.closed": "#/components/schemas/ReturnClosedEvent",
            "return.refund_due_soon": "#/components/schemas/ReturnRefundDueSoonEvent",
            "store.channel_connected": "#/components/schemas/StoreChannelConnectedEvent",
            "store.channel_updated": "#/components/schemas/StoreChannelUpdatedEvent",
            "store.channel_disconnected": "#/components/schemas/StoreChannelDisconnectedEvent",
            "store.channel_error": "#/components/schemas/StoreChannelErrorEvent",
            "listing.live": "#/components/schemas/ListingLiveEvent",
            "listing.rejected": "#/components/schemas/ListingRejectedEvent",
            "listing.removed": "#/components/schemas/ListingRemovedEvent",
            "listing.restricted": "#/components/schemas/ListingRestrictedEvent",
            "store.agent_settings.updated": "#/components/schemas/StoreAgentSettingsUpdatedEvent",
            "store.agent.blocked": "#/components/schemas/StoreAgentBlockedEvent",
            "store.agent.unblocked": "#/components/schemas/StoreAgentUnblockedEvent",
            "review.created": "#/components/schemas/ReviewCreatedEvent",
            "review.replied": "#/components/schemas/ReviewRepliedEvent",
            "product_review.requested": "#/components/schemas/ProductReviewRequestedEvent",
            "product_review.published": "#/components/schemas/ProductReviewPublishedEvent",
            "product_review.rejected": "#/components/schemas/ProductReviewRejectedEvent",
            "store_thread.message_received": "#/components/schemas/StoreThreadMessageReceivedEvent",
            "store_thread.needs_you": "#/components/schemas/StoreThreadNeedsYouEvent",
            "store.privacy_request_received": "#/components/schemas/StorePrivacyRequestReceivedEvent",
            "store_flow.paused": "#/components/schemas/StoreFlowPausedEvent",
            "change_set.applied": "#/components/schemas/ChangeSetAppliedEvent",
            "change_set.reverted": "#/components/schemas/ChangeSetRevertedEvent",
            "change_set.proposed": "#/components/schemas/ChangeSetProposedEvent",
            "change_set.declined": "#/components/schemas/ChangeSetDeclinedEvent",
            "change_set.expired": "#/components/schemas/ChangeSetExpiredEvent",
            "assistant_job.updated": "#/components/schemas/AssistantJobUpdatedEvent",
            "assistant_job.paused": "#/components/schemas/AssistantJobPausedEvent",
            "job_run.finished": "#/components/schemas/JobRunFinishedEvent",
            "store_brief.ready": "#/components/schemas/StoreBriefReadyEvent",
            "store.tax_threshold_near": "#/components/schemas/StoreTaxThresholdNearEvent",
            "store.tax_threshold_reached": "#/components/schemas/StoreTaxThresholdReachedEvent",
            "tax_registration.created": "#/components/schemas/TaxRegistrationCreatedEvent",
            "policy.version_drafted": "#/components/schemas/PolicyVersionDraftedEvent",
            "policy.version_published": "#/components/schemas/PolicyVersionPublishedEvent"
          }
        }
      },
      "StoreExportCartLineModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "product": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "variant": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "quantity": {
            "type": "integer"
          },
          "gift_card": {
            "nullable": true
          }
        },
        "required": [
          "id",
          "kind",
          "product",
          "variant",
          "quantity",
          "gift_card"
        ]
      },
      "StoreExportCartModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "contact": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CheckoutContactModel"
              }
            ],
            "nullable": true
          },
          "shipping_address": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/CheckoutAddressModel"
              }
            ],
            "nullable": true
          },
          "attribution": {
            "nullable": true
          },
          "lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreExportCartLineModel"
            }
          },
          "created": {
            "type": "integer"
          },
          "last_activity": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "site",
          "status",
          "contact",
          "shipping_address",
          "attribution",
          "lines",
          "created",
          "last_activity"
        ]
      },
      "StoreExportFileModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "return": {
            "type": "string",
            "minLength": 1
          },
          "content_type": {
            "type": "string",
            "minLength": 1
          },
          "filename": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "kind",
          "return",
          "content_type",
          "filename",
          "data"
        ]
      },
      "StoreExportFulfilmentModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "order": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "notes": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "shipped": {
            "nullable": true,
            "type": "integer"
          },
          "delivered": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "order",
          "kind",
          "status",
          "notes",
          "shipped",
          "delivered"
        ]
      },
      "StoreExportOrderModel": {
        "type": "object",
        "properties": {
          "order": {
            "$ref": "#/components/schemas/OrderModel"
          },
          "delivery": {
            "nullable": true
          },
          "tax": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/StoreExportTaxModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "order",
          "delivery",
          "tax"
        ]
      },
      "StoreExportRecipientModel": {
        "type": "object",
        "properties": {
          "recipient": {
            "type": "string",
            "minLength": 1
          },
          "what": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "recipient",
          "what"
        ]
      },
      "StoreExportShipmentEventModel": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "minLength": 1
          },
          "detail": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "city": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "country": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "occurred": {
            "type": "integer"
          }
        },
        "required": [
          "status",
          "detail",
          "city",
          "country",
          "occurred"
        ]
      },
      "StoreExportShipmentModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "vendor": {
            "type": "string",
            "minLength": 1
          },
          "carrier": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "service_code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "tracking_number": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "cost_amount": {
            "nullable": true,
            "type": "integer"
          },
          "currency": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "paid_by": {
            "type": "string",
            "minLength": 1
          },
          "label_formats": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "created": {
            "type": "integer"
          },
          "fulfilment": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "return": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "events": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreExportShipmentEventModel"
            }
          }
        },
        "required": [
          "id",
          "object",
          "status",
          "vendor",
          "carrier",
          "service_code",
          "tracking_number",
          "cost_amount",
          "currency",
          "paid_by",
          "label_formats",
          "created",
          "fulfilment",
          "return",
          "events"
        ]
      },
      "StoreExportStockAlertModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "product": {
            "type": "string",
            "minLength": 1
          },
          "variant": {
            "type": "string",
            "minLength": 1
          },
          "contact": {
            "type": "string",
            "minLength": 1
          },
          "channel": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "sent": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "product",
          "variant",
          "contact",
          "channel",
          "status",
          "sent",
          "created"
        ]
      },
      "StoreExportTaxModel": {
        "type": "object",
        "properties": {
          "engine": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "prices_include_tax": {
            "type": "boolean"
          },
          "tax_amount": {
            "type": "integer"
          },
          "destination": {
            "nullable": true
          },
          "evidence": {
            "nullable": true
          },
          "registration": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "lines": {
            "type": "array",
            "items": {
              "type": "object"
            }
          }
        },
        "required": [
          "engine",
          "currency",
          "prices_include_tax",
          "tax_amount",
          "destination",
          "evidence",
          "registration",
          "lines"
        ]
      },
      "StoreExportTrackingMessageModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "order": {
            "type": "string",
            "minLength": 1
          },
          "key": {
            "type": "string",
            "minLength": 1
          },
          "channel": {
            "type": "string",
            "minLength": 1
          },
          "recipient": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "sent": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "order",
          "key",
          "channel",
          "recipient",
          "status",
          "sent"
        ]
      },
      "StoreExportWaitlistModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "product": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "drop": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "contact": {
            "type": "string",
            "minLength": 1
          },
          "notify_by": {
            "type": "string",
            "minLength": 1
          },
          "notified": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "product",
          "drop",
          "contact",
          "notify_by",
          "notified",
          "created"
        ]
      },
      "StoreFlowBody": {
        "type": "object",
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "copy": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreFlowCopyModel"
            }
          },
          "use_default_copy": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      },
      "StoreFlowCopyModel": {
        "type": "object",
        "properties": {
          "subject": {
            "type": "string",
            "maxLength": 150,
            "minLength": 1
          },
          "heading": {
            "type": "string",
            "maxLength": 150,
            "minLength": 1
          },
          "body": {
            "type": "string",
            "maxLength": 2000,
            "minLength": 1
          },
          "action_label": {
            "type": "string",
            "maxLength": 60,
            "minLength": 1
          }
        },
        "additionalProperties": false,
        "required": [
          "subject",
          "heading",
          "body",
          "action_label"
        ]
      },
      "StoreFlowEventData": {
        "type": "object",
        "description": "What an event carrying a `store_flow` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/StoreFlowEventObject"
          }
        }
      },
      "StoreFlowEventObject": {
        "type": "object",
        "description": "A `store_flow` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "store_flow"
          }
        },
        "additionalProperties": true
      },
      "StoreFlowList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreFlowModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "StoreFlowModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "key": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "trigger": {
            "type": "string",
            "minLength": 1
          },
          "enabled": {
            "type": "boolean"
          },
          "delays": {
            "type": "array",
            "items": {
              "type": "integer"
            }
          },
          "copy": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreFlowCopyModel"
            }
          },
          "default_copy": {
            "type": "boolean"
          },
          "copy_approved_at": {
            "nullable": true,
            "type": "integer"
          },
          "paused": {
            "type": "boolean"
          },
          "paused_at": {
            "nullable": true,
            "type": "integer"
          },
          "paused_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "results": {
            "$ref": "#/components/schemas/StoreFlowResultsModel"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "key",
          "name",
          "trigger",
          "enabled",
          "delays",
          "copy",
          "default_copy",
          "copy_approved_at",
          "paused",
          "paused_at",
          "paused_reason",
          "results"
        ]
      },
      "StoreFlowPausedEvent": {
        "type": "object",
        "description": "The `store_flow.paused` event (the store's shoppers events): `data.object` is the `store_flow`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store_flow.paused"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StoreFlowEventData"
          }
        }
      },
      "StoreFlowResultsModel": {
        "type": "object",
        "properties": {
          "days": {
            "type": "integer",
            "multipleOf": 1
          },
          "sent": {
            "type": "integer",
            "multipleOf": 1
          },
          "orders": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "days",
          "sent",
          "orders"
        ]
      },
      "StoreImportBringBody": {
        "type": "object",
        "properties": {
          "collections": {
            "type": "boolean"
          },
          "products": {
            "type": "boolean"
          },
          "customers": {
            "type": "boolean"
          },
          "orders": {
            "type": "boolean"
          },
          "gift_cards": {
            "type": "boolean"
          },
          "discounts": {
            "type": "boolean"
          },
          "pages": {
            "type": "boolean"
          },
          "redirects": {
            "type": "boolean"
          },
          "reviews": {
            "type": "boolean"
          }
        }
      },
      "StoreImportCompletedEvent": {
        "type": "object",
        "description": "The `store.import_completed` event (the store's site events): `data.object` is the `store_import`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.import_completed"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StoreImportEventData"
          }
        }
      },
      "StoreImportEventData": {
        "type": "object",
        "description": "What an event carrying a `store_import` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/StoreImportEventObject"
          }
        }
      },
      "StoreImportEventObject": {
        "type": "object",
        "description": "A `store_import` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "store_import"
          }
        },
        "additionalProperties": true
      },
      "StoreImportFileModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "rows": {
            "type": "integer",
            "multipleOf": 1
          },
          "complete": {
            "type": "boolean"
          },
          "uploaded_at": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "id",
          "name",
          "kind",
          "rows",
          "complete",
          "uploaded_at"
        ]
      },
      "StoreImportIssueModel": {
        "type": "object",
        "properties": {
          "phase": {
            "type": "string",
            "enum": [
              "collections",
              "products",
              "customers",
              "orders",
              "gift_cards",
              "discounts",
              "pages",
              "redirects",
              "reviews"
            ],
            "minLength": 1
          },
          "code": {
            "type": "string",
            "minLength": 1
          },
          "external_id": {
            "type": "string",
            "minLength": 1
          },
          "message": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "phase",
          "code",
          "external_id",
          "message"
        ]
      },
      "StoreImportKeptModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "id": {
            "type": "string",
            "minLength": 1
          },
          "used_by": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "id",
          "used_by"
        ]
      },
      "StoreImportList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreImportModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "StoreImportMappingBody": {
        "type": "object",
        "properties": {
          "bring": {
            "$ref": "#/components/schemas/StoreImportBringBody"
          }
        }
      },
      "StoreImportModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "source": {
            "type": "string",
            "enum": [
              "shopify",
              "woocommerce",
              "squarespace",
              "wix",
              "etsy",
              "big_cartel",
              "square_online"
            ],
            "minLength": 1
          },
          "method": {
            "type": "string",
            "enum": [
              "api",
              "files"
            ],
            "minLength": 1
          },
          "shop": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "connected": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "reading",
              "previewed",
              "importing",
              "completed",
              "failed",
              "undone"
            ],
            "minLength": 1
          },
          "mapping": {
            "type": "object"
          },
          "files": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreImportFileModel"
            }
          },
          "preview": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/StoreImportPreviewModel"
              }
            ],
            "nullable": true
          },
          "phases": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreImportPhaseModel"
            }
          },
          "issues": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreImportIssueModel"
            }
          },
          "failure": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "completed_at": {
            "nullable": true,
            "type": "integer"
          },
          "undo_until": {
            "nullable": true,
            "type": "integer"
          },
          "undone_at": {
            "nullable": true,
            "type": "integer"
          },
          "undo": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/StoreImportUndoModel"
              }
            ],
            "nullable": true
          },
          "started_by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created_by": {
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "source",
          "method",
          "shop",
          "connected",
          "status",
          "mapping",
          "files",
          "preview",
          "phases",
          "issues",
          "failure",
          "completed_at",
          "undo_until",
          "undone_at",
          "undo",
          "started_by",
          "created_by",
          "created"
        ],
        "example": {
          "id": "simp_01K7HBBM4P6R8T0V2X4Z6B8D0F",
          "object": "store_import",
          "livemode": false,
          "source": "shopify",
          "method": "api",
          "shop": "harbour-gifts.myshopify.com",
          "connected": true,
          "status": "completed",
          "mapping": {},
          "files": [],
          "preview": {
            "at": 1792306800,
            "phases": [
              {
                "phase": "products",
                "read": 42,
                "create": 40,
                "match": 2,
                "update": 0,
                "unchanged": 0,
                "samples": [
                  "Sea salt candle",
                  "Harbour mug"
                ]
              }
            ],
            "conflicts": [],
            "warnings": [],
            "not_moved": [
              {
                "what": "Shopify Flow automations",
                "reason": "Tuppence has no equivalent yet."
              }
            ],
            "shop": {
              "name": "Harbour Gifts",
              "currency": "GBP",
              "plan": "basic"
            }
          },
          "phases": [
            {
              "phase": "products",
              "status": "done",
              "read": 42,
              "created": 40,
              "matched": 2,
              "updated": 0,
              "skipped": 0,
              "conflicts": 0
            }
          ],
          "issues": [],
          "failure": null,
          "completed_at": 1792310400,
          "undo_until": 1792915200,
          "undone_at": null,
          "undo": null,
          "started_by": "usr_01J8ZK0A2C4E6G8J0L2N4Q6S8U",
          "created_by": "usr_01J8ZK0A2C4E6G8J0L2N4Q6S8U",
          "created": 1792306000
        }
      },
      "StoreImportNotMovedModel": {
        "type": "object",
        "properties": {
          "what": {
            "type": "string",
            "minLength": 1
          },
          "reason": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "what",
          "reason"
        ]
      },
      "StoreImportPhaseModel": {
        "type": "object",
        "properties": {
          "phase": {
            "type": "string",
            "enum": [
              "collections",
              "products",
              "customers",
              "orders",
              "gift_cards",
              "discounts",
              "pages",
              "redirects",
              "reviews"
            ],
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "running",
              "done",
              "failed"
            ],
            "minLength": 1
          },
          "read": {
            "type": "integer",
            "multipleOf": 1
          },
          "created": {
            "type": "integer",
            "multipleOf": 1
          },
          "matched": {
            "type": "integer",
            "multipleOf": 1
          },
          "updated": {
            "type": "integer",
            "multipleOf": 1
          },
          "skipped": {
            "type": "integer",
            "multipleOf": 1
          },
          "conflicts": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "phase",
          "status",
          "read",
          "created",
          "matched",
          "updated",
          "skipped",
          "conflicts"
        ]
      },
      "StoreImportPreviewModel": {
        "type": "object",
        "properties": {
          "at": {
            "type": "integer",
            "multipleOf": 1
          },
          "phases": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreImportPreviewPhaseModel"
            }
          },
          "conflicts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreImportIssueModel"
            }
          },
          "warnings": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "not_moved": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreImportNotMovedModel"
            }
          },
          "shop": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/StoreImportSourceShopModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "at",
          "phases",
          "conflicts",
          "warnings",
          "not_moved",
          "shop"
        ]
      },
      "StoreImportPreviewPhaseModel": {
        "type": "object",
        "properties": {
          "phase": {
            "type": "string",
            "enum": [
              "collections",
              "products",
              "customers",
              "orders",
              "gift_cards",
              "discounts",
              "pages",
              "redirects",
              "reviews"
            ],
            "minLength": 1
          },
          "read": {
            "type": "integer",
            "multipleOf": 1
          },
          "create": {
            "type": "integer",
            "multipleOf": 1
          },
          "match": {
            "type": "integer",
            "multipleOf": 1
          },
          "update": {
            "type": "integer",
            "multipleOf": 1
          },
          "unchanged": {
            "type": "integer",
            "multipleOf": 1
          },
          "samples": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "phase",
          "read",
          "create",
          "match",
          "update",
          "unchanged",
          "samples"
        ]
      },
      "StoreImportSavingsModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": [
              "store_import_savings"
            ],
            "minLength": 1
          },
          "store_import": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "assumptions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "period_start": {
            "type": "integer",
            "multipleOf": 1
          },
          "period_end": {
            "type": "integer",
            "multipleOf": 1
          },
          "orders": {
            "type": "integer",
            "multipleOf": 1
          },
          "sales": {
            "type": "integer",
            "multipleOf": 1
          },
          "other_currency_orders": {
            "type": "integer",
            "multipleOf": 1
          },
          "tuppence": {
            "$ref": "#/components/schemas/StoreImportSavingsTuppenceModel"
          },
          "plan": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/StoreImportSavingsPlanModel"
              }
            ],
            "nullable": true
          },
          "saving": {
            "nullable": true,
            "type": "integer"
          },
          "plans": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StorePlanModel"
            }
          },
          "suggested_plan": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "store_import",
          "livemode",
          "assumptions",
          "currency",
          "period_start",
          "period_end",
          "orders",
          "sales",
          "other_currency_orders",
          "tuppence",
          "plan",
          "saving",
          "plans",
          "suggested_plan"
        ]
      },
      "StoreImportSavingsPlanModel": {
        "type": "object",
        "properties": {
          "key": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "monthly_fee": {
            "type": "integer",
            "multipleOf": 1
          },
          "card_bps": {
            "type": "integer",
            "multipleOf": 1
          },
          "card_fixed": {
            "type": "integer",
            "multipleOf": 1
          },
          "source_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "checked": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "monthly_fees": {
            "type": "integer",
            "multipleOf": 1
          },
          "card_fees": {
            "type": "integer",
            "multipleOf": 1
          },
          "total": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "key",
          "name",
          "monthly_fee",
          "card_bps",
          "card_fixed",
          "source_url",
          "checked",
          "monthly_fees",
          "card_fees",
          "total"
        ]
      },
      "StoreImportSavingsTuppenceModel": {
        "type": "object",
        "properties": {
          "monthly_fees": {
            "type": "integer",
            "multipleOf": 1
          },
          "card_fees": {
            "type": "integer",
            "multipleOf": 1
          },
          "total": {
            "type": "integer",
            "multipleOf": 1
          },
          "schedule_version": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "monthly_fees",
          "card_fees",
          "total",
          "schedule_version"
        ]
      },
      "StoreImportSourceShopModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "plan": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "name",
          "currency",
          "plan"
        ]
      },
      "StoreImportStartedEvent": {
        "type": "object",
        "description": "The `store.import_started` event (the store's site events): `data.object` is the `store_import`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.import_started"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StoreImportEventData"
          }
        }
      },
      "StoreImportUndoModel": {
        "type": "object",
        "properties": {
          "removed": {
            "type": "object"
          },
          "kept": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreImportKeptModel"
            }
          }
        },
        "required": [
          "removed",
          "kept"
        ]
      },
      "StoreImportUndoneEvent": {
        "type": "object",
        "description": "The `store.import_undone` event (the store's site events): `data.object` is the `store_import`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.import_undone"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StoreImportEventData"
          }
        }
      },
      "StoreOrderPlacedEvent": {
        "type": "object",
        "description": "The `store.order_placed` event (the store's orders events): `data.object` is the `order`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.order_placed"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StoreOrderPlacedEventData"
          }
        }
      },
      "StoreOrderPlacedEventData": {
        "type": "object",
        "description": "What an event carrying a `order` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/OrderEventObject"
          }
        }
      },
      "StorePlanModel": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "minLength": 1
          },
          "provider": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "monthly_fee": {
            "type": "integer",
            "multipleOf": 1
          },
          "card_bps": {
            "type": "integer",
            "multipleOf": 1
          },
          "card_fixed": {
            "type": "integer",
            "multipleOf": 1
          },
          "source_url": {
            "type": "string",
            "minLength": 1
          },
          "checked": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "key",
          "provider",
          "name",
          "monthly_fee",
          "card_bps",
          "card_fixed",
          "source_url",
          "checked"
        ]
      },
      "StorePrivacyRequestEventData": {
        "type": "object",
        "description": "What an event carrying a `store_privacy_request` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/StorePrivacyRequestEventObject"
          }
        }
      },
      "StorePrivacyRequestEventObject": {
        "type": "object",
        "description": "A `store_privacy_request` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "store_privacy_request"
          }
        },
        "additionalProperties": true
      },
      "StorePrivacyRequestList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StorePrivacyRequestModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "StorePrivacyRequestModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "order": {
            "type": "string",
            "minLength": 1
          },
          "order_number": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "customer": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "export",
              "erasure"
            ],
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "open",
              "done"
            ],
            "minLength": 1
          },
          "received": {
            "type": "integer"
          },
          "due": {
            "type": "integer"
          },
          "done": {
            "nullable": true,
            "type": "integer"
          },
          "download_until": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "site",
          "order",
          "order_number",
          "customer",
          "kind",
          "status",
          "received",
          "due",
          "done",
          "download_until"
        ]
      },
      "StorePrivacyRequestReceivedEvent": {
        "type": "object",
        "description": "The `store.privacy_request_received` event (the store's shoppers events): `data.object` is the `store_privacy_request`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.privacy_request_received"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StorePrivacyRequestEventData"
          }
        }
      },
      "StoreProductPublishedEvent": {
        "type": "object",
        "description": "The `store.product_published` event (the store's catalogue events): `data.object` is the `product`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.product_published"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ProductEventData"
          }
        }
      },
      "StoreProductUnpublishedEvent": {
        "type": "object",
        "description": "The `store.product_unpublished` event (the store's catalogue events): `data.object` is the `product`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.product_unpublished"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/ProductEventData"
          }
        }
      },
      "StoreProposalEventData": {
        "type": "object",
        "description": "What an event carrying a `store_proposal` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/StoreProposalEventObject"
          }
        }
      },
      "StoreProposalEventObject": {
        "type": "object",
        "description": "A `store_proposal` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "store_proposal"
          }
        },
        "additionalProperties": true
      },
      "StoreProposalFailedEvent": {
        "type": "object",
        "description": "The `store.proposal_failed` event (the store's site events): `data.object` is the `store_proposal`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.proposal_failed"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StoreProposalEventData"
          }
        }
      },
      "StoreProposalListModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreProposalSummaryModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "StoreProposalModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "inputs": {
            "$ref": "#/components/schemas/ProposalInputsModel"
          },
          "stages": {
            "$ref": "#/components/schemas/ProposalStagesModel"
          },
          "cost_minor": {
            "type": "integer",
            "multipleOf": 1
          },
          "cost_currency": {
            "type": "string",
            "minLength": 1
          },
          "models": {
            "type": "object"
          },
          "counts": {
            "$ref": "#/components/schemas/ProposalCountsModel"
          },
          "items": {
            "$ref": "#/components/schemas/ProposalItemList"
          },
          "ai_allowance": {
            "$ref": "#/components/schemas/StoreAiAllowanceModel"
          },
          "ready_at": {
            "nullable": true,
            "type": "integer"
          },
          "published_at": {
            "nullable": true,
            "type": "integer"
          },
          "published_version": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "error": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "site",
          "status",
          "inputs",
          "stages",
          "cost_minor",
          "cost_currency",
          "models",
          "counts",
          "items",
          "ai_allowance",
          "ready_at",
          "published_at",
          "published_version",
          "error",
          "created"
        ]
      },
      "StoreProposalPublishedEvent": {
        "type": "object",
        "description": "The `store.proposal_published` event (the store's site events): `data.object` is the `store_proposal`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.proposal_published"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StoreProposalEventData"
          }
        }
      },
      "StoreProposalReadyEvent": {
        "type": "object",
        "description": "The `store.proposal_ready` event (the store's site events): `data.object` is the `store_proposal`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.proposal_ready"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StoreProposalEventData"
          }
        }
      },
      "StoreProposalStartedEvent": {
        "type": "object",
        "description": "The `store.proposal_started` event (the store's site events): `data.object` is the `store_proposal`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.proposal_started"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StoreProposalEventData"
          }
        }
      },
      "StoreProposalSummaryModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "stages": {
            "$ref": "#/components/schemas/ProposalStagesModel"
          },
          "cost_minor": {
            "type": "integer",
            "multipleOf": 1
          },
          "counts": {
            "$ref": "#/components/schemas/ProposalCountsModel"
          },
          "ready_at": {
            "nullable": true,
            "type": "integer"
          },
          "published_at": {
            "nullable": true,
            "type": "integer"
          },
          "published_version": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "error": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "site",
          "status",
          "stages",
          "cost_minor",
          "counts",
          "ready_at",
          "published_at",
          "published_version",
          "error",
          "created"
        ]
      },
      "StoreReturnLineBody": {
        "type": "object",
        "properties": {
          "line": {
            "type": "string",
            "maxLength": 40
          },
          "quantity": {
            "type": "string",
            "maxLength": 16
          },
          "reason": {
            "type": "string",
            "maxLength": 24
          },
          "reason_text": {
            "type": "string",
            "maxLength": 1000
          }
        }
      },
      "StoreSegmentBody": {
        "type": "object",
        "properties": {
          "bought_category": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "wishlisted_product": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "spent_over": {
            "nullable": true,
            "type": "integer",
            "multipleOf": 1
          },
          "last_order_before": {
            "nullable": true,
            "type": "string",
            "maxLength": 10
          }
        },
        "additionalProperties": false
      },
      "StoreSegmentModel": {
        "type": "object",
        "properties": {
          "bought_category": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "wishlisted_product": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "spent_over": {
            "nullable": true,
            "type": "integer",
            "multipleOf": 1
          },
          "last_order_before": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "bought_category",
          "wishlisted_product",
          "spent_over",
          "last_order_before"
        ]
      },
      "StoreSettingsBody": {
        "type": "object",
        "properties": {
          "po_limit": {
            "nullable": true,
            "type": "integer",
            "minimum": 0,
            "maximum": 100000000,
            "multipleOf": 1
          },
          "credit_limit": {
            "nullable": true,
            "type": "integer",
            "minimum": 0,
            "maximum": 100000,
            "multipleOf": 1
          },
          "referrals": {
            "type": "boolean"
          },
          "referral_reward": {
            "nullable": true,
            "type": "integer",
            "minimum": 0,
            "maximum": 100000,
            "multipleOf": 1
          },
          "referral_friend_reward": {
            "nullable": true,
            "type": "integer",
            "minimum": 0,
            "maximum": 100000,
            "multipleOf": 1
          },
          "min_margin_bps": {
            "nullable": true,
            "type": "integer",
            "minimum": 0,
            "maximum": 9000,
            "multipleOf": 1
          }
        }
      },
      "StoreSettingsModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "po_limit": {
            "nullable": true,
            "type": "integer"
          },
          "po_limit_default": {
            "type": "integer"
          },
          "credit_limit": {
            "nullable": true,
            "type": "integer"
          },
          "credit_limit_default": {
            "type": "integer"
          },
          "referrals": {
            "type": "boolean"
          },
          "referral_reward": {
            "nullable": true,
            "type": "integer"
          },
          "referral_friend_reward": {
            "nullable": true,
            "type": "integer"
          },
          "referral_reward_default": {
            "type": "integer"
          },
          "min_margin_bps": {
            "nullable": true,
            "type": "integer"
          },
          "min_margin_bps_default": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "po_limit",
          "po_limit_default",
          "credit_limit",
          "credit_limit_default",
          "referrals",
          "referral_reward",
          "referral_friend_reward",
          "referral_reward_default",
          "min_margin_bps",
          "min_margin_bps_default",
          "currency"
        ]
      },
      "StoreSitePublishedEvent": {
        "type": "object",
        "description": "The `store.site_published` event (the store's site events): `data.object` is the `site`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.site_published"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/SiteEventData"
          }
        }
      },
      "StoreSiteRevertedEvent": {
        "type": "object",
        "description": "The `store.site_reverted` event (the store's site events): `data.object` is the `site`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.site_reverted"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/SiteEventData"
          }
        }
      },
      "StoreSiteScheduledEvent": {
        "type": "object",
        "description": "The `store.site_scheduled` event (the store's site events): `data.object` is the `site`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.site_scheduled"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/SiteEventData"
          }
        }
      },
      "StoreSiteUpdatedEvent": {
        "type": "object",
        "description": "The `store.site_updated` event (the store's site events): `data.object` is the `site`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.site_updated"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/SiteEventData"
          }
        }
      },
      "StoreSnapEventData": {
        "type": "object",
        "description": "What an event carrying a `store_snap` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/StoreSnapEventObject"
          }
        }
      },
      "StoreSnapEventObject": {
        "type": "object",
        "description": "A `store_snap` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "store_snap"
          }
        },
        "additionalProperties": true
      },
      "StoreSnapFailedEvent": {
        "type": "object",
        "description": "The `store.snap_failed` event (the store's site events): `data.object` is the `store_snap`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.snap_failed"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StoreSnapEventData"
          }
        }
      },
      "StoreSnapModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "product": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "media": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "note": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "barcode": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "location": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "stages": {
            "$ref": "#/components/schemas/SnapStagesModel"
          },
          "title": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "product_type": {
            "nullable": true,
            "type": "integer"
          },
          "weight": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/SnapWeightModel"
              }
            ],
            "nullable": true
          },
          "price_band": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/SnapPriceBandModel"
              }
            ],
            "nullable": true
          },
          "clean_media": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "studio_media": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "lifestyle_media": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "channels": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "claims_status": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "cost_minor": {
            "type": "integer",
            "multipleOf": 1
          },
          "error": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "started_at": {
            "type": "integer",
            "multipleOf": 1
          },
          "ready_at": {
            "nullable": true,
            "type": "integer"
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "id",
          "object",
          "status",
          "product",
          "media",
          "note",
          "barcode",
          "location",
          "stages",
          "title",
          "product_type",
          "weight",
          "price_band",
          "clean_media",
          "studio_media",
          "lifestyle_media",
          "channels",
          "claims_status",
          "cost_minor",
          "error",
          "started_at",
          "ready_at",
          "livemode",
          "created"
        ]
      },
      "StoreSnapPublishedEvent": {
        "type": "object",
        "description": "The `store.snap_published` event (the store's site events): `data.object` is the `store_snap`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.snap_published"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StoreSnapEventData"
          }
        }
      },
      "StoreSnapReadyEvent": {
        "type": "object",
        "description": "The `store.snap_ready` event (the store's site events): `data.object` is the `store_snap`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.snap_ready"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StoreSnapEventData"
          }
        }
      },
      "StoreSnapStartedEvent": {
        "type": "object",
        "description": "The `store.snap_started` event (the store's site events): `data.object` is the `store_snap`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.snap_started"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StoreSnapEventData"
          }
        }
      },
      "StoreTaxThresholdNearEvent": {
        "type": "object",
        "description": "The `store.tax_threshold_near` event (the store's rules events): `data.object` is the `tax_nexus_state`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.tax_threshold_near"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/TaxNexusStateEventData"
          }
        }
      },
      "StoreTaxThresholdReachedEvent": {
        "type": "object",
        "description": "The `store.tax_threshold_reached` event (the store's rules events): `data.object` is the `tax_nexus_state`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store.tax_threshold_reached"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/TaxNexusStateEventData"
          }
        }
      },
      "StoreThreadCitationModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "ref": {
            "type": "string",
            "minLength": 1
          },
          "label": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "kind",
          "ref",
          "label"
        ]
      },
      "StoreThreadEventData": {
        "type": "object",
        "description": "What an event carrying a `store_thread` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/StoreThreadEventObject"
          }
        }
      },
      "StoreThreadEventObject": {
        "type": "object",
        "description": "A `store_thread` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "store_thread"
          }
        },
        "additionalProperties": true
      },
      "StoreThreadList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreThreadModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "StoreThreadMessageModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "seq": {
            "type": "integer",
            "multipleOf": 1
          },
          "role": {
            "type": "string",
            "minLength": 1
          },
          "text": {
            "type": "string",
            "minLength": 1
          },
          "citations": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreThreadCitationModel"
            }
          },
          "author": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "email": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "seq",
          "role",
          "text",
          "citations",
          "author",
          "email",
          "created"
        ]
      },
      "StoreThreadMessageReceivedEvent": {
        "type": "object",
        "description": "The `store_thread.message_received` event (the store's shoppers events): `data.object` is the `store_thread`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store_thread.message_received"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StoreThreadEventData"
          }
        }
      },
      "StoreThreadModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "site": {
            "type": "string",
            "minLength": 1
          },
          "channel": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "needs_you_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "assignee": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "email": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "external_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "reply_until": {
            "nullable": true,
            "type": "integer"
          },
          "outside_window": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "subject": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "order": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "customer": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "suggested_customer": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "page": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "verified": {
            "type": "boolean"
          },
          "summary": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "handed_over_at": {
            "nullable": true,
            "type": "integer"
          },
          "last_message_at": {
            "type": "integer"
          },
          "created": {
            "type": "integer"
          },
          "messages": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreThreadMessageModel"
            }
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "site",
          "channel",
          "status",
          "needs_you_reason",
          "assignee",
          "email",
          "external_name",
          "reply_until",
          "outside_window",
          "subject",
          "order",
          "customer",
          "suggested_customer",
          "page",
          "verified",
          "summary",
          "handed_over_at",
          "last_message_at",
          "created",
          "messages"
        ]
      },
      "StoreThreadNeedsYouEvent": {
        "type": "object",
        "description": "The `store_thread.needs_you` event (the store's shoppers events): `data.object` is the `store_thread`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "store_thread.needs_you"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/StoreThreadEventData"
          }
        }
      },
      "StoreThreadReplyBody": {
        "type": "object",
        "properties": {
          "text": {
            "type": "string",
            "maxLength": 10000,
            "minLength": 1
          }
        },
        "additionalProperties": false,
        "required": [
          "text"
        ]
      },
      "StoreThreadTemplateBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 200,
            "minLength": 1
          },
          "language": {
            "type": "string",
            "maxLength": 20,
            "minLength": 2
          }
        },
        "additionalProperties": false,
        "required": [
          "name",
          "language"
        ]
      },
      "StoreThreadTemplateModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "language": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "name",
          "language"
        ]
      },
      "StoreThreadTemplates": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "templates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StoreThreadTemplateModel"
            }
          }
        },
        "required": [
          "object",
          "templates"
        ]
      },
      "StoreThreadUpdateBody": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "open",
              "needs_you",
              "waiting_customer",
              "closed"
            ]
          },
          "assignee": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "customer": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          }
        },
        "additionalProperties": false
      },
      "StudioBackdropModel": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "minLength": 1
          },
          "colour": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "label",
          "colour"
        ]
      },
      "StudioEditOptionModel": {
        "type": "object",
        "properties": {
          "edit": {
            "type": "string",
            "enum": [
              "clean",
              "studio",
              "relight",
              "scene"
            ],
            "minLength": 1
          },
          "available": {
            "type": "boolean"
          },
          "message": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "estimate": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "edit",
          "available",
          "message",
          "estimate"
        ]
      },
      "SubscriptionDiscountModel": {
        "type": "object",
        "properties": {
          "coupon": {
            "type": "string",
            "minLength": 1
          },
          "promo_code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "percent_off": {
            "nullable": true,
            "type": "integer"
          },
          "amount_off": {
            "nullable": true,
            "type": "integer"
          },
          "currency": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "periods_remaining": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "coupon",
          "promo_code",
          "percent_off",
          "amount_off",
          "currency",
          "periods_remaining"
        ]
      },
      "SubscriptionEventData": {
        "type": "object",
        "description": "What an event carrying a `subscription` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/SubscriptionEventObject"
          }
        }
      },
      "SubscriptionEventObject": {
        "type": "object",
        "description": "A `subscription` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "subscription"
          }
        },
        "additionalProperties": true
      },
      "SubscriptionList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SubscriptionModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "SubscriptionModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "plan": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "interval": {
            "type": "string",
            "minLength": 1
          },
          "interval_count": {
            "type": "integer"
          },
          "payment_method": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "trialing",
              "active",
              "past_due",
              "paused",
              "canceled"
            ],
            "minLength": 1
          },
          "current_period_start": {
            "nullable": true,
            "type": "integer"
          },
          "current_period_end": {
            "nullable": true,
            "type": "integer"
          },
          "next_action_at": {
            "nullable": true,
            "type": "integer"
          },
          "attempts": {
            "type": "integer"
          },
          "cancel_at_period_end": {
            "type": "boolean"
          },
          "pending_plan": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "credit": {
            "type": "integer"
          },
          "canceled_at": {
            "nullable": true,
            "type": "integer"
          },
          "paused_at": {
            "nullable": true,
            "type": "integer"
          },
          "resumes_at": {
            "nullable": true,
            "type": "integer"
          },
          "discount": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/SubscriptionDiscountModel"
              }
            ],
            "nullable": true
          },
          "metadata": {
            "type": "object"
          },
          "created": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "customer",
          "plan",
          "amount",
          "currency",
          "interval",
          "interval_count",
          "payment_method",
          "status",
          "current_period_start",
          "current_period_end",
          "next_action_at",
          "attempts",
          "cancel_at_period_end",
          "pending_plan",
          "credit",
          "canceled_at",
          "paused_at",
          "resumes_at",
          "discount",
          "metadata",
          "created"
        ]
      },
      "SubscriptionOfferBody": {
        "type": "object",
        "properties": {
          "product": {
            "type": "string",
            "maxLength": 40
          },
          "variants": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "intervals": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SubscriptionOfferIntervalModel"
            }
          },
          "discount_bps": {
            "type": "integer",
            "multipleOf": 1
          },
          "first_order_discount_bps": {
            "nullable": true,
            "type": "integer",
            "multipleOf": 1
          },
          "min_cycles": {
            "type": "integer",
            "multipleOf": 1
          },
          "active": {
            "type": "boolean"
          }
        }
      },
      "SubscriptionOfferIntervalModel": {
        "type": "object",
        "properties": {
          "interval": {
            "type": "string",
            "enum": [
              "week",
              "month"
            ],
            "minLength": 1
          },
          "count": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "interval",
          "count"
        ]
      },
      "SubscriptionOfferList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SubscriptionOfferModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "SubscriptionOfferModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "product": {
            "type": "string",
            "minLength": 1
          },
          "variants": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "intervals": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SubscriptionOfferIntervalModel"
            }
          },
          "discount_bps": {
            "type": "integer",
            "multipleOf": 1
          },
          "first_order_discount_bps": {
            "nullable": true,
            "type": "integer"
          },
          "min_cycles": {
            "type": "integer",
            "multipleOf": 1
          },
          "active": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "updated": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "product",
          "variants",
          "intervals",
          "discount_bps",
          "first_order_discount_bps",
          "min_cycles",
          "active",
          "created",
          "updated"
        ]
      },
      "SubscriptionRenewalNoticeSentEvent": {
        "type": "object",
        "description": "The `subscription.renewal_notice_sent` event (the store's orders events): `data.object` is the `subscription`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "subscription.renewal_notice_sent"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/SubscriptionEventData"
          }
        }
      },
      "SubscriptionRenewalSkippedEvent": {
        "type": "object",
        "description": "The `subscription.renewal_skipped` event (the store's orders events): `data.object` is the `subscription`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "subscription.renewal_skipped"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/SubscriptionEventData"
          }
        }
      },
      "SupplierCreateBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 120,
            "minLength": 1
          },
          "email": {
            "nullable": true,
            "type": "string",
            "maxLength": 254
          },
          "lead_time_days": {
            "type": "integer",
            "maximum": 365,
            "minimum": 0,
            "multipleOf": 1
          }
        },
        "required": [
          "name"
        ]
      },
      "SupplierList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SupplierModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "SupplierModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "email": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "lead_time_days": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ],
            "minLength": 1
          }
        },
        "required": [
          "id",
          "object",
          "name",
          "email",
          "lead_time_days",
          "status"
        ]
      },
      "SupplierProductBody": {
        "type": "object",
        "properties": {
          "product": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "case_size": {
            "type": "integer",
            "maximum": 10000,
            "minimum": 1,
            "multipleOf": 1
          },
          "unit_cost": {
            "nullable": true,
            "type": "integer",
            "minimum": 0,
            "maximum": 100000000,
            "multipleOf": 1
          },
          "lead_time_days": {
            "nullable": true,
            "type": "integer",
            "minimum": 0,
            "maximum": 365,
            "multipleOf": 1
          }
        },
        "required": [
          "product"
        ]
      },
      "SupplierProductList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SupplierProductModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "SupplierProductModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "supplier": {
            "type": "string",
            "minLength": 1
          },
          "product": {
            "type": "string",
            "minLength": 1
          },
          "variant": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "case_size": {
            "type": "integer"
          },
          "unit_cost": {
            "nullable": true,
            "type": "integer"
          },
          "lead_time_days": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "supplier",
          "product",
          "variant",
          "name",
          "case_size",
          "unit_cost",
          "lead_time_days"
        ]
      },
      "SupplierUpdateBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 120,
            "minLength": 1
          },
          "email": {
            "nullable": true,
            "type": "string",
            "maxLength": 254
          },
          "lead_time_days": {
            "type": "integer",
            "maximum": 365,
            "minimum": 0,
            "multipleOf": 1
          }
        }
      },
      "SurchargesModel": {
        "type": "object",
        "properties": {
          "amex_bps": {
            "type": "integer",
            "description": "Added to the card rate for an American Express card, in basis points."
          },
          "commercial_bps": {
            "type": "integer",
            "description": "Added for a commercial (business) card, in basis points."
          },
          "foreign_bps": {
            "type": "integer",
            "description": "Added for a card issued outside the business's own card market (its country; the EEA for a business in the eurozone), in basis points."
          },
          "stack": {
            "type": "boolean",
            "description": "`true`: every surcharge that applies is added. `false`: only the dearest one that applies."
          }
        },
        "required": [
          "amex_bps",
          "commercial_bps",
          "foreign_bps",
          "stack"
        ]
      },
      "TakeTenderBody": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "maxLength": 40
          },
          "method": {
            "type": "string",
            "enum": [
              "cash",
              "card",
              "external"
            ]
          },
          "amount": {
            "type": "integer"
          },
          "tendered": {
            "type": "integer"
          },
          "tip_amount": {
            "type": "integer"
          },
          "external_kind": {
            "type": "string",
            "enum": [
              "other_terminal",
              "bank_transfer",
              "meal_voucher",
              "other"
            ]
          },
          "payment_method": {
            "type": "string",
            "maxLength": 40
          },
          "created_offline": {
            "type": "boolean"
          },
          "totals": {
            "$ref": "#/components/schemas/TotalsBody"
          }
        }
      },
      "TaxByRateBody": {
        "type": "object",
        "properties": {
          "tax_rate": {
            "type": "string",
            "maxLength": 40
          },
          "tax": {
            "type": "integer"
          },
          "taxable": {
            "type": "integer"
          }
        }
      },
      "TaxByRateModel": {
        "type": "object",
        "properties": {
          "tax_rate": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "rate_ppm": {
            "type": "integer"
          },
          "taxable": {
            "type": "integer"
          },
          "tax": {
            "type": "integer"
          },
          "inclusive": {
            "type": "boolean"
          }
        },
        "required": [
          "tax_rate",
          "name",
          "rate_ppm",
          "taxable",
          "tax",
          "inclusive"
        ]
      },
      "TaxClassBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 120
          },
          "rules": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TaxRuleBody"
            }
          }
        }
      },
      "TaxClassList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TaxClassModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "TaxClassModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "rules": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TaxRuleModel"
            }
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ],
            "minLength": 1
          },
          "pack_key": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "name",
          "rules",
          "status",
          "pack_key",
          "created"
        ]
      },
      "TaxClassPreviewModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "tax_class": {
            "type": "string",
            "minLength": 1
          },
          "order_type": {
            "type": "string",
            "enum": [
              "eat_in",
              "takeaway",
              "delivery",
              "collection"
            ],
            "minLength": 1
          },
          "rule": {
            "type": "integer"
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "prices_include_tax": {
            "type": "boolean"
          },
          "rounding": {
            "type": "string",
            "enum": [
              "per_line",
              "per_total"
            ],
            "minLength": 1
          },
          "rounding_mode": {
            "type": "string",
            "enum": [
              "half_up",
              "half_even",
              "down"
            ],
            "minLength": 1
          },
          "components": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TaxPreviewComponentModel"
            }
          },
          "tax_amount": {
            "type": "integer"
          },
          "net_amount": {
            "type": "integer"
          },
          "total_amount": {
            "type": "integer"
          }
        },
        "required": [
          "object",
          "tax_class",
          "order_type",
          "rule",
          "location",
          "currency",
          "amount",
          "prices_include_tax",
          "rounding",
          "rounding_mode",
          "components",
          "tax_amount",
          "net_amount",
          "total_amount"
        ]
      },
      "TaxExemptionBody": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "maxLength": 40
          },
          "reference": {
            "nullable": true,
            "type": "string",
            "maxLength": 100
          }
        }
      },
      "TaxExemptionModel": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "minLength": 1
          },
          "reference": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "approved_by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "reason",
          "reference",
          "approved_by"
        ]
      },
      "TaxJurisdictionBody": {
        "type": "object",
        "properties": {
          "country": {
            "type": "string",
            "maxLength": 2,
            "minLength": 1
          },
          "region": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "level": {
            "type": "string",
            "enum": [
              "country",
              "state",
              "province",
              "county",
              "city",
              "district"
            ],
            "minLength": 1
          }
        },
        "required": [
          "country",
          "level"
        ]
      },
      "TaxJurisdictionModel": {
        "type": "object",
        "properties": {
          "country": {
            "type": "string",
            "minLength": 1
          },
          "region": {
            "type": "string"
          },
          "level": {
            "type": "string",
            "enum": [
              "country",
              "state",
              "province",
              "county",
              "city",
              "district"
            ],
            "minLength": 1
          }
        },
        "required": [
          "country",
          "level"
        ]
      },
      "TaxNexusStateEventData": {
        "type": "object",
        "description": "What an event carrying a `tax_nexus_state` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/TaxNexusStateEventObject"
          }
        }
      },
      "TaxNexusStateEventObject": {
        "type": "object",
        "description": "A `tax_nexus_state` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "tax_nexus_state"
          }
        },
        "additionalProperties": true
      },
      "TaxPreviewBody": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "order_type": {
            "type": "string",
            "enum": [
              "eat_in",
              "takeaway",
              "delivery",
              "collection"
            ]
          },
          "location": {
            "type": "string",
            "maxLength": 40
          }
        },
        "required": [
          "amount"
        ]
      },
      "TaxPreviewComponentModel": {
        "type": "object",
        "properties": {
          "tax_rate": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "rate_ppm": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "inclusive": {
            "type": "boolean"
          }
        },
        "required": [
          "tax_rate",
          "name",
          "rate_ppm",
          "amount",
          "inclusive"
        ]
      },
      "TaxRateBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 80
          },
          "rate_ppm": {
            "type": "integer",
            "multipleOf": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "vat",
              "gst",
              "hst",
              "pst",
              "qst",
              "sales_tax",
              "other"
            ]
          },
          "jurisdiction": {
            "$ref": "#/components/schemas/TaxJurisdictionBody"
          },
          "registration_label": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "registration_number": {
            "nullable": true,
            "type": "string",
            "maxLength": 60
          }
        }
      },
      "TaxRateList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TaxRateModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "TaxRateModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "rate_ppm": {
            "type": "integer"
          },
          "kind": {
            "type": "string",
            "enum": [
              "vat",
              "gst",
              "hst",
              "pst",
              "qst",
              "sales_tax",
              "other"
            ],
            "minLength": 1
          },
          "jurisdiction": {
            "$ref": "#/components/schemas/TaxJurisdictionModel"
          },
          "registration_label": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "registration_number": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ],
            "minLength": 1
          },
          "pack_key": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "name",
          "rate_ppm",
          "kind",
          "jurisdiction",
          "registration_label",
          "registration_number",
          "status",
          "pack_key",
          "created"
        ]
      },
      "TaxRegistrationBody": {
        "type": "object",
        "properties": {
          "country": {
            "type": "string",
            "maxLength": 2
          },
          "type": {
            "type": "string",
            "enum": [
              "state_sales_tax",
              "standard",
              "ioss"
            ]
          },
          "state": {
            "type": "string",
            "maxLength": 40
          },
          "number": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "source": {
            "type": "string",
            "enum": [
              "business",
              "nexus_tracker"
            ]
          }
        }
      },
      "TaxRegistrationCreatedEvent": {
        "type": "object",
        "description": "The `tax_registration.created` event (the store's rules events): `data.object` is the `tax_registration`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "tax_registration.created"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/TaxRegistrationEventData"
          }
        }
      },
      "TaxRegistrationEventData": {
        "type": "object",
        "description": "What an event carrying a `tax_registration` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/TaxRegistrationEventObject"
          }
        }
      },
      "TaxRegistrationEventObject": {
        "type": "object",
        "description": "A `tax_registration` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "tax_registration"
          }
        },
        "additionalProperties": true
      },
      "TaxRegistrationList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TaxRegistrationModel"
            }
          }
        },
        "required": [
          "object",
          "data"
        ]
      },
      "TaxRegistrationModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "country": {
            "type": "string",
            "minLength": 1
          },
          "state": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "type": {
            "type": "string",
            "minLength": 1
          },
          "number": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "source": {
            "type": "string",
            "minLength": 1
          },
          "active_from": {
            "type": "integer",
            "multipleOf": 1
          },
          "expires_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer",
            "multipleOf": 1
          },
          "livemode": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "object",
          "country",
          "state",
          "type",
          "number",
          "source",
          "active_from",
          "expires_at",
          "created",
          "livemode"
        ]
      },
      "TaxRuleBody": {
        "type": "object",
        "properties": {
          "when": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/TaxRuleWhenBody"
              }
            ],
            "nullable": true
          },
          "rates": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "rates"
        ]
      },
      "TaxRuleModel": {
        "type": "object",
        "properties": {
          "when": {
            "$ref": "#/components/schemas/TaxRuleWhenModel"
          },
          "rates": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "rates"
        ]
      },
      "TaxRuleWhenBody": {
        "type": "object",
        "properties": {
          "order_type": {
            "type": "string",
            "enum": [
              "eat_in",
              "takeaway",
              "delivery",
              "collection"
            ]
          }
        }
      },
      "TaxRuleWhenModel": {
        "type": "object",
        "properties": {
          "order_type": {
            "type": "string",
            "enum": [
              "eat_in",
              "takeaway",
              "delivery",
              "collection"
            ]
          }
        }
      },
      "TaxSectionModel": {
        "type": "object",
        "properties": {
          "components": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PackTaxRateModel"
            }
          },
          "classes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PackTaxClassModel"
            }
          }
        },
        "required": [
          "components",
          "classes"
        ]
      },
      "TenderBody": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "maxLength": 40
          },
          "method": {
            "type": "string",
            "enum": [
              "cash",
              "card",
              "external"
            ]
          },
          "amount": {
            "type": "integer"
          },
          "tendered": {
            "type": "integer"
          },
          "tip_amount": {
            "type": "integer"
          },
          "external_kind": {
            "type": "string",
            "enum": [
              "other_terminal",
              "bank_transfer",
              "meal_voucher",
              "other"
            ]
          },
          "payment_method": {
            "type": "string",
            "maxLength": 40
          },
          "created_offline": {
            "type": "boolean"
          }
        }
      },
      "TenderCreatedEvent": {
        "type": "object",
        "description": "The `tender.created` event (the store's orders events): `data.object` is the `tender`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "tender.created"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/TenderEventData"
          }
        }
      },
      "TenderEventData": {
        "type": "object",
        "description": "What an event carrying a `tender` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/TenderEventObject"
          }
        }
      },
      "TenderEventObject": {
        "type": "object",
        "description": "A `tender` object, as the API returns it.",
        "required": [
          "id",
          "object"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "object": {
            "type": "string",
            "example": "tender"
          }
        },
        "additionalProperties": true
      },
      "TenderList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TenderModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "TenderModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "order": {
            "type": "string",
            "minLength": 1
          },
          "method": {
            "type": "string",
            "enum": [
              "cash",
              "card",
              "voucher",
              "package",
              "membership",
              "credit",
              "external",
              "booking_deposit",
              "pre_auth",
              "deposit_refund",
              "account"
            ],
            "minLength": 1
          },
          "external_kind": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "payment": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "voucher_redemption": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "tip_amount": {
            "type": "integer"
          },
          "tendered": {
            "nullable": true,
            "type": "integer"
          },
          "change": {
            "type": "integer"
          },
          "rounding_amount": {
            "type": "integer"
          },
          "network": {
            "nullable": true,
            "type": "string",
            "minLength": 1,
            "enum": [
              "interac",
              "eftpos_au",
              "cartes_bancaires",
              "girocard"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "pending_forwarding",
              "succeeded",
              "failed",
              "failed_after_forwarding",
              "refunded",
              "voided"
            ],
            "minLength": 1
          },
          "refunded_amount": {
            "type": "integer"
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "device": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "reader": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "client_created_at": {
            "nullable": true,
            "type": "integer"
          },
          "created_offline": {
            "type": "boolean"
          },
          "sort": {
            "type": "integer"
          },
          "shift": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "order",
          "method",
          "external_kind",
          "payment",
          "voucher_redemption",
          "amount",
          "currency",
          "tip_amount",
          "tendered",
          "change",
          "rounding_amount",
          "network",
          "status",
          "refunded_amount",
          "staff_member",
          "device",
          "reader",
          "client_created_at",
          "created_offline",
          "sort",
          "shift",
          "created"
        ]
      },
      "TenderNextActionModel": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "pay_page"
            ],
            "minLength": 1
          },
          "url": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "type",
          "url"
        ]
      },
      "TenderSummaryModel": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string",
            "enum": [
              "cash",
              "card",
              "voucher",
              "package",
              "membership",
              "credit",
              "external",
              "booking_deposit",
              "pre_auth",
              "deposit_refund",
              "account"
            ],
            "minLength": 1
          },
          "count": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "tips": {
            "type": "integer"
          },
          "rounding": {
            "type": "integer"
          },
          "total": {
            "type": "integer"
          }
        },
        "required": [
          "method",
          "count",
          "amount",
          "tips",
          "rounding",
          "total"
        ]
      },
      "TermsAcceptanceBody": {
        "type": "object",
        "properties": {
          "date": {
            "type": "integer",
            "multipleOf": 1
          },
          "ip": {
            "type": "string",
            "maxLength": 64
          },
          "user_agent": {
            "type": "string",
            "maxLength": 255
          }
        }
      },
      "TestClockModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "offset_seconds": {
            "type": "integer"
          },
          "now": {
            "type": "integer"
          }
        },
        "required": [
          "object",
          "livemode",
          "offset_seconds",
          "now"
        ]
      },
      "TestEventModel": {
        "type": "object",
        "properties": {
          "event": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "event"
        ]
      },
      "TestFundBody": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "TestRequirementsBody": {
        "type": "object",
        "properties": {
          "currently_due": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "past_due": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "pending_verification": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "disabled_reason": {
            "nullable": true,
            "type": "string",
            "maxLength": 80
          },
          "current_deadline": {
            "nullable": true,
            "type": "integer"
          }
        }
      },
      "ThemeTokenColorsModel": {
        "type": "object",
        "properties": {
          "bg": {
            "type": "string",
            "minLength": 1
          },
          "ink": {
            "type": "string",
            "minLength": 1
          },
          "muted": {
            "type": "string",
            "minLength": 1
          },
          "accent": {
            "type": "string",
            "minLength": 1
          },
          "accent_ink": {
            "type": "string",
            "minLength": 1
          },
          "card": {
            "type": "string",
            "minLength": 1
          },
          "line": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "bg",
          "ink",
          "muted",
          "accent",
          "accent_ink",
          "card",
          "line"
        ]
      },
      "ThemeTokensModel": {
        "type": "object",
        "properties": {
          "theme": {
            "type": "string",
            "minLength": 1
          },
          "scheme": {
            "type": "string",
            "minLength": 1
          },
          "title_font": {
            "type": "string",
            "minLength": 1
          },
          "colors": {
            "$ref": "#/components/schemas/ThemeTokenColorsModel"
          },
          "decor": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "adjusted": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "theme",
          "scheme",
          "title_font",
          "colors",
          "decor",
          "adjusted"
        ]
      },
      "TicketAffiliateBody": {
        "type": "object",
        "properties": {
          "partner_code": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "commission_amount": {
            "nullable": true,
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          },
          "commission_percent": {
            "nullable": true,
            "type": "integer",
            "minimum": 1,
            "maximum": 100,
            "multipleOf": 1
          }
        },
        "required": [
          "partner_code"
        ]
      },
      "TicketAffiliateModel": {
        "type": "object",
        "properties": {
          "partner": {
            "type": "string",
            "minLength": 1
          },
          "partner_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "commission_amount": {
            "nullable": true,
            "type": "integer"
          },
          "commission_percent": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "partner",
          "partner_name",
          "commission_amount",
          "commission_percent"
        ]
      },
      "TicketBuyerModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "email": {
            "type": "string",
            "minLength": 1
          },
          "phone": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "sms_opt_in": {
            "type": "boolean"
          },
          "whatsapp_opt_in": {
            "type": "boolean"
          },
          "marketing_opt_in": {
            "type": "boolean"
          }
        },
        "required": [
          "name",
          "email",
          "phone",
          "sms_opt_in",
          "whatsapp_opt_in",
          "marketing_opt_in"
        ]
      },
      "TicketCheckedInEvent": {
        "type": "object",
        "description": "The `ticket.checked_in` event (Tuppence Events' tickets events): `data.object` is the `ticket`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "ticket.checked_in"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/TicketEventData"
          }
        }
      },
      "TicketCommissionList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TicketCommissionModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "TicketCommissionModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "event": {
            "type": "string",
            "minLength": 1
          },
          "date": {
            "type": "string",
            "minLength": 1
          },
          "order": {
            "type": "string",
            "minLength": 1
          },
          "promo_code": {
            "type": "string",
            "minLength": 1
          },
          "partner": {
            "type": "string",
            "minLength": 1
          },
          "tickets": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "amount_reversed": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "collected_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "event",
          "date",
          "order",
          "promo_code",
          "partner",
          "tickets",
          "amount",
          "amount_reversed",
          "currency",
          "status",
          "collected_at",
          "created"
        ]
      },
      "TicketEventData": {
        "type": "object",
        "description": "What an event carrying a `ticket` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/TicketModel"
          }
        }
      },
      "TicketEventFigures": {
        "type": "object",
        "properties": {
          "orders": {
            "type": "integer"
          },
          "tickets_sold": {
            "type": "integer"
          },
          "tickets_refunded": {
            "type": "integer"
          },
          "gross": {
            "type": "integer"
          },
          "discounts": {
            "type": "integer"
          },
          "donations": {
            "type": "integer"
          },
          "refunds": {
            "type": "integer"
          },
          "fees": {
            "type": "integer"
          },
          "platform_fees": {
            "type": "integer"
          },
          "net": {
            "type": "integer"
          },
          "event": {
            "type": "string",
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "orders",
          "tickets_sold",
          "tickets_refunded",
          "gross",
          "discounts",
          "donations",
          "refunds",
          "fees",
          "platform_fees",
          "net",
          "event",
          "title"
        ]
      },
      "TicketFiguresModel": {
        "type": "object",
        "properties": {
          "orders": {
            "type": "integer"
          },
          "tickets_sold": {
            "type": "integer"
          },
          "tickets_refunded": {
            "type": "integer"
          },
          "gross": {
            "type": "integer"
          },
          "discounts": {
            "type": "integer"
          },
          "donations": {
            "type": "integer"
          },
          "refunds": {
            "type": "integer"
          },
          "fees": {
            "type": "integer"
          },
          "platform_fees": {
            "type": "integer"
          },
          "net": {
            "type": "integer"
          }
        },
        "required": [
          "orders",
          "tickets_sold",
          "tickets_refunded",
          "gross",
          "discounts",
          "donations",
          "refunds",
          "fees",
          "platform_fees",
          "net"
        ]
      },
      "TicketFundsExtendedEvent": {
        "type": "object",
        "description": "The `ticket_funds.extended` event (Tuppence Events' funds events): `data.object` is the `ticket_funds_hold`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "ticket_funds.extended"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/TicketFundsHoldEventData"
          }
        }
      },
      "TicketFundsHoldEventData": {
        "type": "object",
        "description": "What an event carrying a `ticket_funds_hold` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/TicketFundsHoldModel"
          }
        }
      },
      "TicketFundsHoldList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TicketFundsHoldModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "TicketFundsHoldModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "event": {
            "type": "string",
            "minLength": 1
          },
          "date": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "release_after": {
            "nullable": true,
            "type": "integer"
          },
          "released_at": {
            "nullable": true,
            "type": "integer"
          },
          "extended_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "event",
          "date",
          "currency",
          "amount",
          "status",
          "release_after",
          "released_at",
          "extended_reason"
        ]
      },
      "TicketFundsReleasedEvent": {
        "type": "object",
        "description": "The `ticket_funds.released` event (Tuppence Events' funds events): `data.object` is the `ticket_funds_hold`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "ticket_funds.released"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/TicketFundsHoldEventData"
          }
        }
      },
      "TicketGroupDiscountBody": {
        "type": "object",
        "properties": {
          "min_quantity": {
            "type": "integer",
            "minimum": 2,
            "multipleOf": 1
          },
          "percent_off": {
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          }
        },
        "required": [
          "min_quantity",
          "percent_off"
        ]
      },
      "TicketGroupDiscountModel": {
        "type": "object",
        "properties": {
          "min_quantity": {
            "type": "integer"
          },
          "percent_off": {
            "type": "integer"
          }
        },
        "required": [
          "min_quantity",
          "percent_off"
        ]
      },
      "TicketHolderModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "email": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "name",
          "email"
        ]
      },
      "TicketIncludeBody": {
        "type": "object",
        "properties": {
          "product": {
            "type": "string",
            "minLength": 1
          },
          "quantity": {
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          }
        },
        "required": [
          "product"
        ]
      },
      "TicketIncludeModel": {
        "type": "object",
        "properties": {
          "product": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "quantity": {
            "type": "integer"
          }
        },
        "required": [
          "product",
          "name",
          "quantity"
        ]
      },
      "TicketIssuedEvent": {
        "type": "object",
        "description": "The `ticket.issued` event (Tuppence Events' tickets events): `data.object` is the `ticket`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "ticket.issued"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/TicketEventData"
          }
        }
      },
      "TicketList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TicketModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "TicketModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "order": {
            "type": "string",
            "minLength": 1
          },
          "event": {
            "type": "string",
            "minLength": 1
          },
          "date": {
            "type": "string",
            "minLength": 1
          },
          "ticket_type": {
            "type": "string",
            "minLength": 1
          },
          "holder": {
            "$ref": "#/components/schemas/TicketHolderModel"
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "short_code": {
            "type": "string",
            "minLength": 1
          },
          "code": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "checked_in_at": {
            "nullable": true,
            "type": "integer"
          },
          "voided_at": {
            "nullable": true,
            "type": "integer"
          },
          "refund": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "returned_at": {
            "nullable": true,
            "type": "integer"
          },
          "answers": {
            "type": "object"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "order",
          "event",
          "date",
          "ticket_type",
          "holder",
          "status",
          "short_code",
          "code",
          "amount",
          "currency",
          "checked_in_at",
          "voided_at",
          "refund",
          "returned_at",
          "answers",
          "created"
        ]
      },
      "TicketOrderDeclinedEvent": {
        "type": "object",
        "description": "The `ticket_order.declined` event (Tuppence Events' orders events): `data.object` is the `ticket_order`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "ticket_order.declined"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/TicketOrderEventData"
          }
        }
      },
      "TicketOrderEventData": {
        "type": "object",
        "description": "What an event carrying a `ticket_order` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/TicketOrderModel"
          }
        }
      },
      "TicketOrderLineModel": {
        "type": "object",
        "properties": {
          "ticket_type": {
            "type": "string",
            "minLength": 1
          },
          "quantity": {
            "type": "integer"
          },
          "unit_price": {
            "type": "integer"
          },
          "price_phase": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "unit_discount": {
            "type": "integer"
          },
          "unit_group_discount": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "amount_discount": {
            "type": "integer"
          }
        },
        "required": [
          "ticket_type",
          "quantity",
          "unit_price",
          "price_phase",
          "unit_discount",
          "unit_group_discount",
          "amount",
          "amount_discount"
        ]
      },
      "TicketOrderList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TicketOrderModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "TicketOrderModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "event": {
            "type": "string",
            "minLength": 1
          },
          "date": {
            "type": "string",
            "minLength": 1
          },
          "buyer": {
            "$ref": "#/components/schemas/TicketBuyerModel"
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "quantity": {
            "type": "integer"
          },
          "lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TicketOrderLineModel"
            }
          },
          "amount_subtotal": {
            "type": "integer"
          },
          "amount_discount": {
            "type": "integer"
          },
          "amount_donation": {
            "type": "integer"
          },
          "amount_total": {
            "type": "integer"
          },
          "amount_refunded": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "payment": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "promo_code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "membership": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "source": {
            "type": "string",
            "minLength": 1
          },
          "pos_order": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "utm": {
            "type": "object"
          },
          "expires_at": {
            "type": "integer"
          },
          "paid_at": {
            "nullable": true,
            "type": "integer"
          },
          "failure_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "event",
          "date",
          "buyer",
          "status",
          "quantity",
          "lines",
          "amount_subtotal",
          "amount_discount",
          "amount_donation",
          "amount_total",
          "amount_refunded",
          "currency",
          "payment",
          "promo_code",
          "membership",
          "source",
          "pos_order",
          "utm",
          "expires_at",
          "paid_at",
          "failure_reason",
          "created"
        ]
      },
      "TicketOrderPaidEvent": {
        "type": "object",
        "description": "The `ticket_order.paid` event (Tuppence Events' orders events): `data.object` is the `ticket_order`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "ticket_order.paid"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/TicketOrderEventData"
          }
        }
      },
      "TicketOrderRefundBody": {
        "type": "object",
        "properties": {
          "tickets": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "TicketOrderRefundModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "order": {
            "$ref": "#/components/schemas/TicketOrderModel"
          },
          "tickets": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TicketModel"
            }
          },
          "refund": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/RefundModel"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "object",
          "order",
          "tickets",
          "refund"
        ]
      },
      "TicketOrderRefundedEvent": {
        "type": "object",
        "description": "The `ticket_order.refunded` event (Tuppence Events' orders events): `data.object` is the `ticket_order`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "ticket_order.refunded"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/TicketOrderEventData"
          }
        }
      },
      "TicketOrderRequestedEvent": {
        "type": "object",
        "description": "The `ticket_order.requested` event (Tuppence Events' orders events): `data.object` is the `ticket_order`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "ticket_order.requested"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/TicketOrderEventData"
          }
        }
      },
      "TicketPricePhaseBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 80,
            "minLength": 1
          },
          "price": {
            "type": "integer",
            "minimum": 0,
            "multipleOf": 1
          },
          "until_at": {
            "nullable": true,
            "type": "string"
          },
          "until_sold": {
            "nullable": true,
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          }
        },
        "required": [
          "name",
          "price"
        ]
      },
      "TicketPricePhaseModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "price": {
            "type": "integer"
          },
          "until_at": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "until_sold": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "name",
          "price",
          "until_at",
          "until_sold"
        ]
      },
      "TicketPromoCodeBody": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "maxLength": 40
          },
          "event": {
            "nullable": true,
            "type": "string"
          },
          "percent_off": {
            "nullable": true,
            "type": "integer",
            "minimum": 1,
            "maximum": 100,
            "multipleOf": 1
          },
          "amount_off": {
            "nullable": true,
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          },
          "unlocks": {
            "type": "boolean"
          },
          "ticket_types": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "maxItems": 50
          },
          "max_redemptions": {
            "nullable": true,
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          },
          "valid_from": {
            "nullable": true,
            "type": "string"
          },
          "valid_until": {
            "nullable": true,
            "type": "string"
          },
          "active": {
            "type": "boolean"
          },
          "affiliate": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/TicketAffiliateBody"
              }
            ],
            "nullable": true
          }
        }
      },
      "TicketPromoCodeList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TicketPromoCodeModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "TicketPromoCodeModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "code": {
            "type": "string",
            "minLength": 1
          },
          "event": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "percent_off": {
            "nullable": true,
            "type": "integer"
          },
          "amount_off": {
            "nullable": true,
            "type": "integer"
          },
          "currency": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "unlocks": {
            "type": "boolean"
          },
          "ticket_types": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "max_redemptions": {
            "nullable": true,
            "type": "integer"
          },
          "times_redeemed": {
            "type": "integer"
          },
          "valid_from": {
            "nullable": true,
            "type": "integer"
          },
          "valid_until": {
            "nullable": true,
            "type": "integer"
          },
          "active": {
            "type": "boolean"
          },
          "affiliate": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/TicketAffiliateModel"
              }
            ],
            "nullable": true
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "code",
          "event",
          "percent_off",
          "amount_off",
          "currency",
          "unlocks",
          "ticket_types",
          "max_redemptions",
          "times_redeemed",
          "valid_from",
          "valid_until",
          "active",
          "affiliate",
          "created"
        ]
      },
      "TicketQuestionBody": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "label": {
            "type": "string",
            "maxLength": 200,
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "enum": [
              "text",
              "choice",
              "checkbox"
            ]
          },
          "required": {
            "type": "boolean"
          },
          "options": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "maxItems": 20
          }
        },
        "required": [
          "label"
        ]
      },
      "TicketQuestionModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "label": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "required": {
            "type": "boolean"
          },
          "options": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "id",
          "label",
          "kind",
          "required",
          "options"
        ]
      },
      "TicketRefundedEvent": {
        "type": "object",
        "description": "The `ticket.refunded` event (Tuppence Events' tickets events): `data.object` is the `ticket`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "ticket.refunded"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/TicketEventData"
          }
        }
      },
      "TicketSalesReportModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "from": {
            "type": "string",
            "minLength": 1
          },
          "to": {
            "type": "string",
            "minLength": 1
          },
          "totals": {
            "$ref": "#/components/schemas/TicketFiguresModel"
          },
          "events": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TicketEventFigures"
            }
          },
          "ticket_types": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TicketTypeFiguresModel"
            }
          },
          "sources": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TicketSourceFigures"
            }
          }
        },
        "required": [
          "object",
          "livemode",
          "currency",
          "from",
          "to",
          "totals",
          "events",
          "ticket_types",
          "sources"
        ]
      },
      "TicketSettlementModel": {
        "type": "object",
        "properties": {
          "orders": {
            "type": "integer"
          },
          "tickets_sold": {
            "type": "integer"
          },
          "tickets_refunded": {
            "type": "integer"
          },
          "gross": {
            "type": "integer"
          },
          "discounts": {
            "type": "integer"
          },
          "donations": {
            "type": "integer"
          },
          "refunds": {
            "type": "integer"
          },
          "fees": {
            "type": "integer"
          },
          "platform_fees": {
            "type": "integer"
          },
          "net": {
            "type": "integer"
          },
          "event": {
            "type": "string",
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "held": {
            "type": "integer"
          },
          "released": {
            "type": "integer"
          },
          "used_for_refunds": {
            "type": "integer"
          },
          "release_after": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "released_at": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "orders",
          "tickets_sold",
          "tickets_refunded",
          "gross",
          "discounts",
          "donations",
          "refunds",
          "fees",
          "platform_fees",
          "net",
          "event",
          "title",
          "object",
          "livemode",
          "currency",
          "held",
          "released",
          "used_for_refunds",
          "release_after",
          "released_at"
        ]
      },
      "TicketSourceFigures": {
        "type": "object",
        "properties": {
          "orders": {
            "type": "integer"
          },
          "tickets_sold": {
            "type": "integer"
          },
          "tickets_refunded": {
            "type": "integer"
          },
          "gross": {
            "type": "integer"
          },
          "discounts": {
            "type": "integer"
          },
          "donations": {
            "type": "integer"
          },
          "refunds": {
            "type": "integer"
          },
          "fees": {
            "type": "integer"
          },
          "platform_fees": {
            "type": "integer"
          },
          "net": {
            "type": "integer"
          },
          "source": {
            "type": "string",
            "minLength": 1
          },
          "utm_source": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "utm_medium": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "utm_campaign": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "orders",
          "tickets_sold",
          "tickets_refunded",
          "gross",
          "discounts",
          "donations",
          "refunds",
          "fees",
          "platform_fees",
          "net",
          "source",
          "utm_source",
          "utm_medium",
          "utm_campaign"
        ]
      },
      "TicketTransferBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "email": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "name",
          "email"
        ]
      },
      "TicketTransferEventData": {
        "type": "object",
        "description": "What an event carrying a `ticket_transfer` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/TicketTransferModel"
          }
        }
      },
      "TicketTransferModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "event": {
            "type": "string",
            "minLength": 1
          },
          "from_ticket": {
            "type": "string",
            "minLength": 1
          },
          "ticket": {
            "type": "string",
            "minLength": 1
          },
          "order": {
            "type": "string",
            "minLength": 1
          },
          "from": {
            "$ref": "#/components/schemas/TicketTransferPartyModel"
          },
          "to": {
            "$ref": "#/components/schemas/TicketTransferPartyModel"
          },
          "refund": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "kind",
          "event",
          "from_ticket",
          "ticket",
          "order",
          "from",
          "to",
          "refund",
          "created"
        ]
      },
      "TicketTransferPartyModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "email": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "name",
          "email"
        ]
      },
      "TicketTransferResultModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "transfer": {
            "$ref": "#/components/schemas/TicketTransferModel"
          },
          "ticket": {
            "$ref": "#/components/schemas/TicketModel"
          }
        },
        "required": [
          "object",
          "transfer",
          "ticket"
        ]
      },
      "TicketTransferredEvent": {
        "type": "object",
        "description": "The `ticket.transferred` event (Tuppence Events' tickets events): `data.object` is the `ticket_transfer`.",
        "required": [
          "id",
          "object",
          "type",
          "livemode",
          "created",
          "api_version",
          "request_id",
          "data"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "ticket.transferred"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "api_version": {
            "type": "string",
            "minLength": 1
          },
          "request_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/TicketTransferEventData"
          }
        }
      },
      "TicketTypeBody": {
        "type": "object",
        "properties": {
          "event": {
            "type": "string"
          },
          "date": {
            "nullable": true,
            "type": "string"
          },
          "pass_dates": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "maxItems": 104,
            "nullable": true
          },
          "name": {
            "type": "string",
            "maxLength": 80
          },
          "description": {
            "nullable": true,
            "type": "string",
            "maxLength": 500
          },
          "kind": {
            "type": "string",
            "enum": [
              "paid",
              "free",
              "donation",
              "pwyw"
            ]
          },
          "price": {
            "type": "integer",
            "minimum": 0,
            "multipleOf": 1
          },
          "minimum_price": {
            "nullable": true,
            "type": "integer",
            "minimum": 0,
            "multipleOf": 1
          },
          "capacity": {
            "nullable": true,
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          },
          "max_per_order": {
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          },
          "max_per_buyer": {
            "nullable": true,
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          },
          "sales_start_at": {
            "nullable": true,
            "type": "string"
          },
          "sales_end_at": {
            "nullable": true,
            "type": "string"
          },
          "hidden": {
            "type": "boolean"
          },
          "access_code_only": {
            "type": "boolean"
          },
          "position": {
            "type": "integer",
            "minimum": 0,
            "multipleOf": 1
          },
          "product": {
            "nullable": true,
            "type": "string"
          },
          "door_allowance": {
            "type": "integer",
            "minimum": 0,
            "multipleOf": 1
          },
          "hand_over": {
            "nullable": true,
            "type": "string",
            "maxLength": 140
          },
          "price_phases": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TicketPricePhaseBody"
            },
            "maxItems": 5
          },
          "questions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TicketQuestionBody"
            },
            "maxItems": 20
          },
          "group_discount": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/TicketGroupDiscountBody"
              }
            ],
            "nullable": true
          },
          "includes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TicketIncludeBody"
            },
            "maxItems": 5
          }
        }
      },
      "TicketTypeFiguresModel": {
        "type": "object",
        "properties": {
          "ticket_type": {
            "type": "string",
            "minLength": 1
          },
          "event": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "tickets_sold": {
            "type": "integer"
          },
          "tickets_refunded": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "refunds": {
            "type": "integer"
          }
        },
        "required": [
          "ticket_type",
          "event",
          "name",
          "tickets_sold",
          "tickets_refunded",
          "amount",
          "refunds"
        ]
      },
      "TicketTypeList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TicketTypeModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "TicketTypeModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "event": {
            "type": "string",
            "minLength": 1
          },
          "date": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "pass_dates": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "description": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "type": "string",
            "minLength": 1
          },
          "price": {
            "type": "integer"
          },
          "minimum_price": {
            "nullable": true,
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "current_price": {
            "type": "integer"
          },
          "current_phase": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "price_phases": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TicketPricePhaseModel"
            }
          },
          "capacity": {
            "nullable": true,
            "type": "integer"
          },
          "quantity_sold": {
            "type": "integer"
          },
          "max_per_order": {
            "type": "integer"
          },
          "max_per_buyer": {
            "nullable": true,
            "type": "integer"
          },
          "sales_start_at": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "sales_end_at": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "hidden": {
            "type": "boolean"
          },
          "access_code_only": {
            "type": "boolean"
          },
          "position": {
            "type": "integer"
          },
          "product": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "door_allowance": {
            "type": "integer"
          },
          "door_sold": {
            "type": "integer"
          },
          "hand_over": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "questions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TicketQuestionModel"
            }
          },
          "group_discount": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/TicketGroupDiscountModel"
              }
            ],
            "nullable": true
          },
          "includes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TicketIncludeModel"
            }
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "event",
          "date",
          "pass_dates",
          "name",
          "description",
          "kind",
          "price",
          "minimum_price",
          "currency",
          "current_price",
          "current_phase",
          "price_phases",
          "capacity",
          "quantity_sold",
          "max_per_order",
          "max_per_buyer",
          "sales_start_at",
          "sales_end_at",
          "hidden",
          "access_code_only",
          "position",
          "product",
          "door_allowance",
          "door_sold",
          "hand_over",
          "status",
          "questions",
          "group_discount",
          "includes",
          "created"
        ]
      },
      "TicketedEventBody": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "maxLength": 140
          },
          "about": {
            "nullable": true,
            "type": "string",
            "maxLength": 5000
          },
          "slug": {
            "type": "string",
            "maxLength": 40
          },
          "venue_name": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          },
          "venue_address": {
            "nullable": true,
            "type": "string",
            "maxLength": 500
          },
          "venue_latitude": {
            "nullable": true,
            "type": "string"
          },
          "venue_longitude": {
            "nullable": true,
            "type": "string"
          },
          "named_tickets": {
            "type": "boolean"
          },
          "online_url": {
            "nullable": true,
            "type": "string",
            "maxLength": 2048
          },
          "timezone": {
            "type": "string"
          },
          "starts_at": {
            "type": "string"
          },
          "ends_at": {
            "type": "string"
          },
          "doors_at": {
            "nullable": true,
            "type": "string"
          },
          "capacity": {
            "nullable": true,
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          },
          "dates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EventDateBody"
            },
            "maxItems": 104,
            "minItems": 1
          },
          "repeat": {
            "$ref": "#/components/schemas/RepeatRuleBody"
          },
          "visibility": {
            "type": "string",
            "enum": [
              "public",
              "unlisted",
              "invite"
            ]
          },
          "approval_required": {
            "type": "boolean"
          },
          "donations_enabled": {
            "type": "boolean"
          },
          "refund_policy": {
            "type": "string",
            "enum": [
              "none",
              "until_start",
              "until_1_day",
              "until_7_days",
              "until_30_days"
            ]
          },
          "reminder_hours_before": {
            "nullable": true,
            "type": "integer",
            "minimum": 1,
            "multipleOf": 1
          },
          "code_reveal": {
            "type": "string",
            "enum": [
              "auto",
              "on",
              "off"
            ]
          },
          "code_reveal_hours_before": {
            "type": "integer",
            "minimum": 0,
            "multipleOf": 1
          },
          "announce_to_past_attendees": {
            "type": "boolean"
          },
          "metadata": {
            "type": "object"
          },
          "questions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TicketQuestionBody"
            },
            "maxItems": 20
          },
          "gates": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "maxItems": 10
          },
          "cover": {
            "nullable": true,
            "type": "string"
          },
          "theme": {
            "type": "string"
          },
          "palette_overrides": {
            "nullable": true,
            "type": "object"
          },
          "title_font": {
            "nullable": true,
            "type": "string"
          },
          "pixels": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/EventPixelsModel"
              }
            ],
            "nullable": true
          }
        }
      },
      "TicketedEventList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TicketedEventModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "TicketedEventModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "slug": {
            "type": "string",
            "minLength": 1
          },
          "url": {
            "type": "string",
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "about": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "venue_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "venue_address": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "venue_latitude": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "venue_longitude": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "named_tickets": {
            "type": "boolean"
          },
          "online_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "timezone": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "visibility": {
            "type": "string",
            "minLength": 1
          },
          "approval_required": {
            "type": "boolean"
          },
          "donations_enabled": {
            "type": "boolean"
          },
          "refund_policy": {
            "type": "string",
            "minLength": 1
          },
          "reminder_hours_before": {
            "nullable": true,
            "type": "integer"
          },
          "code_reveal": {
            "type": "string",
            "minLength": 1
          },
          "code_reveal_hours_before": {
            "type": "integer"
          },
          "announce_to_past_attendees": {
            "type": "boolean"
          },
          "dates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EventDateModel"
            }
          },
          "repeat": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/RepeatRuleModel"
              }
            ],
            "nullable": true
          },
          "published_at": {
            "nullable": true,
            "type": "integer"
          },
          "metadata": {
            "type": "object"
          },
          "questions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TicketQuestionModel"
            }
          },
          "gates": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "cover": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "cover_url": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "theme": {
            "type": "string",
            "minLength": 1
          },
          "palette": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "palette_overrides": {
            "nullable": true,
            "type": "object"
          },
          "title_font": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "theme_tokens": {
            "$ref": "#/components/schemas/ThemeTokensModel"
          },
          "pixels": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/EventPixelsModel"
              }
            ],
            "nullable": true
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "slug",
          "url",
          "title",
          "about",
          "venue_name",
          "venue_address",
          "venue_latitude",
          "venue_longitude",
          "named_tickets",
          "online_url",
          "timezone",
          "currency",
          "status",
          "visibility",
          "approval_required",
          "donations_enabled",
          "refund_policy",
          "reminder_hours_before",
          "code_reveal",
          "code_reveal_hours_before",
          "announce_to_past_attendees",
          "dates",
          "repeat",
          "published_at",
          "metadata",
          "questions",
          "gates",
          "cover",
          "cover_url",
          "theme",
          "palette",
          "palette_overrides",
          "title_font",
          "theme_tokens",
          "pixels",
          "created"
        ]
      },
      "TicketingEvent": {
        "description": "Any of Tuppence Events' events: narrow on `type` and `data.object` is that event's object (the event, an order, a ticket, a transfer or a funds hold).",
        "oneOf": [
          {
            "$ref": "#/components/schemas/EventPublishedEvent"
          },
          {
            "$ref": "#/components/schemas/EventUnpublishedEvent"
          },
          {
            "$ref": "#/components/schemas/EventCancelledEvent"
          },
          {
            "$ref": "#/components/schemas/TicketOrderPaidEvent"
          },
          {
            "$ref": "#/components/schemas/TicketOrderRefundedEvent"
          },
          {
            "$ref": "#/components/schemas/TicketOrderRequestedEvent"
          },
          {
            "$ref": "#/components/schemas/TicketOrderDeclinedEvent"
          },
          {
            "$ref": "#/components/schemas/TicketIssuedEvent"
          },
          {
            "$ref": "#/components/schemas/TicketRefundedEvent"
          },
          {
            "$ref": "#/components/schemas/TicketTransferredEvent"
          },
          {
            "$ref": "#/components/schemas/TicketCheckedInEvent"
          },
          {
            "$ref": "#/components/schemas/TicketFundsReleasedEvent"
          },
          {
            "$ref": "#/components/schemas/TicketFundsExtendedEvent"
          }
        ],
        "discriminator": {
          "propertyName": "type",
          "mapping": {
            "event.published": "#/components/schemas/EventPublishedEvent",
            "event.unpublished": "#/components/schemas/EventUnpublishedEvent",
            "event.cancelled": "#/components/schemas/EventCancelledEvent",
            "ticket_order.paid": "#/components/schemas/TicketOrderPaidEvent",
            "ticket_order.refunded": "#/components/schemas/TicketOrderRefundedEvent",
            "ticket_order.requested": "#/components/schemas/TicketOrderRequestedEvent",
            "ticket_order.declined": "#/components/schemas/TicketOrderDeclinedEvent",
            "ticket.issued": "#/components/schemas/TicketIssuedEvent",
            "ticket.refunded": "#/components/schemas/TicketRefundedEvent",
            "ticket.transferred": "#/components/schemas/TicketTransferredEvent",
            "ticket.checked_in": "#/components/schemas/TicketCheckedInEvent",
            "ticket_funds.released": "#/components/schemas/TicketFundsReleasedEvent",
            "ticket_funds.extended": "#/components/schemas/TicketFundsExtendedEvent"
          }
        }
      },
      "TicketingEventEventData": {
        "type": "object",
        "description": "What an event carrying a `ticketing.event` holds.",
        "required": [
          "object"
        ],
        "properties": {
          "object": {
            "$ref": "#/components/schemas/TicketedEventModel"
          }
        }
      },
      "TicketingSettingsBody": {
        "type": "object",
        "properties": {
          "pixels": {
            "$ref": "#/components/schemas/EventPixelsModel"
          }
        }
      },
      "TicketingSettingsModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "pixels": {
            "$ref": "#/components/schemas/EventPixelsModel"
          }
        },
        "required": [
          "object",
          "pixels"
        ]
      },
      "TillPermissionSetModel": {
        "type": "object",
        "properties": {
          "sell": {
            "type": "boolean"
          },
          "refund_up_to": {
            "nullable": true,
            "type": "integer"
          },
          "discount_up_to_bps": {
            "type": "integer"
          },
          "void_after_payment": {
            "type": "boolean"
          },
          "open_drawer_without_sale": {
            "type": "boolean"
          },
          "pay_in_out": {
            "type": "boolean"
          },
          "open_close_shift": {
            "type": "boolean"
          },
          "price_override": {
            "type": "boolean"
          },
          "see_reports": {
            "type": "boolean"
          },
          "postage_up_to": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "sell",
          "refund_up_to",
          "discount_up_to_bps",
          "void_after_payment",
          "open_drawer_without_sale",
          "pay_in_out",
          "open_close_shift",
          "price_override",
          "see_reports",
          "postage_up_to"
        ]
      },
      "TillPermissionsBody": {
        "type": "object",
        "properties": {
          "sell": {
            "type": "boolean"
          },
          "refund_up_to": {
            "nullable": true,
            "type": "integer"
          },
          "discount_up_to_bps": {
            "type": "integer"
          },
          "void_after_payment": {
            "type": "boolean"
          },
          "open_drawer_without_sale": {
            "type": "boolean"
          },
          "pay_in_out": {
            "type": "boolean"
          },
          "open_close_shift": {
            "type": "boolean"
          },
          "price_override": {
            "type": "boolean"
          },
          "see_reports": {
            "type": "boolean"
          },
          "postage_up_to": {
            "nullable": true,
            "type": "integer"
          }
        }
      },
      "TillPermissionsModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "staff_member": {
            "type": "string",
            "minLength": 1
          },
          "source": {
            "type": "string",
            "enum": [
              "explicit",
              "role_default"
            ],
            "minLength": 1
          },
          "role": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "permissions": {
            "$ref": "#/components/schemas/TillPermissionSetModel"
          }
        },
        "required": [
          "object",
          "livemode",
          "staff_member",
          "source",
          "role",
          "permissions"
        ]
      },
      "TimeOffRequestBody": {
        "type": "object",
        "properties": {
          "staff_member": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "starts_at": {
            "type": "string",
            "maxLength": 40
          },
          "ends_at": {
            "type": "string",
            "maxLength": 40
          },
          "all_day": {
            "type": "boolean"
          },
          "date": {
            "type": "string",
            "maxLength": 10
          },
          "end_date": {
            "type": "string",
            "maxLength": 10
          },
          "reason": {
            "nullable": true,
            "type": "string",
            "maxLength": 300
          }
        }
      },
      "TimeOffRequestList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TimeOffRequestModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "TimeOffRequestModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "staff_member": {
            "type": "string",
            "minLength": 1
          },
          "starts_at": {
            "type": "string",
            "minLength": 1
          },
          "ends_at": {
            "type": "string",
            "minLength": 1
          },
          "all_day": {
            "type": "boolean"
          },
          "timezone": {
            "type": "string",
            "minLength": 1
          },
          "reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "approved",
              "declined"
            ],
            "minLength": 1
          },
          "requested_by": {
            "type": "string",
            "minLength": 1
          },
          "decided_by": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "decided_at": {
            "nullable": true,
            "type": "integer"
          },
          "decision_note": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "schedule_exception": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "staff_member",
          "starts_at",
          "ends_at",
          "all_day",
          "timezone",
          "reason",
          "status",
          "requested_by",
          "decided_by",
          "decided_at",
          "decision_note",
          "schedule_exception",
          "created"
        ]
      },
      "TimelineStepModel": {
        "type": "object",
        "properties": {
          "at": {
            "type": "integer"
          },
          "kind": {
            "type": "string",
            "enum": [
              "approval_requested",
              "approval_decided",
              "authorized",
              "declined",
              "captured",
              "refunded",
              "disputed",
              "dispute_won",
              "dispute_lost"
            ],
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "detail": {
            "type": "object"
          }
        },
        "required": [
          "at",
          "kind",
          "object",
          "detail"
        ]
      },
      "TipShareModel": {
        "type": "object",
        "properties": {
          "staff_member": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "staff_member",
          "amount"
        ]
      },
      "TippingBody": {
        "type": "object",
        "properties": {
          "prompt": {
            "type": "boolean"
          },
          "presets_bps": {
            "type": "array",
            "items": {
              "type": "integer"
            }
          },
          "allow_custom": {
            "type": "boolean"
          }
        }
      },
      "TippingModel": {
        "type": "object",
        "properties": {
          "prompt": {
            "type": "boolean"
          },
          "presets_bps": {
            "type": "array",
            "items": {
              "type": "integer"
            }
          },
          "allow_custom": {
            "type": "boolean"
          }
        },
        "required": [
          "prompt",
          "presets_bps",
          "allow_custom"
        ]
      },
      "ToolCallDiffModel": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "minLength": 1
          },
          "before": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "after": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "field",
          "before",
          "after"
        ]
      },
      "ToolCallLinkModel": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "minLength": 1
          },
          "href": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "label",
          "href"
        ]
      },
      "ToolCallSummaryModel": {
        "type": "object",
        "properties": {
          "headline": {
            "type": "string",
            "minLength": 1
          },
          "lines": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "warning": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "links": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ToolCallLinkModel"
            }
          },
          "diff": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ToolCallDiffModel"
            }
          }
        },
        "required": [
          "headline",
          "lines",
          "warning",
          "links",
          "diff"
        ]
      },
      "TopupAuthenticationBody": {
        "type": "object",
        "properties": {
          "outcome": {
            "type": "string",
            "enum": [
              "pass",
              "fail"
            ],
            "minLength": 1
          }
        },
        "required": [
          "outcome"
        ]
      },
      "TopupBankTransferModel": {
        "type": "object",
        "properties": {
          "reference": {
            "type": "string",
            "minLength": 1
          },
          "account_holder_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "account_number": {
            "type": "string",
            "minLength": 1
          },
          "sort_code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "routing_number": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "bank_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "iban": {
            "nullable": true,
            "type": "string"
          },
          "bic": {
            "nullable": true,
            "type": "string"
          },
          "swift": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/TopupSwiftModel"
              }
            ],
            "nullable": true
          },
          "networks": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "reference",
          "account_holder_name",
          "account_number",
          "sort_code",
          "routing_number",
          "bank_name"
        ]
      },
      "TopupBody": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "description": {
            "type": "string",
            "maxLength": 500
          }
        },
        "required": [
          "amount"
        ]
      },
      "TopupConfirmPaymentModel": {
        "type": "object",
        "properties": {
          "client_secret": {
            "type": "string",
            "minLength": 1
          },
          "hosted_url": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "client_secret",
          "hosted_url"
        ]
      },
      "TopupLinkBody": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "return_url": {
            "type": "string"
          }
        }
      },
      "TopupModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "payment": {
            "$ref": "#/components/schemas/PaymentModel"
          }
        },
        "required": [
          "id",
          "object",
          "amount",
          "status",
          "payment"
        ]
      },
      "TopupOptionBankDetailsModel": {
        "type": "object",
        "properties": {
          "account_holder_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "account_number": {
            "type": "string",
            "minLength": 1
          },
          "sort_code": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "routing_number": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "bank_name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "iban": {
            "nullable": true,
            "type": "string"
          },
          "bic": {
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "account_holder_name",
          "account_number",
          "sort_code",
          "routing_number",
          "bank_name"
        ]
      },
      "TopupOptionFeeModel": {
        "type": "object",
        "properties": {
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "rate_bps": {
            "type": "integer"
          },
          "fixed": {
            "type": "integer"
          },
          "cap": {
            "nullable": true,
            "type": "integer"
          },
          "platform_fee": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/TopupPlatformFeeModel"
              }
            ],
            "nullable": true
          },
          "paid_by": {
            "type": "string",
            "enum": [
              "account",
              "platform"
            ],
            "minLength": 1
          }
        },
        "required": [
          "amount",
          "rate_bps",
          "fixed",
          "cap",
          "platform_fee",
          "paid_by"
        ]
      },
      "TopupPlatformFeeModel": {
        "type": "object",
        "properties": {
          "amount": {
            "nullable": true,
            "type": "integer"
          },
          "rate_bps": {
            "type": "integer"
          },
          "fixed": {
            "type": "integer"
          }
        },
        "required": [
          "amount",
          "rate_bps",
          "fixed"
        ]
      },
      "TopupSwiftModel": {
        "type": "object",
        "properties": {
          "bic": {
            "type": "string",
            "minLength": 1
          },
          "account_number": {
            "type": "string",
            "minLength": 1
          },
          "bank_name": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "bic",
          "account_number",
          "bank_name"
        ]
      },
      "TosAcceptanceBody": {
        "type": "object",
        "properties": {
          "date": {
            "type": "integer",
            "minimum": 1000000000,
            "multipleOf": 1
          },
          "ip": {
            "type": "string",
            "maxLength": 45,
            "minLength": 1
          },
          "user_agent": {
            "type": "string",
            "maxLength": 255
          },
          "service_agreement": {
            "type": "string",
            "enum": [
              "full"
            ]
          }
        },
        "required": [
          "date",
          "ip"
        ]
      },
      "TotalsBody": {
        "type": "object",
        "properties": {
          "subtotal": {
            "type": "integer"
          },
          "discount": {
            "type": "integer"
          },
          "service_charge": {
            "type": "integer"
          },
          "tax_by_rate": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TaxByRateBody"
            }
          },
          "tax": {
            "type": "integer"
          },
          "tip": {
            "type": "integer"
          },
          "total": {
            "type": "integer"
          },
          "cash_rounding": {
            "type": "integer"
          },
          "paid": {
            "type": "integer"
          },
          "due": {
            "type": "integer"
          },
          "change": {
            "type": "integer"
          }
        }
      },
      "TransactionMerchantModel": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "network_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "country": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "mcc": {
            "type": "integer"
          }
        },
        "required": [
          "name",
          "network_id",
          "country",
          "mcc"
        ]
      },
      "TransferList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TransferModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "TransferModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "destination": {
            "type": "string",
            "minLength": 1
          },
          "description": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "transfer_group": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "amount_reversed": {
            "type": "integer"
          },
          "reversed": {
            "type": "boolean"
          },
          "failure_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "metadata": {
            "type": "object"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "amount",
          "currency",
          "destination",
          "description",
          "transfer_group",
          "status",
          "amount_reversed",
          "reversed",
          "failure_reason",
          "metadata",
          "created"
        ]
      },
      "TransferReversalList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TransferReversalModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "TransferReversalModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "transfer": {
            "type": "string",
            "minLength": 1
          },
          "metadata": {
            "type": "object"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "amount",
          "currency",
          "transfer",
          "metadata",
          "created"
        ]
      },
      "TransitDaysModel": {
        "type": "object",
        "properties": {
          "min": {
            "type": "integer"
          },
          "max": {
            "type": "integer"
          }
        },
        "required": [
          "min",
          "max"
        ]
      },
      "UnusualPurchaseModel": {
        "type": "object",
        "properties": {
          "authorization": {
            "type": "string",
            "minLength": 1
          },
          "card": {
            "type": "string",
            "minLength": 1
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "merchant": {
            "type": "string",
            "minLength": 1
          },
          "unusual": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "approved": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "authorization",
          "card",
          "amount",
          "currency",
          "merchant",
          "unusual",
          "approved",
          "created"
        ]
      },
      "UnverifiedItemModel": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "minLength": 1
          },
          "notes": {
            "type": "string"
          }
        },
        "required": [
          "path"
        ]
      },
      "UpdateAccountBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 120,
            "minLength": 2
          },
          "minimum_payment_amount": {
            "nullable": true,
            "type": "integer",
            "multipleOf": 1
          },
          "settings": {
            "$ref": "#/components/schemas/AccountSettingsBody"
          }
        }
      },
      "UpdateBookingBody": {
        "type": "object",
        "properties": {
          "client_notes": {
            "nullable": true,
            "type": "string",
            "maxLength": 1000
          },
          "internal_notes": {
            "nullable": true,
            "type": "string",
            "maxLength": 2000
          },
          "metadata": {
            "type": "object"
          }
        }
      },
      "UpdateCapabilityBody": {
        "type": "object",
        "properties": {
          "requested": {
            "type": "boolean"
          },
          "tos_acceptance": {
            "$ref": "#/components/schemas/CapabilityTosAcceptanceBody"
          }
        },
        "required": [
          "requested"
        ]
      },
      "UpdateCardBody": {
        "type": "object",
        "properties": {
          "spend_policy": {
            "nullable": true,
            "type": "string"
          },
          "metadata": {
            "type": "object"
          }
        }
      },
      "UpdateCardDisputeBody": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "enum": [
              "fraudulent",
              "not_received",
              "canceled",
              "duplicate",
              "merchandise_not_as_described",
              "service_not_as_described",
              "no_valid_authorization",
              "other"
            ]
          },
          "explanation": {
            "type": "string",
            "maxLength": 2000
          },
          "evidence": {
            "$ref": "#/components/schemas/EvidenceBody"
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "UpdateCarrierAccountBody": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "maxLength": 80
          },
          "fallback_to_balance": {
            "type": "boolean"
          }
        }
      },
      "UpdateConnectAccountBody": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "maxLength": 320
          },
          "business_profile": {
            "$ref": "#/components/schemas/BusinessProfileBody"
          },
          "settings": {
            "$ref": "#/components/schemas/SettingsBody"
          },
          "metadata": {
            "type": "object"
          },
          "controller": {
            "description": "Set when the account is created: refused here with `parameter_invalid`.",
            "nullable": true
          },
          "business_type": {
            "type": "string",
            "enum": [
              "individual",
              "company"
            ]
          },
          "capabilities": {
            "$ref": "#/components/schemas/CapabilitiesBody"
          },
          "company": {
            "$ref": "#/components/schemas/AccountCompanyBody"
          },
          "individual": {
            "$ref": "#/components/schemas/PersonBody"
          },
          "tos_acceptance": {
            "$ref": "#/components/schemas/TosAcceptanceBody"
          },
          "external_account": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/ExternalAccountDetailsBody"
              }
            ]
          }
        }
      },
      "UpdateDisputeBody": {
        "type": "object",
        "properties": {
          "evidence": {
            "$ref": "#/components/schemas/DisputeEvidenceModel"
          }
        },
        "required": [
          "evidence"
        ]
      },
      "UpdateExternalAccountBody": {
        "type": "object",
        "properties": {
          "default_for_currency": {
            "type": "boolean"
          }
        }
      },
      "UpdateFormBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 121
          },
          "questions": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "attachment": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "valid_for_days": {
            "nullable": true,
            "type": "integer"
          },
          "clinical": {
            "type": "boolean"
          },
          "status": {
            "type": "string"
          },
          "kind": {
            "type": "string"
          },
          "template": {
            "type": "string"
          }
        }
      },
      "UpdateMarketingSettingsBody": {
        "type": "object",
        "properties": {
          "monthly_cap": {
            "type": "integer",
            "multipleOf": 1
          },
          "texts": {
            "type": "boolean"
          },
          "rebooking": {
            "nullable": true
          },
          "birthday": {
            "nullable": true
          }
        }
      },
      "UpdateMessagingSettingsBody": {
        "type": "object",
        "properties": {
          "reminders": {
            "nullable": true
          },
          "sender_name": {
            "nullable": true,
            "type": "string"
          },
          "templates": {
            "nullable": true
          },
          "quiet_hours": {
            "nullable": true
          },
          "daily_sms_cap": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      },
      "UpdateNoteBody": {
        "type": "object",
        "properties": {
          "body": {
            "type": "string",
            "maxLength": 5001
          },
          "pinned": {
            "type": "boolean"
          },
          "visibility": {
            "type": "string"
          }
        }
      },
      "UpdatePackageBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 100
          },
          "offer_on_page": {
            "type": "boolean"
          }
        }
      },
      "UpdatePlanBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 120
          },
          "metadata": {
            "type": "object"
          },
          "entitlements": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PlanEntitlementsModel"
              }
            ],
            "nullable": true
          },
          "event_entitlements": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/PlanEventEntitlementsBody"
              }
            ],
            "nullable": true
          },
          "offer_on_page": {
            "type": "boolean"
          }
        }
      },
      "UpdateStoreImportBody": {
        "type": "object",
        "properties": {
          "mapping": {
            "$ref": "#/components/schemas/StoreImportMappingBody"
          }
        },
        "required": [
          "mapping"
        ]
      },
      "UpdateSubjectBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 101
          },
          "fields": {
            "nullable": true
          },
          "status": {
            "type": "string"
          },
          "kind": {
            "type": "string"
          }
        }
      },
      "UsFundingDetailsModel": {
        "type": "object",
        "properties": {
          "routing_number": {
            "type": "string",
            "minLength": 1
          },
          "account_number": {
            "type": "string",
            "minLength": 1
          },
          "bank_name": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "routing_number",
          "account_number",
          "bank_name"
        ]
      },
      "UsageBatchBody": {
        "type": "object",
        "properties": {
          "events": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UsageBody"
            },
            "maxItems": 100,
            "minItems": 1
          }
        },
        "required": [
          "events"
        ]
      },
      "UsageBody": {
        "type": "object",
        "properties": {
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "meter": {
            "type": "string",
            "minLength": 1
          },
          "identifier": {
            "type": "string",
            "maxLength": 255,
            "minLength": 1
          },
          "quantity": {
            "type": "integer",
            "multipleOf": 1
          },
          "amount": {
            "type": "integer",
            "multipleOf": 1
          },
          "credit_token": {
            "type": "string",
            "maxLength": 4000
          }
        },
        "required": [
          "customer",
          "meter",
          "identifier"
        ]
      },
      "UsageByDayModel": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string",
            "minLength": 1
          },
          "events": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "date",
          "events",
          "amount"
        ]
      },
      "UsageByMeterModel": {
        "type": "object",
        "properties": {
          "events": {
            "type": "integer"
          },
          "quantity": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "meter": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "events",
          "quantity",
          "amount",
          "meter",
          "name"
        ]
      },
      "UsageEventList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UsageEventModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "UsageEventModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "identifier": {
            "type": "string",
            "minLength": 1
          },
          "customer": {
            "type": "string",
            "minLength": 1
          },
          "meter": {
            "type": "string",
            "minLength": 1
          },
          "meter_name": {
            "type": "string",
            "minLength": 1
          },
          "quantity": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "credit_token": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "identifier",
          "customer",
          "meter",
          "meter_name",
          "quantity",
          "amount",
          "credit_token",
          "created"
        ]
      },
      "UsageSummaryModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "from": {
            "type": "string",
            "minLength": 1
          },
          "to": {
            "type": "string",
            "minLength": 1
          },
          "total": {
            "$ref": "#/components/schemas/UsageTotalsModel"
          },
          "meters": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UsageByMeterModel"
            }
          },
          "days": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UsageByDayModel"
            }
          }
        },
        "required": [
          "object",
          "currency",
          "from",
          "to",
          "total",
          "meters",
          "days"
        ]
      },
      "UsageTotalsModel": {
        "type": "object",
        "properties": {
          "events": {
            "type": "integer"
          },
          "quantity": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "events",
          "quantity",
          "amount"
        ]
      },
      "UtilisationModel": {
        "type": "object",
        "properties": {
          "staff": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UtilisationRowModel"
            }
          },
          "total": {
            "$ref": "#/components/schemas/UtilisationTotalModel"
          }
        },
        "required": [
          "staff",
          "total"
        ]
      },
      "UtilisationRowModel": {
        "type": "object",
        "properties": {
          "staff_member": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "working_minutes": {
            "type": "integer"
          },
          "booked_minutes": {
            "type": "integer"
          },
          "rate": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "staff_member",
          "name",
          "working_minutes",
          "booked_minutes",
          "rate"
        ]
      },
      "UtilisationTotalModel": {
        "type": "object",
        "properties": {
          "working_minutes": {
            "type": "integer"
          },
          "booked_minutes": {
            "type": "integer"
          },
          "rate": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "working_minutes",
          "booked_minutes",
          "rate"
        ]
      },
      "VerificationFieldListModel": {
        "type": "object",
        "properties": {
          "minimum": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "additional": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "minimum",
          "additional"
        ]
      },
      "VerificationFieldsModel": {
        "type": "object",
        "properties": {
          "individual": {
            "$ref": "#/components/schemas/VerificationFieldListModel"
          },
          "company": {
            "$ref": "#/components/schemas/VerificationFieldListModel"
          }
        },
        "required": [
          "individual",
          "company"
        ]
      },
      "VerifyBody": {
        "type": "object",
        "properties": {
          "location": {
            "type": "string",
            "maxLength": 40
          },
          "from": {
            "type": "string",
            "maxLength": 10
          },
          "to": {
            "type": "string",
            "maxLength": 10
          }
        }
      },
      "VideoFrameBody": {
        "type": "object",
        "properties": {
          "at_ms": {
            "type": "integer",
            "multipleOf": 1
          },
          "image": {
            "type": "string",
            "maxLength": 560000,
            "minLength": 1
          }
        },
        "required": [
          "at_ms",
          "image"
        ]
      },
      "VideoTagBody": {
        "type": "object",
        "properties": {
          "product": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "at_ms": {
            "type": "integer",
            "multipleOf": 1
          }
        },
        "required": [
          "product",
          "at_ms"
        ]
      },
      "VideoTagModel": {
        "type": "object",
        "properties": {
          "product": {
            "type": "string",
            "minLength": 1
          },
          "at_ms": {
            "type": "integer",
            "multipleOf": 1
          },
          "state": {
            "type": "string",
            "enum": [
              "proposed",
              "confirmed"
            ],
            "minLength": 1
          },
          "confidence": {
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "product",
          "at_ms",
          "state",
          "confidence"
        ]
      },
      "VideoTagsBody": {
        "type": "object",
        "properties": {
          "tags": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/VideoTagBody"
            }
          }
        },
        "required": [
          "tags"
        ]
      },
      "VideoTagsProposeBody": {
        "type": "object",
        "properties": {
          "frames": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/VideoFrameBody"
            }
          }
        },
        "required": [
          "frames"
        ]
      },
      "VoidRecordBody": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "maxLength": 300
          }
        }
      },
      "VoidSummaryModel": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "count",
          "amount"
        ]
      },
      "VoucherCodeModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "voucher": {
            "type": "string",
            "minLength": 1
          },
          "code": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "voucher",
          "code"
        ]
      },
      "VoucherList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/VoucherModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "VoucherModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "balance": {
            "type": "integer"
          },
          "held": {
            "type": "integer"
          },
          "code_last4": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "active",
              "void",
              "expired"
            ],
            "minLength": 1
          },
          "recipient": {
            "$ref": "#/components/schemas/VoucherRecipientModel"
          },
          "purchaser": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "purchase_payment": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "expires_at": {
            "type": "integer"
          },
          "issued_at": {
            "nullable": true,
            "type": "integer"
          },
          "voided_at": {
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "type": "integer"
          },
          "approval_url": {
            "type": "string"
          },
          "client_secret": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "amount",
          "currency",
          "balance",
          "held",
          "code_last4",
          "status",
          "recipient",
          "purchaser",
          "purchase_payment",
          "expires_at",
          "issued_at",
          "voided_at",
          "created"
        ],
        "example": {
          "id": "vch_01K6AB3C5D7E9F1G3H5J7K9M1N",
          "object": "voucher",
          "livemode": false,
          "amount": 5000,
          "currency": "gbp",
          "balance": 5000,
          "held": 1000,
          "code_last4": "2WYD",
          "status": "active",
          "recipient": {
            "name": "Alex Chen",
            "email": "alex@example.com",
            "message": "Happy birthday!"
          },
          "purchaser": "cus_01J8ZK1Q9H2B4C6D8E0F2G4H6J",
          "purchase_payment": "pay_01K6AB3C5D7E9F1G3H5J7K9M1P",
          "expires_at": 1790500000,
          "issued_at": 1758964000,
          "voided_at": null,
          "created": 1758963900
        }
      },
      "VoucherPurchaserBody": {
        "type": "object",
        "properties": {
          "customer": {
            "type": "string",
            "maxLength": 40
          },
          "name": {
            "type": "string",
            "maxLength": 100
          },
          "email": {
            "type": "string",
            "maxLength": 320
          }
        }
      },
      "VoucherRecipientBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 100
          },
          "email": {
            "type": "string",
            "maxLength": 320,
            "minLength": 1
          },
          "message": {
            "type": "string",
            "maxLength": 500
          }
        },
        "required": [
          "email"
        ]
      },
      "VoucherRecipientModel": {
        "type": "object",
        "properties": {
          "name": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "email": {
            "type": "string",
            "minLength": 1
          },
          "message": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "name",
          "email",
          "message"
        ]
      },
      "WaitlistClientBody": {
        "type": "object",
        "properties": {
          "name": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          },
          "email": {
            "nullable": true,
            "type": "string",
            "maxLength": 320
          },
          "phone": {
            "nullable": true,
            "type": "string",
            "maxLength": 30
          }
        }
      },
      "WaitlistEntryBody": {
        "type": "object",
        "properties": {
          "customer": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "client": {
            "$ref": "#/components/schemas/WaitlistClientBody"
          },
          "service": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "variant": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "staff_member": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "location": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "date_from": {
            "nullable": true,
            "type": "string",
            "maxLength": 10
          },
          "date_to": {
            "nullable": true,
            "type": "string",
            "maxLength": 10
          },
          "time_windows": {
            "type": "object"
          },
          "notes": {
            "nullable": true,
            "type": "string",
            "maxLength": 500
          }
        },
        "required": [
          "service",
          "location"
        ]
      },
      "WaitlistEntryEditBody": {
        "type": "object",
        "properties": {
          "staff_member": {
            "nullable": true,
            "type": "string",
            "maxLength": 40
          },
          "date_from": {
            "nullable": true,
            "type": "string",
            "maxLength": 10
          },
          "date_to": {
            "nullable": true,
            "type": "string",
            "maxLength": 10
          },
          "time_windows": {
            "type": "object"
          },
          "notes": {
            "nullable": true,
            "type": "string",
            "maxLength": 500
          }
        }
      },
      "WaitlistOfferLinkModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "entry": {
            "type": "string",
            "minLength": 1
          },
          "booking": {
            "type": "string",
            "minLength": 1
          },
          "url": {
            "type": "string",
            "minLength": 1
          },
          "expires_at": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "object",
          "livemode",
          "entry",
          "booking",
          "url",
          "expires_at"
        ]
      },
      "WaiveFeeBody": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "maxLength": 300
          }
        }
      },
      "WayBackOptionList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WayBackOptionModel"
            }
          }
        },
        "required": [
          "object",
          "data"
        ]
      },
      "WayBackOptionModel": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "label",
              "drop_off",
              "shop"
            ],
            "minLength": 1
          },
          "service": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "cost": {
            "nullable": true,
            "type": "integer"
          },
          "currency": {
            "type": "string",
            "minLength": 1
          },
          "payer": {
            "type": "string",
            "enum": [
              "business",
              "shopper"
            ],
            "minLength": 1
          },
          "deducted": {
            "type": "integer"
          },
          "location": {
            "nullable": true
          }
        },
        "required": [
          "kind",
          "service",
          "name",
          "cost",
          "currency",
          "payer",
          "deducted",
          "location"
        ]
      },
      "WebhookDeliveryList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WebhookDeliveryModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "WebhookDeliveryModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "event": {
            "type": "string",
            "minLength": 1
          },
          "event_type": {
            "type": "string",
            "minLength": 1
          },
          "webhook_endpoint": {
            "type": "string",
            "minLength": 1
          },
          "account": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "attempt_count": {
            "type": "integer"
          },
          "next_attempt_at": {
            "nullable": true,
            "type": "integer"
          },
          "delivered_at": {
            "nullable": true,
            "type": "integer"
          },
          "attempts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DeliveryAttemptModel"
            }
          },
          "last_response_body": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "created": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "event",
          "event_type",
          "webhook_endpoint",
          "account",
          "status",
          "attempt_count",
          "next_attempt_at",
          "delivered_at",
          "attempts",
          "last_response_body",
          "created"
        ]
      },
      "WebhookEndpointBody": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "maxLength": 2048
          },
          "enabled_events": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "description": {
            "nullable": true,
            "type": "string",
            "maxLength": 200
          },
          "status": {
            "type": "string",
            "enum": [
              "enabled",
              "disabled"
            ]
          },
          "connect": {
            "type": "boolean"
          }
        }
      },
      "WebhookEndpointList": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WebhookEndpointModel"
            }
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "data",
          "has_more"
        ]
      },
      "WebhookEndpointModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "url": {
            "type": "string",
            "minLength": 1
          },
          "description": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "enabled_events": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "status": {
            "type": "string",
            "minLength": 1
          },
          "disabled_reason": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "connect": {
            "type": "boolean"
          },
          "created": {
            "type": "integer"
          },
          "previous_secret_expires_at": {
            "nullable": true,
            "type": "integer"
          },
          "secret": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "url",
          "description",
          "enabled_events",
          "status",
          "disabled_reason",
          "connect",
          "created",
          "previous_secret_expires_at"
        ],
        "example": {
          "id": "we_01J8ZKD6E8F0G2H4J6K8M0N2P4",
          "object": "webhook_endpoint",
          "livemode": false,
          "url": "https://example.com/tuppence/webhooks",
          "description": "Order fulfilment",
          "enabled_events": [
            "payment.succeeded",
            "refund.created"
          ],
          "status": "enabled",
          "disabled_reason": null,
          "connect": false,
          "created": 1789970000,
          "previous_secret_expires_at": null
        }
      },
      "WebhookInboxModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "object": {
            "type": "string",
            "minLength": 1
          },
          "livemode": {
            "type": "boolean"
          },
          "url": {
            "type": "string",
            "minLength": 1
          },
          "expires_at": {
            "type": "integer"
          },
          "created": {
            "type": "integer"
          },
          "requests": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InboxRequestModel"
            }
          }
        },
        "required": [
          "id",
          "object",
          "livemode",
          "url",
          "expires_at",
          "created",
          "requests"
        ]
      },
      "WorkingDayModel": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string",
            "minLength": 1
          },
          "spans": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WorkingSpanModel"
            }
          }
        },
        "required": [
          "date",
          "spans"
        ]
      },
      "WorkingHoursModel": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "minLength": 1
          },
          "staff_member": {
            "type": "string",
            "minLength": 1
          },
          "from": {
            "type": "string",
            "minLength": 1
          },
          "to": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WorkingDayModel"
            }
          }
        },
        "required": [
          "object",
          "staff_member",
          "from",
          "to",
          "data"
        ]
      },
      "WorkingSpanModel": {
        "type": "object",
        "properties": {
          "starts_at": {
            "type": "string",
            "minLength": 1
          },
          "ends_at": {
            "type": "string",
            "minLength": 1
          },
          "location": {
            "type": "string",
            "minLength": 1
          },
          "timezone": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "starts_at",
          "ends_at",
          "location",
          "timezone"
        ]
      },
      "ZoneBody": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 80
          },
          "countries": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "regions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "postcodes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "excluded_postcodes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "international": {
            "type": "boolean"
          },
          "enabled": {
            "type": "boolean"
          },
          "sort": {
            "type": "integer",
            "multipleOf": 1
          }
        }
      }
    },
    "responses": {
      "BadRequest": {
        "description": "invalid_request_error — `parameter_missing`, `parameter_invalid`, `invalid_id`, `invalid_api_version`, and the operation's own codes (see `code`). Cards: `limit_above_account_maximum` (a card's own limit above what your account's cards can have right now — `param` names the field). Card disputes: `dispute_evidence_incomplete` (`missing_evidence` names what the reason still needs), `dispute_window_closed` (`dispute_by`), `dispute_not_allowed` (`available_at` when the network's rules allow it), `invalid_state` (submitted already: a dispute is submitted once). Connect: `application_fee_too_high` (an application fee above your platform's cap — 20% of the payment unless we raised it; `max_fee_bps`, `max_fee_amount` and `fix_url` say the cap and where to ask for more; a percentage set ahead is refused when it is set). Regions (55, 100): `region_unavailable` (your region's platform isn't open in this environment yet — `country`, `country_label`, `coming_soon`, `waitlist_url`), `country_not_supported` (Connect: a connected account is in one of its platform's region's countries: the UK's, the US's, or the eurozone's 20). Bank accounts: `parameter_invalid` on `external_account[account_number]` for an IBAN of the wrong country, length or check digits (the eurozone), or an account number that isn't 4–17 digits (the UK and the US).",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Unauthorized": {
        "description": "authentication_error — `invalid_api_key`: no key, a revoked key, or a key from another mode.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Forbidden": {
        "description": "permission_error — `permission_denied` (a restricted key without the scope), `ip_not_allowed`, `onboarding_incomplete`, `live_mode_unavailable`, `feature_not_enabled` (not yet on for your account in this mode). Payouts: `payouts_on_hold`, `payouts_not_approved` (payouts start once we have reviewed your account), `payout_unavailable` (money can't leave your account right now — a payout, instant, a transfer or a move to your cards; your money is safe in your balance; contact us and we'll help). Payments: `manual_capture_unavailable` (`capture_method: manual` isn't available on your account yet — `fix_url` opens *Contact us*). Cards: `issuing_card_limit` / `issuing_cardholder_limit` (you can't add another card or cardholder right now — `fix_url` opens *Contact us*). `next_day_unavailable` and `topup_unavailable` carry `reason`: `not_available_yet` when it isn't open on your account yet. Card disputes: `dispute_submission_needs_person` (an agent's restricted key drafts a dispute and adds evidence; a person submits it — over MCP, `submit_card_dispute` asks one for you). Card details: `permission_denied` (only a restricted key made with `card_details:read` — never a secret key — and only an agent's own virtual card), `feature_not_enabled` (the account's owner has not allowed agents to read card numbers, or it is not available here).",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "NotFound": {
        "description": "invalid_request_error — `resource_missing`: no such object in THIS account and mode.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Conflict": {
        "description": "idempotency_error — `idempotency_in_progress` (retry shortly) or `idempotency_key_reuse` (the key was used with different parameters). invalid_request_error — `region_mismatch`: the account's Stripe account still lives on another region's platform; nothing was charged, and Tuppence moves it (55-10). `country_mismatch`: the account's Stripe account is in a different country from the business (100-06); nothing was done, and Tuppence fixes it.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "PaymentFailed": {
        "description": "card_error — `card_declined` (see `decline_code`), `authentication_required`, `own_card_not_allowed`, `insufficient_credits`. invalid_request_error — `payment_unavailable`: the payment can't be taken right now, and nothing was charged. Don't retry it: contact us and we'll help. A payer on a hosted page sees only that the business can't take the payment right now.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "TooManyRequests": {
        "description": "rate_limit_error — `rate_limited`: slow down and retry after `Retry-After` seconds.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      }
    },
    "parameters": {
      "Limit": {
        "name": "limit",
        "in": "query",
        "required": false,
        "description": "How many to return, 1–100.",
        "schema": {
          "type": "integer",
          "minimum": 1,
          "maximum": 100,
          "default": 10
        }
      },
      "StartingAfter": {
        "name": "starting_after",
        "in": "query",
        "required": false,
        "description": "A cursor: the id of the last object you have. Returns the ones after it.",
        "schema": {
          "type": "string"
        }
      },
      "EndingBefore": {
        "name": "ending_before",
        "in": "query",
        "required": false,
        "description": "A cursor: the id of the first object you have. Returns the ones before it.",
        "schema": {
          "type": "string"
        }
      },
      "TuppenceVersion": {
        "name": "Tuppence-Version",
        "in": "header",
        "required": false,
        "description": "The API version to answer in (`YYYY-MM-DD`). Without it, the version your account was pinned to when it was created.",
        "schema": {
          "type": "string",
          "example": "2026-09-20"
        }
      }
    },
    "securitySchemes": {
      "apiKey": {
        "type": "http",
        "scheme": "bearer",
        "description": "Your secret key (`sk_test_…` / `sk_live_…`) or a restricted key (`rk_…`) as a bearer token. A restricted key may call only what its scopes allow."
      }
    }
  }
}
