Glossary

plan_required

plan_required is the 402 error OneLifeVibe returns when a feature such as webhooks needs a paid plan; the free Sandbox polls GET /events instead.

Updated November 12, 2026

At OneLifeVibe

Related terms

What it means

plan_required is an error code that comes with HTTP status 402. It means the request asked for a feature that needs a paid plan, so the request did not go through. In HTTP terms, 402 is the status for payment required. OneLifeVibe uses the code to make the reason specific: the plan is the blocker, not your token or your request body.

Read the status and the code together. A 402 with plan_required tells you the feature is outside the current plan. A 401 or 403 is a different conversation: authentication or authorization. Treating all three as the same failure sends you down the wrong path.

How it works

You see plan_required when a request asks for a feature that requires a paid plan. For webhooks, a request on a plan without webhooks returns 402 plan_required. The error tells you the plan is the missing piece, so changing the request body or resending it unchanged will not help.

Error handling should branch on the status code and the code string, not on human-readable text. Log both and stop retrying. Retries are for transient failures such as timeouts or 5xx responses, not for an entitlement result that will not change on the next attempt.

How OneLifeVibe uses it

On OneLifeVibe, webhooks start on the Starter plan. If you are on the free Sandbox tier, webhooks are not the delivery path: poll GET /events instead. A webhook request from Sandbox returns 402 plan_required.

That gives you two working patterns. Use the Starter plan and receive webhooks, or stay on Sandbox and poll GET /events for events. The error code makes the split explicit, so your integration can choose the right path.

Common mistakes

The first mistake is reading plan_required as an auth problem. A 401 means the credential failed. A 402 plan_required means the feature needs a paid plan. Another mistake is retrying the same webhook call on Sandbox; the result will not change.

The fix is to poll GET /events on Sandbox or use a plan where webhooks are available, starting with Starter. Also record the code string exactly. Matching only on the status makes logs harder to read when other services use 402 as well.

Questions

What does plan_required mean in a OneLifeVibe API response?

It means the request needed a paid plan and came back with HTTP 402. The code plan_required identifies the reason, so check the feature you called and your plan before changing the request.

Can I use webhooks on the free Sandbox tier?

No. Webhooks start on the Starter plan, and the free Sandbox tier polls GET /events instead. A webhook request on Sandbox returns 402 plan_required.

See it working. The OneLifeVibe connector and Platform API put these pieces together.

Get a free key Read the docs

Written from the OneLifeVibe tool registry and platform configuration, and checked automatically before publishing. Something wrong? Tell us.