pricklymails-com · Schema
CreateCheckoutRequest
Request body for `POST /api/billing/checkout`.
Email VerificationSoftware-as-a-ServiceData ValidationEU-hosted
Properties
| Name | Type | Description |
|---|---|---|
| cancel_url | string | URL the buyer is redirected to when they cancel the checkout. |
| locale | stringnull | Language of the hosted checkout page and of the terms the buyer accepts there (`"en"` or `"fr"`). English when absent. |
| success_url | string | URL the buyer is redirected to after a successful payment. |
| target | object | What to check out: a plan subscription or a credit top-up. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/pricklymails-com/json-schema/pricklymails-com-create-checkout-request-schema.json",
"title": "CreateCheckoutRequest",
"description": "Request body for `POST /api/billing/checkout`.",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/pricklymails-com-billing-api-openapi.yml#/components/schemas/CreateCheckoutRequest",
"type": "object",
"required": [
"target",
"success_url",
"cancel_url"
],
"properties": {
"cancel_url": {
"type": "string",
"description": "URL the buyer is redirected to when they cancel the checkout."
},
"locale": {
"type": [
"string",
"null"
],
"description": "Language of the hosted checkout page and of the terms the buyer accepts there (`\"en\"` or `\"fr\"`).\nEnglish when absent."
},
"success_url": {
"type": "string",
"description": "URL the buyer is redirected to after a successful payment."
},
"target": {
"$ref": "#/$defs/CheckoutTargetRequest",
"description": "What to check out: a plan subscription or a credit top-up."
}
},
"$defs": {
"CheckoutTargetRequest": {
"oneOf": [
{
"type": "object",
"description": "Subscribe to a plan.",
"required": [
"plan",
"cycle",
"type"
],
"properties": {
"cycle": {
"type": "string",
"description": "Billing cycle (`\"monthly\"` or `\"yearly\"`)."
},
"plan": {
"type": "string",
"description": "Plan code (e.g. `\"starter\"`, `\"pro\"`, `\"business\"`, `\"enterprise\"`)."
},
"type": {
"type": "string",
"enum": [
"plan"
]
}
}
},
{
"type": "object",
"description": "One-time credit top-up.",
"required": [
"token_quantity",
"type"
],
"properties": {
"token_quantity": {
"type": "integer",
"format": "int32",
"description": "Number of tokens to purchase.\nMust be a multiple of the top-up step, between the minimum and maximum quantities (inclusive).\n`GET /api/config` returns these values as `topup.step_tokens`, `topup.min_tokens` and `topup.max_tokens`.",
"minimum": 0
},
"type": {
"type": "string",
"enum": [
"top_up"
]
}
}
}
],
"description": "Checkout target from the request body."
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/pricklymails-com-create-checkout-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.