get_order
One paid order in full.
One paid order of this account in full: state, setup (website and phrases, or the setup link), the phrases in use with their ids, the AIs, add-ons, the programs' state, every check with its date and answer counts, the next check, answers that didn't come back (retried once, then refunded to the card when the order ends), what the refund policy gives today, and invoice and receipt links. Read-only; nothing is changed or charged.
Who can use it
- Access
- A paid order.
- Scope
scan:read- Changes anything
- No. Read-only.
Inputs
| Name | Type | Required | Values and limits |
|---|---|---|---|
order_id | string | Yes | An order id from get_dashboard |
What it answers
Every answer has status and, where useful, message in plain words.
| Field | Meaning |
|---|---|
state, frequency, months, pay | The order's terms. |
phrases_bought, checks_bought, total_usd, paid_usd, refunded_usd | What was bought and paid. |
setup | done, the site, and setup_url while the website and phrases aren't set. |
phrases | The phrases in use: phrase_id, text, kind, added_on. |
ais | The AIs: key, label, mode, withdrawn. |
addons | Competitor research, backlinks, the keyword package, and add-ons bought later. |
programs | Whether the checklists are open to this order, and how many places are live in each. |
checks | Every check: check_id, due_on, status, answers (X of Y), named_answers. |
next_check | The next check. |
skipped_answers | Answers that didn't come back: retrying, recovered, never_returned, refund_usd and the refund (at_order_end, pending or refunded). No credit or balance exists. |
refund_today | What the refund policy gives if the person asks today, with its lines. Asking happens on the order page. |
invoices | Each payment with its invoice and receipt links. |
Errors
| status | What it means |
|---|---|
invalid_input | order_id isn't an order id. Take one from get_dashboard. |
not_found | No order with that id on this account. |
forbidden | The credential lacks the tool's scope, or an agent's owner has no ScanFree account yet (the owner signs in on the website once). |
Input validation error | An argument doesn't match the schema below. The call fails with MCP error -32602, naming the field. |
Errors before the tool runs (a missing key, too many requests) are on the MCP page.
Example
Example shape; values are illustrative.
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "get_order",
"arguments": {
"order_id": "00000000-0000-4000-8000-000000000002"
}
}
}{
"status": "ok",
"order_id": "00000000-0000-4000-8000-000000000002",
"state": "active",
"frequency": "monthly",
"months": 3,
"pay": "once",
"phrases_bought": 10,
"checks_bought": 3,
"total_usd": "…",
"paid_usd": "…",
"refunded_usd": 0,
"ordered_on": "2026-10-17",
"started_on": "2026-10-18",
"setup": {
"done": true,
"site": {
"site_id": "00000000-0000-4000-8000-000000000004",
"name": "example.com",
"url": "https://example.com/"
}
},
"phrases": [
{
"phrase_id": "00000000-0000-4000-8000-000000000005",
"text": "emergency plumber boise",
"kind": "generic",
"added_on": "2026-10-18"
}
],
"retired_phrases": 0,
"ais": [
{
"key": "perplexity.live.fast",
"label": "Perplexity",
"mode": "live_search",
"withdrawn": false
}
],
"addons": {
"competitor_research": 0,
"backlinks": null,
"keyword_package": null,
"bought_later": []
},
"programs": null,
"checks": [
{
"check_id": "00000000-0000-4000-8000-000000000003",
"due_on": "2026-11-18",
"status": "complete",
"answers": "80 of 80",
"named_answers": 14
}
],
"next_check": "2026-12-18",
"skipped_answers": {
"retrying": 0,
"recovered": 0,
"never_returned": 0,
"refund_usd": 0,
"refund": null,
"note": "…"
},
"refund_today": null,
"invoices": [],
"results_url": "https://app.scanfree.dev/app/orders/00000000-0000-4000-8000-000000000002",
"order_url": "https://app.scanfree.dev/orders/00000000-0000-4000-8000-000000000002"
}