Skip to content

Read business

Reads the store's business.

Needs the organization:read scope.

Call

  • Tool: get_organization
  • Scope: organization:read
  • Reads only.
  • Acts on a store.

Arguments

Name Type Required Description
store string No The store to act on.
{
  "type": "object",
  "properties": {
    "store": {
      "type": "string",
      "description": "The store to act on."
    }
  },
  "additionalProperties": false
}

Answer

Name Type Required Description
plan object or null Yes
base_plan object or null Yes The plan held for good beneath any bought, whether or not one is live; null for none.
standing object or null Yes
has_customer boolean Yes Whether the business is a customer at Stripe, so its billing portal can open.
fee object or null Yes
connections array of object Yes
stores object Yes
members object Yes
id string Yes
name string Yes
short_name string Yes
email string Yes
description string or null Yes
swatch string or null Yes
logo string or null Yes
created_at string or null Yes

The answer’s full shape is on its API reference page.

Errors

A refused call is a tool error. Its structuredContent holds a code and its context, except for client-fault. This tool may answer:

  • invalid: an argument is malformed; context.path names it.
  • invalid at ["store"]: store is missing while the connection reaches more than one store, or names a store it doesn’t reach.
  • not_permitted: this connection may not make this call. When context.reason is limit, too many calls: retry_after says when to try again.
  • internal or unavailable: the call failed inside Sherpo. A read marked transient may be retried.
  • client-fault: the server failed around the call. reached_core says whether it reached Sherpo; the call may be made again.
  • HTTP 403 with insufficient_scope: the connection lacks the scope this tool needs.
  • HTTP 401 with invalid_token: the access token expired or the connection ended. Refresh the token, and connect again if the refresh fails or the new token is refused too.

Any other code may come back too, such as a conflict when the state changed under the call. When the answer was already streaming, a 401 or 403 comes back as a tool error with only its text. See Errors for every code and its context.

Type to search…

↑↓ navigate↵ selectEsc close