Superwall

Superwall RevenueCat V1 (compatible) API

RevenueCat v1 API-compatible, read-only subscriber view backed by the subscription source of truth: the subscriber object with its entitlements, subscriptions, non-subscriptions, and attributes.

GitHub OpenAPI

Operations 1

GET /revenuecat/v1/projects/{project_id}/subscribers/{app_user_id} Get Subscriber #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/superwall/openapi/superwall-revenuecat-v1-compatible-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/superwall/json-schema/superwall-audit-log-entry-with-actor-schema.json
📊
JSONSchema
https://artifacts.apis.io/superwall/json-schema/superwall-custom-store-event-schema.json
📊
JSONSchema
https://artifacts.apis.io/superwall/json-schema/superwall-rule-conditions-schema.json
📊
JSONSchema
https://artifacts.apis.io/superwall/json-schema/superwall-rule-conditions-1-schema.json
📊
JSONSchema
https://artifacts.apis.io/superwall/json-schema/superwall-doctor-report-schema.json
📊
JSONSchema
https://artifacts.apis.io/superwall/json-schema/superwall-audit-log-list-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/superwall:superwall-revenuecat-v1-compatible-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

superwall-revenuecat-v1-compatible-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Superwall API V2 RevenueCat V1 (compatible) API
  version: 2.0.0
  description: Superwall V2 API - Scope-based authentication with organization API keys
servers:
- url: https://api.superwall.com
  description: Production
- url: https://api.superwall.dev
  description: Staging
- url: /
  description: Local
security: []
tags:
- name: RevenueCat V1 (compatible)
  description: 'RevenueCat v1 API-compatible, read-only subscriber view backed by the subscription source of truth: the subscriber object with its entitlements, subscriptions, non-subscriptions, and attributes.'
paths:
  /revenuecat/v1/projects/{project_id}/subscribers/{app_user_id}:
    get:
      tags:
      - RevenueCat V1 (compatible)
      operationId: revenuecatv1.getSubscriber
      parameters:
      - name: project_id
        in: path
        schema:
          type: string
        required: true
      - name: app_user_id
        in: path
        schema:
          type: string
          description: App user ID (the RevenueCat subscriber id)
        required: true
      security:
      - bearer: []
      - cookie: []
      - oauth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_date:
                    type: string
                  request_date_ms:
                    type: number
                  subscriber:
                    type: object
                    properties:
                      original_app_user_id:
                        type: string
                      original_application_version:
                        type: 'null'
                      original_purchase_date:
                        anyOf:
                        - type: string
                        - type: 'null'
                      management_url:
                        anyOf:
                        - type: string
                        - type: 'null'
                      first_seen:
                        type: string
                      last_seen:
                        type: string
                      entitlements:
                        type: object
                        additionalProperties:
                          type: object
                          properties:
                            expires_date:
                              anyOf:
                              - type: string
                              - type: 'null'
                            grace_period_expires_date:
                              anyOf:
                              - type: string
                              - type: 'null'
                            product_identifier:
                              type: string
                            product_plan_identifier:
                              anyOf:
                              - type: string
                              - type: 'null'
                            purchase_date:
                              anyOf:
                              - type: string
                              - type: 'null'
                          required:
                          - expires_date
                          - grace_period_expires_date
                          - product_identifier
                          - product_plan_identifier
                          - purchase_date
                          additionalProperties: false
                      subscriptions:
                        type: object
                        additionalProperties:
                          type: object
                          properties:
                            auto_resume_date:
                              anyOf:
                              - type: string
                              - type: 'null'
                            billing_issues_detected_at:
                              anyOf:
                              - type: string
                              - type: 'null'
                            expires_date:
                              anyOf:
                              - type: string
                              - type: 'null'
                            grace_period_expires_date:
                              anyOf:
                              - type: string
                              - type: 'null'
                            is_sandbox:
                              type: boolean
                            original_purchase_date:
                              anyOf:
                              - type: string
                              - type: 'null'
                            ownership_type:
                              type: string
                              enum:
                              - PURCHASED
                              - FAMILY_SHARED
                            period_type:
                              type: string
                              enum:
                              - normal
                              - trial
                              - intro
                            product_plan_identifier:
                              anyOf:
                              - type: string
                              - type: 'null'
                            purchase_date:
                              anyOf:
                              - type: string
                              - type: 'null'
                            refunded_at:
                              anyOf:
                              - type: string
                              - type: 'null'
                            store:
                              type: string
                            store_transaction_id:
                              type: string
                            unsubscribe_detected_at:
                              anyOf:
                              - type: string
                              - type: 'null'
                          required:
                          - auto_resume_date
                          - billing_issues_detected_at
                          - expires_date
                          - grace_period_expires_date
                          - is_sandbox
                          - original_purchase_date
                          - ownership_type
                          - period_type
                          - product_plan_identifier
                          - purchase_date
                          - refunded_at
                          - store
                          - store_transaction_id
                          - unsubscribe_detected_at
                          additionalProperties: false
                      non_subscriptions:
                        type: object
                        additionalProperties:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              is_sandbox:
                                type: boolean
                              original_purchase_date:
                                anyOf:
                                - type: string
                                - type: 'null'
                              purchase_date:
                                anyOf:
                                - type: string
                                - type: 'null'
                              store:
                                type: string
                              store_transaction_id:
                                type: string
                            required:
                            - id
                            - is_sandbox
                            - original_purchase_date
                            - purchase_date
                            - store
                            - store_transaction_id
                            additionalProperties: false
                      other_purchases:
                        type: object
                      subscriber_attributes:
                        type: object
                        additionalProperties:
                          type: object
                          properties:
                            value:
                              type: string
                            updated_at_ms:
                              type: number
                          required:
                          - value
                          - updated_at_ms
                          additionalProperties: false
                    required:
                    - original_app_user_id
                    - original_application_version
                    - original_purchase_date
                    - management_url
                    - first_seen
                    - last_seen
                    - entitlements
                    - subscriptions
                    - non_subscriptions
                    - other_purchases
                    - subscriber_attributes
                    additionalProperties: false
                required:
                - request_date
                - request_date_ms
                - subscriber
                additionalProperties: false
        '400':
          description: The request did not match the expected schema | The request was invalid or malformed
          content:
            application/json:
              schema:
                anyOf:
                - type: object
                  properties:
                    _tag:
                      type: string
                      enum:
                      - HttpApiDecodeError
                    issues:
                      type: array
                      items:
                        type: object
                        properties:
                          _tag:
                            type: string
                            enum:
                            - Type
                            - Missing
                            - Unexpected
                            - Forbidden
                            - Pointer
                            - Refinement
                            - Transformation
                            - Composite
                          path:
                            type: array
                            items:
                              anyOf:
                              - type: string
                              - type: number
                              - type: object
                                properties:
                                  _tag:
                                    type: string
                                    enum:
                                    - symbol
                                  key:
                                    type: string
                                required:
                                - _tag
                                - key
                                additionalProperties: false
                          message:
                            type: string
                        required:
                        - _tag
                        - path
                        - message
                        additionalProperties: false
                    message:
                      type: string
                  required:
                  - _tag
                  - issues
                  - message
                  additionalProperties: false
                - type: object
                  properties:
                    _tag:
                      type: string
                      enum:
                      - '@superwall/api-schema/v2/errors/BadRequest'
                    type:
                      anyOf:
                      - type: string
                        enum:
                        - api_error
                        - authentication_error
                        - invalid_request_error
                        - rate_limit_error
                        - permission_error
                    code:
                      type: string
                      enum:
                      - resource_missing
                      - resource_already_exists
                      - resource_archived
                      - parameter_invalid
                      - parameter_missing
                      - parameter_unknown
                      - invalid_reference
                      - unsupported_operation
                      - idempotency_key_in_use
                      - rate_limit_exceeded
                      - invalid_api_key
                      - invalid_api_key_format
                      - missing_api_key
                      - authentication_failed
                      - invalid_session
                      - organization_required
                      - insufficient_permissions
                      - internal_error
                      - upstream_service_error
                      - side_effect_failed
                    message:
                      type: string
                    param:
                      anyOf:
                      - type: string
                    doc_url:
                      anyOf:
                      - type: string
                  required:
                  - _tag
                  - code
                  - message
                  additionalProperties: false
        '401':
          description: No API key was provided in the request | The API key does not have a valid format | The API key is invalid or has been revoked | An error occurred while validating the API key | The session cookie is invalid or expired
          content:
            application/json:
              schema:
                anyOf:
                - type: object
                  properties:
                    _tag:
                      type: string
                      enum:
                      - '@superwall/api-schema/v2/errors/MissingApiKey'
                    type:
                      anyOf:
                      - type: string
                        enum:
                        - api_error
                        - authentication_error
                        - invalid_request_error
                        - rate_limit_error
                        - permission_error
                    code:
                      anyOf:
                      - type: string
                        enum:
                        - resource_missing
                        - resource_already_exists
                        - resource_archived
                        - parameter_invalid
                        - parameter_missing
                        - parameter_unknown
                        - invalid_reference
                        - unsupported_operation
                        - idempotency_key_in_use
                        - rate_limit_exceeded
                        - invalid_api_key
                        - invalid_api_key_format
                        - missing_api_key
                        - authentication_failed
                        - invalid_session
                        - organization_required
                        - insufficient_permissions
                        - internal_error
                        - upstream_service_error
                        - side_effect_failed
                    message:
                      anyOf:
                      - type: string
                    doc_url:
                      anyOf:
                      - type: string
                  required:
                  - _tag
                  additionalProperties: false
                - type: object
                  properties:
                    _tag:
                      type: string
                      enum:
                      - '@superwall/api-schema/v2/errors/InvalidApiKeyFormat'
                    type:
                      anyOf:
                      - type: string
                        enum:
                        - api_error
                        - authentication_error
                        - invalid_request_error
                        - rate_limit_error
                        - permission_error
                    code:
                      anyOf:
                      - type: string
                        enum:
                        - resource_missing
                        - resource_already_exists
                        - resource_archived
                        - parameter_invalid
                        - parameter_missing
                        - parameter_unknown
                        - invalid_reference
                        - unsupported_operation
                        - idempotency_key_in_use
                        - rate_limit_exceeded
                        - invalid_api_key
                        - invalid_api_key_format
                        - missing_api_key
                        - authentication_failed
                        - invalid_session
                        - organization_required
                        - insufficient_permissions
                        - internal_error
                        - upstream_service_error
                        - side_effect_failed
                    message:
                      anyOf:
                      - type: string
                    doc_url:
                      anyOf:
                      - type: string
                  required:
                  - _tag
                  additionalProperties: false
                - type: object
                  properties:
                    _tag:
                      type: string
                      enum:
                      - '@superwall/api-schema/v2/errors/InvalidApiKey'
                    type:
                      anyOf:
                      - type: string
                        enum:
                        - api_error
                        - authentication_error
                        - invalid_request_error
                        - rate_limit_error
                        - permission_error
                    code:
                      anyOf:
                      - type: string
                        enum:
                        - resource_missing
                        - resource_already_exists
                        - resource_archived
                        - parameter_invalid
                        - parameter_missing
                        - parameter_unknown
                        - invalid_reference
                        - unsupported_operation
                        - idempotency_key_in_use
                        - rate_limit_exceeded
                        - invalid_api_key
                        - invalid_api_key_format
                        - missing_api_key
                        - authentication_failed
                        - invalid_session
                        - organization_required
                        - insufficient_permissions
                        - internal_error
                        - upstream_service_error
                        - side_effect_failed
                    message:
                      anyOf:
                      - type: string
                    doc_url:
                      anyOf:
                      - type: string
                  required:
                  - _tag
                  additionalProperties: false
                - type: object
                  properties:
                    _tag:
                      type: string
                      enum:
                      - '@superwall/api-schema/v2/errors/AuthenticationFailed'
                    type:
                      anyOf:
                      - type: string
                        enum:
                        - api_error
                        - authentication_error
                        - invalid_request_error
                        - rate_limit_error
                        - permission_error
                    code:
                      anyOf:
                      - type: string
                        enum:
                        - resource_missing
                        - resource_already_exists
                        - resource_archived
                        - parameter_invalid
                        - parameter_missing
                        - parameter_unknown
                        - invalid_reference
                        - unsupported_operation
                        - idempotency_key_in_use
                        - rate_limit_exceeded
                        - invalid_api_key
                        - invalid_api_key_format
                        - missing_api_key
                        - authentication_failed
                        - invalid_session
                        - organization_required
                        - insufficient_permissions
                        - internal_error
                        - upstream_service_error
                        - side_effect_failed
                    message:
                      anyOf:
                      - type: string
                    doc_url:
                      anyOf:
                      - type: string
                  required:
                  - _tag
                  additionalProperties: false
                - type: object
                  properties:
                    _tag:
                      type: string
                      enum:
                      - '@superwall/api-schema/v2/errors/InvalidSession'
                    type:
                      anyOf:
                      - type: string
                        enum:
                        - api_error
                        - authentication_error
                        - invalid_request_error
                        - rate_limit_error
                        - permission_error
                    code:
                      anyOf:
                      - type: string
                        enum:
                        - resource_missing
                        - resource_already_exists
                        - resource_archived
                        - parameter_invalid
                        - parameter_missing
                        - parameter_unknown
                        - invalid_reference
                        - unsupported_operation
                        - idempotency_key_in_use
                        - rate_limit_exceeded
                        - invalid_api_key
                        - invalid_api_key_format
                        - missing_api_key
                        - authentication_failed
                        - invalid_session
                        - organization_required
                        - insufficient_permissions
                        - internal_error
                        - upstream_service_error
                        - side_effect_failed
                    message:
                      anyOf:
                      - type: string
                  required:
                  - _tag
                  additionalProperties: false
        '403':
          description: The API key does not have permission for this action (RevenueCat-compatible) | The API key does not have permission to perform this action
          content:
            application/json:
              schema:
                anyOf:
                - type: object
                  properties:
                    _tag:
                      type: string
                      enum:
                      - '@superwall/api-schema/v2/errors/RcAuthorization'
                    object:
                      anyOf:
                      - type: string
                        enum:
                        - error
                    type:
                      anyOf:
                      - type: string
                        enum:
                        - authorization_error
                    message:
                      type: string
                    retryable:
                      anyOf:
                      - type: boolean
                    doc_url:
                      anyOf:
                      - type: string
                  required:
                  - _tag
                  - message
                  additionalProperties: false
                - type: object
                  properties:
                    _tag:
                      type: string
                      enum:
                      - '@superwall/api-schema/v2/errors/PermissionError'
                    type:
                      anyOf:
                      - type: string
                        enum:
                        - api_error
                        - authentication_error
                        - invalid_request_error
                        - rate_limit_error
                        - permission_error
                    code:
                      anyOf:
                      - type: string
                        enum:
                        - resource_missing
                        - resource_already_exists
                        - resource_archived
                        - parameter_invalid
                        - parameter_missing
                        - parameter_unknown
                        - invalid_reference
                        - unsupported_operation
                        - idempotency_key_in_use
                        - rate_limit_exceeded
                        - invalid_api_key
                        - invalid_api_key_format
                        - missing_api_key
                        - authentication_failed
                        - invalid_session
                        - organization_required
                        - insufficient_permissions
                        - internal_error
                        - upstream_service_error
                        - side_effect_failed
                    message:
                      type: string
                    required_scope:
                      anyOf:
                      - type: string
                    doc_url:
                      anyOf:
                      - type: string
                  required:
                  - _tag
                  - message
                  additionalProperties: false
        '404':
          description: The requested resource was not found (RevenueCat-compatible error shape)
          content:
            application/json:
              schema:
                type: object
                properties:
                  _tag:
                    type: string
                    enum:
                    - '@superwall/api-schema/v2/errors/RcResourceMissing'
                  object:
                    anyOf:
                    - type: string
                      enum:
                      - error
                  type:
                    anyOf:
                    - type: string
                      enum:
                      - resource_missing
                  message:
                    type: string
                  retryable:
                    anyOf:
                    - type: boolean
                  doc_url:
                    anyOf:
                    - type: string
                required:
                - _tag
                - message
                additionalProperties: false
        '429':
          description: Too many requests have been made in a short period
          content:
            application/json:
              schema:
                type: object
                properties:
                  _tag:
                    type: string
                    enum:
                    - '@superwall/api-schema/v2/errors/RateLimit'
                  type:
                    anyOf:
                    - type: string
                      enum:
                      - api_error
                      - authentication_error
                      - invalid_request_error
                      - rate_limit_error
                      - permission_error
                  code:
                    anyOf:
                    - type: string
                      enum:
                      - resource_missing
                      - resource_already_exists
                      - resource_archived
                      - parameter_invalid
                      - parameter_missing
                      - parameter_unknown
                      - invalid_reference
                      - unsupported_operation
                      - idempotency_key_in_use
                      - rate_limit_exceeded
                      - invalid_api_key
                      - invalid_api_key_format
                      - missing_api_key
                      - authentication_failed
                      - invalid_session
                      - organization_required
                      - insufficient_permissions
                      - internal_error
                      - upstream_service_error
                      - side_effect_failed
                  message:
                    anyOf:
                    - type: string
                  retry_after:
                    anyOf:
                    - type: number
                required:
                - _tag
                additionalProperties: false
        '500':
          description: An unexpected server error occurred (RevenueCat-compatible error shape)
          content:
            application/json:
              schema:
                type: object
                properties:
                  _tag:
                    type: string
                    enum:
                    - '@superwall/api-schema/v2/errors/RcServer'
                  object:
                    anyOf:
                    - type: string
                      enum:
                      - error
                  type:
                    anyOf:
                    - type: string
                      enum:
                      - server_error
                  message:
                    anyOf:
                    - type: string
                  retryable:
                    anyOf:
                    - type: boolean
                  doc_url:
                    anyOf:
                    - type: string
                required:
                - _tag
                additionalProperties: false
        '502':
          description: The upstream subscriptions service failed (RevenueCat-compatible error shape)
          content:
            application/json:
              schema:
                type: object
                properties:
                  _tag:
                    type: string
                    enum:
                    - '@superwall/api-schema/v2/errors/RcUpstream'
                  object:
                    anyOf:
                    - type: string
                      enum:
                      - error
                  type:
                    anyOf:
                    - type: string
                      enum:
                      - server_error
                  message:
                    anyOf:
                    - type: string
                  retryable:
                    anyOf:
                    - type: boolean
                  doc_url:
                    anyOf:
                    - type: string
                required:
                - _tag
                additionalProperties: false
      description: Returns the subscriber (RevenueCat v1 subscriber object) with current, clock-correct entitlements and subscriptions, alias-aware across the customer's identity group. An unknown app user id returns a 200 with an empty subscriber. Requires customers:read scope.
      summary: Get Subscriber
components:
  securitySchemes:
    bearer:
      type: http
      scheme: Bearer
    cookie:
      type: apiKey
      name: accounts_superwall_token
      in: cookie
    oauth:
      type: http
      scheme: Bearer