Access and gates
get_paid_access
Return the site's paid access configuration: Stripe readiness, every offer (title, GBP pence price, status, protection scope, locked paths, buyer_audience, access_days or null for lifetime plus access_until for legacy fixed-expiry offers), the site's page paths, the paths protected in the published snapshot, the gate now versus after the next publish, and whether a publish is required. For detailed Stripe onboarding state call get_commerce_setup; for the public seller details consumer selling requires, call get_seller_details. Buyer requirements: get_paid_access_requirements. Read-only.
Behaviour
- Effect
- Read only. Calling it never changes anything in the account.
- Repeat calls
- Idempotent. Repeating the same call produces the same result.
- Plan
- Available on every plan, including free.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| site_id | uuid | Yes | Site UUID from list_sites. |
Returns
| Name | Type | Description |
|---|---|---|
| site_id | string | - |
| stripe_ready | boolean | DEPRECATED and AMBIGUOUS: true when SOME payment environment (test OR live) can charge. MUST NOT be read as 'real money can be taken'. Use real_payments_ready for live money and test_payments_ready for test mode. |
| commerce_readiness | enum not_connected | onboarding_incomplete | restricted | test_ready | live_ready | Canonical account payment readiness; same enum and derivation as get_commerce_setup. test_ready means test charges only and no real money; live_ready means real money can be taken. |
| real_payments_ready | boolean | TRUE only when LIVE-mode Stripe can charge real cards right now. This is the ONLY field that means real money can be taken. |
| test_payments_ready | boolean | TRUE when TEST-mode Stripe can charge test cards right now. Test-mode purchases move no real money and are not sales. |
| payment_environment | enum or null test | live | Payment environment this site's own offers are pinned to ('test' or 'live'), or null when the site has no offers or they disagree. 'test' means no real money changes hands. |
| publish_required | boolean | - |
| page_paths | array of string | - |
| published_protected_paths | array of string | - |
| published_primary_gate | enum classic | paid | - |
| published_paid_site_scope | enum or null entire_site | except_homepage | - |
| configured_primary_gate | enum classic | paid | - |
| configured_paid_site_scope | enum or null entire_site | except_homepage | - |
| items | array of object | - |
Using it
get_paid_access is called by an AI assistant connected to Sentway over MCP, not by hand. Point the assistant at the Sentway MCP endpoint and complete the OAuth flow, and the tool becomes available in the same session as the other 56 Sentway tools. See connecting over MCP.