Plan details (current store plan)

Overview

Get the currently active plan for the store identified by store_id, plus its who_will_pay billing flag from store_options. Backs getCurrentPlan.

Prerequisites

• A bearer token. Callable with Partner and Account tokens.

Base URL

Endpoint

GET /api/v1/store/current-plan

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Who can call it: Partner and Account tokens.

• (Partner or Account user) — authentication, role-agnostic store/ group.

• store_id: required, must be an existing location, and must pass an ownership check. The check resolves the store to its company and confirms it is inside the caller's hierarchy.

• A partner reaches any store in its tree. An account user reaches only its own.

Rate limit

• No rate limit.

Query parameters

• Query: store_id (integer, required) — Store id; exists:store + an ownership check.

Response

• data.currentPlan (object) — { store_plan_id, status, cancel_subscription_at, plan_start, plan_end, plan_id, plan (name), price, daysRemaining, totalDays, features: [feature_name.] }.
• data.who_will_pay (string) — billing payer flag from store_options (e.g. partner).

200 Success · 200

{
  "data": {
    "currentPlan": {
      "store_plan_id": 5,
      "status": "active",
      "plan_start": "2026-04-01",
      "plan_end": "2026-12-31",
      "plan": "Pro Monthly",
      "price": 49.99,
      "daysRemaining": 211,
      "totalDays": 274,
      "features": [
        "response_to_past_reviews",
        "ai_response",
        "response_posting"
      ]
    },
    "who_will_pay": "brand"
  }
}

Errors

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/store/current-plan?store_id=123" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'