SplitWall API Reference
Complete API reference for SplitWall's REST API. Authentication, endpoints, webhooks, and integration examples to help you build powerful subscription experiences.
Authentication
Secure your API calls with our flexible authentication methods.
API Key
High SecuritySimple authentication using your API key
Authorization: Bearer sk_live_1234567890abcdefJWT Token
Very High SecurityJSON Web Token for secure authentication
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...OAuth 2.0
Very High SecurityIndustry-standard OAuth 2.0 authentication
Authorization: Bearer oauth_token_hereAPI Endpoints
Explore our comprehensive API endpoints for paywall management, analytics, and experiments.
/api/v1/paywallsRetrieve all paywalls for your app
Parameters:
Your app identifier
Number of results to return (max 100)
Number of results to skip
Response:
{
"paywalls": [
{
"id": "paywall_123",
"name": "Premium Features",
"status": "active",
"created_at": "2024-01-15T10:30:00Z"
}
],
"total": 1,
"limit": 50,
"offset": 0
}/api/v1/paywallsCreate a new paywall
Parameters:
Paywall name
Paywall description
List of features to unlock
Response:
{
"id": "paywall_456",
"name": "Premium Features",
"status": "draft",
"created_at": "2024-01-15T10:30:00Z"
}/api/v1/analytics/revenueGet revenue analytics for your app
Parameters:
Your app identifier
Start date (YYYY-MM-DD)
End date (YYYY-MM-DD)
Data granularity: day, week, month
Response:
{
"revenue": [
{
"date": "2024-01-15",
"revenue": 1250.5,
"conversions": 15,
"conversion_rate": 0.12
}
],
"total_revenue": 1250.5,
"total_conversions": 15
}/api/v1/experimentsCreate a new A/B test experiment
Parameters:
Experiment name
Paywall to test
Test variants configuration
Response:
{
"id": "exp_789",
"name": "Button Color Test",
"status": "running",
"created_at": "2024-01-15T10:30:00Z"
}Webhooks
Stay informed about important events with our webhook system.
subscription.created
WebhookTriggered when a new subscription is created
Payload:
{
"id": "sub_123",
"user_id": "user_456",
"plan_id": "plan_789",
"status": "active",
"created_at": "2024-01-15T10:30:00Z"
}subscription.cancelled
WebhookTriggered when a subscription is cancelled
Payload:
{
"id": "sub_123",
"user_id": "user_456",
"plan_id": "plan_789",
"status": "cancelled",
"cancelled_at": "2024-01-15T10:30:00Z"
}experiment.completed
WebhookTriggered when an A/B test experiment is completed
Payload:
{
"id": "exp_789",
"name": "Button Color Test",
"winner": "variant_b",
"confidence": 0.95,
"completed_at": "2024-01-15T10:30:00Z"
}Rate Limits
Status Codes
SDKs & Examples
Get started quickly with our SDKs and code examples.
iOS SDK
Native iOS integration
Android SDK
Native Android integration
React Native
Cross-platform integration
Flutter
Flutter integration
Ready to integrate?
Get your API key and start building powerful subscription experiences.