Skip to main content

• General
  • Overview (v2)
    • About RevenueCat’s REST API
    • Should I use this REST API or the RevenueCat SDK?
    • Base URL
    • Authentication
    • API v2 Permissions
    • Request Payload
    • Params
  • Pagination
    • Parameters
  • Rate Limit
    • Rate Limits by Domain
    • Rate Limit Headers
  • Expandables
  • Error Handling
    • Error Codes
    • Error Types
  • Representation of Subscriptions
    • What constitutes a new subscription
• Model Reference
  • Subscription Data Model
• Endpoint Reference
  • App
    • getGet a list of the public API keys of an app
    • getGet a list of apps
    • postCreate an app
    • getGet an app
    • postUpdate an app
    • delDelete an app
    • getGet the StoreKit configuration for an app
  • Audit Log
    • getList audit logs
  • Charts & Metrics
    • getGet overview metrics for a project
    • getGet revenue for a project
    • getGet chart data
    • getGet available options for a chart
  • Collaborator
    • getGet a list of collaborators
  • Customer
    • getGet a list of customers
    • postCreate a customer
    • getGet a customer
    • delDelete a customer
    • getGet customer center configuration
    • postTransfer customer's subscriptions and one-time purchases to another customer
    • postGrant an entitlement to a customer
    • postRevoke a granted entitlement from a customer
    • postAssign or clear an offering override for a customer
    • postRestore a Google Play purchase by order ID
    • getGet a list of subscriptions associated with a customer
    • getGet a list of purchases associated with a customer
    • getGet a list of customer's active entitlements
    • getGet a list of the customer's aliases
    • getGet a list of customer's virtual currencies balances
    • postCreate a virtual currencies transaction
    • postUpdate a virtual currencies balance without creating a transaction
    • getGet a list of the customer's attributes
    • postSet a customer's attributes
  • Entitlement
    • getGet an entitlement
    • postUpdate an entitlement
    • delDelete an entitlement
    • getGet a list of entitlements
    • postCreate an entitlement
    • getGet a list of products attached to a given entitlement
    • postArchive an entitlement
    • postUnarchive an entitlement
    • postAttach a set of products to an entitlement
    • postDetach a set of product from an entitlement
  • Offering
    • getGet an offering
    • postUpdate an offering
    • delDelete an offering and its attached packages
    • postArchive an offering
    • postUnarchive an offering
    • getGet a list of offerings
    • postCreate an offering
  • Package
    • getGet a package
    • postUpdate a package
    • delDelete a package
    • getGet a list of packages in an offering
    • postCreate a package
    • getGet a list of products attached to a given package of an offering
    • postAttach a set of products to a package
    • postDetach a set of products from a package
  • Product
    • getGet a product
    • postUpdate a product
    • delDelete a product
    • postArchive a product
    • postUnarchive a product
    • postPush a product to the store
    • getGet a list of products
    • postCreate a product
  • Virtual Currency
    • getGet a list of virtual currencies
    • postCreate a virtual currency
    • getGet a virtual currency
    • postUpdate a virtual currency
    • delDelete a virtual currency
    • postArchive a virtual currency
    • postUnarchive a virtual currency
  • Purchase
    • getGet a purchase
    • getGet a list of entitlements associated with a purchase
    • postRefund a Web Billing purchase
    • getSearch one-time purchases by store purchase identifier
  • Subscription
    • getGet a subscription
    • getGet a Play Store or App Store subscription's transactions
    • postRefund a Play Store or Galaxy subscription's transaction
    • getGet a list of entitlements associated with a subscription
    • postCancel an active Web Billing subscription
    • postExtend the current billing period of a subscription
    • postRefund an active Web Billing subscription
    • getGet an authenticated subscription management URL
    • getSearch subscriptions by store subscription identifier
  • Invoice
    • getGet a list of the customer's invoices
    • getGet an invoice
  • Paywall
    • postUpload a media asset
    • getGet a list of paywalls
    • postCreate a paywall
    • getGet a paywall
    • patchUpdate a paywall draft
    • delDelete a paywall
  • Integration
    • getList webhook integrations
    • postCreate a webhook integration
    • getGet a webhook integration
    • postUpdate a webhook integration
    • delDelete a webhook integration
  • Project
    • getGet a list of projects
    • postCreates a new project

API docs by Redocly](https://redocly.com/redoc/)

Developer API (2.0.0)

Download OpenAPI specification: Download

tag/Overview-(v2) Overview (v2)

New to RevenueCat?

Welcome! If you're adding subscriptions or other in-app purchases to your app, the RevenueCat SDK will handle most of the heavy-lifting without the need to interact with this API directly. See our Quickstart for more information on getting started with RevenueCat.

API v2 under development

REST API v2 is currently under development and does not yet cover all use cases from API v1. For those missing use cases, please use v1 in the meantime.

tag/Overview-(v2)/About-RevenueCat's-REST-API About RevenueCat’s REST API

RevenueCat provides a REST API for developers to perform customer and transaction related actions from their own server.

Most of this API is geared toward client usage via RevenueCat’s SDK, but there are various endpoints that can be used for refunding purchases, granting promotional entitlements, and other sensitive actions that can only be done via a Secret API key from your server.

tag/Overview-(v2)/Should-I-use-this-REST-API-or-the-RevenueCat-SDK Should I use this REST API or the RevenueCat SDK?

If you’re adding subscriptions or other in-app purchases to your app for the first time or if you don’t have a backend that stores your user’s receipts, you’re probably looking to implement the RevenueCat SDK.

If you want to start migrating your existing users to RevenueCat and you have your user’s receipts stored on your own server, or you want to check subscription status of your users from your own server, the REST API is a great solution.

tag/Overview-(v2)/Base-URL Base URL

The base URL for the RevenueCat REST API v2 is https://api.revenuecat.com/v2.

tag/Overview-(v2)/Authentication Authentication

Authentication for the RevenueCat REST API is achieved by setting the Authorization header with a valid API key. You'll find two types of API keys in your RevenueCat dashboard: public and secret.

Certain endpoints require secret keys, which should be kept out of any publicly accessible areas such as GitHub, client-side code, and so forth. See our Authentication guide for more information.

Authorization: Bearer YOUR_REVENUECAT_API_KEY

Authorization type `Bearer` required in header

he RevenueCat REST API v2 requires stating the authorization type `Bearer` in the `Authorization` header before the API key in accordance with [RFC 7235](https://datatracker.ietf.org/doc/html/rfc7235). This is different to the v1 API which allowed passing just the API key as the `Authorization` header.

API v1 keys will not work with REST API v2

In order to utilize the RevenueCat API v2, please create new v2 secret keys and define your permissions.

tag/Overview-(v2)/API-v2-Permissions API v2 Permissions

You can create a new secret API key in your project settings page > API keys. Select + New.

Give it a name, select V2 as the version, and set your permissions. Be sure to select Generate at the top right corner.

Each endpoint in this documentation will contain a description informing you which permissions are required.

tag/Overview-(v2)/Request-Payload Request Payload

The body of the POST requests should be encoded in JSON and have the 'Content-Type' header set to 'application/json'.

Content-Type: application/json

{
  "app_user_id": "user-1456",
  "fetch_token": "MQABC...EFH1234="
}

tag/Overview-(v2)/Params Params

Encode your URL params

For URL params, such as the `app_user_id`, make sure you URL encode them before using them.

tag/Pagination Pagination

Top-level API resources have support for bulk fetches via "list" API methods. For instance, you can list products, list entitlements, and list offerings. These list API methods share a common structure, taking at least these two parameters: limit and starting_after.

When a response or a field contains multiple entities of the same type, it returns a list object of the following structure:

{
  "object": "list",
  "items": [{}],
  "next_page": "LIST_BASE_URL?starting_after=LAST_ID",
  "url": "LIST_BASE_URL"
}

Where…

• url is the full path base URL of the list endpoint (i.e., if you make a request to this endpoint, you will get the first page), e.g. /v2/projects/{project_id}/products
• next_page is the URL for the next page, if there is one. If there is no next page, the next_page field will not be present. Example: /v2/projects/{project_id}/products?starting_after={last_id}
• items is an array of the entries of the list.

The starting_after query parameter of list endpoints accepts the ID of the first list item that will not be part of the list (in other words, the ID of the last item of the previous page).

At the moment we only support forward pagination.

tag/Pagination/Parameters Parameters

limit optional, default is 20

A limit on the number of objects to be returned.

starting_after optional

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo, your subsequent call can include starting_after=foo in order to fetch the next page of the list.

tag/Rate-Limit Rate Limit

API v2 uses rate limiting to prevent abuse. Rate limits are configured per domain, and all endpoints within the same domain share the same rate limit.

tag/Rate-Limit/Rate-Limits-by-Domain Rate Limits by Domain

Each endpoint belongs to one of these domains. The rate limit applies per API key (for app-level keys) or per developer (for developer-level keys).

tag/Rate-Limit/Rate-Limit-Headers Rate Limit Headers

We will return the following headers on all successful requests:

• RevenueCat-Rate-Limit-Current-Usage: the number of executed requests for the current rate limiting period, including the current request. The rate limiting period is one minute.
• RevenueCat-Rate-Limit-Current-Limit: the limit in requests per minute for this endpoint

If you reach the rate limit, as indicated by a 429 error code, we will also include the following header:

• Retry-After: the number of seconds to wait until you can retry this request.

Below is an example of the response body that will be sent when the rate limit is reached. The value of the backoff_ms field corresponds to the `Retry-After`` header but specified in milliseconds.

{
  "type": "rate_limit_error",
  "message": "Rate limit exceeded",
  "retryable": true,
  "doc_url": "https://errors.rev.cat/rate-limit-error",
  "backoff_ms": 1000
}

tag/Expandables Expandables

Expandables allow you to retrieve related data along with the request without making additional requests. Fields in the REST API will allow you to request additional information as an expanded response by using the expand query parameter.

For example, a product object will have an associated app_id field. This app_id field can be expanded in the same request with the expand query parameter and will include an app object in the response.

Without expand query param

{
  "object": "product",
  "id": "prod1a2b3c4d5e",
  "store_identifier": "rc_1w_199",
  "type": "subscription",
  "subscription": {
    "duration": "P1M",
    "grace_period_duration": "P3D",
    "trial_duration": "P1W"
  },
  "created_at": 1658399423658,
  "app_id": "app1a2b3c4"
}

With expand query param:

{
  "object": "product",
  "id": "prod1a2b3c4d5e",
  "store_identifier": "rc_1w_199",
  "type": "subscription",
  "subscription": {
    "duration": "P1M",
    "grace_period_duration": "P3D",
    "trial_duration": "P1W"
  },
  "created_at": 1658399423658,
  "app_id": "app1a2b3c4",
  "app": {
    "id": "app1a2b3c4",
    "name": "string",
    "created_at": 1658399423658,
    "type": "amazon",
    "project_id": "proj1a2b3c4"
  }
}

As you can see from above, the app_id field remains the same, but the response contains an additional app object.

Fields that can be expanded into objects are indicated in the endpoint documentation under Query Params and will list accepted values. Also, the required permissions to be defined in the API key are listed there.

tag/Error-Handling Error Handling

RevenueCat uses standard HTTP status codes to indicate the success or failure of an API request. Codes in the 2XX range indicate the request was successful. 4XX codes indicate an error caused by the client. 5XX codes indicate an error in RevenueCat servers.

Successful modifications return the modified entity. Errors return the following fields:

{
  "type": "parameter_error",
  "param": "customer_id",
  "message": "id is too long",
  "retryable": false,
  "doc_url": "https://errors.rev.cat/parameter-error"
}

For more information on the type field and how to resolve these errors, please visit our Error Types documentation.

tag/Error-Handling/Error-Codes Error Codes

tag/Error-Handling/Error-Types Error Types

authentication_error

Authentication is not valid for the given API key. Double check your API key.

authorization_error

The API key does not belong the project you specified. Double check that your API key is associated with the IDs you are passing.

invalid_request

This error can be due to several reasons:

• Content-Type: application/json is missing in the request header for POST/PUT/PATCH requests
• Using the incorrect HTTP method on a path (i.e: GET …/entitlements/<entitlements_id>/actions/attach_products)

parameter_error

The parameter provided is invalid. Please refer to the message field for more information.

• IDs (e.g: entitlement_id, project_id, etc): 1 to 255 characters
• display_name(applies to Entitlements): 1 to 1000 characters
• lookup_key(applies to Entitlements): 1 to 200 characters

rate_limit_error

The request has hit the rate limit for this endpoint. Refer to the backoff_ms field to determine how many milliseconds to wait before making another request to the same endpoint.

resource_missing

The resource with the specific ID does not exist. Double check the IDs (e.g: product ID, entitlement ID, etc) you are passing into the endpoints.

resource_already_exists

The resource with the specific ID already exists. Use a different, unique value for ID and try again.

resource_locked_error

The resource is currently being modified by a concurrent request. Refer to the backoff_ms field to determine when to try again.

server_error

Request is not able to be processed due to an internal server error. Refer to the backoff_ms field to determine when to try again. Please report this to the RevenueCat team if you are encountering this issue.

store_error

There was a problem with the stores (e.g: Apple App Store, Google Play Store, etc). This typically occurs when the stores are unable to process the request. Refer to the backoff_ms field to determine when to try again.

unprocessable_entity_error

Request is not able to be processed. Please refer to the message field for more information.

entity_references_archived_entities

The entity you are trying to make active references other entities that are currently inactive (archived). The referenced_object_ids field contains the IDs of the inactive entities that need to be made active before the operation can succeed. Make those entities active first, then retry the request.

tag/Representation-of-Subscriptions Representation of Subscriptions

In comparison to our v1 REST API, we have made changes to improve the organization and accessibility of your customers’ subscriptions. The data model used in the RevenueCat REST API v2 has several advantages. Firstly, it better abstracts differences between different app stores, making it easier for you to access your data without needing to understand the specificities and idiosyncrasies of each individual store.

Additionally, the REST API v2 subscription data model provides richer information regarding your subscription data and includes new fields such as:

• gives_access: Rather than having to create your own logic to determine if a customer should have access, we will provide you with that information directly.
• auto_renewal_status: Previously you would have to use unsubscribe_detected_at, billing_issues_detected_at, and other fields to determine the auto renewal status of the customer, now we include this information to take away the estimation work.
• status: Gives you a quick and easy way to gather the status of the customer’s subscription to determine what state they are currently in.
• store_subscription_identifier: Whereas the old data model was missing the store’s subscription identifier (aka the transaction ID directly from the stores), we have included this new field to help identify your customer’s subscription.
• total_revenue_in_usd: You can easily determine how much a customer has spent for this subscription in USD and utilize it for your own bookkeeping purposes. This object also contains information such as gross, commission, tax, and proceeds to help you break down the customer’s revenue.

To view more details of fields we have included for the subscription object, check out the model reference.

Eventually we will also expose this sort of information in webhooks and customer event details to incorporate the new data model throughout RevenueCat.

tag/Representation-of-Subscriptions/What-constitutes-a-new-subscription What constitutes a new subscription

Different stores supported by RevenueCat have different logic to define what is a new subscription vs. a change to an existing subscription. To make it easier to handle subscriptions across different stores, the data model for the RevenueCat REST API v2 is now following a consistent definition of what continues the same subscription vs. a new one:

• After a subscription has lapsed (e.g: after a billing retry or letting subscription expire after an unsubscribe), if a customer subscribes to the same product it will be considered a new subscription (this was previously treated differently on Apple App Store vs. Google Play Store)
• If the product of a paid subscription is changed, the subscription to the new product will be considered a new subscription. An exception is product changes during a trial period, the post-trial subscription period to a different product will not be considered a new subscription, but a regular trial conversion
• For family shared subscriptions:
  • Family shared subscriptions will be considered as a new subscription (albeit with no revenue)
  • If family sharing access is revoked and later re-enabled, this will be considered as a new subscription

Diagrams for different cases

Billing issue: unrecovered

Billing issue: recovered

Lapsed subscription

Product changes: upgrade (no trial)

Product changes: downgrade (no trial)

Product changes (with trial)

Subscription paused: Recovery

Subscription paused: Billing issue, recovered

Subscription paused: Billing issue, unrecovered

Family shared subscriptions

Family shared subscriptions: regranted

tag/Subscription-Data-Model Subscription Data Model

MonetaryAmount

Copy Expand all Collapse all

`{"object": "subscription",

"id": "sub1ab2c3d4e5",

"customer_id": "19b8de26-77c1-49f1-aa18-019a391603e2",

"original_customer_id": "19b8de26-77c1-49f1-aa18-019a391603e2",

"product_id": "prod1a2b3c4d5e",

"starts_at": 1658399423658,

"current_period_starts_at": 1658399423658,

"current_period_ends_at": 1658399423658,

"ends_at": 1658399423658,

"gives_access": true,

"pending_payment": true,

"auto_renewal_status": "will_renew",

"status": "trialing",

"total_revenue_in_usd": {"currency": "USD",

"gross": 9.99,

"commission": 2.99,

"tax": 0.75,

"proceeds": 6.25

},

"presented_offering_id": "ofrnge1a2b3c4d5",

"entitlements": {"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",

"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/subscriptions/sub1a2b3c4d5e/entitlements?status=active&starting_after=entlab21dac",

"url": "/v2/projects/proj1ab2c3d4/subscriptions/sub1a2b3c4d5e/entitlements"

},

"environment": "production",

"store": "amazon",

"store_subscription_identifier": 12345678,

"ownership": "purchased",

"pending_changes": {"product": {"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",

"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"

},

"current_period_starts_at": 1658399423658,

"current_period_ends_at": 1660991423658,

"store_subscription_identifier": 12345679,

"auto_renewal_status": "will_renew",

"status": "active",

"pending_payment": false,

"gives_access": true

},

"country": "US",

"management_url": "https://apps.apple.com/account/subscriptions"

}`

tag/App App

Operations about apps.

tag/App/operation/list-app-public-api-keys Get a list of the public API keys of an app

get/projects/{project_id}/apps/{app_id}/public_api_keys

https://api.revenuecat.com/v2/projects/{project\_id}/apps/{app\_id}/public\_api\_keys

Returns public API keys for the app. RC Checkout public keys are omitted. Sandbox keys are always included. Production keys are omitted when the app uses Stripe or Web Billing and the linked Stripe connected account is sandbox or test-only (same behavior as the RevenueCat dashboard list). This endpoint requires the following permission(s): project_configuration:apps:read. This endpoint belongs to the Project Configuration domain, which has a default rate limit of 60 requests per minute.

Authorizations:

BearerAuth

path Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "list",

"items": [{"object": "public_api_key",

"id": "apikey12345",

"key": "goog_1ab2c3d4",

"environment": "production",

"app_id": "app1a2b3c4",

"created_at": 1658399423658

}

],

"next_page": "/v2/projects/projec1a2b3c4d/apps/app1a2b3c4d/public_api_keys?starting_after=pub1a2b3c4d",

"url": "/v2/projects/projec1a2b3c4d/apps/app1a2b3c4d/public_api_keys"

}`

tag/App/operation/list-apps Get a list of apps

get/projects/{project_id}/apps

https://api.revenuecat.com/v2/projects/{project\_id}/apps

This endpoint requires the following permission(s): project_configuration:apps:read. This endpoint belongs to the Project Configuration domain, which has a default rate limit of 60 requests per minute.

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "list",

"items": [{"object": "app",

"id": "app1a2b3c4",

"name": "string",

"created_at": 1658399423658,

"type": "amazon",

"project_id": "proj1a2b3c4",

"amazon": {"package_name": "string"

}

}

],

"next_page": "/v2/projects/projec1a2b3c4d/apps?starting_after=app1a2b3c4d",

"url": "/v2/projects/projec1a2b3c4d/apps"

}`

tag/App/operation/create-app Create an app

post/projects/{project_id}/apps

https://api.revenuecat.com/v2/projects/{project\_id}/apps

This endpoint requires the following permission(s): project_configuration:apps:read_write. This endpoint belongs to the Project Configuration domain, which has a default rate limit of 60 requests per minute.

Authorizations:

BearerAuth

path Parameters

Request Body schema: application/json required

Responses

201

Success. The app was created

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Request samples

• Payload

Content type

application/json

Example

App StorePlay StoreStripeAmazonWeb BillingRokuPaddleApp Store

Copy Expand all Collapse all

`{"name": "My App Store App",

"type": "app_store",

"app_store": {"bundle_id": "com.apple.Pages",

"shared_secret": "1234567890abcdef1234567890abcdef",

"subscription_private_key": "-----BEGIN EC PRIVATE KEY-----\nMHQCAQEEIGAkwOF0qkGO19yJlIzQVcOg+HBfvLL4KDXDtL+MMHk2oAcGBSuBBAAK\noUQDQgAEhDP7RaX4c6qOHkE1nIWMr5C90ybtr87VRGFm4VsfWqG47NPN+/dHcfwJ\nJPZGFgMcgvBc37AxQPPQjyXYjhhQDg==\n-----END EC PRIVATE KEY-----",

"subscription_key_id": "6345942CC3",

"subscription_key_issuer": "5a049d62-1b9b-453c-b605-1988189d8129"

}

}`

Response samples

• 201
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Example

amazonapp_storemac_app_storeplay_storestriperc_billingrokupaddletest_storeamazon

Copy Expand all Collapse all

`{"object": "app",

"id": "app1a2b3c4",

"name": "string",

"created_at": 1658399423658,

"type": "amazon",

"project_id": "proj1a2b3c4",

"amazon": {"package_name": "string"

}

}`

tag/App/operation/get-app Get an app

get/projects/{project_id}/apps/{app_id}

https://api.revenuecat.com/v2/projects/{project\_id}/apps/{app\_id}

Authorizations:

BearerAuth

path Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Example

amazonapp_storemac_app_storeplay_storestriperc_billingrokupaddletest_storeamazon

Copy Expand all Collapse all

`{"object": "app",

"id": "app1a2b3c4",

"name": "string",

"created_at": 1658399423658,

"type": "amazon",

"project_id": "proj1a2b3c4",

"amazon": {"package_name": "string"

}

}`

tag/App/operation/update-app Update an app

post/projects/{project_id}/apps/{app_id}

https://api.revenuecat.com/v2/projects/{project\_id}/apps/{app\_id}

Authorizations:

BearerAuth

path Parameters

Request Body schema: application/json required

Responses

200

Success. The app was updated

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Request samples

• Payload

Content type

application/json

Example

Update App Store App propertiesUpdate App Store App secretRemove App Store App secretUpdate App Store App properties

Copy Expand all Collapse all

`{"name": "New App name",

"app_store": {"bundle_id": "com.my.new-app",

"shared_secret": "1234567890abcdef1234567890abcdef"

}

}`

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Example

amazonapp_storemac_app_storeplay_storestriperc_billingrokupaddletest_storeamazon

Copy Expand all Collapse all

`{"object": "app",

"id": "app1a2b3c4",

"name": "string",

"created_at": 1658399423658,

"type": "amazon",

"project_id": "proj1a2b3c4",

"amazon": {"package_name": "string"

}

}`

tag/App/operation/delete-app Delete an app

delete/projects/{project_id}/apps/{app_id}

https://api.revenuecat.com/v2/projects/{project\_id}/apps/{app\_id}

Authorizations:

BearerAuth

path Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy

`{"object": "app",

"id": "string",

"deleted_at": 1658399423658

}`

tag/App/operation/get-app-storekit-config Get the StoreKit configuration for an app

get/projects/{project_id}/apps/{app_id}/store_kit_config

https://api.revenuecat.com/v2/projects/{project\_id}/apps/{app\_id}/store\_kit\_config

Authorizations:

BearerAuth

path Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "store_kit_config_file",

"contents": { }

}`

tag/Audit-Log Audit Log

Operations about audit logs.

tag/Audit-Log/operation/list-audit-logs List audit logs

get/projects/{project_id}/audit_logs

https://api.revenuecat.com/v2/projects/{project\_id}/audit\_logs

This endpoint requires the following permission(s): project_configuration:audit_logs:read. This endpoint belongs to the Project Configuration domain, which has a default rate limit of 60 requests per minute.

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "list",

"items": [{"object": "audit_log",

"id": "log1ab2c3d4e5",

"project_id": "proj1ab2c3d4",

"action_type": "project_name_updated",

"target_type": "project",

"target_identifier": "proj1ab2c3d4",

"actor_type": "user",

"actor_identifier": "user_abc123",

"occurred_at": 1713297600000,

"additional_data": { }

}

],

"next_page": "/v2/projects/proj1ab2c3d4/audit_logs?starting_after=log1ab2c3d4e5",

"url": "/v2/projects/proj1ab2c3d4/audit_logs"

}`

tag/Charts-and-Metrics Charts & Metrics

Operations about chart metrics.

tag/Charts-and-Metrics/operation/get-overview-metrics Get overview metrics for a project

get/projects/{project_id}/metrics/overview

https://api.revenuecat.com/v2/projects/{project\_id}/metrics/overview

This endpoint requires the following permission(s): charts_metrics:overview:read. This endpoint belongs to the Charts & Metrics domain, which has a default rate limit of 25 requests per minute.

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "overview_metrics",

"metrics": [{"object": "overview_metric",

"id": "active_trials",

"name": "Active Trials",

"description": "string",

"unit": "$",

"period": "P0D",

"value": 34765,

"last_updated_at": 1658399423658,

"last_updated_at_iso8601": "2022-10-13 09:45:00.123000+00:00"

}

],

"currency": "EUR"

}`

tag/Charts-and-Metrics/operation/get-revenue-metric Get revenue for a project

get/projects/{project_id}/metrics/revenue

https://api.revenuecat.com/v2/projects/{project\_id}/metrics/revenue

Returns the total revenue for the project across all of its apps for the given inclusive date range [start_date, end_date]. The value is expressed in the project's primary currency unless currency is provided.

Use revenue_type to choose which revenue definition the value represents: gross revenue (default), revenue_net_of_taxes, or proceeds (net of both taxes and store commission — the amount the developer keeps).

This endpoint is backed by the same realtime (v3) revenue chart that powers the dashboard. It is intended for cases where an app needs an authoritative revenue total without inferring it from the transaction list.

Note that the most recent day in the range may be partial if it includes today, since transactions for today are still arriving. This endpoint requires the following permission(s): charts_metrics:overview:read. This endpoint belongs to the Charts & Metrics domain, which has a default rate limit of 25 requests per minute.

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy

`{"object": "revenue_metric",

"start_date": "2026-01-01",

"end_date": "2026-01-31",

"currency": "USD",

"value": 12345.67,

"revenue_type": "proceeds"

}`

tag/Charts-and-Metrics/operation/get-chart-data Get chart data

get/projects/{project_id}/charts/{chart_name}

https://api.revenuecat.com/v2/projects/{project\_id}/charts/{chart\_name}

Returns time-series data for a specific chart.

Response Structure

The response includes:

• Chart metadata (category, display_name, description)
• Time boundaries (start_date, end_date, last_computed_at)
• Data values (array of data points)
• Summary statistics
• Segment information (when segmented)

Chart Types

Different charts may return data in slightly different formats:

• Standard charts: values as arrays of data points with timestamps
• Cohort charts: values include cohort-specific data structures
• Segmented charts: include segment information in the response

Filtering and Segmentation

Use the /charts/{chart_name}/options endpoint to discover available filters and segments for a specific chart before making requests.

Filter parameters vary by chart and can be passed as additional query parameters.

Aggregation

Use aggregate to request summary-only output for supported charts. When aggregate is provided, values is returned as an empty array and summary includes only the requested aggregate operations.

Incomplete data For the most recent periods, data may be flagged as incomplete, and may not be appropriate to use for analysis. This endpoint requires the following permission(s): charts_metrics:charts:read. This endpoint belongs to the Charts & Metrics domain, which has a default rate limit of 25 requests per minute.

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Chart data retrieved successfully

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "chart_data",

"category": "revenue",

"display_type": "line",

"display_name": "Revenue",

"description": "string",

"documentation_link": "string",

"last_computed_at": 0,

"start_date": 0,

"end_date": 0,

"yaxis_currency": "USD",

"filtering_allowed": true,

"segmenting_allowed": true,

"resolution": "day",

"values": [[0

]

],

"summary": { },

"yaxis": "$",

"segments": [{"id": "string",

"display_name": "string"

}

],

"segments_limit": 0,

"measures": [{ }

],

"user_selectors": {"property1": "string",

"property2": "string"

},

"unsupported_params": {"filters": ["string"

],

"segment": "string"

},

"annotations": [{"object": "chart_annotation",

"id": "chartannot1a2b3c",

"description": "App version 2.0 released",

"start_date": "2024-01-15",

"end_date": "2024-01-20"

}

]

}`

tag/Charts-and-Metrics/operation/get-chart-options Get available options for a chart

get/projects/{project_id}/charts/{chart_name}/options

https://api.revenuecat.com/v2/projects/{project\_id}/charts/{chart\_name}/options

Returns configuration options for a specific chart.

Use this endpoint to discover:

• Resolutions: Available time granularities (day, week, month, etc.)
• Segments: Dimensions you can segment the data by (country, store, product, etc.)
• Filters: Available filters and their possible values

The options returned are specific to the chart and may vary based on your project's data and configuration.

Usage

Call this endpoint before requesting chart data to:

1. Build dynamic filter UIs
2. Validate parameters before making chart data requests
3. Discover available dimensions for analysis . This endpoint requires the following permission(s): charts_metrics:charts:read. This endpoint belongs to the Charts & Metrics domain, which has a default rate limit of 25 requests per minute.

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Chart options retrieved successfully

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "chart_options",

"resolutions": [{"id": "0",

"display_name": "day"

},

{"id": "1",

"display_name": "week"

},

{"id": "2",

"display_name": "month"

}

],

"segments": [{"object": "chart_segment_option",

"id": "country",

"display_name": "Country",

"group_display_name": "Geography"

}

],

"filters": [{"object": "chart_filter_option",

"id": "country",

"display_name": "Country",

"group_display_name": "Geography",

"options": [{"id": "US",

"display_name": "United States"

}

]

}

],

"user_selectors": {"property1": {"default": "string",

"display_name": "string",

"options": [{"id": "string",

"display_name": "string"

}

]

},

"property2": {"default": "string",

"display_name": "string",

"options": [{"id": "string",

"display_name": "string"

}

]

}

}

}`

tag/Collaborator Collaborator

Operations about collaborators.

tag/Collaborator/operation/list-collaborators Get a list of collaborators

get/projects/{project_id}/collaborators

https://api.revenuecat.com/v2/projects/{project\_id}/collaborators

This endpoint requires the following permission(s): project_configuration:collaborators:read. This endpoint belongs to the Project Configuration domain, which has a default rate limit of 60 requests per minute.

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "list",

"items": [{"object": "collaborator",

"id": "collab1a2b3c4d5",

"name": "John Doe",

"email": "john.doe@example.com",

"role": "admin",

"accepted_at": 1658399423658,

"has_mfa": true

}

],

"next_page": "/v2/projects/proj1ab2c3d4/collaborators?starting_after=collab1a2b3c4d5",

"url": "/v2/projects/proj1ab2c3d4/collaborators"

}`

tag/Customer Customer

Operations about customers.

tag/Customer/operation/list-customers Get a list of customers

get/projects/{project_id}/customers

https://api.revenuecat.com/v2/projects/{project\_id}/customers

This endpoint requires the following permission(s): customer_information:customers:read. This endpoint belongs to the Customer Information domain, which has a default rate limit of 480 requests per minute.

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "list",

"items": [{"object": "customer",

"id": "19b8de26-77c1-49f1-aa18-019a391603e2",

"project_id": "proj1ab2c3d4",

"first_seen_at": 1658399423658,

"last_seen_at": 1658399423658,

"last_seen_app_version": "1.0.0",

"last_seen_country": "US",

"last_seen_platform": "android",

"last_seen_platform_version": "35",

"active_entitlements": {"object": "list",

"items": [{"object": "customer.active_entitlement",

"entitlement_id": "entla1b2c3d4e5",

"expires_at": 1658399423658

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/active_entitlements?starting_after=entlab21dac",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/active_entitlements"

},

"experiment": {"object": "experiment_enrollment",

"id": "string",

"name": "string",

"variant": "a"

},

"attributes": {"object": "list",

"items": [{"object": "customer.attribute",

"name": "$email",

"value": "garfield@revenuecat.com",

"updated_at": 1658399423658

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/attributes?starting_after=myCustomAttribute",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/attributes"

}

}

],

"next_page": "/v2/projects/projec1a2b3c4d/customers?starting_after=223xx1100",

"url": "/v2/projects/projec1a2b3c4d/customers"

}`

tag/Customer/operation/create-customer Create a customer

post/projects/{project_id}/customers

https://api.revenuecat.com/v2/projects/{project\_id}/customers

This endpoint requires the following permission(s): customer_information:customers:read_write. This endpoint belongs to the Customer Information domain, which has a default rate limit of 480 requests per minute.

Authorizations:

BearerAuth

path Parameters

Request Body schema: application/json required

Responses

201

Success. The customer was created

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"id": "19b8de26-77c1-49f1-aa18-019a391603e2",

"attributes": [{"name": "$email",

"value": "cat@revenuecat.com"

}

]

}`

Response samples

• 201
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "customer",

"id": "19b8de26-77c1-49f1-aa18-019a391603e2",

"project_id": "proj1ab2c3d4",

"first_seen_at": 1658399423658,

"last_seen_at": 1658399423658,

"last_seen_app_version": "1.0.0",

"last_seen_country": "US",

"last_seen_platform": "android",

"last_seen_platform_version": "35",

"active_entitlements": {"object": "list",

"items": [{"object": "customer.active_entitlement",

"entitlement_id": "entla1b2c3d4e5",

"expires_at": 1658399423658

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/active_entitlements?starting_after=entlab21dac",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/active_entitlements"

},

"experiment": {"object": "experiment_enrollment",

"id": "string",

"name": "string",

"variant": "a"

},

"attributes": {"object": "list",

"items": [{"object": "customer.attribute",

"name": "$email",

"value": "garfield@revenuecat.com",

"updated_at": 1658399423658

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/attributes?starting_after=myCustomAttribute",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/attributes"

}

}`

tag/Customer/operation/get-customer Get a customer

get/projects/{project_id}/customers/{customer_id}

https://api.revenuecat.com/v2/projects/{project\_id}/customers/{customer\_id}

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "customer",

"id": "19b8de26-77c1-49f1-aa18-019a391603e2",

"project_id": "proj1ab2c3d4",

"first_seen_at": 1658399423658,

"last_seen_at": 1658399423658,

"last_seen_app_version": "1.0.0",

"last_seen_country": "US",

"last_seen_platform": "android",

"last_seen_platform_version": "35",

"active_entitlements": {"object": "list",

"items": [{"object": "customer.active_entitlement",

"entitlement_id": "entla1b2c3d4e5",

"expires_at": 1658399423658

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/active_entitlements?starting_after=entlab21dac",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/active_entitlements"

},

"experiment": {"object": "experiment_enrollment",

"id": "string",

"name": "string",

"variant": "a"

},

"attributes": {"object": "list",

"items": [{"object": "customer.attribute",

"name": "$email",

"value": "garfield@revenuecat.com",

"updated_at": 1658399423658

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/attributes?starting_after=myCustomAttribute",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/attributes"

}

}`

tag/Customer/operation/delete-customer Delete a customer

delete/projects/{project_id}/customers/{customer_id}

https://api.revenuecat.com/v2/projects/{project\_id}/customers/{customer\_id}

Authorizations:

BearerAuth

path Parameters

Responses

200

Success

202

Accepted. The customer deletion was queued.

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 202
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy

`{"object": "customer",

"id": "b5b7bfd2-66fb-4091-af50-7c3cdccfdf24",

"deleted_at": 1658399423658

}`

tag/Customer/operation/get-customer-center-config Get customer center configuration

get/projects/{project_id}/customers/{customer_id}/customer_center

https://api.revenuecat.com/v2/projects/{project\_id}/customers/{customer\_id}/customer\_center

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "customer_center_config",

"customer_center": { }

}`

tag/Customer/operation/transfer-customer-data Transfer customer's subscriptions and one-time purchases to another customer

post/projects/{project_id}/customers/{customer_id}/actions/transfer

https://api.revenuecat.com/v2/projects/{project\_id}/customers/{customer\_id}/actions/transfer

This endpoint requires the following permission(s): customer_information:customers:read_write, customer_information:subscriptions:read_write, customer_information:purchases:read_write. This endpoint belongs to the Customer Information domain, which has a default rate limit of 480 requests per minute.

Authorizations:

BearerAuth

path Parameters

Request Body schema: application/json required

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"target_customer_id": "string",

"app_ids": ["appa2b3c4d5e"

]

}`

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"source_customer": {"object": "customer",

"id": "19b8de26-77c1-49f1-aa18-019a391603e2",

"project_id": "proj1ab2c3d4",

"first_seen_at": 1658399423658,

"last_seen_at": 1658399423658,

"last_seen_app_version": "1.0.0",

"last_seen_country": "US",

"last_seen_platform": "android",

"last_seen_platform_version": "35",

"active_entitlements": {"object": "list",

"items": [{"object": "customer.active_entitlement",

"entitlement_id": "entla1b2c3d4e5",

"expires_at": 1658399423658

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/active_entitlements?starting_after=entlab21dac",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/active_entitlements"

},

"experiment": {"object": "experiment_enrollment",

"id": "string",

"name": "string",

"variant": "a"

},

"attributes": {"object": "list",

"items": [{"object": "customer.attribute",

"name": "$email",

"value": "garfield@revenuecat.com",

"updated_at": 1658399423658

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/attributes?starting_after=myCustomAttribute",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/attributes"

}

},

"target_customer": {"object": "customer",

"id": "19b8de26-77c1-49f1-aa18-019a391603e2",

"project_id": "proj1ab2c3d4",

"first_seen_at": 1658399423658,

"last_seen_at": 1658399423658,

"last_seen_app_version": "1.0.0",

"last_seen_country": "US",

"last_seen_platform": "android",

"last_seen_platform_version": "35",

"active_entitlements": {"object": "list",

"items": [{"object": "customer.active_entitlement",

"entitlement_id": "entla1b2c3d4e5",

"expires_at": 1658399423658

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/active_entitlements?starting_after=entlab21dac",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/active_entitlements"

},

"experiment": {"object": "experiment_enrollment",

"id": "string",

"name": "string",

"variant": "a"

},

"attributes": {"object": "list",

"items": [{"object": "customer.attribute",

"name": "$email",

"value": "garfield@revenuecat.com",

"updated_at": 1658399423658

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/attributes?starting_after=myCustomAttribute",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/attributes"

}

}

}`

tag/Customer/operation/grant-customer-entitlement Grant an entitlement to a customer

post/projects/{project_id}/customers/{customer_id}/actions/grant_entitlement

https://api.revenuecat.com/v2/projects/{project\_id}/customers/{customer\_id}/actions/grant\_entitlement

Grants an entitlement to a customer unless one already exists. As a side effect, a promotional subscription is created. This endpoint requires the following permission(s): customer_information:customers:read_write. This endpoint belongs to the Customer Information domain, which has a default rate limit of 480 requests per minute.

Authorizations:

BearerAuth

path Parameters

Request Body schema: application/json required

Responses

201

Entitlement granted successfully

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Request samples

• Payload

Content type

application/json

Copy

`{"entitlement_id": "entla1b2c3d4e5",

"expires_at": 1658399423658

}`

Response samples

• 201
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "customer",

"id": "19b8de26-77c1-49f1-aa18-019a391603e2",

"project_id": "proj1ab2c3d4",

"first_seen_at": 1658399423658,

"last_seen_at": 1658399423658,

"last_seen_app_version": "1.0.0",

"last_seen_country": "US",

"last_seen_platform": "android",

"last_seen_platform_version": "35",

"active_entitlements": {"object": "list",

"items": [{"object": "customer.active_entitlement",

"entitlement_id": "entla1b2c3d4e5",

"expires_at": 1658399423658

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/active_entitlements?starting_after=entlab21dac",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/active_entitlements"

},

"experiment": {"object": "experiment_enrollment",

"id": "string",

"name": "string",

"variant": "a"

},

"attributes": {"object": "list",

"items": [{"object": "customer.attribute",

"name": "$email",

"value": "garfield@revenuecat.com",

"updated_at": 1658399423658

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/attributes?starting_after=myCustomAttribute",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/attributes"

}

}`

tag/Customer/operation/revoke-customer-granted-entitlement Revoke a granted entitlement from a customer

post/projects/{project_id}/customers/{customer_id}/actions/revoke_granted_entitlement

https://api.revenuecat.com/v2/projects/{project\_id}/customers/{customer\_id}/actions/revoke\_granted\_entitlement

Revokes a granted entitlement from a customer. As a side effect, the promotional subscription associated with the granted entitlement is expired. This endpoint requires the following permission(s): customer_information:customers:read_write. This endpoint belongs to the Customer Information domain, which has a default rate limit of 480 requests per minute.

Authorizations:

BearerAuth

path Parameters

Request Body schema: application/json required

Responses

200

Entitlement revoked successfully

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Request samples

• Payload

Content type

application/json

Copy

`{"entitlement_id": "entla1b2c3d4e5"

}`

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "customer",

"id": "19b8de26-77c1-49f1-aa18-019a391603e2",

"project_id": "proj1ab2c3d4",

"first_seen_at": 1658399423658,

"last_seen_at": 1658399423658,

"last_seen_app_version": "1.0.0",

"last_seen_country": "US",

"last_seen_platform": "android",

"last_seen_platform_version": "35",

"active_entitlements": {"object": "list",

"items": [{"object": "customer.active_entitlement",

"entitlement_id": "entla1b2c3d4e5",

"expires_at": 1658399423658

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/active_entitlements?starting_after=entlab21dac",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/active_entitlements"

},

"experiment": {"object": "experiment_enrollment",

"id": "string",

"name": "string",

"variant": "a"

},

"attributes": {"object": "list",

"items": [{"object": "customer.attribute",

"name": "$email",

"value": "garfield@revenuecat.com",

"updated_at": 1658399423658

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/attributes?starting_after=myCustomAttribute",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/attributes"

}

}`

tag/Customer/operation/assign-customer-offering Assign or clear an offering override for a customer

post/projects/{project_id}/customers/{customer_id}/actions/assign_offering

https://api.revenuecat.com/v2/projects/{project\_id}/customers/{customer\_id}/actions/assign\_offering

This endpoint requires the following permission(s): project_configuration:offerings:read, customer_information:customers:read_write. This endpoint belongs to the Customer Information domain, which has a default rate limit of 480 requests per minute.

Authorizations:

BearerAuth

path Parameters

Request Body schema: application/json required

Responses

200

Offering assigned successfully

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Request samples

• Payload

Content type

application/json

Copy

`{"offering_id": "offrng1b2c3d4e5"

}`

Response samples

• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Example

parameter_errorinvalid_requestparameter_error

Copy

`{"object": "error",

"type": "parameter_error",

"param": "customer_id",

"message": "id is too long",

"retryable": false,

"doc_url": "https://errors.rev.cat/parameter-error"

}`

tag/Customer/operation/restore-purchase-by-order-id Restore a Google Play purchase by order ID

post/projects/{project_id}/customers/{customer_id}/actions/restore_purchase_by_order_id

https://api.revenuecat.com/v2/projects/{project\_id}/customers/{customer\_id}/actions/restore\_purchase\_by\_order\_id

Restores a Google Play purchase to the specified customer using a Google Play order ID. This endpoint requires the following permission(s): customer_information:customers:read_write. This endpoint belongs to the Customer Information domain, which has a default rate limit of 480 requests per minute.

Authorizations:

BearerAuth

path Parameters

Request Body schema: application/json required

Responses

200

Purchase restored successfully

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Request samples

• Payload

Content type

application/json

Copy

`{"order_id": "GPA.1234-5678-9012-34567"

}`

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "customer",

"id": "19b8de26-77c1-49f1-aa18-019a391603e2",

"project_id": "proj1ab2c3d4",

"first_seen_at": 1658399423658,

"last_seen_at": 1658399423658,

"last_seen_app_version": "1.0.0",

"last_seen_country": "US",

"last_seen_platform": "android",

"last_seen_platform_version": "35",

"active_entitlements": {"object": "list",

"items": [{"object": "customer.active_entitlement",

"entitlement_id": "entla1b2c3d4e5",

"expires_at": 1658399423658

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/active_entitlements?starting_after=entlab21dac",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/active_entitlements"

},

"experiment": {"object": "experiment_enrollment",

"id": "string",

"name": "string",

"variant": "a"

},

"attributes": {"object": "list",

"items": [{"object": "customer.attribute",

"name": "$email",

"value": "garfield@revenuecat.com",

"updated_at": 1658399423658

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/attributes?starting_after=myCustomAttribute",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/attributes"

}

}`

tag/Customer/operation/list-subscriptions Get a list of subscriptions associated with a customer

get/projects/{project_id}/customers/{customer_id}/subscriptions

https://api.revenuecat.com/v2/projects/{project\_id}/customers/{customer\_id}/subscriptions

This endpoint requires the following permission(s): customer_information:subscriptions:read. This endpoint belongs to the Customer Information domain, which has a default rate limit of 480 requests per minute.

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "list",

"items": [{"object": "subscription",

"id": "sub1ab2c3d4e5",

"customer_id": "19b8de26-77c1-49f1-aa18-019a391603e2",

"original_customer_id": "19b8de26-77c1-49f1-aa18-019a391603e2",

"product_id": "prod1a2b3c4d5e",

"starts_at": 1658399423658,

"current_period_starts_at": 1658399423658,

"current_period_ends_at": 1658399423658,

"ends_at": 1658399423658,

"gives_access": true,

"pending_payment": true,

"auto_renewal_status": "will_renew",

"status": "trialing",

"total_revenue_in_usd": {"currency": "USD",

"gross": 9.99,

"commission": 2.99,

"tax": 0.75,

"proceeds": 6.25

},

"presented_offering_id": "ofrnge1a2b3c4d5",

"entitlements": {"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": null,

"grace_period_duration": null,

"trial_duration": null

},

"one_time": {"is_consumable": null

},

"created_at": 1658399423658,

"app_id": "app1a2b3c4",

"app": {"object": null,

"id": null,

"name": null,

"created_at": null,

"type": null,

"project_id": null,

"amazon": { }

},

"indicative_price": {"object": null,

"currency": null,

"country": null,

"amount_micros": null

},

"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/subscriptions/sub1a2b3c4d5e/entitlements?status=active&starting_after=entlab21dac",

"url": "/v2/projects/proj1ab2c3d4/subscriptions/sub1a2b3c4d5e/entitlements"

},

"environment": "production",

"store": "amazon",

"store_subscription_identifier": 12345678,

"ownership": "purchased",

"pending_changes": {"product": {"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",

"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"

},

"current_period_starts_at": 1658399423658,

"current_period_ends_at": 1660991423658,

"store_subscription_identifier": 12345679,

"auto_renewal_status": "will_renew",

"status": "active",

"pending_payment": false,

"gives_access": true

},

"country": "US",

"management_url": "https://apps.apple.com/account/subscriptions"\
}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/subscriptions?starting_after=sub1a2b3c4d",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/subscriptions"

}`

tag/Customer/operation/list-purchases Get a list of purchases associated with a customer

get/projects/{project_id}/customers/{customer_id}/purchases

https://api.revenuecat.com/v2/projects/{project\_id}/customers/{customer\_id}/purchases

This endpoint requires the following permission(s): customer_information:purchases:read. This endpoint belongs to the Customer Information domain, which has a default rate limit of 480 requests per minute.

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "list",

"items": [{"object": "purchase",

"id": "purch1a2b3c4d5e",

"customer_id": "19b8de26-77c1-49f1-aa18-019a391603e2",

"original_customer_id": "19b8de26-77c1-49f1-aa18-019a391603e2",

"product_id": "prod1a2b3c4d5e",

"purchased_at": 1658399423658,

"revenue_in_usd": {"currency": "USD",

"gross": 9.99,

"commission": 2.99,

"tax": 0.75,

"proceeds": 6.25

},

"quantity": 1,

"status": "owned",

"presented_offering_id": "ofrnge1a2b3c4d5",

"entitlements": {"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": null,

"grace_period_duration": null,

"trial_duration": null

},

"one_time": {"is_consumable": null

},

"created_at": 1658399423658,

"app_id": "app1a2b3c4",

"app": {"object": null,

"id": null,

"name": null,

"created_at": null,

"type": null,

"project_id": null,

"amazon": { }

},

"indicative_price": {"object": null,

"currency": null,

"country": null,

"amount_micros": null

},

"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/purchases/sub1a2b3c4d5e/entitlements?status=active&starting_after=entlab21dac",

"url": "/v2/projects/proj1ab2c3d4/purchases/sub1a2b3c4d5e/entitlements"

},

"environment": "production",

"store": "amazon",

"store_purchase_identifier": 12345678,

"ownership": "purchased",

"country": "US"

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/purchases?starting_after=purc1a2b3c4d5e",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/purchases"

}`

tag/Customer/operation/list-customer-active-entitlements Get a list of customer's active entitlements

get/projects/{project_id}/customers/{customer_id}/active_entitlements

https://api.revenuecat.com/v2/projects/{project\_id}/customers/{customer\_id}/active\_entitlements

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "list",

"items": [{"object": "customer.active_entitlement",

"entitlement_id": "entla1b2c3d4e5",

"expires_at": 1658399423658

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/active_entitlements?starting_after=entlab21dac",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/active_entitlements"

}`

tag/Customer/operation/list-customer-aliases Get a list of the customer's aliases

get/projects/{project_id}/customers/{customer_id}/aliases

https://api.revenuecat.com/v2/projects/{project\_id}/customers/{customer\_id}/aliases

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "list",

"items": [{"object": "customer.alias",

"id": "19b8de26-77c1-49f1-aa18-019a391603e2",

"created_at": 1658399423658

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/aliases?starting_after=9fjeja8fjed",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/aliases"

}`

tag/Customer/operation/list-virtual-currencies-balances Get a list of customer's virtual currencies balances

get/projects/{project_id}/customers/{customer_id}/virtual_currencies

https://api.revenuecat.com/v2/projects/{project\_id}/customers/{customer\_id}/virtual\_currencies

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "list",

"items": [{"object": "virtual_currency_balance",

"currency_code": "string",

"balance": 0,

"description": "string",

"name": "string"

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/virtual_currencies?starting_after=9fjeja8fjed",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/virtual_currencies"

}`

tag/Customer/operation/create-virtual-currencies-transaction Create a virtual currencies transaction

post/projects/{project_id}/customers/{customer_id}/virtual_currencies/transactions

https://api.revenuecat.com/v2/projects/{project\_id}/customers/{customer\_id}/virtual\_currencies/transactions

This endpoint requires the following permission(s): customer_information:purchases:read_write. This endpoint belongs to the Virtual Currencies - Create Transaction domain, which has a default rate limit of 480 requests per minute.

Authorizations:

BearerAuth

path Parameters

query Parameters

header Parameters

Request Body schema: application/json required

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"adjustments": {"property1": 0,

"property2": 0

},

"reference": "string"

}`

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "list",

"items": [{"object": "virtual_currency_balance",

"currency_code": "string",

"balance": 0,

"description": "string",

"name": "string"

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/virtual_currencies?starting_after=9fjeja8fjed",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/virtual_currencies"

}`

tag/Customer/operation/update-virtual-currencies-balance Update a virtual currencies balance without creating a transaction

post/projects/{project_id}/customers/{customer_id}/virtual_currencies/update_balance

https://api.revenuecat.com/v2/projects/{project\_id}/customers/{customer\_id}/virtual\_currencies/update\_balance

Authorizations:

BearerAuth

path Parameters

query Parameters

header Parameters

Request Body schema: application/json required

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"adjustments": {"property1": 0,

"property2": 0

},

"reference": "string"

}`

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "list",

"items": [{"object": "virtual_currency_balance",

"currency_code": "string",

"balance": 0,

"description": "string",

"name": "string"

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/virtual_currencies?starting_after=9fjeja8fjed",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/virtual_currencies"

}`

tag/Customer/operation/list-customer-attributes Get a list of the customer's attributes

get/projects/{project_id}/customers/{customer_id}/attributes

https://api.revenuecat.com/v2/projects/{project\_id}/customers/{customer\_id}/attributes

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "list",

"items": [{"object": "customer.attribute",

"name": "$email",

"value": "garfield@revenuecat.com",

"updated_at": 1658399423658

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/attributes?starting_after=myCustomAttribute",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/attributes"

}`

tag/Customer/operation/set-customer-attributes Set a customer's attributes

post/projects/{project_id}/customers/{customer_id}/attributes

https://api.revenuecat.com/v2/projects/{project\_id}/customers/{customer\_id}/attributes

Authorizations:

BearerAuth

path Parameters

Request Body schema: application/json required

Responses

200

Success. The customer attributes were set

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"attributes": [{"name": "$email",

"value": "support@revenuecat.com"

},

{"name": "$displayName",

"value": "John Appleseed"

},

{"name": "my_custom_attr",

"value": "custom value"

}

]

}`

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "list",

"items": [{"object": "customer.attribute",

"name": "$email",

"value": "garfield@revenuecat.com",

"updated_at": 1658399423658

}

],

"next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/attributes?starting_after=myCustomAttribute",

"url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/attributes"

}`

tag/Entitlement Entitlement

Operations about entitlements.

tag/Entitlement/operation/get-entitlement Get an entitlement

get/projects/{project_id}/entitlements/{entitlement_id}

https://api.revenuecat.com/v2/projects/{project\_id}/entitlements/{entitlement\_id}

This endpoint requires the following permission(s): project_configuration:entitlements:read. This endpoint belongs to the Project Configuration domain, which has a default rate limit of 60 requests per minute.

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"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",

"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"

}

}`

tag/Entitlement/operation/update-entitlement Update an entitlement

post/projects/{project_id}/entitlements/{entitlement_id}

https://api.revenuecat.com/v2/projects/{project\_id}/entitlements/{entitlement\_id}

This endpoint requires the following permission(s): project_configuration:entitlements:read_write. This endpoint belongs to the Project Configuration domain, which has a default rate limit of 60 requests per minute.

Authorizations:

BearerAuth

path Parameters

Request Body schema: application/json required

Responses

200

Success. The entitlement was updated

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Request samples

• Payload

Content type

application/json

Copy

`{"display_name": "Premium"

}`

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"state": "active",

"object": "entitlement",

"project_id": "proj1ab2c3d4",

"id": "entla1b2c3d4e5",

"lookup_key": "premium",

"display_name": "Premium",

"created_at": 1658399423658,

"products": {"object": "list",

"next_page": "/v2/projects/proj1ab2c3d4/entitlements/entle1a2b3c4d5/products?starting_after=prodeab21dac",

"url": "/v2/projects/proj1ab2c3d4/entitlements/entle1a2b3c4d5/products"

}

}`

tag/Entitlement/operation/delete-entitlement Delete an entitlement

delete/projects/{project_id}/entitlements/{entitlement_id}

https://api.revenuecat.com/v2/projects/{project\_id}/entitlements/{entitlement\_id}

Authorizations:

BearerAuth

path Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy

`{"object": "app",

"id": "string",

"deleted_at": 1658399423658

}`

tag/Entitlement/operation/list-entitlements Get a list of entitlements

get/projects/{project_id}/entitlements

https://api.revenuecat.com/v2/projects/{project\_id}/entitlements

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "list",

"next_page": "/v2/projects/proj1ab2c3d4/entitlements?starting_after=entlab21dac",

"url": "/v2/projects/proj1ab2c3d4/entitlements"

}`

tag/Entitlement/operation/create-entitlement Create an entitlement

post/projects/{project_id}/entitlements

https://api.revenuecat.com/v2/projects/{project\_id}/entitlements

Authorizations:

BearerAuth

path Parameters

Request Body schema: application/json required

Responses

201

Success. The entitlement was created

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Request samples

• Payload

Content type

application/json

Copy

`{"lookup_key": "premium",

"display_name": "Premium access to all features"

}`

Response samples

• 201
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"state": "active",

"object": "entitlement",

"project_id": "proj1ab2c3d4",

"id": "entla1b2c3d4e5",

"lookup_key": "premium",

"display_name": "Premium",

"created_at": 1658399423658,

"products": {"object": "list",

"next_page": "/v2/projects/proj1ab2c3d4/entitlements/entle1a2b3c4d5/products?starting_after=prodeab21dac",

"url": "/v2/projects/proj1ab2c3d4/entitlements/entle1a2b3c4d5/products"

}

}`

tag/Entitlement/operation/get-products-from-entitlement Get a list of products attached to a given entitlement

get/projects/{project_id}/entitlements/{entitlement_id}/products

https://api.revenuecat.com/v2/projects/{project\_id}/entitlements/{entitlement\_id}/products

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "list",

"next_page": "/v2/projects/proj1ab2c3d4/entitlements/entla1b2c3d4e5/products?starting_after=prod1a2b3c4d5",

"url": "/v2/projects/proj1ab2c3d4/entitlements/entla1b2c3d4e5/products"

}`

tag/Entitlement/operation/archive-entitlement Archive an entitlement

post/projects/{project_id}/entitlements/{entitlement_id}/actions/archive

https://api.revenuecat.com/v2/projects/{project\_id}/entitlements/{entitlement\_id}/actions/archive

Archives an entitlement (makes it inactive). This endpoint requires the following permission(s): project_configuration:entitlements:read_write. This endpoint belongs to the Project Configuration domain, which has a default rate limit of 60 requests per minute.

Authorizations:

BearerAuth

path Parameters

Responses

200

Success. The entitlement was archived

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"state": "active",

"object": "entitlement",

"project_id": "proj1ab2c3d4",

"id": "entla1b2c3d4e5",

"lookup_key": "premium",

"display_name": "Premium",

"created_at": 1658399423658,

"products": {"object": "list",

"next_page": "/v2/projects/proj1ab2c3d4/entitlements/entle1a2b3c4d5/products?starting_after=prodeab21dac",

"url": "/v2/projects/proj1ab2c3d4/entitlements/entle1a2b3c4d5/products"

}

}`

tag/Entitlement/operation/unarchive-entitlement Unarchive an entitlement

post/projects/{project_id}/entitlements/{entitlement_id}/actions/unarchive

https://api.revenuecat.com/v2/projects/{project\_id}/entitlements/{entitlement\_id}/actions/unarchive

Unarchives an entitlement (makes it active). This endpoint requires the following permission(s): project_configuration:entitlements:read_write. This endpoint belongs to the Project Configuration domain, which has a default rate limit of 60 requests per minute.

Authorizations:

BearerAuth

path Parameters

Responses

200

Success. The entitlement was unarchived

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"state": "active",

"object": "entitlement",

"project_id": "proj1ab2c3d4",

"id": "entla1b2c3d4e5",

"lookup_key": "premium",

"display_name": "Premium",

"created_at": 1658399423658,

"products": {"object": "list",

"next_page": "/v2/projects/proj1ab2c3d4/entitlements/entle1a2b3c4d5/products?starting_after=prodeab21dac",

"url": "/v2/projects/proj1ab2c3d4/entitlements/entle1a2b3c4d5/products"

}

}`

tag/Entitlement/operation/attach-products-to-entitlement Attach a set of products to an entitlement

post/projects/{project_id}/entitlements/{entitlement_id}/actions/attach_products

https://api.revenuecat.com/v2/projects/{project\_id}/entitlements/{entitlement\_id}/actions/attach\_products

Authorizations:

BearerAuth

path Parameters

Request Body schema: application/json required

Responses

200

Success. The products were attached to the entitlement

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"product_ids": ["prod1a2b3c4d5e"

]

}`

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"state": "active",

"object": "entitlement",

"project_id": "proj1ab2c3d4",

"id": "entla1b2c3d4e5",

"lookup_key": "premium",

"display_name": "Premium",

"created_at": 1658399423658,

"products": {"object": "list",

"next_page": "/v2/projects/proj1ab2c3d4/entitlements/entle1a2b3c4d5/products?starting_after=prodeab21dac",

"url": "/v2/projects/proj1ab2c3d4/entitlements/entle1a2b3c4d5/products"

}

}`

tag/Entitlement/operation/detach-products-from-entitlement Detach a set of product from an entitlement

post/projects/{project_id}/entitlements/{entitlement_id}/actions/detach_products

https://api.revenuecat.com/v2/projects/{project\_id}/entitlements/{entitlement\_id}/actions/detach\_products

Authorizations:

BearerAuth

path Parameters

Request Body schema: application/json required

Responses

200

Success. The products were detached from the entitlement

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"product_ids": ["prod1a2b3c4d5e"

]

}`

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"state": "active",

"object": "entitlement",

"project_id": "proj1ab2c3d4",

"id": "entla1b2c3d4e5",

"lookup_key": "premium",

"display_name": "Premium",

"created_at": 1658399423658,

"products": {"object": "list",

"next_page": "/v2/projects/proj1ab2c3d4/entitlements/entle1a2b3c4d5/products?starting_after=prodeab21dac",

"url": "/v2/projects/proj1ab2c3d4/entitlements/entle1a2b3c4d5/products"

}

}`

tag/Offering Offering

Operations about offerings.

tag/Offering/operation/get-offering Get an offering

get/projects/{project_id}/offerings/{offering_id}

https://api.revenuecat.com/v2/projects/{project\_id}/offerings/{offering\_id}

This endpoint requires the following permission(s): project_configuration:offerings:read. This endpoint belongs to the Project Configuration domain, which has a default rate limit of 60 requests per minute.

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"state": "active",

"object": "offering",

"id": "ofrnge1a2b3c4d5",

"lookup_key": "default",

"display_name": "The standard set of packages",

"is_current": true,

"created_at": 1658399423658,

"project_id": "proj1ab2c3d4",

"metadata": {"color": "blue",

"call_to_action": "Subscribe Now!"

},

"packages": {"object": "list",

"items": [{"object": "package",

"id": "pkge1a2b3c4d5",

"lookup_key": "monthly",

"display_name": "Monthly discounted with 3-day trial",

"position": 1,

"created_at": 1658399423658,

"products": {"object": "list",

"items": [{"product": {"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",

"amazon": {"package_name": null

}

},

"indicative_price": {"object": "indicative_price",

"currency": "USD",

"country": "US",

"amount_micros": "For 99.99, the value should be 99990000"

},

"display_name": "Premium Monthly 2023"

},

"eligibility_criteria": "all"

}

],

"next_page": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages/pkge1a2b3c4d5/products?starting_after=prodab21dac",

"url": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages/pkge1a2b3c4d5/products"

}

}

],

"next_page": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages?starting_after=pkgeab21dac",

"url": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages"

}

}`

tag/Offering/operation/update-offering Update an offering

post/projects/{project_id}/offerings/{offering_id}

https://api.revenuecat.com/v2/projects/{project\_id}/offerings/{offering\_id}

This endpoint requires the following permission(s): project_configuration:offerings:read_write. This endpoint belongs to the Project Configuration domain, which has a default rate limit of 60 requests per minute.

Authorizations:

BearerAuth

path Parameters

Request Body schema: application/json required

Responses

200

Success. The offering was updated

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"display_name": "premium access to features",

"is_current": true,

"metadata": {"color": "blue",

"call_to_action": "Subscribe Now!"

}

}`

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"state": "active",

"object": "offering",

"id": "ofrnge1a2b3c4d5",

"lookup_key": "default",

"display_name": "The standard set of packages",

"is_current": true,

"created_at": 1658399423658,

"project_id": "proj1ab2c3d4",

"metadata": {"color": "blue",

"call_to_action": "Subscribe Now!"

},

"packages": {"object": "list",

"next_page": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages?starting_after=pkgeab21dac",

"url": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages"

}

}`

tag/Offering/operation/delete-offering Delete an offering and its attached packages

delete/projects/{project_id}/offerings/{offering_id}

https://api.revenuecat.com/v2/projects/{project\_id}/offerings/{offering\_id}

Authorizations:

BearerAuth

path Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy

`{"object": "app",

"id": "string",

"deleted_at": 1658399423658

}`

tag/Offering/operation/archive-offering Archive an offering

post/projects/{project_id}/offerings/{offering_id}/actions/archive

https://api.revenuecat.com/v2/projects/{project\_id}/offerings/{offering\_id}/actions/archive

Archives an offering (makes it inactive). This endpoint requires the following permission(s): project_configuration:offerings:read_write. This endpoint belongs to the Project Configuration domain, which has a default rate limit of 60 requests per minute.

Authorizations:

BearerAuth

path Parameters

Responses

200

Success. The offering was archived

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"state": "active",

"object": "offering",

"id": "ofrnge1a2b3c4d5",

"lookup_key": "default",

"display_name": "The standard set of packages",

"is_current": true,

"created_at": 1658399423658,

"project_id": "proj1ab2c3d4",

"metadata": {"color": "blue",

"call_to_action": "Subscribe Now!"

},

"packages": {"object": "list",

"next_page": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages?starting_after=pkgeab21dac",

"url": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages"

}

}`

tag/Offering/operation/unarchive-offering Unarchive an offering

post/projects/{project_id}/offerings/{offering_id}/actions/unarchive

https://api.revenuecat.com/v2/projects/{project\_id}/offerings/{offering\_id}/actions/unarchive

Unarchives an offering (makes it active). This endpoint requires the following permission(s): project_configuration:offerings:read_write. This endpoint belongs to the Project Configuration domain, which has a default rate limit of 60 requests per minute.

Authorizations:

BearerAuth

path Parameters

Request Body schema: application/json optional

Responses

200

Success. The offering was unarchived

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Request samples

• Payload

Content type

application/json

Copy

`{"unarchive_referenced_entities": false

}`

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"state": "active",

"object": "offering",

"id": "ofrnge1a2b3c4d5",

"lookup_key": "default",

"display_name": "The standard set of packages",

"is_current": true,

"created_at": 1658399423658,

"project_id": "proj1ab2c3d4",

"metadata": {"color": "blue",

"call_to_action": "Subscribe Now!"

},

"packages": {"object": "list",

"next_page": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages?starting_after=pkgeab21dac",

"url": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages"

}

}`

tag/Offering/operation/list-offerings Get a list of offerings

get/projects/{project_id}/offerings

https://api.revenuecat.com/v2/projects/{project\_id}/offerings

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "list",

"items": [{"state": "active",

"object": "offering",

"id": "ofrnge1a2b3c4d5",

"lookup_key": "default",

"display_name": "The standard set of packages",

"is_current": true,

"created_at": 1658399423658,

"project_id": "proj1ab2c3d4",

"metadata": {"color": "blue",

"call_to_action": "Subscribe Now!"

},

"packages": {"object": "list",

"items": [{"object": "package",

"id": "pkge1a2b3c4d5",

"lookup_key": "monthly",

"display_name": "Monthly discounted with 3-day trial",

"position": 1,

"created_at": 1658399423658,

"products": {"object": "list",

"items": [{"product": {"state": null,

"object": null,

"id": null,

"store_identifier": null,

"type": null,

"subscription": null,

"one_time": null,

"created_at": null,

"app_id": null,

"app": null,

"indicative_price": null,

"display_name": null

},

"eligibility_criteria": "all"

}

],

"next_page": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages/pkge1a2b3c4d5/products?starting_after=prodab21dac",

"url": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages/pkge1a2b3c4d5/products"

}

}

],

"next_page": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages?starting_after=pkgeab21dac",

"url": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages"

}

}

],

"next_page": "/v2/projects/proj1ab2c3d4/offerings?starting_after=ofrngeab21da",

"url": "/v2/projects/proj1ab2c3d4/offerings"

}`

tag/Offering/operation/create-offering Create an offering

post/projects/{project_id}/offerings

https://api.revenuecat.com/v2/projects/{project\_id}/offerings

Authorizations:

BearerAuth

path Parameters

Request Body schema: application/json required

Responses

201

Success. The offering was created

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"lookup_key": "default",

"display_name": "The standard set of packages",

"metadata": {"color": "blue",

"call_to_action": "Subscribe Now!"

}

}`

Response samples

• 201
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"state": "active",

"object": "offering",

"id": "ofrnge1a2b3c4d5",

"lookup_key": "default",

"display_name": "The standard set of packages",

"is_current": true,

"created_at": 1658399423658,

"project_id": "proj1ab2c3d4",

"metadata": {"color": "blue",

"call_to_action": "Subscribe Now!"

},

"packages": {"object": "list",

"next_page": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages?starting_after=pkgeab21dac",

"url": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages"

}

}`

tag/Package Package

Operations about packages.

tag/Package/operation/get-package Get a package

get/projects/{project_id}/packages/{package_id}

https://api.revenuecat.com/v2/projects/{project\_id}/packages/{package\_id}

This endpoint requires the following permission(s): project_configuration:packages:read. This endpoint belongs to the Project Configuration domain, which has a default rate limit of 60 requests per minute.

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "package",

"id": "pkge1a2b3c4d5",

"lookup_key": "monthly",

"display_name": "Monthly discounted with 3-day trial",

"position": 1,

"created_at": 1658399423658,

"products": {"object": "list",

"items": [{"product": {"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",

"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"

},

"eligibility_criteria": "all"

}

],

"next_page": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages/pkge1a2b3c4d5/products?starting_after=prodab21dac",

"url": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages/pkge1a2b3c4d5/products"

}

}`

tag/Package/operation/update-package Update a package

post/projects/{project_id}/packages/{package_id}

https://api.revenuecat.com/v2/projects/{project\_id}/packages/{package\_id}

This endpoint requires the following permission(s): project_configuration:packages:read_write. This endpoint belongs to the Project Configuration domain, which has a default rate limit of 60 requests per minute.

Authorizations:

BearerAuth

path Parameters

Request Body schema: application/json required

Responses

200

Success. The package was updated

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Request samples

• Payload

Content type

application/json

Copy

`{"display_name": "monthly with one-week trial",

"position": 2

}`

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "package",

"id": "pkge1a2b3c4d5",

"lookup_key": "monthly",

"display_name": "Monthly discounted with 3-day trial",

"position": 1,

"created_at": 1658399423658,

"products": {"object": "list",

"next_page": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages/pkge1a2b3c4d5/products?starting_after=prodab21dac",

"url": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages/pkge1a2b3c4d5/products"

}

}`

tag/Package/operation/delete-package-from-offering Delete a package

delete/projects/{project_id}/packages/{package_id}

https://api.revenuecat.com/v2/projects/{project\_id}/packages/{package\_id}

Authorizations:

BearerAuth

path Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy

`{"object": "app",

"id": "string",

"deleted_at": 1658399423658

}`

tag/Package/operation/list-packages Get a list of packages in an offering

get/projects/{project_id}/offerings/{offering_id}/packages

https://api.revenuecat.com/v2/projects/{project\_id}/offerings/{offering\_id}/packages

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "list",

"next_page": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages?starting_after=pkgeab21dac",

"url": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages"

}`

tag/Package/operation/create-packages Create a package

post/projects/{project_id}/offerings/{offering_id}/packages

https://api.revenuecat.com/v2/projects/{project\_id}/offerings/{offering\_id}/packages

Authorizations:

BearerAuth

path Parameters

Request Body schema: application/json required

Responses

201

Success. The package was created

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Request samples

• Payload

Content type

application/json

Copy

`{"lookup_key": "monthly",

"display_name": "monthly with one-week trial",

"position": 1

}`

Response samples

• 201
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "package",

"id": "pkge1a2b3c4d5",

"lookup_key": "monthly",

"display_name": "Monthly discounted with 3-day trial",

"position": 1,

"created_at": 1658399423658,

"products": {"object": "list",

"next_page": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages/pkge1a2b3c4d5/products?starting_after=prodab21dac",

"url": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages/pkge1a2b3c4d5/products"

}

}`

tag/Package/operation/get-products-from-package Get a list of products attached to a given package of an offering

get/projects/{project_id}/packages/{package_id}/products

https://api.revenuecat.com/v2/projects/{project\_id}/packages/{package\_id}/products

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "list",

"next_page": "/v2/projects/proj1ab2c3d4/packages/pkge1a2b3c4d5/products?starting_after=prod1a2b3c4d5",

"url": "/v2/projects/proj1ab2c3d4/packages/pkge1a2b3c4d5/products"

}`

tag/Package/operation/attach-products-to-package Attach a set of products to a package

post/projects/{project_id}/packages/{package_id}/actions/attach_products

https://api.revenuecat.com/v2/projects/{project\_id}/packages/{package\_id}/actions/attach\_products

Authorizations:

BearerAuth

path Parameters

Request Body schema: application/json required

Responses

200

Success. The products were attached to the package.

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Request samples

• Payload

Content type

application/json

Example

Single product for package (applies to any store)Play Store with different products depending on SDK version (SDK v6+ and SDK <v5) for one packageSingle product for package (applies to any store)

Copy Expand all Collapse all

`{"products": [{"product_id": "prod1a2b3c4d5e",

"eligibility_criteria": "all"

}

]

}`

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "package",

"id": "pkge1a2b3c4d5",

"lookup_key": "monthly",

"display_name": "Monthly discounted with 3-day trial",

"position": 1,

"created_at": 1658399423658,

"products": {"object": "list",

"next_page": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages/pkge1a2b3c4d5/products?starting_after=prodab21dac",

"url": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages/pkge1a2b3c4d5/products"

}

}`

tag/Package/operation/detach-products-from-package Detach a set of products from a package

post/projects/{project_id}/packages/{package_id}/actions/detach_products

https://api.revenuecat.com/v2/projects/{project\_id}/packages/{package\_id}/actions/detach\_products

Authorizations:

BearerAuth

path Parameters

Request Body schema: application/json required

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"product_ids": ["prod1a2b3c4d5e"

]

}`

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"object": "package",

"id": "pkge1a2b3c4d5",

"lookup_key": "monthly",

"display_name": "Monthly discounted with 3-day trial",

"position": 1,

"created_at": 1658399423658,

"products": {"object": "list",

"next_page": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages/pkge1a2b3c4d5/products?starting_after=prodab21dac",

"url": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages/pkge1a2b3c4d5/products"

}

}`

tag/Product Product

Operations about products.

tag/Product/operation/get-product Get a product

get/projects/{project_id}/products/{product_id}

https://api.revenuecat.com/v2/projects/{project\_id}/products/{product\_id}

This endpoint requires the following permission(s): project_configuration:products:read. This endpoint belongs to the Project Configuration domain, which has a default rate limit of 60 requests per minute.

Authorizations:

BearerAuth

path Parameters

query Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"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",

"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"

}`

tag/Product/operation/update-product Update a product

post/projects/{project_id}/products/{product_id}

https://api.revenuecat.com/v2/projects/{project\_id}/products/{product\_id}

This endpoint requires the following permission(s): project_configuration:products:read_write. This endpoint belongs to the Project Configuration domain, which has a default rate limit of 60 requests per minute.

Authorizations:

BearerAuth

path Parameters

query Parameters

Request Body schema: application/json required

Responses

200

Success. The product was updated

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Request samples

• Payload

Content type

application/json

Copy

`{"display_name": "string"

}`

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy Expand all Collapse all

`{"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",

"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"

}`

tag/Product/operation/delete-product Delete a product

delete/projects/{project_id}/products/{product_id}

https://api.revenuecat.com/v2/projects/{project\_id}/products/{product\_id}

Authorizations:

BearerAuth

path Parameters

Responses

200

Success

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.

500

Internal server error

503

Internal server error

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 422
• 423
• 429
• 500
• 503

Content type

application/json

Copy

`{"object": "app",

"id": "string",

"deleted_at": 1658399423658

}`

tag/Product/operation/archive-product Archive a product

post/projects/{project_id}/products/{product_id}/actions/archive

https://api.revenuecat.com/v2/projects/{project\_id}/products/{product\_id}/actions/archive

Archives a product (makes it inactive). This endpoint requires the following permission(s): project_configuration:products:read_write. This endpoint belongs to the Project Configuration domain, which has a default rate limit of 60 requests per minute.

Authorizations:

BearerAuth

path Parameters

Responses

200

Success. The product was archived

400

Bad request

401

Unauthorized

403

Access denied

404

Not found

409

Conflict

422

Unprocessable entity

423

Locked

429

The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.