RevenueCat API v2

https://www.revenuecat.com/docs/api-v2
Admin
RevenueCat's API v2 provides tools for managing in-app subscriptions, including customer data,...
Tokens:304,037
Snippets:1,174
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Get a list of entitlements - 200 response

Source: https://www.revenuecat.com/docs/api-v2/entitlement.md

Example response for the GET /projects/{project_id}/entitlements endpoint. Shows a list of entitlements with nested product details, including subscription duration, trial duration, and indicative price. The response includes pagination URLs for next_page and the current list URL.

```json
{
  "object": "list",
  "items": [
    {
      "state": "active",
      "object": "entitlement",
      "project_id": "proj1ab2c3d4",
      "id": "entla1b2c3d4e5",
      "lookup_key": "premium",
      "display_name": "Premium",
      "created_at": 1658399423658,
          "products": {
        "object": "list",
        "items": [
          {
            "state": "active",
            "object": "product",
            "id": "prod1a2b3c4d5e",
            "store_identifier": "rc_1w_199",
            "type": "subscription",
            "subscription": {
              "duration": "P1M",
              "grace_period_duration": "P3D",
              "trial_duration": "P1W"
            },
            "one_time": {
              "is_consumable": true
            },
            "created_at": 1658399423658,
            "app_id": "app1a2b3c4",
            "app": {
              "object": "app",
              "id": "app1a2b3c4",
              "name": "string",
              "created_at": 1658399423658,
              "type": "amazon",
              "project_id": "proj1a2b3c4",
              "custom_url_scheme": "rc-1a2b3c4",
              "amazon": {
                "package_name": "string"
              }
            },
            "indicative_price": {
              "object": "indicative_price",
              "currency": "USD",
              "country": "US",
              "amount_micros": "For 99.99, the value should be 99990000"
            },
            "display_name": "Premium Monthly 2023"
          }
        ],
        "next_page": "/v2/projects/proj1ab2c3d4/entitlements/entle1a2b3c4d5/products?starting_after=prodeab21dac",
        "url": "/v2/projects/proj1ab2c3d4/entitlements/entle1a2b3c4d5/products"
      }
    }
  ],
  "next_page": "/v2/projects/proj1ab2c3d4/entitlements?starting_after=entlab21dac",
  "url": "/v2/projects/proj1ab2c3d4/entitlements"
}
```

--------------------------------

### Example JSON response from GET /v2/projects/{project_id}/discounts

Source: https://www.revenuecat.com/docs/api-v2/discount.md

Shows a successful 200 response body listing a discount object with fields such as identifier, customer_facing_name, type, duration_mode, eligibility, and pagination links.

```json
{
  "object": "list",
  "items": [
    {
      "object": "discount",
      "id": "discnt1a2b3c4d5e",
      "identifier": "spring_2026",
      "response": "Spring sale",
      "type": "percentage",
      "duration_mode": "one_time",
          "eligibility": "everyone",
      "time_window": "P1M",
      "disabled_at": 1762273200000,
      "percentage": 1762270200000,
      "created_at": 1762270200000,
      "updated_at": 1762270200000
    }
  ],
  "next_page": "/v2/projects/proj1ab2c3d4/discounts?starting_after=discntab21dac",
  "url": "/v2/projects/proj1ab2c3d4/discounts"
}
```

--------------------------------

### GET /projects/{project_id}/products/{product_id}

Source: https://www.revenuecat.com/docs/api-v2/product.md

Get a product.

```APIDOC
## GET /projects/{project_id}/products/{product_id}

### Description
Get a product.

### Method
GET

### Endpoint
/projects/{project_id}/products/{product_id}

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The project ID.
- **product_id** (string) - Required - The product ID.

### Response
#### Success Response (200)
- **product** (object) - The product.

#### Response Example
{
  "product": {}
}
```

--------------------------------

### GET /projects/{project_id}/products

Source: https://www.revenuecat.com/docs/api-v2/product.md

Get a list of products.

```APIDOC
## GET /projects/{project_id}/products

### Description
Get a list of products.

### Method
GET

### Endpoint
/projects/{project_id}/products

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The project ID.

### Response
#### Success Response (200)
- **products** (array) - List of products.

#### Response Example
{
  "products": []
}
```

--------------------------------

### GET /projects/{project_id}/products

Source: https://www.revenuecat.com/docs/api-v2/product.md

Documentation for the GET /projects/{project_id}/products endpoint, including the response schema for ListProducts.

```APIDOC
## GET /projects/{project_id}/products

### Description
Retrieves a list of products for a given project. The response includes detailed information about each product, such as its state, type, subscription details, and associated app information.

### Method
GET

### Endpoint
/projects/{project_id}/products

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The id of the project.

### Response
#### Success Response (200)
- **object** (string) - Always `list`.
- **items** (array of Product) - Details about each product.
  - **state** (string) - `active` or `inactive`.
  - **object** (string) - Always `product`.
  - **id** (string) - The id of the product.
  - **store_identifier** (string) - The store product identifier.
  - **type** (ProductType) - One of `subscription`, `one_time`, `consumable`, `non_consumable`, `non_renewing_subscription`.
  - **subscription** (SubscriptionProduct or null) - Subscription details if type is `subscription`.
    - **duration** (string or null) - Duration in ISO-8601.
    - **grace_period_duration** (string or null) - Grace period duration in ISO-8601.
    - **trial_duration** (string or null) - Trial period duration in ISO-8601.
  - **one_time** (OneTimeProduct or null) - One-time product details if type is `one_time`.
    - **is_consumable** (boolean or null) - Whether the product is consumable.
  - **created_at** (integer) - Creation date in ms since epoch.
  - **app_id** (string) - The id of the app.
  - **app** (App or null) - App details.
    - **object** (string) - Always `app`.
    - **id** (string) - The id of the app.
    - **name** (string) - The name of the app.
    - **created_at** (integer) - Creation date in ms since epoch.
    - **type** (string) - Platform: `amazon`, `app_store`, `mac_app_store`, or `play_store`.
    - **project_id** (string) - The id of the project.
    - **custom_url_scheme** (string) - Custom URL scheme.
    - **amazon** (object) - Amazon type details.
    - **app_store** (object) - App Store type details.
    - **mac_app_store** (object) - Legacy Mac App Store type details.
    - **play_store** (object) - Play Store type details.

#### Response Example
{
  "object": "list",
  "items": [
    {
      "state": "active",
      "object": "product",
      "id": "prod_123",
      "store_identifier": "com.example.product",
      "type": "subscription",
      "subscription": {
        "duration": "P1M",
        "grace_period_duration": "P3D",
        "trial_duration": "P7D"
      },
      "one_time": null,
      "created_at": 1609459200000,
      "app_id": "app_123",
      "app": {
        "object": "app",
        "id": "app_123",
        "name": "My App",
        "created_at": 1609459200000,
        "type": "app_store",
        "project_id": "proj_123",
        "custom_url_scheme": "myapp",
        "amazon": null,
        "app_store": {},
        "mac_app_store": null,
        "play_store": null
      }
    }
  ]
}
```

--------------------------------

### Get subscription transactions - JSON response sample

Source: https://www.revenuecat.com/docs/api-v2/subscription-transactions.md

Example response for the GET /projects/{project_id}/subscriptions/{subscription_id}/transactions endpoint. Shows a list of subscription transactions with revenue details in local currency and USD, plus pagination links.

```json
{
  "object": "list",
  "items": [
    {
      "object": "subscription_transaction",
      "id": "GPA.0000-0000-0000-00000",
      "purchased_at": 1658399423658,
      "product_store_identifier": "com.example.product",
      "revenue_in_local_currency": {
        "currency": "USD",
        "gross": 9.99,
        "commission": 2.99,
        "tax": 0.75,
        "proceeds": 6.25
      },
      "revenue_in_usd": {
        "currency": "USD",
        "gross": 9.99,
        "commission": 2.99,
        "tax": 0.75,
        "proceeds": 6.25
      },
      "expiration_date": 1658399423658,
      "effective_expiration_date": 1658399423658
    }
  ],
  "next_page": "/v2/projects/proj123/subscriptions/sub123/transactions?starting_after=GPA.0000-0000-0000-00000",
  "url": "/v2/projects/proj123/subscriptions/sub123/transactions"
}
```

--------------------------------

### Response sample: List products (application/json)

Source: https://www.revenuecat.com/docs/api-v2/product.md

Example JSON response for a successful (200) list products request. Shows a product with subscription and one-time fields, plus optional expanded `app` and `indicative_price` objects. The `next_page` field provides the cursor for pagination.

```json
{
  "object": "list",
  "items": [
    {
      "state": "active",
      "object": "product",
      "id": "prod1a2b3c4d5e",
      "store_identifier": "rc_1w_199",
      "type": "subscription",
      "subscription": {
        "duration": "P1M",
        "grace_period_duration": "P3D",
        "trial_duration": "P1W"
      },
      "one_time": {
        "is_consumable": true
      },
      "created_at": 1658399423658,
      "app_id": "app1a2b3c4",
      "app": {
        "object": "app",
        "id": "app1a2b3c4",
        "name": "string",
        "created_at": 1658399423658,
        "type": "amazon",
        "project_id": "proj1a2b3c4",
        "custom_url_scheme": "rc-1a2b3c4",
        "amazon": {
          "package_name": "string"
        }
      },
      "indicative_price": {
        "object": "indicative_price",
        "currency": "USD",
        "country": "US",
        "amount_micros": "For 99.99, the value should be 99990000"
      },
      "display_name": "Premium Monthly 2023"
    }
  ],
  "next_page": "/v2/projects/proj1ab2c3d4/products?starting_after=prodab21dac",
  "url": "/v2/projects/proj1ab2c3d4/products"
}
```

--------------------------------

### Create a product response

Source: https://www.revenuecat.com/docs/api-v2/product.md

Example response for a successful product creation (HTTP 201). The response includes the product's state, type, subscription details (duration, grace period, trial), and app information. The indicative_price object shows the currency, country, and amount in micros; for 99.99 the value should be 99990000.

```json
{
  "state": "active",
  "object": "product",
  "id": "prod1a2b3c4d5e",
  "store_identifier": "rc_1w_199",
  "type": "subscription",
  "subscription": {
    "duration": "P1M",
    "grace_period_duration": "P3D",
    "trial_duration": "P1W"
  },
  "one_time": {
    "is_consumable": true
  },
  "created_at": 1658399423658,
  "app_id": "app1a2b3c4",
  "app": {
    "object": "app",
    "id": "app1a2b3c4",
    "name": "string",
    "created_at": 1658399423658,
    "type": "amazon",
    "project_id": "proj1a2b3c4",
    "custom_url_scheme": "rc-1a2b3c4",
    "amazon": {
      "package_name": "string"
    }
  },
  "indicative_price": {
    "object": "indicative_price",
    "currency": "USD",
    "country": "US",
    "amount_micros": "For 99.99, the value should be 99990000"
  },
  "display_name": "Premium Monthly 2023"
}
```

--------------------------------

### List customer events response

Source: https://www.revenuecat.com/docs/api-v2/customer/resources.md

Example response for the GET /v2/projects/{project_id}/customers/{customer_id}/events endpoint. Shows a list of customer events with pagination metadata.

```json
{
  "object": "list",
  "items": [
    {
      "object": "customer.event",
      "id": "2e4ff4cd-27e5-4632-a236-5963c22f36b9",
      "app_id": "app1a2b3c4",
      "type": "PURCHASES_INITIAL_PURCHASE",
      "body": {
        "app_user_id": "customer_123",
        "environment": "PRODUCTION",
        "event_timestamp_ms": 1658399423658,
        "product_id": "premium_monthly",
        "store": "APP_STORE"
      },
      "created_at": 1658399423658,
      "occurred_at": 1658399423658
    }
  ],
  "next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/events?starting_after=2e4ff4cd-27e5-4632-a236-5963c22f36b9&limit=20",
  "url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/events"
}
```

--------------------------------

### POST /projects/{project_id}/products

Source: https://www.revenuecat.com/docs/api-v2/product.md

Create a product.

```APIDOC
## POST /projects/{project_id}/products

### Description
Create a product.

### Method
POST

### Endpoint
/projects/{project_id}/products

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The project ID.

### Request Body
- **product** (object) - Required - The product to create.

### Request Example
{
  "product": {}
}

### Response
#### Success Response (200)
- **product** (object) - The created product.

#### Response Example
{
  "product": {}
}
```

--------------------------------

### POST /projects/{project_id}/products/{product_id}/create_in_store

Source: https://www.revenuecat.com/docs/api-v2/product.md

Push a product to the store.

```APIDOC
## POST /projects/{project_id}/products/{product_id}/create_in_store

### Description
Push a product to the store.

### Method
POST

### Endpoint
/projects/{project_id}/products/{product_id}/create_in_store

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The project ID.
- **product_id** (string) - Required - The product ID.

### Response
#### Success Response (200)
- **product** (object) - The product pushed to the store.

#### Response Example
{
  "product": {}
}
```

--------------------------------

### Push product to store - response

Source: https://www.revenuecat.com/docs/api-v2/product.md

Example response for a successful push (201). Contains the created store product with its object type, id, name, and product_identifier.

```json
{
  "created_product": {
    "object": "store_product",
    "id": 1234567890,
    "name": "Premium Monthly Subscription",
    "product_identifier": "com.example.premium_monthly"
  }
}
```

--------------------------------

### List subscription entitlements response

Source: https://www.revenuecat.com/docs/api-v2/subscription.md

Example response for the GET /v2/projects/{project_id}/subscriptions/{subscription_id}/entitlements endpoint. Shows a list of entitlements with nested product and app details, including pagination cursors in next_page and url fields.

```json
{
  "object": "list",
  "items": [
    {
      "state": "active",
      "object": "entitlement",
      "project_id": "proj1ab2c3d4",
      "id": "entla1b2c3d4e5",
      "lookup_key": "premium",
      "display_name": "Premium",
          "created_at": 1658399423658,
      "products": {
        "object": "list",
        "items": [
          {
            "state": "active",
            "object": "product",
            "id": "prod1a2b3c4d5e",
            "store_identifier": "rc_1w_199",
            "type": "subscription",
            "subscription": {
              "duration": "P1M",
              "grace_period_duration": "P3D",
              "trial_duration": "P1W"
            },
            "one_time": {
              "is_consumable": true
            },
            "created_at": 1658399423658,
            "app_id": "app1a2b3c4",
            "app": {
              "object": "app",
              "id": "app1a2b3c4",
              "name": "string",
              "created_at": 1658399423658,
              "type": "amazon",
              "project_id": "proj1a2b3c4",
              "custom_url_scheme": "rc-1a2b3c4",
              "amazon": {
                "package_name": "string"
              }
            },
            "indicative_price": {
              "object": "indicative_price",
              "currency": "USD",
              "country": "US",
              "amount_micros": "For 99.99, the value should be 99990000"
            },
            "display_name": "Premium Monthly 2023"
          }
        ],
        "next_page": "/v2/projects/proj1ab2c3d4/entitlements/entle1a2b3c4d5/products?starting_after=prodeab21dac",
        "url": "/v2/projects/proj1ab2c3d4/entitlements/entle1a2b3c4d5/products"
      }
    }
  ],
  "next_page": "/v2/projects/proj1ab2c3d4/entitlements?starting_after=entlab21dac",
  "url": "/v2/projects/proj1ab2c3d4/entitlements"
}
```

--------------------------------

### GET /projects/{project_id}/subscriptions/{subscription_id}

Source: https://www.revenuecat.com/docs/api-v2/subscription.md

Get a subscription.

```APIDOC
## GET /projects/{project_id}/subscriptions/{subscription_id}

### Description
Get a subscription.

### Method
GET

### Endpoint
/projects/{project_id}/subscriptions/{subscription_id}

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The project ID.
- **subscription_id** (string) - Required - The subscription ID.

### Response
#### Success Response (200)
- **subscription** (object) - The subscription details.

#### Response Example
{
  "subscription": {}
}
```

--------------------------------

### Update discount offer response example

Source: https://www.revenuecat.com/docs/api-v2/discount.md

Example response for a successful update, showing the discount object with fields such as id, identifier, customer_facing_name, type, duration_mode, eligibility, time_window, and timestamps.

```json
{
  "object": "discount",
  "id": "discnt1a2b3c4d5e",
  "identifier": "spring_2026",
  "customer_facing_name": "Spring sale",
  "type": "percentage",
  "duration_mode": "one_time",
  "eligibility": "everyone",
  "time_window": "P1M",
  "disabled_at": 1762273200000,
  "percentage": 20,
  "created_at": 1762270200000,
  "updated_at": 1762270200000
}
```

--------------------------------

### GET /v2/projects/{project_id}/products/{product_id}

Source: https://www.revenuecat.com/docs/api-v2/product.md

Retrieves a product from a project. Requires the project_configuration:products:read permission.

```APIDOC
## [GET] /v2/projects/{project_id}/products/{product_id}

### Description
Retrieves a product from the specified project.

### Method
GET

### Endpoint
https://api.revenuecat.com/v2/projects/{project_id}/products/{product_id}

### Parameters
#### Path Parameters
- **project_id** (string) - Required - ID of the project. Max 255 characters.
- **product_id** (string) - Required - ID of the product. 1 to 255 characters.

#### Query Parameters
- **expand** (Array of strings) - Optional - Specifies which fields in the response should be expanded. Accepted values: `app` (requires `project_configuration:apps:read` permission), `indicative_price` (requires `project_configuration:products:read` permission). Items must be 1 to 5000 characters.

### Authorizations
BearerAuth

### Permissions
`project_configuration:products:read`

### Rate Limit
60 requests per minute (Project Configuration domain)

### Responses
- **200** - Success
- **400** - Bad request
- **401** - Unauthorized
- **403** - Access denied
- **404** - Not found
- **423** - Locked
- **429** - Rate limit exceeded
- **500** - Internal server error
- **503** - Internal server error

### Response Example
```json
{
  "state": "active",
  "object": "product",
  "id": "prod1a2b3c4d5e",
  "store_identifier": "rc_1w_199",
  "type": "subscription",
  "subscription": {
    "duration": "P1M",
    "grace_period_duration": "P3D",
    "trial_duration": "P1W"
  },
  "one_time": {
    "is_consumable": true
  },
  "created_at": 1658399423658,
  "app_id": "app1a2b3c4",
  "app": {
    "object": "app",
    "id": "app1a2b3c4",
    "name": "string",
    "created_at": 1658399423658,
    "type": "amazon",
    "project_id": "proj1a2b3c4",
    "custom_url_scheme": "rc-1a2b3c4",
    "amazon": {
      "package_name": "string"
    }
  },
  "indicative_price": {
    "object": "indicative_price",
    "currency": "USD",
    "country": "US",
    "amount_micros": "For 99.99, the value should be 99990000"
  },
  "display_name": "Premium Monthly 2023"
}
```
```

--------------------------------

### GET /projects/{project_id}/integrations/webhooks/{webhook_integration_id}

Source: https://www.revenuecat.com/docs/api-v2/integration.md

Gets a specific webhook integration by ID.

```APIDOC
## GET /projects/{project_id}/integrations/webhooks/{webhook_integration_id}

### Description
Gets a specific webhook integration by ID.

### Method
GET

### Endpoint
/projects/{project_id}/integrations/webhooks/{webhook_integration_id}

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The ID of the project
- **webhook_integration_id** (string) - Required - The ID of the webhook integration

### Response
#### Success Response (200)
- **object** (string) - Required - one of `webhook_integration`; String representing the object's type.
- **id** (string) - Required - length 1–255; The ID of the webhook integration
- **project_id** (string) - Required - length 1–255; The ID of the project the webhook integration belongs to
- **name** (string) - Required - length 1–1500; The display name of the webhook integration
- **url** (string) - Required - format: `uri`; length 0–5000; The URL RevenueCat will send webhook notifications to
- **environment** (string or null) - Required - one of `production`, `sandbox`, ``; The environment the webhook integration is configured for.
- **event_types** (array of string or null) - Optional - Event types that will trigger the webhook.
- **app_id** (string or null) - Required - length 1–255; The ID of the app the webhook integration is scoped to.
- **signing_secret** (string) - Optional - The plaintext HMAC signing secret.
- **created_at** (integer) - Required - format: `int64`; The timestamp in ms since epoch when the webhook integration was created

#### Response Example
{
  "object": "webhook_integration",
  "id": "string",
  "project_id": "string",
  "name": "string",
  "url": "string",
  "environment": "production",
  "event_types": ["string"],
  "app_id": "string",
  "signing_secret": "string",
  "created_at": 0
}
```

--------------------------------

### GET /projects/{project_id}/paywalls/{paywall_id}/versions/{version_id}

Source: https://www.revenuecat.com/docs/api-v2/paywall/publishing.md

Gets a paywall version.

```APIDOC
## GET /projects/{project_id}/paywalls/{paywall_id}/versions/{version_id}

### Description
Gets a paywall version.

### Method
GET

### Endpoint
`/projects/{project_id}/paywalls/{paywall_id}/versions/{version_id}`

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The project ID.
- **paywall_id** (string) - Required - The paywall ID.
- **version_id** (string) - Required - The version ID.

### Response
#### Success Response (200)
- **version** (object) - The paywall version.

#### Response Example
```json
{
  "version": {}
}
```
```

--------------------------------

### GET /projects/{project_id}/subscriptions/{subscription_id}/entitlements

Source: https://www.revenuecat.com/docs/api-v2/subscription.md

Get a list of entitlements associated with a subscription.

```APIDOC
## GET /projects/{project_id}/subscriptions/{subscription_id}/entitlements

### Description
Get a list of entitlements associated with a subscription.

### Method
GET

### Endpoint
/projects/{project_id}/subscriptions/{subscription_id}/entitlements

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The project ID.
- **subscription_id** (string) - Required - The subscription ID.

### Response
#### Success Response (200)
- **items** (array) - List of entitlements associated with the subscription.

#### Response Example
{
  "items": []
}
```

--------------------------------

### Create project response

Source: https://www.revenuecat.com/docs/api-v2/project.md

Example response for a successful project creation. The response includes the project object with its unique identifier, name, creation timestamp, and icon URLs.

```json
{
  "object": "project",
  "id": "proj1ab2c3d4",
  "name": "MagicWeather",
  "created_at": 1658399423658,
  "icon_url": "https://www.appatar.io/abc123/small",
  "icon_url_large": "https://www.appatar.io/abc123/large"
}
```

--------------------------------

### GET /projects/{project_id}/subscriptions/{subscription_id}/authenticated_management_url

Source: https://www.revenuecat.com/docs/api-v2/subscription.md

Get an authenticated subscription management URL.

```APIDOC
## GET /projects/{project_id}/subscriptions/{subscription_id}/authenticated_management_url

### Description
Get an authenticated subscription management URL.

### Method
GET

### Endpoint
/projects/{project_id}/subscriptions/{subscription_id}/authenticated_management_url

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The project ID.
- **subscription_id** (string) - Required - The subscription ID.

### Response
#### Success Response (200)
- **url** (string) - The authenticated management URL.

#### Response Example
{
  "url": "https://example.com"
}
```
Tokens:
Raw