APIActive

Superwall API V2

Superwall API V2: Changelog Search ⌘ K Superwall Documentation Everything you need to integrate paywalls, manage subscriptions, and grow your revenue.

Open source page

Field note

What it does

Integrations Use webhooks to get real-time notifications about your app's subscription and payment events. Integrate Superwall with other services. Copy Markdown Open The integrations page is where you can manage your webhooks and other integrations with Superwall: Webhooks Superwall sends webhooks to notify your application about important subscription and payment events in real-time. These webhooks are designed to closely match App Store and other revenue provider events, minimizing migration difficulty. Important Design Principle : Webhook events are structured so that summing proceeds or price across all events (without filtering) accurately represents total revenue net of refunds. To calculate gross revenue, filter out events with negative proceeds. Webhook Payload Structure Every webhook sent by Superwall contains the following structure: { "object" : "event" , "type" : "renewal" , "projectId" : 3827 , "applicationId" : 1 , "timestamp" : 1754067715103 , "data" : { "id" : "42fc6339-dc28-470b-a0fa-0d13c92d8b61:renewal" , "name" : "renewal" , "cancelReason" : null , "exchangeRate" : 1.0 , "isSmallBusiness" : false , "periodType" : "NORMAL" , "countryCode" : "US" , "price" : 9.99 , "proceeds" : 6.99 , "priceInPurchasedCurrency" : 9.99 , "taxPercentage" : 0 , "commissionPercentage" : 0.3 , "takehomePercentage" : 0.7 , "offerCode" : null , "isFamilyShare" : false , "expirationAt" : 1756659704000 , "transactionId" : "700002054157982" , "originalTransactionId" : "700002050981465" , "originalAppUserId" : "$SuperwallAlias:7152E89E-60A6-4B2E-9C67-D7ED8F5BE372" , "store" : "APP_STORE" , "purchasedAt" : 1754067704000 , "currencyCode" : "USD" , "productId" : "com.example.premium.monthly" , "environment" : "PRODUCTION" , "isTrialConversion" : false , "newProductId" : null , "bundleId" : "com.example.app" , "ts" : 1754067710106 } } Webhook Payload Fields Field Type Description object string Always "event" type string The event type (e.g., "initial_purchase", "renewal", "cancellation") projectId number Your Superwall project ID applicationId number Your Superwall application ID timestamp number Event timestamp in milliseconds since epoch dat Overview Let customers purchase products online via Stripe, then link them to your iOS app with one seamless flow. No authentication required.

Capabilities

Available capabilities

Tags

Tags

No tags filed yet.

Ways to use it

Ways to use it

No integrations filed yet.

Product features

Product features

Cancel/Expiration Reasons

Common Use Cases

Environments

Event Data Fields

Event Data Object

Event Names

Integrations

Period Types

Stores

Webhook Payload Fields

Webhook Payload Structure

Webhooks