Skip to main content
Documentation

Shop

shop.plan

Read the shop's plan, trial state and what it includes
Read-onlySensitiveRead budget

REST

Shipping
POST /api/v1/shop/plan

MCP tool

Live
shop.plan

Exposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Shop domain.

Operating contract

What this organization is paying for, and what state that subscription is in.

effective_tier IS THE ONE TO READ. It is what every plan gate in the product actually asks about, and it is not always the tier on the invoice: a trial resolves to the tier being trialled, and a past-due subscription can resolve down. Quoting plan_tier when they differ describes the billing record rather than what the shop can currently do.

trial_ends_at in the future with status: trialing means the shop is inside a trial. That date is the single most useful thing on this response for anybody helping them get set up.

past_due_since set means a payment failed and the clock is running. It is worth raising, and it is billing's to fix — nothing here changes it.

READ ONLY BY THE PROGRAM'S OWN LINE. Nothing in this registry changes a plan, adds a payment method, or spends money. That is not caution about this domain; it is the line the whole program draws.

One organization's plan state, entirely returned, so nothing is truncated.

Who may call it

Permission
shop.manageThe caller must hold shop.manage at the ACT level. A read-only dashboard grant on the same section is refused.
Plan
Every planNo plan gate. Available on every Service VIN plan.
Retries
naturalNaturally idempotent — running it twice leaves the same world as running it once. A retrying integration needs no key.
Rate class
readCounted against the read budget — the widest of the four.

Input

This capability takes no arguments.

Output

FieldTypeDescription
effective_tierstring

plan_tierstring | null

statusstring | null

intervalstring | null

trial_ends_atstring | null

renews_atstring | null

past_due_sincestring | null

Examples

Built from this capability's own schema — required fields and the ones carrying a default, and nothing invented. Paste one and it validates.

curl
export SERVICEVIN_API_KEY=svk_live_…

curl -X POST https://www.servicevin.com/api/v1/shop/plan \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

TypeScript (fetch)
const res = await fetch("https://www.servicevin.com/api/v1/shop/plan", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});

// Success and failure are both envelopes. Switch on error.code, never
// on error.message — the codes are stable, the messages are for people.
const payload = await res.json();
if (!res.ok) throw new Error(payload.error.code);
const data = payload.data;

Python (requests)
import os, requests

res = requests.post(
    "https://www.servicevin.com/api/v1/shop/plan",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={},
    timeout=30,
)
payload = res.json()
if not res.ok:
    raise RuntimeError(payload["error"]["code"])
data = payload["data"]

MCP tools/call — https://www.servicevin.com/api/mcp
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "shop.plan",
    "arguments": {}
  }
}

Refusals

The four gates run in this order on every surface, and the order is not arbitrary — see Authentication.

StatusCodeWhen
404not_foundThe id is unknown, or the feature is not enabled for this account. Deliberately the same answer for both.
403forbiddenThis login does not hold shop.manage.
422validation_errorAn argument was wrong. The message names the field.
429rate_limitedToo many read calls. Back off and retry.
500internal_errorSomething failed on our side. Nothing was changed.