Skip to content

plan_required

Needs a paid STOQ plan

BetaAPI v2 is in public beta: endpoints, fields and behaviour can change before general availability. See the changelog

Last updated

Code: plan_required · HTTP status: usually 403

The change uses a feature that is only available on a paid STOQ plan. Connecting a paid-only integration returns 403; a write that sets paid-only fields returns 422 and saves nothing.

Ask the merchant to upgrade in the STOQ dashboard (Settings, then Plans), or leave the paid-only fields out.

{
"code": "plan_required",
"type": "https://docs.stoqapp.com/v2/docs/api-v2/errors/plan-required/",
"title": "Needs a paid STOQ plan",
"status": 403,
"detail": "Partial payments are only available on a paid plan. Upgrade to enable it. Ask the merchant to upgrade in the STOQ dashboard (Settings, then Plans), or leave the paid-only fields out.",
"errors": [
"Partial payments are only available on a paid plan. Upgrade to enable it."
],
"details": [
{
"code": "plan_required",
"message": "Partial payments are only available on a paid plan. Upgrade to enable it.",
"path": null,
"value": null,
"expected": null
}
]
}

Every API v2 and MCP failure carries code and a type link to its page here. See Errors & Responses for the full envelope.

Was this page helpful?

Still stuck? Ask Quinn or chat with support