For AI agents: visit https://docs.recurly.com/recurly-subscriptions/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Home
Product Docs
API Reference
Changelog
Product Documentation
v1.2.1
v1.2.2
v2.0
v2.1
v2.2
v2.3
v2.4
v2.5
v2.6
v2.7
v2.8
v2.9
v2.10
v2.11
v2.12
v2.13
v2.14
v2.15
v2.16
v2.17
v2.18
v2.19
v2.20
v2.21
v2.22
v2.24
v2.25
v2.26
v2.27
v2.28
v2.29
v2.99
v2019-10-10
v2020-01-01
v2021-02-25
v2022-01-01
v2999-01-01
Recurly
API Guides
Recurly.js
Webhooks
API Reference
Support
Book demo
Product Docs
Recurly
API Guides
Recurly.js
Webhooks
API Reference
Support
Book demo
Product Documentation
Home
Product Docs
API Reference
Changelog
Recurly for Shopify
GETTING STARTED
Recurly's overview
Go live checklist
Sandbox features to discover
Recurly Subscriptions Changelog
Browser support
Help & support
Frequently asked questions (FAQs)
Do you need help?
Professional services
Managed services
Customer success manager
PLANS, PRICING & PROMOTIONS
Overview: Plans, pricing & promotions
Plan structure
Plans
Add-ons
Decimal pricing
Item catalog
Line items
Pricing models
Fixed recurring pricing
Ramp pricing
One-time pricing
Usage-based billing
Quantity-based pricing
Hybrid pricing
Tiered, volume and stairstep pricing
Prepaid account balance
Currencies
Promotions
Free trial management
Coupons & discounts
Bulk unique coupons
Multiple coupons per account
Gift subscriptions
Gift cards
Gift cards dashboard
SUBSCRIBER MANAGEMENT
Overview: Subscriber management
Accounts
Accounts dashboard
Account acquisition data
Accounts settings
Account hierarchy
Account hierarchy - invoice rollup
Countries provinces and states
Shipping addresses
Shipping addresses per purchase
Subscriber wallet
Subscriber wallet implementation guide
Entitlements
Subscription lifecycle
Subscription dashboard
Create subscription
Change subscription
Pause subscription
Postpone subscription
Expire/cancel subscription
Multiple subscription support
Lifecycle communications
Email templates
Alternate Email Templates
Email language support (30)
Email timezones and timestamps
Renewal reminder and trial ending notifications
Advanced email deliverability (SendGrid)
Transactions
Transactions dashboard
Authorization and capture
MOTO transactions
Refund
HOSTED PAGES
Hosted pages
Checkout
Checkout analytics dashboard
Hosted payment page
Hosted account management
PAYMENT ORCHESTRATION
Overview: Payment orchestration
Payment settings
Payment gateways
Adyen
Authorize.net
Amazon Pay V2
Braintree
Chase Paymentech Orbital
Check Commerce
Checkout.com
Commerce Hub by Fiserv
Cybersource
Ebanx (APAC and LATAM)
FreedomPay
GoCardless
Nuvei
PayPal Complete
Stripe
TSYS
WorldPay US eCommerce (formerly Vantiv)
Worldpay - Global e-commerce
Payment methods
Credit cards
Prepaid and gift cards
PayPal
Apple Pay on the Web
Google Pay™
Link Pay by Stripe
Amazon Pay
Cash App Pay
ACH (US only)
SEPA
BACS (UK Only)
Revolut
BECS
Klarna (BNPL, Pay Now, Pay Later)
iDEAL
Klarna Debit Risk (formerly Sofort)
Venmo™
Boleto
Mercado Pago
Pix Automático
UPI AutoPay
Gateway configuration and features
Payment gateway & merchant account overview
Gateways & payment methods configuration
Multiple gateway configuration
Gateways and token support
Custom gateway routing (merchant-initiated)
Gateway failover
NACHA verification
Currency support
Fraud management
Chargeback management for cards
Payment descriptors
Gateway specific information for invoice numbers
Direct debit retries
How to test your gateway
Test gateway
CHURN MANAGEMENT
Overview: Churn management
Involuntary churn
Account updater
Static retries
Intelligent retries
Dunning campaigns
Expired card management
Backup payment method
Voluntary churn
Pause subscriptions
RECURRING BILLING
Overview: Recurring billing
Invoices
Invoice dashboard
Invoice management
Edit invoice
Credit invoices
Invoice configuration
Automated invoicing
Automatic invoicing terms
Manual invoicing
Invoice template customization
Charges and credits adjustments
Chargebacks and late failures for direct debit
Billing preferences
Subscription billing terms
Calendar billing
Shipping fees
Verify billing info
Taxes
Sales taxes
Tax inclusive pricing
Tax location validation
VAT & GST support
European Union VAT
VAT number/Tax ID number validation
Recurly Recover
Overview: Recurly Recover
RECURLY COMPASS
Overview: Recurly Compass
Compass Assistant
APP MANAGEMENT
Overview: App Management
App Management
App Management setup
API support and webhooks
Using App Management
Integration best practices
Sell and manage Apple subscriptions through Recurly
SITE MANAGEMENT
Business entity
Multiple business entities
Site settings
User roles and permissions
Two-factor authentication (2FA)
Single sign-on
Profile
Custom fields
Custom fields - API
Account activities export
Site activities export
Users export
Recurly account
Data retention
INTEGRATION METHODS
Implementing Recurly
REST API keys
Recurly.js
Stripe Payment Elements
Adyen Web Components
Webhooks (JSON & XML)
Native Mobile SDKs
REPORTING & ANALYTICS
Analytics overview
Analytics settings
Built-in benchmarks
Dashboard
Explore overview
Explore - Invoices and workbook agent
Explore - Transactions and workbook agent
Business entities overview
Subscriber management analytics
Subscriber benchmarks
Subscribers
Subscribers (Legacy)
Hourly activation & churn
Signup declines
Signup declines trendalyzer
Trial performance
Subscriber retention
Accounts analysis
Recurring billing analytics
Monthly recurring revenue
Billings
Plans, pricing and promotions analytics
Plan KPI
Plans (legacy)
Subscription by plan
Churn trends by plan
Retention by plan
Movement by plan
Trials by plan
MRR by plan
LTV by plan
Churn management analytics
Subscriber churn benchmarks
Subscriber churn analysis
Renewal benchmarks
Renewal invoices
Renewal invoices trendalyzer
Recovered revenue
Renewal declines
Renewal declines trendalyzer
Dunning campaigns overview
Dunning campaigns dashboards
Dunning benchmarks
Dunning summary
Invoices details
Revenue details
Subscription details
Compare dunning
Compare versions
Compare campaigns
Payments Hub
Overview dashboard
Payment processing
Account updater
Payment retry recovery
Fraud prevention
Data imports and exports
Customer data imports
Data exports
Automated exports
Custom exports
Account activities - export
Account notes - export
Accounts - export
Adjustments - export
Adjustments — coupons - export
Adjustments — taxes - export
Billing info - export
Coupons - export
Coupons redemption - export
Coupons — bulk unique codes - export
Credit payments - export
Gift cards - export
Invoices — accounts receivable - export
Invoices — external - export
Invoices — summary - export
Invoices — unused numbers - export
Items — associated plans - export
Items — associated subscriptions - export
Product Catalog - export
Site activities - export
Subscriptions - export
Subscription add-ons - export
Subscription add-ons — history - export
Subscriptions — churned - export
Subscriptions — external - export
Subscriptions — history - export
Subscriptions — pending changes - export
Subscriptions — ramp pricing - export
Subscriptions — usage records - export
Transactions - export
Users - export
PARTNER INTEGRATIONS
Integration partners
Justt.AI
Accounting, fraud and taxes
Avalara AvaTax integration
Avalara for Communications (AFC) integration
Vertex tax integration
Xero integration
QuickBooks Online integration
Kount (fraud) integration
Oracle NetSuite integration
Sales, marketing and services
Braze integration
MailChimp integration
SendGrid
Zendesk integration
Salesforce integration
Recurly Engage integration
Data and analytics
Snowflake integration
Merchant of record
Reach integration
Workflow automation
Zapier integration
Tray.io integration
SECURITY & COMPLIANCE
Security
Data hosting
PGP encryption
IP allowlist
Compliance
PCI-DSS compliance
PSD2 compliance
Strong customer authentication
3D secure
Dunning setup for 3D Secure 2 declines
Card on file
HIPAA Guidelines
CCPA
General Data Protection Regulation (GDPR)
RBI regulations
API GUIDES
Integration guides
Quick-start guide
Upgrade to API V3
Multi-item upload guide
Pagination guide
Payments Use Case Guides
Purchases guide
3D secure 2.0 integration guide
3D secure 2.0 with stored Billing Information
Send CVV for Return Customers
Using Gateway Tokens and External NTIDs with Recurly APIs
Dynamic Transaction Statement Descriptor guide
Level 2 and Level 3 / CEDP
Kount 360 review webhook
Free Trial Gateway Routing Continuity
Third-party checkout guide: Stripe Elements
Third-party checkout guide: Adyen Web Components
MOTO (Mail Order / Telephone Order) guide
Co-badged cards guide
LATAM Payment Methods
Pix Automático integration guide
Mercado Pago integration guide
APAC Payment Methods
E-mandates with Cards in India
UPI AutoPay integration guide
Webhooks Use Case guides
Synchronous payments webhook guide
Aynchronous payments webhook guide
Pricing and billing guides
Coupons and discounts guide
Quantity-based pricing guide
Usage-based pricing guide
Subscription management guides
Subscription management guide
Subscription add-ons guide
Troubleshooting
API transaction errors
WEBHOOKS
Overview: Webhooks
Notifications
Account notifications
Subscription notifications
Prerenewal notifications
Usage notifications
Gift card notifications
Charge invoice notifications
Credit invoice notifications
Invoice notifications
Payment notifications
Credit payment notifications
Dunning events notifications
Item notifications
External subscription notifications
RECURLY.JS
Overview
Getting started
Customizing Elements
Getting a token
Using a token
Events
Elements
Apple Pay
Google Pay
Bank accounts: US, IBAN, BACS, BECS
Boleto, iDEAL, Sofort, and CashApp
PayPal
Venmo
Amazon Pay
Pricing
3D Secure
Fraud
Recurly Engage
Validation
Errors
Examples
React & TypeScript
Upgrading
Support
ABOUT
Open source attribution
RECURLY NAVIGATE
Recurly Navigate Home Page
Recurly Navigate: Launch
Welcome to Navigate
Welcome: The Subscription Flywheel
Welcome: Exploring Navigate home
Welcome: The full program
Resource Library
Navigate monthly calendar
Launchpad phase one: Optimize
Launchpad phase one: Final production testing
Launchpad phase one: Dunning
Launchpad phase one: Account Updater
Launchpad phase one: Branding emails & invoices
Launchpad phase one: Gateway Failover
Launchpad phase one: Review & resources
Launchpad phase two: Mastering metrics
Launchpad phase two: Benchmarks & reporting
Launchpad phase two: Acquisition & decline
Launchpad phase two: Churn metrics
Launchpad phase two: Revenue recovery
Launchpad phase two: Review & resources
Recurly Navigate: Acquire
Plan price increase
Plan price increase: Use cases
Plan price increase: What to consider
Plan price increase: Communicating the change
Plan price increase: Tracking your impact
Plan price increase: Review & resources
Pricing & plans 101: The basics
Pricing & plans 101: Plans
Pricing & plans 101: Add-ons
Pricing & plans 101: Currency
Pricing & plans 101: Pricing models
Pricing & plans 101: Trials
Pricing & Plans 101: Tracking success
Pricing & Plans 101: Review & resources
Pricing & plans 201: Advanced
Pricing & plans 201: Price segmentation
Pricing & plans 201: Account hierarchy
Pricing & plans 201: Usage billing
Pricing & plans 201: Advanced pricing models
Pricing & plans 201: Advanced currency
Pricing & plans 201: Advanced analytics
Pricing & plans 201: Review & resources
Recurly Navigate: Retain
Account Updater
Account Updater: Why use it?
Account Updater: Things to consider
Account Updater: How to enable it
Account Updater: Tracking impact
Account Updater: Pitch to leadership
Pause subscriptions
Pause subscriptions: Why Pause reduces churn
Pause subscriptions: Things to consider
Pause subscriptions: How to enable Pause
Pause subscriptions: Tracking your Pause impact
Pause subscriptions: Review & resources
Dunning 101: The Basics
Dunning 101: Understanding Dunning windows
Dunning 101: Dunning window configuration
Dunning 101: Email branding
Dunning 101: Email configuration
Dunning 101: Email messaging strategy
Dunning 101: Multiple campaigns
Dunning 101: Campaign configuration
Dunning 101: Measuring your performance
Dunning 101: Review & resources
Payment banners
Payment banners: Why it matters & when to use it
Payment banners: Choosing your implementation path
Payment banners: Strategy & best practices
Payment banners: Tracking your impact
Payment banners: Review & resources
Recurly Navigate: Scale
Payments Hub: Getting started
Payments Hub: Overview dashboard
Payments Hub: Payment processing dashboard
Payments Hub: Account Updater
Payments Hub: Payment retry recovery dashboard
Payments Hub: Fraud prevention
Payments Hub: Review & resources
Benchmarks 101
Benchmarks 101: Reading benchmarks
Benchmarks 101: Subscriber benchmarks
Benchmarks 101: Churn benchmarks
Benchmarks 101: Renewal & Dunning benchmarks
Benchmarks 101: Review & resources
Recurly Navigate: Customer Success Office Hours
Recurly Navigate Events
Recurly for Shopify
Copy Page
