Skip to main content
Skip to navigation
API docs by Redocly

Offerings | REST API v1 Reference (1.0)

Download OpenAPI specification:Download

RevenueCat API v1 endpoint reference for Offerings.

Offerings

Part of the REST API v1 Reference.

Operations about offerings.

Endpoints

Override a Customer's Current Offering

Overrides the current Offering for a specific Customer

Authorizations:
BearerAuth
path Parameters
app_user_id
required
string

The App User ID of the Customer.

offering_uuid
required
string

The UUID for the offering you want to set as the override for the Customer. The UUID can be found in the URL of the offering. For example, the offering UUID in https://app.revenuecat.com/apps/abcd1234/offerings/ofrng1234567abc is ofrng1234567abc.

Responses

Response samples

Content type
application/json
{
  • "value": {
    }
}

Remove a Customer's Current Offering Override

Reset the offering overrides back to the current offering for a specific Customer

Authorizations:
BearerAuth
path Parameters
app_user_id
required
string

The App User ID of the Customer.

Responses

Response samples

Content type
application/json
{
  • "value": {
    }
}

Get Offerings

Gets the offerings for your app.

Authorizations:
BearerAuth
path Parameters
app_user_id
required
string

The App User ID used with the mobile SDK. The App User ID doesn't have to exist for the endpoint to work but it can affect the current offering depending on whether you have any Experiments running or have overridden the current offering for this specific App User ID.

header Parameters
X-Platform
string
Example: ios

Set the X-Platform header to fetch that platform's packages. Can be ios, android, amazon, stripe, roku, or paddle. This header is required if you use a legacy public API key to determine which store the products should be returned for. It is not required if you use a new, app-specific API key, in which case the products for the app associated with the API key will be returned.

Responses

Response samples

Content type
application/json
{
  • "value": {
    }
}

Get Authenticated Customer Offerings

Gets the offerings for the Customer identified by the access token. Returns the same response as Get Offerings.

Requires an Authentication access token. Authentication is in private beta.

Authorizations:
AccessToken

Responses

Response samples

Content type
application/json
{
  • "value": {
    }
}

Override the Authenticated Customer's Current Offering

Overrides the current Offering for the Customer identified by the access token. Works like Override a Customer's Current Offering.

Requires an Authentication access token. Authentication is in private beta.

Authorizations:
AccessToken
path Parameters
offering_uuid
required
string

The UUID for the offering you want to set as the override for the Customer. The UUID can be found in the URL of the offering. For example, the offering UUID in https://app.revenuecat.com/apps/abcd1234/offerings/ofrng1234567abc is ofrng1234567abc.

Responses

Response samples

Content type
application/json
{
  • "value": {
    }
}

Remove the Authenticated Customer's Current Offering Override

Resets the offering override back to the current offering for the Customer identified by the access token.

Requires an Authentication access token. Authentication is in private beta.

Authorizations:
AccessToken

Responses

Response samples

Content type
application/json
{
  • "value": {
    }
}

Endpoint Reference

All API v1 resources, one page each. General concepts (authentication, request format, URL parameters) live on the API v1 overview.