create_order
Prepare a paid order.
Price an order and return a Stripe Checkout link for a person to pay. Nothing is charged by this call and an agent cannot pay. phrases 10 to 50; frequency one_time, monthly, biweekly or weekly; months 1 to 6; pay once (15% off for more than one check) or monthly (ends by itself). The minimum order is $7.00: an order that comes to less is charged the minimum. Omit routes for the default AIs. Or pass preset, a ready-made order: cheapest (50 phrases, 5 AIs, one check: $8.17); recommended (50 phrases, 5 AIs, monthly for 3 months, 3 checks: $20.82 paid once); premium (50 phrases, 8 AIs, monthly for 6 months, 6 checks: $42.66 paid once). Other arguments given with a preset override its parts. Every price comes back from the server's settings at the time of the call.
Who can use it
- Access
- A verified account, while paid orders are open. A person pays; an agent can't.
- Scope
scan:write- Changes anything
- Yes.
Inputs
| Name | Type | Required | Values and limits |
|---|---|---|---|
preset | string | No | cheapest, recommended, premium. A ready-made order from the settings; other arguments given override its parts |
phrases | integer | No | 1 to 200 |
frequency | string | No | one_time, monthly, biweekly, weekly |
months | integer | No | 1 to 12 |
pay | string | No | once, monthly |
routes | array of string | No | at most 30 items |
research | integer | No | 0 to 100 |
What it answers
Every answer has status and, where useful, message in plain words.
| Field | Meaning |
|---|---|
status | awaiting_payment: the order exists and nothing has been charged. |
order_id | The new order. |
total_usd | The total, from the server's settings at the time of the call. |
summary | The order in words: phrases, checks, AIs, the total and how it's paid. Nothing renews. |
checkout_url | Stripe's page, for the person to open and pay. |
Errors
| status | What it means |
|---|---|
closed | Paid orders aren't open yet. pricing_url has the prices. |
invalid_input | The order can't be priced as given (the message says why), or a preset is switched off. |
verify_email | The account hasn't confirmed its email. |
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": "create_order",
"arguments": {
"preset": "recommended"
}
}
}{
"status": "awaiting_payment",
"order_id": "00000000-0000-4000-8000-000000000002",
"total_usd": "…",
"summary": "…",
"checkout_url": "https://checkout.stripe.com/…",
"message": "Nothing has been charged. A person must open checkout_url and pay on Stripe's page; an agent cannot pay. …"
}