Plan details (current store plan)

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

Auth: Both (Partner or Account user) — authentication, role-agnostic store/ group. store_id: required, must Must be an existing location, and must pass an ownership check (resolves the store to its company and confirms it is inside the caller's hierarchy) — partner reaches any store in its tree, account user only its own.

Rate limit: No rate limit.

Request

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

Response{ data. } envelope.

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

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json