Skip to main content

Developer API (2.0.0)

Download OpenAPI specification:Download

App

Operations about apps.

Get a list of apps

This endpoint requires the following permission(s): project_configuration:apps:read.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

query Parameters
starting_after
string
Example: starting_after=ent12354
limit
integer
Default: 20
Example: limit=10

Responses

Response samples

Content type
application/json
{
  • "object": "list",
  • "items": [
    ],
  • "next_page": "/v2/projects/projec1a2b3c4d/apps?starting_after=app1a2b3c4d",
  • "url": "/v2/projects/projec1a2b3c4d/apps"
}

Create an App

This endpoint requires the following permission(s): project_configuration:apps:read_write.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

Request Body schema: application/json
required
name
required
string [ 1 .. 255 ] characters

The name of the app

type
required
string
Enum: "amazon" "app_store" "mac_app_store" "play_store" "stripe"

The platform of the app. Mac App Store is disabled by default. See Legacy Mac Apps for more details.

object

Amazon type details. Should only be used when type is amazon.

object

App Store type details. Should only be used when type is app_store.

object

Mac App Store type details. Should only be used when type is mac_app_store.

object

Play Store type details. Should only be used when type is play_store.

Responses

Request samples

Content type
application/json
Example
{
  • "name": "My App Store App",
  • "type": "app_store",
  • "app_store": {
    }
}

Response samples

Content type
application/json
{
  • "object": "app",
  • "id": "app1a2b3c4",
  • "name": "string",
  • "created_at": 1658399423658,
  • "type": "app_store",
  • "project_id": "proj1a2b3c4",
  • "amazon": {
    },
  • "app_store": {
    },
  • "mac_app_store": {
    },
  • "play_store": {
    }
}

Get an app

This endpoint requires the following permission(s): project_configuration:apps:read.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

app_id
required
string <= 255 characters
Example: app1ab2c3d4

ID of the app

Responses

Response samples

Content type
application/json
{
  • "object": "app",
  • "id": "app1a2b3c4",
  • "name": "string",
  • "created_at": 1658399423658,
  • "type": "app_store",
  • "project_id": "proj1a2b3c4",
  • "amazon": {
    },
  • "app_store": {
    },
  • "mac_app_store": {
    },
  • "play_store": {
    }
}

Update an app

This endpoint requires the following permission(s): project_configuration:apps:read_write.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

app_id
required
string <= 255 characters
Example: app1ab2c3d4

ID of the app

Request Body schema: application/json
required
name
string [ 1 .. 255 ] characters

The name of the app

object

Amazon type details. Should only be used when type is amazon.

object

App Store type details. Should only be used when type is app_store.

object

Legacy Mac App Store type details. Should only be used when type is mac_app_store.

object

Play Store type details. Should only be used when type is play_store.

Responses

Request samples

Content type
application/json
Example
{
  • "name": "New App name",
  • "app_store": {
    }
}

Response samples

Content type
application/json
{
  • "object": "app",
  • "id": "app1a2b3c4",
  • "name": "string",
  • "created_at": 1658399423658,
  • "type": "app_store",
  • "project_id": "proj1a2b3c4",
  • "amazon": {
    },
  • "app_store": {
    },
  • "mac_app_store": {
    },
  • "play_store": {
    }
}

Delete an app

This endpoint requires the following permission(s): project_configuration:apps:read_write.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

app_id
required
string <= 255 characters
Example: app1ab2c3d4

ID of the app

Responses

Response samples

Content type
application/json
{
  • "object": "app",
  • "id": "string",
  • "deleted_at": 1658399423658
}

Charts & Metrics

Operations about chart metrics.

Get overview metrics for a project

This endpoint requires the following permission(s): charts_metrics:overview:read.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

Responses

Response samples

Content type
application/json
{
  • "object": "overview_metrics",
  • "metrics": [
    ]
}

Entitlement

Operations about entitlements.

Get an entitlement

This endpoint requires the following permission(s): project_configuration:entitlements:read.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

entitlement_id
required
string [ 1 .. 255 ] characters
Example: entla1b2c3d4e5

ID of the entitlement

query Parameters
expand
Array of strings[ items [ 1 .. 5000 ] characters ]
Items Value: "product"
Example: expand=product

Specifies which fields in the response should be expanded. Accepted values are: product.

Responses

Response samples

Content type
application/json
{
  • "object": "entitlement",
  • "project_id": "proj1ab2c3d4",
  • "id": "entla1b2c3d4e5",
  • "lookup_key": "premium",
  • "display_name": "Premium",
  • "created_at": 1658399423658,
  • "products": {
    }
}

Update an entitlement

This endpoint requires the following permission(s): project_configuration:entitlements:read_write.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

entitlement_id
required
string [ 1 .. 255 ] characters
Example: entla1b2c3d4e5

ID of the entitlement

Request Body schema: application/json
required
display_name
required
string [ 1 .. 1500 ] characters

The display name of the entitlement

Responses

Request samples

Content type
application/json
{
  • "display_name": "Premium"
}

Response samples

Content type
application/json
{
  • "object": "entitlement",
  • "project_id": "proj1ab2c3d4",
  • "id": "entla1b2c3d4e5",
  • "lookup_key": "premium",
  • "display_name": "Premium",
  • "created_at": 1658399423658,
  • "products": {
    }
}

Delete an entitlement

This endpoint requires the following permission(s): project_configuration:entitlements:read_write.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

entitlement_id
required
string [ 1 .. 255 ] characters
Example: entla1b2c3d4e5

ID of the entitlement

Responses

Response samples

Content type
application/json
{
  • "object": "app",
  • "id": "string",
  • "deleted_at": 1658399423658
}

Get a list of entitlements

This endpoint requires the following permission(s): project_configuration:entitlements:read.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

query Parameters
starting_after
string
Example: starting_after=ent12354
limit
integer
Default: 20
Example: limit=10
expand
Array of strings[ items [ 1 .. 5000 ] characters ]
Items Value: "items.product"
Example: expand=items.product

Specifies which fields in the response should be expanded. Accepted values are: items.product.

Responses

Response samples

Content type
application/json
{
  • "object": "list",
  • "items": [
    ],
  • "next_page": "/v2/projects/proj1ab2c3d4/entitlements?starting_after=entlab21dac",
  • "url": "/v2/projects/proj1ab2c3d4/entitlements"
}

Create an entitlement

This endpoint requires the following permission(s): project_configuration:entitlements:read_write.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

Request Body schema: application/json
required
lookup_key
required
string [ 1 .. 200 ] characters

The identifier of the entitlement

display_name
required
string [ 1 .. 1500 ] characters

The display name of the entitlement

Responses

Request samples

Content type
application/json
{
  • "lookup_key": "premium",
  • "display_name": "Premium access to all features"
}

Response samples

Content type
application/json
{
  • "object": "entitlement",
  • "project_id": "proj1ab2c3d4",
  • "id": "entla1b2c3d4e5",
  • "lookup_key": "premium",
  • "display_name": "Premium",
  • "created_at": 1658399423658,
  • "products": {
    }
}

Get a list of products attached to a given entitlement

This endpoint requires the following permission(s): project_configuration:entitlements:read.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

entitlement_id
required
string [ 1 .. 255 ] characters
Example: entla1b2c3d4e5

ID of the entitlement

query Parameters
starting_after
string
Example: starting_after=ent12354
limit
integer
Default: 20
Example: limit=10

Responses

Response samples

Content type
application/json
{
  • "object": "list",
  • "items": [
    ],
  • "next_page": "/v2/projects/proj1ab2c3d4/entitlements/entla1b2c3d4e5/products?starting_after=prod1a2b3c4d5",
  • "url": "/v2/projects/proj1ab2c3d4/entitlements/entla1b2c3d4e5/products"
}

Attach a set of products to an entitlement

This endpoint requires the following permission(s): project_configuration:entitlements:read_write.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

entitlement_id
required
string [ 1 .. 255 ] characters
Example: entla1b2c3d4e5

ID of the entitlement

Request Body schema: application/json
required
product_ids
required
Array of strings [ 1 .. 50 ] characters [ items [ 1 .. 255 ] characters ]

IDs of the products to be attached to the entitlement.

Responses

Request samples

Content type
application/json
{
  • "product_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "object": "entitlement",
  • "project_id": "proj1ab2c3d4",
  • "id": "entla1b2c3d4e5",
  • "lookup_key": "premium",
  • "display_name": "Premium",
  • "created_at": 1658399423658,
  • "products": {
    }
}

Detach a set of product from an entitlement

This endpoint requires the following permission(s): project_configuration:entitlements:read_write.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

entitlement_id
required
string [ 1 .. 255 ] characters
Example: entla1b2c3d4e5

ID of the entitlement

Request Body schema: application/json
required
product_ids
required
Array of strings [ 1 .. 50 ] characters [ items [ 1 .. 255 ] characters ]

IDs of the products to be detached from the entitlement.

Responses

Request samples

Content type
application/json
{
  • "product_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "object": "entitlement",
  • "project_id": "proj1ab2c3d4",
  • "id": "entla1b2c3d4e5",
  • "lookup_key": "premium",
  • "display_name": "Premium",
  • "created_at": 1658399423658,
  • "products": {
    }
}

Offering

Operations about offerings.

Get an offering

This endpoint requires the following permission(s): project_configuration:offerings:read.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

offering_id
required
string [ 1 .. 255 ] characters
Example: ofrnge1a2b3c4d5

ID of the offering

query Parameters
expand
Array of strings[ items [ 1 .. 5000 ] characters ]
Items Enum: "package" "package.product"
Example: expand=package

Specifies which fields in the response should be expanded. Accepted values are: package, package.product.

Responses

Response samples

Content type
application/json
{
  • "object": "offering",
  • "id": "ofrnge1a2b3c4d5",
  • "lookup_key": "default",
  • "display_name": "The standard set of packages",
  • "is_current": true,
  • "created_at": 1658399423658,
  • "project_id": "proj1ab2c3d4",
  • "metadata": {
    },
  • "packages": {
    }
}

Update an offering

This endpoint requires the following permission(s): project_configuration:offerings:read_write.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

offering_id
required
string [ 1 .. 255 ] characters
Example: ofrnge1a2b3c4d5

ID of the offering

Request Body schema: application/json
required
display_name
string [ 1 .. 1500 ] characters

The display name of the offering

is_current
boolean

Indicates if the offering is the current offering

object or null (OfferingMetadata)

Custom metadata of the offering

Responses

Request samples

Content type
application/json
{
  • "display_name": "premium access to features",
  • "is_current": true,
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "object": "offering",
  • "id": "ofrnge1a2b3c4d5",
  • "lookup_key": "default",
  • "display_name": "The standard set of packages",
  • "is_current": true,
  • "created_at": 1658399423658,
  • "project_id": "proj1ab2c3d4",
  • "metadata": {
    },
  • "packages": {
    }
}

Delete an offering and its attached packages

This endpoint requires the following permission(s): project_configuration:offerings:read_write.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

offering_id
required
string [ 1 .. 255 ] characters
Example: ofrnge1a2b3c4d5

ID of the offering

Responses

Response samples

Content type
application/json
{
  • "object": "app",
  • "id": "string",
  • "deleted_at": 1658399423658
}

Get a list of offerings

This endpoint requires the following permission(s): project_configuration:offerings:read.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

query Parameters
starting_after
string
Example: starting_after=ent12354
limit
integer
Default: 20
Example: limit=10
expand
Array of strings[ items [ 1 .. 5000 ] characters ]
Items Enum: "items.package" "items.package.product"
Example: expand=items.package

Specifies which fields in the response should be expanded. Accepted values are: items.package, items.package.product.

Responses

Response samples

Content type
application/json
{
  • "object": "list",
  • "items": [
    ],
  • "next_page": "/v2/projects/proj1ab2c3d4/offerings?starting_after=ofrngeab21da",
  • "url": "/v2/projects/proj1ab2c3d4/offerings"
}

Create an offering

This endpoint requires the following permission(s): project_configuration:offerings:read_write.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

Request Body schema: application/json
required
lookup_key
required
string [ 1 .. 200 ] characters

The custom identifier of the offering

display_name
required
string [ 1 .. 1500 ] characters

The display_name of the offering

object or null (OfferingMetadata)

Custom metadata of the offering

Responses

Request samples

Content type
application/json
{
  • "lookup_key": "default",
  • "display_name": "The standard set of packages",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "object": "offering",
  • "id": "ofrnge1a2b3c4d5",
  • "lookup_key": "default",
  • "display_name": "The standard set of packages",
  • "is_current": true,
  • "created_at": 1658399423658,
  • "project_id": "proj1ab2c3d4",
  • "metadata": {
    },
  • "packages": {
    }
}

Package

Operations about packages.

Get a list of packages in an offering

This endpoint requires the following permission(s): project_configuration:packages:read.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

offering_id
required
string [ 1 .. 255 ] characters
Example: ofrnge1a2b3c4d5

ID of the offering

query Parameters
starting_after
string
Example: starting_after=ent12354
limit
integer
Default: 20
Example: limit=10
expand
Array of strings[ items [ 1 .. 5000 ] characters ]
Items Value: "items.product"
Example: expand=items.product

Specifies which fields in the response should be expanded. Accepted values are: items.product.

Responses

Response samples

Content type
application/json
{
  • "object": "list",
  • "items": [
    ],
  • "next_page": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages?starting_after=pkgeab21dac",
  • "url": "/v2/projects/proj1ab2c3d4/offerings/ofrnge1a2b3c4d5/packages"
}

Create a package

This endpoint requires the following permission(s): project_configuration:packages:read_write.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

offering_id
required
string [ 1 .. 255 ] characters
Example: ofrnge1a2b3c4d5

ID of the offering

Request Body schema: application/json
required
lookup_key
required
string [ 1 .. 200 ] characters

The lookup_key of the package

display_name
required
string [ 1 .. 1500 ] characters

The display name of the package

position
integer

The position of the package in the offering

Responses

Request samples

Content type
application/json
{
  • "lookup_key": "monthly",
  • "display_name": "monthly with one-week trial",
  • "position": 1
}

Response samples

Content type
application/json
{
  • "object": "package",
  • "id": "pkge1a2b3c4d5",
  • "lookup_key": "monthly",
  • "display_name": "Monthly discounted with 3-day trial",
  • "position": 1,
  • "created_at": 1658399423658,
  • "products": {
    }
}

Get a package

This endpoint requires the following permission(s): project_configuration:packages:read.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

package_id
required
string [ 1 .. 255 ] characters
Example: pkge1a2b3c4d5

ID of the package

query Parameters
expand
Array of strings[ items [ 1 .. 5000 ] characters ]
Items Value: "product"
Example: expand=product

Specifies which fields in the response should be expanded. Accepted values are: product.

Responses

Response samples

Content type
application/json
{
  • "object": "package",
  • "id": "pkge1a2b3c4d5",
  • "lookup_key": "monthly",
  • "display_name": "Monthly discounted with 3-day trial",
  • "position": 1,
  • "created_at": 1658399423658,
  • "products": {
    }
}

Update a package

This endpoint requires the following permission(s): project_configuration:packages:read_write.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

package_id
required
string [ 1 .. 255 ] characters
Example: pkge1a2b3c4d5

ID of the package

Request Body schema: application/json
required
display_name
string [ 1 .. 1500 ] characters

The display name of the package

position
integer >= 1

The position of the package within the offering

Responses

Request samples

Content type
application/json
{
  • "display_name": "monthly with one-week trial",
  • "position": 2
}

Response samples

Content type
application/json
{
  • "object": "package",
  • "id": "pkge1a2b3c4d5",
  • "lookup_key": "monthly",
  • "display_name": "Monthly discounted with 3-day trial",
  • "position": 1,
  • "created_at": 1658399423658,
  • "products": {
    }
}

Delete a package

This endpoint requires the following permission(s): project_configuration:packages:read_write.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

package_id
required
string [ 1 .. 255 ] characters
Example: pkge1a2b3c4d5

ID of the package

Responses

Response samples

Content type
application/json
{
  • "object": "app",
  • "id": "string",
  • "deleted_at": 1658399423658
}

Get a list of products attached to a given package of an offering

This endpoint requires the following permission(s): project_configuration:packages:read.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

package_id
required
string [ 1 .. 255 ] characters
Example: pkge1a2b3c4d5

ID of the package

query Parameters
starting_after
string
Example: starting_after=ent12354
limit
integer
Default: 20
Example: limit=10

Responses

Response samples

Content type
application/json
{
  • "object": "list",
  • "items": [
    ],
  • "next_page": "/v2/projects/proj1ab2c3d4/packages/pkge1a2b3c4d5/products?starting_after=prod1a2b3c4d5",
  • "url": "/v2/projects/proj1ab2c3d4/packages/pkge1a2b3c4d5/products"
}

Attach a set of products to a package

This endpoint requires the following permission(s): project_configuration:packages:read_write.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

package_id
required
string [ 1 .. 255 ] characters
Example: pkge1a2b3c4d5

ID of the package

Request Body schema: application/json
required
required
Array of objects (PackageProductIDAssociation) [ 1 .. 50 ] characters

Product association list

Array
product_id
required
string [ 1 .. 255 ] characters
eligibility_criteria
required
string (EligibilityCriteria)
Enum: "all" "google_sdk_lt_6" "google_sdk_ge_6"

Responses

Request samples

Content type
application/json
Example
{
  • "products": [
    ]
}

Response samples

Content type
application/json
{
  • "object": "package",
  • "id": "pkge1a2b3c4d5",
  • "lookup_key": "monthly",
  • "display_name": "Monthly discounted with 3-day trial",
  • "position": 1,
  • "created_at": 1658399423658,
  • "products": {
    }
}

Detach a set of products from a package

This endpoint requires the following permission(s): project_configuration:packages:read_write.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

package_id
required
string [ 1 .. 255 ] characters
Example: pkge1a2b3c4d5

ID of the package

Request Body schema: application/json
required
product_ids
required
Array of strings [ 1 .. 50 ] characters [ items [ 1 .. 255 ] characters ]

IDs of the products to detach from the package

Responses

Request samples

Content type
application/json
{
  • "product_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "object": "package",
  • "id": "pkge1a2b3c4d5",
  • "lookup_key": "monthly",
  • "display_name": "Monthly discounted with 3-day trial",
  • "position": 1,
  • "created_at": 1658399423658,
  • "products": {
    }
}

Product

Operations about products.

Get a product

This endpoint requires the following permission(s): project_configuration:products:read.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

product_id
required
string [ 1 .. 255 ] characters
Example: prod1a2b3c4d5

ID of the product

query Parameters
expand
Array of strings[ items [ 1 .. 5000 ] characters ]
Items Value: "app"
Example: expand=app

Specifies which fields in the response should be expanded. Accepted values are: app.

Responses

Response samples

Content type
application/json
{
  • "object": "product",
  • "id": "prod1a2b3c4d5e",
  • "store_identifier": "rc_1w_199",
  • "type": "subscription",
  • "subscription": {
    },
  • "created_at": 1658399423658,
  • "app_id": "app1a2b3c4",
  • "app": {
    },
  • "display_name": "Premium Monthly 2023"
}

Delete a product

This endpoint requires the following permission(s): project_configuration:products:read_write.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

product_id
required
string [ 1 .. 255 ] characters
Example: prod1a2b3c4d5

ID of the product

Responses

Response samples

Content type
application/json
{
  • "object": "app",
  • "id": "string",
  • "deleted_at": 1658399423658
}

Get a list of products

This endpoint requires the following permission(s): project_configuration:products:read.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

query Parameters
app_id
string
Example: app_id=app1a2b3c4

This is an optional query parameter to get a list of products of a given entitlement associated with a particular app

starting_after
string
Example: starting_after=ent12354
limit
integer
Default: 20
Example: limit=10
expand
Array of strings[ items [ 1 .. 5000 ] characters ]
Items Value: "items.app"
Example: expand=items.app

Specifies which fields in the response should be expanded. Accepted values are: items.app.

Responses

Response samples

Content type
application/json
{
  • "object": "list",
  • "items": [
    ],
  • "next_page": "/v2/projects/proj1ab2c3d4/products?starting_after=prodab21dac",
  • "url": "/v2/projects/proj1ab2c3d4/products"
}

Create a product

This endpoint requires the following permission(s): project_configuration:products:read_write.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

Request Body schema: application/json
required
store_identifier
required
string [ 1 .. 200 ] characters

The store identifier of the product.

  • For Apple App Store products this is the product ID of the subscription or in-app product.
  • For Google's Play Store, it should follow the format 'productId:basePlanId' for subscription products and SKU for one-time purchase products.
  • For Stripe, the product identifier that always starts with "prod_"
  • For Amazon, if it's a subscription, the term SKU of the subscription. If it's a one-time purchase, the SKU of the product.
app_id
required
string [ 1 .. 255 ] characters

The ID of the app

type
required
string (ProductType)
Enum: "subscription" "one_time"
display_name
string or null [ 1 .. 1500 ] characters

The display name of the product

Responses

Request samples

Content type
application/json
Example
{
  • "store_identifier": "com.revenuecat.magicweather.monthly9.99",
  • "app_id": "app1a2b3c4",
  • "type": "subscription",
  • "display_name": "Premium Monthly 2023"
}

Response samples

Content type
application/json
{
  • "object": "product",
  • "id": "prod1a2b3c4d5e",
  • "store_identifier": "rc_1w_199",
  • "type": "subscription",
  • "subscription": {
    },
  • "created_at": 1658399423658,
  • "app_id": "app1a2b3c4",
  • "app": {
    },
  • "display_name": "Premium Monthly 2023"
}

Project

Operations about projects.

Get a list of projects

This endpoint requires the following permission(s): project_configuration:projects:read.

Authorizations:
BearerAuth
query Parameters
starting_after
string
Example: starting_after=ent12354
limit
integer
Default: 20
Example: limit=10

Responses

Response samples

Content type
application/json
{
  • "object": "list",
  • "items": [
    ],
  • "next_page": "/v2/projects?starting_after=projab21dac",
  • "url": "/v2/projects"
}