Skip to content

Grant access

Grants a customer access to a product or tier.

Needs the customer:write scope.

Call

  • Tool: grant_access
  • Scope: customer:write
  • Writes, adding without changing what is there.
  • Acts on a store.

Arguments

Name Type Required Description
store string No The store to act on.
customer object Yes By id, or by email: whoever the address reaches, else its invited customer.
product object Yes
tier object or null Yes
ends_at string or null No
reason string or null No
{
  "type": "object",
  "properties": {
    "store": {
      "type": "string",
      "description": "The store to act on."
    },
    "customer": {
      "description": "By id, or by email: whoever the address reaches, else its invited customer.",
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "email": {
              "type": "string",
              "minLength": 1,
              "maxLength": 254,
              "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"
            }
          },
          "required": [
            "email"
          ],
          "additionalProperties": false
        }
      ]
    },
    "product": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "slug": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "slug"
          ],
          "additionalProperties": false
        }
      ]
    },
    "tier": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "ends_at": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"
        },
        {
          "type": "null"
        }
      ]
    },
    "reason": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 500
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "customer",
    "product",
    "tier"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
token_id string or null Yes
customer object or null Yes
product object or null Yes
tier object or null Yes
id string Yes
customer_id string Yes
product_id string Yes
tier_id string or null Yes
source_kind string Yes
source_ref string or null Yes
grant_reason string or null Yes
settlement_id string or null Yes
valid_from string or null Yes
ends_at string or null Yes
end_reason string or null Yes
status string Yes Where it stands now: not begun, standing, or how it ended.
revocable boolean Yes Whether revokeGrant may still end it.
granted_by string or null Yes
occurred_at string or null Yes
recorded_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_found: nothing matches a reference given.
  • 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