Skip to content

Preview extra store cost

Previews what one more store on the business's plan charges now and bills from its next renewal.

Needs the organization:read scope.

Call

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

Arguments

Name Type Required Description
store string No The store to act on.
price string or null Yes The plan as the seller saw it, so a plan changed since is never previewed.
quantity integer Yes Stores the plan bills before the one added.
{
  "type": "object",
  "properties": {
    "store": {
      "type": "string",
      "description": "The store to act on."
    },
    "price": {
      "description": "The plan as the seller saw it, so a plan changed since is never previewed.",
      "anyOf": [
        {
          "type": "string",
          "maxLength": 255
        },
        {
          "type": "null"
        }
      ]
    },
    "quantity": {
      "description": "Stores the plan bills before the one added.",
      "type": "integer",
      "minimum": 1,
      "maximum": 10
    }
  },
  "required": [
    "price",
    "quantity"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
quote string Yes
proration_date string Yes
expires_at string Yes
currency string Yes
exponent number Yes
amount_due number Yes
tax number Yes
renewal_amount number Yes
renewal_tax number Yes
renews_at string Yes
trial_ends_at string or null Yes
plan object 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