Skip to content

Change plan

Switches the business's plan to the one a preview quoted: now, charged at once at the quoted amount and applied only once paid, or from the period's end. A charge the card holder must confirm answers what to confirm it with. Not past a plan held for good, nor to Lite over its limits. Only a member with full access switches.

Needs the organization:write scope.

Call

  • Tool: change_plan
  • Scope: organization:write
  • Writes, and may change or remove what is there.
  • Acts on a store.

Arguments

Name Type Required Description
store string No The store to act on.
key "lite_monthly" or "lite_yearly" or "pro_monthly" or "pro_yearly" Yes The plan to switch to, as previewed.
quote string Yes The quote previewPlanChange answered, whose amount is the one charged.
{
  "type": "object",
  "properties": {
    "store": {
      "type": "string",
      "description": "The store to act on."
    },
    "key": {
      "description": "The plan to switch to, as previewed.",
      "type": "string",
      "enum": [
        "lite_monthly",
        "lite_yearly",
        "pro_monthly",
        "pro_yearly"
      ]
    },
    "quote": {
      "description": "The quote `previewPlanChange` answered, whose amount is the one charged.",
      "type": "string",
      "maxLength": 4096
    }
  },
  "required": [
    "key",
    "quote"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
plan object or null Yes
confirm object 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.
  • conflict: the call clashes with the current state; context names the field and, where it helps, its current value, and for a from, live, expect or version that no longer matches, the argument (path) and what it takes (reason).
  • 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, and the write may have landed. This write takes no idempotency key, so read the state back before trying again.
  • client-fault: the server failed around the call. core_answer ok means the write landed, so don’t send it again. When reached_core is false, nothing happened and the call may be made again. Otherwise, this write takes no idempotency key, so read the state back before trying 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