Access and gates
get_paid_access_design
Return the FULL-SCREEN paywall design for one SITE-WIDE offer (entire_site or except_homepage): the effective design, the stored cell (null when uncustomised), and the offer's title, price and currency. Canonical GateDesignV1. selected_pages offers render a modal and are refused here — use get_paid_modal_design. 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. |
| offer_id | uuid | Yes | Offer UUID from get_paid_access. |
Returns
| Name | Type |
|---|---|
| site_id | string |
| offer_id | string |
| title | string |
| price_minor | integer |
| currency | string |
| effective_design | object |
| stored_design | object or null |
| surface | enum site_gate | pages |
Using it
get_paid_access_design 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.