# WallaB.AI > WallaB.AI is an AI-powered subscription-retention app for Shopify — a cancel-save concierge (WallaB), a passwordless self-serve shopper portal, dunning recovery, win-back, and a read-only developer data API. This file helps AI assistants discover WallaB.AI's public documentation and its read-only developer API. All docs are English-only and hosted under https://wallab.ai. ## Merchant guide - [Getting started](https://wallab.ai/docs/merchants/getting-started): From install to your first subscriber: the self-tracking setup guide. - [Plans & pricing wizard](https://wallab.ai/docs/merchants/plans-pricing): Selling plans, tiered intro pricing, volume discounts, build-a-box bundles, and prepaid. - [WallaB concierge & guardrails](https://wallab.ai/docs/merchants/concierge): Configuring the AI cancel-save concierge: allowed actions, discount caps, moderation, and auditability. - [Win-back & campaigns](https://wallab.ai/docs/merchants/winback-campaigns): Single win-back offers and paced bulk campaigns for cancelled subscribers. - [Dunning & card-expiry warnings](https://wallab.ai/docs/merchants/dunning-card-expiry): The failed-payment retry ladder and proactive card-expiry emails. - [Email Studio & sending domains](https://wallab.ai/docs/merchants/email-studio): Customizing every outbound email and verifying your own sending domains. - [Integrations: Shopify Flow, Klaviyo & PostHog](https://wallab.ai/docs/merchants/integrations): Fanning subscription lifecycle events out to Flow, Klaviyo, and PostHog. - [SMS & the consent model](https://wallab.ai/docs/merchants/sms): The concierge over SMS: dual-level consent and carrier keywords. - [Bulk actions](https://wallab.ai/docs/merchants/bulk-actions): Plan-wide pause, resume, skip, price, and variant changes — preview first. - [Importing subscribers](https://wallab.ai/docs/merchants/importer): Migrating from Recharge or CSV with dry-run validation and safety guarantees. - [Billing plans & support](https://wallab.ai/docs/merchants/billing-support): WallaB.AI's own pricing ladder, trials, and support SLAs. - [Performance fees (Retain & Recover)](https://wallab.ai/docs/merchants/performance-fees): How the 1% saved/recovered-revenue fee works: what's credited, the prepaid rule, your monthly cap, and disputing a credit. - [Skip limits](https://wallab.ai/docs/merchants/skip-limits): Optional merchant caps on how often a subscriber can skip and how far a skip can move the next billing date. - [Over-Deliver: delight campaigns & Moments](https://wallab.ai/docs/merchants/delight-campaigns): Unadvertised $0 surprise-gift campaigns and tenure-milestone Over-Deliver Moments — generosity that's never a save-offer. ## Shopper guide - [Your subscription portal](https://wallab.ai/docs/shoppers/portal): Passwordless sign-in and self-serve skip, pause, swap, cancel, and more. - [Talking to WallaB](https://wallab.ai/docs/shoppers/talking-to-wallab): What the AI concierge can offer you, and how you stay in control. - [Text-message keywords](https://wallab.ai/docs/shoppers/sms-keywords): STOP, HELP, and START — what each does, exactly. ## WallaB Developer Platform - [Developer platform overview](https://wallab.ai/docs/developers/overview): What the WallaB Developer Platform is, what you can build, and where to start. - [Quickstart](https://wallab.ai/docs/developers/quickstart): Create a key and make your first authenticated API call in under a minute. - [Authentication & API keys](https://wallab.ai/docs/developers/authentication): Bearer keys, the Growth-plan requirement, scopes, rotation, and keeping keys safe. - [API reference (v1)](https://wallab.ai/docs/developers/api-reference): The complete v1 reference: base URL, versioning, rate limits, errors, pagination, and every endpoint. - [Entitlements API](https://wallab.ai/docs/developers/entitlements-api): Key-authenticated, read-only subscription status lookups for your own systems. - [Quick-action links & webhooks](https://wallab.ai/docs/developers/quick-action-links): How single-use email action tokens behave, and where webhooks fit. - [Platform reliability & monitoring](https://wallab.ai/docs/developers/platform-monitoring): How WallaB.AI monitors its own production health — durable event logging, job-queue retries, and automated operator alerting. ## Retention glossary - [What is dunning?](https://wallab.ai/docs/glossary/what-is-dunning): Dunning is the automated retry-and-recovery process for a failed subscription payment — and how WallaB's dunning ladder and card-expiry warnings work. - [What is a cancel-save flow?](https://wallab.ai/docs/glossary/what-is-a-cancel-save-flow): A cancel-save flow offers a subscriber alternatives the moment they try to cancel — and how WallaB's guardrailed AI concierge runs one without dark patterns. - [Involuntary vs. voluntary churn](https://wallab.ai/docs/glossary/involuntary-vs-voluntary-churn): The difference between churn from a failed payment and churn from an active decision to cancel — and which WallaB features address each. - [What are prepaid subscriptions?](https://wallab.ai/docs/glossary/what-are-prepaid-subscriptions): Prepaid subscriptions are paid up front for several cycles at once — and how WallaB handles prepaid billing, balance exhaustion, and forfeiture. - [What is a subscription one-off?](https://wallab.ai/docs/glossary/what-is-a-subscription-one-off): A subscription one-off is a one-time extra item added to a shopper's next scheduled delivery, billed and shipped with that order — and how WallaB handles it on pay-as-you-go subscriptions. ## Developer API (v1) - Base URL: https://wallab.ai/api/external/v1 (v1) - Auth: `Authorization: Bearer ` with a `wlb_` API key (created in Settings, owner-only). Growth plan or higher. - Rate limits: per key, by plan — Growth 60/min, Pro 300/min, Enterprise Plus uncapped; 429 + `Retry-After` on exceed. - Scopes: - `read:entitlements` — Read customer entitlement status (active-subscription checks). - `read:subscriptions` — Read subscription records and their status. - `read:metrics` — Read aggregate retention and revenue metrics. - `read:plans` — Read selling-plan definitions. - Endpoints: - `GET /api/external/v1/entitlements` (scope: `read:entitlements`) — Check a customer's live entitlement status - `GET /api/external/v1/subscriptions` (scope: `read:subscriptions`) — List the shop's subscriptions - `GET /api/external/v1/subscriptions/{id}` (scope: `read:subscriptions`) — Get one subscription with its line items - `GET /api/external/v1/metrics/summary` (scope: `read:metrics`) — Get the dashboard KPI summary - `GET /api/external/v1/plans` (scope: `read:plans`) — List the shop's selling plans - `GET /api/external/v1/cancellations` (scope: `read:metrics`) — List cancel-save concierge outcomes ## Machine-readable specs - [OpenAPI 3.1 spec](https://wallab.ai/api/external/v1/openapi.json): the full, machine-readable API contract. - [llms-full.txt](https://wallab.ai/llms-full.txt): this index plus the full API reference inline.