What can I do with REST API v2?

REST API v2 follows RevenueCat's v2 paths, objects, list envelope and error format, so existing scripts keep working when you change the base URL and key. Authenticate with a secret key (Authorization: Bearer sk_...) or the dashboard session cookie. Lists return { "object": "list", "items": [...], "next_page": ..., "url": ... }; follow next_page to page. limit is 1 to 100 (default 20). RevenueDot-only endpoints are on Extensions.

Base URL: your server, for example http://localhost:8787 or https://revenuedot.example.com. The examples read REVENUEDOT_URL, PUBLIC_KEY, SECRET_KEY and PROJECT_ID from your shell.

Operations on this page (181)#

• Projects: List projects, Create a project
• Apps: List apps, Create an app, Get an app, Update an app and its store credentials, Delete an app, Get an app's public SDK key, Get a StoreKit configuration file, Issue a subscriber access token, List the products in the app's store, Import products from the app's store
• Products: List products, Create a product, Get a product, Update a product, Delete a product, List a product's prices, List a product's prices (old path), Add Test Store prices, Change a Test Store price, Remove a Test Store price, Archive a product, Unarchive a product, Create the product in its store
• Entitlements: List entitlements, Create an entitlement, Get an entitlement, Rename an entitlement, Delete an entitlement, Archive an entitlement, Unarchive an entitlement, List an entitlement's products, Attach products to an entitlement, Detach products from an entitlement
• Offerings: List offerings, Create an offering, Get an offering, Update an offering or make it current, Delete an offering, Duplicate an offering, Archive an offering, Unarchive an offering
• Packages: List an offering's packages, Create a package, Get a package, Update a package, Delete a package, List a package's products, Attach products to a package, Detach products from a package
• Customers: List or search customers, Create a customer, Get a customer, Delete a customer, List a customer's app user ids, List a customer's attributes, Set a customer's attributes, List a customer's active entitlements, List a customer's subscriptions, List a customer's one-time purchases, List a customer's events, Grant an entitlement, Revoke a granted entitlement, Assign an offering to a customer, Transfer a customer's purchases to another customer, Get the Customer Center configuration, Restore a purchase by its store order id, List the win-back offers Apple lets a customer redeem
• Subscriptions: Find subscriptions by store id, Get a subscription, List the entitlements a subscription unlocks, List a subscription's payments, Cancel a subscription (Google Play), Refund and revoke a subscription (Google Play), Extend a subscription, Refund one payment of a subscription (Google Play), Get where the customer manages a subscription
• Purchases: Find one-time purchases by store id, Get a one-time purchase, List the entitlements a purchase unlocks, Refund a one-time purchase (Google Play)
• Metrics: Overview metrics, Revenue over a date range
• Charts: Get chart data, Get available options for a chart, List the customers behind a chart, List chart annotations, Create a chart annotation, Get a chart annotation, Update a chart annotation, Delete a chart annotation, List active chart share links, Create a public chart share link, Revoke a chart share link, List saved charts, Save a chart view, Get a saved chart, Rename or update a saved chart, Delete a saved chart
• In-app currencies: List in-app currencies, Create an in-app currency, Get an in-app currency, Update an in-app currency, Delete an in-app currency, Archive an in-app currency, Unarchive an in-app currency, List a customer's balances, Credit or spend in-app currency, Change a balance without a ledger entry
• Audit log: List audit log entries
• Targeting: List audiences, Create an audience, Preview who matches, Known values for attribution and custom-attribute fields, Get an audience, Update an audience, Delete an unused audience, List targeting rules in order, Create a targeting rule, Set the evaluation order, Get a targeting rule, Update a targeting rule, Delete a targeting rule
• Experiments: List experiments, Create an offering experiment, Set the enrollment order, Estimate how many customers would join, Get an experiment, Update an experiment, Delete an experiment, Start or resume, Pause: enrolled customers keep their variant, nobody new joins, Stop for good, Results per variant, Export results as CSV
• Paywalls: List paywalls, Create a paywall, Get a paywall, Update a paywall's draft, Delete a paywall, Publish a paywall, Unpublish a paywall, Attach an offering to a paywall, Detach the offering from a paywall, Duplicate a paywall, List saved snapshots, Save a named snapshot, Restore a snapshot into the draft, Get a snapshot, Get the template form of a paywall, Store the template form of a paywall, List the template gallery, Validate paywall components, Whether the AI generator is available, Generate a paywall with AI, List images, Upload an image, List fonts, Upload a font, Download a paywall image or font, Download a built-in paywall icon, Delete an uploaded font
• Webhook integrations: List webhooks, Create a webhook, Get a webhook, Update a webhook, Delete a webhook
• Discounts: List discounts, Create a discount, Get a discount, Update a discount, Delete a discount, Enable a discount, Disable a discount, List a discount's codes, Create discount codes, Delete a discount code
• Invoices: List a customer's invoices, Download an invoice
• Collaborators: List collaborators

Projects#

Projects hold apps, the catalog, customers and webhooks.

List projects#

GET /v2/projects · Auth: secret key or dashboard session · Permissions: project_configuration:projects:read

A secret key sees its own project. A dashboard session sees every project the user is a member of.

Query parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: A page of results. Returns a list of Project.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.

Create a project#

POST /v2/projects · Auth: dashboard session · Permissions: project_configuration:projects:read_write

Needs a dashboard session: a secret key belongs to one project and cannot create another. The caller becomes the project's admin.

Request body (application/json)

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects" \
  -H "Content-Type: application/json" -d '{"name":"Scanner"}'

Responses

• 200: The project. Returns Project.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.

Apps#

One app per store, each with its public SDK key and store credentials.

List apps#

GET /v2/projects/{project_id}/apps · Auth: secret key or dashboard session · Permissions: project_configuration:apps:read

Path parameters

Query parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/apps" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: A page of results. Returns a list of App.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Create an app#

POST /v2/projects/{project_id}/apps · Auth: secret key or dashboard session · Permissions: project_configuration:apps:read_write

One app per store. app_store and mac_app_store need bundle_id; play_store, amazon and galaxy need package_name. The app gets a public SDK key with the store's prefix (pdl_ for Paddle, roku_ for Roku, galx_ for the Galaxy Store). Other fields in the store object are saved as store credentials (for example subscription_private_key, subscription_key_id, subscription_key_issuer, play_service_account_credentials_json, Amazon's shared_secret, Stripe's stripe_secret_key and stripe_webhook_secret, Paddle's paddle_api_key and paddle_webhook_secret, Roku's roku_api_key, the Galaxy Store's galaxy_service_account_id, galaxy_service_account_private_key and galaxy_iap_public_key). Secrets are sealed and never returned. A Stripe publishable key (pk_…), a Paddle client-side token or a malformed signing secret is refused with 400. Store commission programs (RevenueDot extension, as RevenueCat's app settings): app_store.small_business_program and mac_app_store.small_business_program (Apple's Small Business Program, 15% instead of 30%) and amazon.small_business_accelerator (Amazon's Small Business Accelerator Program, 20% instead of 30%) take { "enrolled": true, "periods": [{ "entry_date": "2024-01-01", "exit_date": null }] }: up to 10 periods, YYYY-MM-DD, an exit date after its entry date, no overlaps; null removes the program. Proceeds in charts, metrics, exports and the REST API are recomputed for the dates; webhooks and integration events already sent keep their values. galaxy is a RevenueDot extension: RevenueCat's v2 API has no Galaxy app object.

Path parameters

Request body (application/json)

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/apps" -H "Authorization: Bearer $SECRET_KEY" \
  -H "Content-Type: application/json" -d '{"name":"Scanner (iOS)","type":"app_store","app_store":{"bundle_id":"com.example.scanner"}}'

Responses

• 201: The app. Returns App.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Example 201 response:

{
  "object": "app",
  "id": "appugfw01uy",
  "name": "Scanner (iOS)",
  "created_at": 1790801342594,
  "type": "app_store",
  "project_id": "proj18pzzkao",
  "custom_url_scheme": "rc-4d13549313",
  "app_store": {
    "bundle_id": "com.example.scanner",
    "app_store_connect_api_key_configured": false,
    "subscription_key_configured": false,
    "app_store_connect_vendor_number": null
  }
}

Get an app#

GET /v2/projects/{project_id}/apps/{app_id} · Auth: secret key or dashboard session · Permissions: project_configuration:apps:read

Path parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/apps/$APP_ID" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: The app. Returns App.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Update an app and its store credentials#

POST /v2/projects/{project_id}/apps/{app_id} · Auth: secret key or dashboard session · Permissions: project_configuration:apps:read_write

Send only the store object of the app's own type. A field set to null removes that credential; other values replace it. RevenueDot extensions in the store object: notification_forward_url (copy store notifications to another URL, for example RevenueCat during a dual run; null or "" turns it off), track_new_purchases, allow_unsigned_receipts, xcode_certificate, app_apple_id, pubsub_audience, pubsub_service_account; Amazon shared_secret, sns_topic_arn; Stripe stripe_secret_key, stripe_webhook_secret, stripe_account_id, app_user_id_source (metadata, customer_id, anonymous), app_user_id_metadata_key, register_on (invoice_paid, invoice_created); Paddle paddle_webhook_secret, app_user_id_source (custom_data, anonymous), app_user_id_custom_data_key; Galaxy Store galaxy_iap_public_key. See App Store setup, Google Play setup, Amazon Appstore setup, Stripe setup, Paddle setup, Roku setup and Galaxy Store setup.

Path parameters

Request body (application/json)

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/apps/$APP_ID" -H "Authorization: Bearer $SECRET_KEY" \
  -H "Content-Type: application/json" -d '{"app_store":{"subscription_private_key":"-----BEGIN PRIVATE KEY-----\n…\n-----END PRIVATE KEY-----","subscription_key_id":"ABC123DEFG","subscription_key_issuer":"57246542-96fe-1a63-e053-0824d011072a"}}'

Responses

• 200: The app. Returns App.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Delete an app#

DELETE /v2/projects/{project_id}/apps/{app_id} · Auth: secret key or dashboard session · Permissions: project_configuration:apps:read_write

Deletes the app and its products. Purchase history stays.

Path parameters

Example request

curl -s -X DELETE "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/apps/$APP_ID" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: Deleted. Returns Deleted.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Example 200 response:

{
  "object": "app",
  "id": "…",
  "deleted_at": 1790801342625
}

Get an app's public SDK key#

GET /v2/projects/{project_id}/apps/{app_id}/public_api_keys · Auth: secret key or dashboard session · Permissions: project_configuration:apps:read

Path parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/apps/$APP_ID/public_api_keys" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: One key. Returns a list of PublicApiKey.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Example 200 response:

{
  "object": "list",
  "items": [
    {
      "object": "public_api_key",
      "id": "pk_appvnrm0a5h",
      "key": "test_ea5120a23e7b9626f8eff225a627762c",
      "environment": "sandbox",
      "app_id": "appvnrm0a5h",
      "created_at": 1790800900758
    }
  ],
  "next_page": null,
  "url": "/v2/projects/proj18pzzkao/apps/appvnrm0a5h/public_api_keys"
}

Get a StoreKit configuration file#

GET /v2/projects/{project_id}/apps/{app_id}/store_kit_config · Auth: secret key or dashboard session · Permissions: project_configuration:apps:read

A .storekit file for the products of an App Store app, to test purchases locally in Xcode. Prices come from the Test Store price when set, else 0.99.

Path parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/apps/$APP_ID/store_kit_config" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: The file contents.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Issue a subscriber access token#

POST /v2/projects/{project_id}/apps/{app_id}/authenticate · Auth: secret key or dashboard session · Permissions: iam:authorization:issue_token

A short-lived access token (one hour) for one app user id of one app. Send it as Authorization: Bearer rdat_... to the subscriber token endpoints (/v1/customer, /v1/customer/offerings ...), which answer for that app user id, or to any SDK endpoint for that app user id. It cannot be refreshed: ask for a new one. Only a hash of the token is stored.

Path parameters

Request body (application/json)

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/apps/$APP_ID/authenticate" -H "Authorization: Bearer $SECRET_KEY" \
  -H "Content-Type: application/json" -d '{"app_user_id":"user_1"}'

Responses

• 200: The token.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Example 200 response:

{
  "object": "authentication",
  "access_token": "rdat_3f0c1d0b9e8a7c6b5a4f3e2d1c0b9a8f7e6d5c4b3a2f1e0d9c8b7a6f5e4d3c2b",
  "expires_at": 1790804514034
}

List the products in the app's store#

GET /v2/projects/{project_id}/apps/{app_id}/store_products · Auth: secret key or dashboard session · RevenueDot extension · Permissions: project_configuration:products:read

What the app's store has, read with the credentials the app already has, every page of the store's lists, each item marked in_catalog. Nothing in the store changes. See Import products.

• App Store and Mac App Store: the App Store Connect API key (app_store_connect_api_key, _id, _issuer), a team key with the App Manager role. Subscriptions by subscription group, then in-app purchases (consumable, non-consumable, non-renewing).
• Google Play: the service account, with "View app information and download bulk reports (read-only)" in Play Console. One item per subscription base plan (subscription_id:base_plan_id) with its billing period, then one-time products (monetization.onetimeproducts, or the legacy inappproducts list where that API is not available).
• Stripe: the app's restricted key with "Products" read (it covers prices). One item per active price; recurring prices are subscriptions.

422 unprocessable_entity_error when the credential is missing or the store refuses it (the message names the role or permission), for Amazon (it has no API that lists in-app items; add products by SKU) and the Test Store. 422 store_error with retryable: true while the store cannot be reached.

Path parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/apps/$APP_ID/store_products" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: The store's products. next_page is always null: every store page has been read.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.
• 422: The request is valid but cannot be done in this state or for this store. Returns V2Error.

Example 200 response:

{
  "object": "list",
  "next_page": null,
  "url": "/v2/projects/proj18pzzkao/apps/app1a2b3c4d/store_products",
  "app_id": "app1a2b3c4d",
  "store": "app_store",
  "warnings": [],
  "items": [
    {
      "object": "store_product_listing",
      "store_identifier": "pro_monthly",
      "type": "subscription",
      "display_name": "Pro Monthly",
      "duration": "P1M",
      "store_state": "APPROVED",
      "group": {
        "id": "21000001",
        "name": "Pro"
      },
      "price": null,
      "importable": true,
      "note": null,
      "in_catalog": true,
      "product_id": "prod1a2b3c4d5e"
    },
    {
      "object": "store_product_listing",
      "store_identifier": "pro_annual",
      "type": "subscription",
      "display_name": "Pro Annual",
      "duration": "P1Y",
      "store_state": "APPROVED",
      "group": {
        "id": "21000001",
        "name": "Pro"
      },
      "price": null,
      "importable": true,
      "note": null,
      "in_catalog": false,
      "product_id": null
    },
    {
      "object": "store_product_listing",
      "store_identifier": "coins_100",
      "type": "consumable",
      "display_name": "100 coins",
      "duration": null,
      "store_state": "APPROVED",
      "group": null,
      "price": null,
      "importable": true,
      "note": null,
      "in_catalog": false,
      "product_id": null
    }
  ]
}

Import products from the app's store#

POST /v2/projects/{project_id}/apps/{app_id}/store_products/actions/import · Auth: secret key or dashboard session · RevenueDot extension · Permissions: project_configuration:products:read_write

Creates catalog products for the chosen store identifiers. The store is read again, so the type, duration and display name always come from the store. Products already in the catalog are left as they are and reported in existing; identifiers the store does not have, or cannot be imported, are reported in failed. Every created and existing product is attached to the entitlement_ids. With entitlement_ids, an API key also needs project_configuration:entitlements:read_write. Running the same import twice changes nothing. Flat-rate Stripe prices also become web products, so the web checkout can sell them.

201 when at least one product was created, else 200. Errors as for listing; 400 for an entitlement_ids entry that is not an entitlement of the project.

Path parameters

Request body (application/json)

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/apps/$APP_ID/store_products/actions/import" -H "Authorization: Bearer $SECRET_KEY" \
  -H "Content-Type: application/json" -d '{"store_identifiers":["pro_annual","coins_100"],"entitlement_ids":["entl1a2b3c4d5e"]}'

Responses

• 200: Nothing new was created. Returns StoreProductImport.
• 201: Products were created. Returns StoreProductImport.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.
• 422: The request is valid but cannot be done in this state or for this store. Returns V2Error.

Products#

Store products.

List products#

GET /v2/projects/{project_id}/products · Auth: secret key or dashboard session · Permissions: project_configuration:products:read

Path parameters

Query parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/products" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: A page of results. Returns a list of Product.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Create a product#

POST /v2/projects/{project_id}/products · Auth: secret key or dashboard session · Permissions: project_configuration:products:read_write

store_identifier is the store's product id. For Google Play subscriptions use subscriptionId:basePlanId; for an App Store monthly billing plan with a 12-month commitment (iOS 26.4) use productId:monthly. Set subscription.duration (ISO 8601, for example P1M): the Test Store uses it as the period, and MRR uses it for every store. test_store_price sets what the SDK shows for a Test Store product.

Path parameters

Query parameters

Request body (application/json)

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/products" -H "Authorization: Bearer $SECRET_KEY" \
  -H "Content-Type: application/json" -d '{"store_identifier":"pro_monthly","app_id":"appvnrm0a5h","type":"subscription","display_name":"Pro monthly","subscription":{"duration":"P1M"}}'

Responses

• 201: The product. Returns Product.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.
• 409: It already exists, or it conflicts with another object. Returns V2Error.

Example 201 response:

{
  "object": "product",
  "id": "prode0zhpfisko",
  "store_identifier": "pro_monthly",
  "type": "subscription",
  "state": "active",
  "subscription": {
    "duration": "P1M",
    "grace_period_duration": null,
    "trial_duration": null
  },
  "created_at": 1790800900948,
  "app_id": "appvnrm0a5h",
  "display_name": "Pro monthly"
}

Get a product#

GET /v2/projects/{project_id}/products/{product_id} · Auth: secret key or dashboard session · Permissions: project_configuration:products:read

Path parameters

Query parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/products/$PRODUCT_ID" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: The product. Returns Product.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Example 200 response:

{
  "object": "product",
  "id": "prode0zhpfisko",
  "store_identifier": "pro_monthly",
  "type": "subscription",
  "state": "active",
  "subscription": {
    "duration": "P1M",
    "grace_period_duration": null,
    "trial_duration": null
  },
  "created_at": 1790800900948,
  "app_id": "appvnrm0a5h",
  "display_name": "Pro monthly"
}

Update a product#

POST /v2/projects/{project_id}/products/{product_id} · Auth: secret key or dashboard session · Permissions: project_configuration:products:read_write

RevenueDot also lets you correct type and subscription.duration (null clears it), and set or clear test_store_price.

Path parameters

Query parameters

Request body (application/json)

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/products/$PRODUCT_ID" -H "Authorization: Bearer $SECRET_KEY" \
  -H "Content-Type: application/json" -d '{"display_name":"Pro (monthly)","test_store_price":{"amount_micros":9990000,"currency":"USD"}}'

Responses

• 200: The product. Returns Product.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Delete a product#

DELETE /v2/projects/{project_id}/products/{product_id} · Auth: secret key or dashboard session · Permissions: project_configuration:products:read_write

Detaches it from entitlements and packages. Purchase history keeps the store id.

Path parameters

Example request

curl -s -X DELETE "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/products/$PRODUCT_ID" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: Deleted. Returns Deleted.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Example 200 response:

{
  "object": "product",
  "id": "…",
  "deleted_at": 1790801342625
}

List a product's prices#

GET /v2/projects/{project_id}/products/{product_id}/prices · Auth: secret key or dashboard session · Permissions: project_configuration:products:read

Every price of a Test Store product, one per currency, the default first (the default is what indicative_price shows and what a customer whose currency has no price sees). For a Stripe web product, its Stripe price (id is the Stripe price id). Other products answer 400. The answer is a JSON array, not a list object, as in RevenueCat.

Path parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/products/$PRODUCT_ID/prices" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: The prices.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Example 200 response:

[
  {
    "id": "prcx8k2m4q9w1z7d",
    "currency": "USD",
    "amount_micros": 9990000
  },
  {
    "id": "prc3n6p0r8t2v4b5",
    "currency": "EUR",
    "amount_micros": 8990000
  }
]

List a product's prices (old path)#

GET /v2/projects/{project_id}/products/{product_id}/test_store_prices · Auth: secret key or dashboard session · Permissions: project_configuration:products:read

The same as GET …/prices. Deprecated in RevenueCat; use …/prices.

Path parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/products/$PRODUCT_ID/test_store_prices" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: The prices.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Add Test Store prices#

POST /v2/projects/{project_id}/products/{product_id}/test_store_prices · Auth: secret key or dashboard session · Permissions: project_configuration:products:read_write

Adds a price in each currency (Test Store products only; other products answer 400). Each currency once per request. A currency the product already has gets the new amount. A product without a price gets USD as its default when USD is among them, else the first one. The SDK shows each customer the price in their storefront's currency, else the default. Answers the prices it wrote, as an array.

Path parameters

Request body (application/json)

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/products/$PRODUCT_ID/test_store_prices" -H "Authorization: Bearer $SECRET_KEY" \
  -H "Content-Type: application/json" -d '{"prices":[{"currency":"EUR","amount_micros":8990000},{"currency":"GBP","amount_micros":7990000}]}'

Responses

• 201: The prices written.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Example 201 response:

[
  {
    "id": "prc3n6p0r8t2v4b5",
    "currency": "EUR",
    "amount_micros": 8990000
  },
  {
    "id": "prc9d1f3h5j7l2c4",
    "currency": "GBP",
    "amount_micros": 7990000
  }
]

Change a Test Store price#

PATCH /v2/projects/{project_id}/products/{product_id}/prices/{currency} · Auth: secret key or dashboard session · Permissions: project_configuration:products:read_write

Sets the amount of the product's price in this currency. 404 when the product has no price in it (add one with POST …/test_store_prices).

Path parameters

Request body (application/json)

Example request

curl -s -X PATCH "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/products/$PRODUCT_ID/prices/$CURRENCY" -H "Authorization: Bearer $SECRET_KEY" \
  -H "Content-Type: application/json" -d '{"amount_micros":9490000}'

Responses

• 200: The price. Returns ProductPrice.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Example 200 response:

{
  "id": "prc3n6p0r8t2v4b5",
  "currency": "EUR",
  "amount_micros": 9490000
}

Remove a Test Store price#

DELETE /v2/projects/{project_id}/products/{product_id}/prices/{currency} · Auth: secret key or dashboard session · RevenueDot extension · Permissions: project_configuration:products:read_write

RevenueDot extension (RevenueCat has no way to remove a currency). Removing the default price makes USD, else the first remaining currency, the default; removing the last price leaves the product without one.

Path parameters

Example request

curl -s -X DELETE "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/products/$PRODUCT_ID/prices/$CURRENCY" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: Removed.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Example 200 response:

{
  "object": "product_price",
  "id": "prcx8k2m4n7q1z",
  "currency": "GBP",
  "deleted_at": 1790801342625
}

Archive a product#

POST /v2/projects/{project_id}/products/{product_id}/actions/archive · Auth: secret key or dashboard session · Permissions: project_configuration:products:read_write

Path parameters

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/products/$PRODUCT_ID/actions/archive" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: The archived product. Returns Product.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Unarchive a product#

POST /v2/projects/{project_id}/products/{product_id}/actions/unarchive · Auth: secret key or dashboard session · Permissions: project_configuration:products:read_write

Path parameters

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/products/$PRODUCT_ID/actions/unarchive" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: The product. Returns Product.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Create the product in its store#

POST /v2/projects/{project_id}/products/{product_id}/create_in_store · Auth: secret key or dashboard session · Permissions: project_configuration:products:read_write

Creates a catalog product in the store its app belongs to. The product's display name becomes the store name.

• App Store (needs the app's App Store Connect API key with the App Manager role: app_store_connect_api_key, app_store_connect_api_key_id, app_store_connect_api_key_issuer). A subscription needs store_information with duration and subscription_group_name (or subscription_group_id); the group is reused by name or created. Consumables, non-consumables and non-renewing subscriptions need no body. Add prices, a review screenshot and localizations in App Store Connect before submitting.
• Google Play (a RevenueDot addition; needs the service account with "Manage store presence"): a subscription with one listing in the app's default language. Add its base plans and prices in Play Console. One-time products answer 422, because Google needs a price to create them.

409 when the store already has the product id, 422 without the credentials or for another store, 422 store_error with retryable: true while the store is down.

Path parameters

Request body (application/json)

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/products/$PRODUCT_ID/create_in_store" -H "Authorization: Bearer $SECRET_KEY" \
  -H "Content-Type: application/json" -d '{"store_information":{"duration":"ONE_MONTH","subscription_group_name":"Pro"}}'

Responses

• 201: The product in the store.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.
• 409: It already exists, or it conflicts with another object. Returns V2Error.
• 422: The request is valid but cannot be done in this state or for this store. Returns V2Error.

Example 201 response:

{
  "created_product": {
    "object": "store_product",
    "id": "6743920115",
    "name": "Pro Monthly",
    "product_identifier": "pro_monthly"
  }
}

Entitlements#

The access your app checks, unlocked by products.

List entitlements#

GET /v2/projects/{project_id}/entitlements · Auth: secret key or dashboard session · Permissions: project_configuration:entitlements:read

Path parameters

Query parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/entitlements" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: A page of results. Returns a list of Entitlement.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Create an entitlement#

POST /v2/projects/{project_id}/entitlements · Auth: secret key or dashboard session · Permissions: project_configuration:entitlements:read_write

Path parameters

Request body (application/json)

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/entitlements" -H "Authorization: Bearer $SECRET_KEY" \
  -H "Content-Type: application/json" -d '{"lookup_key":"pro","display_name":"Pro access"}'

Responses

• 201: The entitlement. Returns Entitlement.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.
• 409: It already exists, or it conflicts with another object. Returns V2Error.

Example 201 response:

{
  "object": "entitlement",
  "id": "entl1v0bp6r0qs",
  "project_id": "proj18pzzkao",
  "lookup_key": "pro",
  "display_name": "Pro access",
  "created_at": 1790800901115,
  "state": "active"
}

Get an entitlement#

GET /v2/projects/{project_id}/entitlements/{entitlement_id} · Auth: secret key or dashboard session · Permissions: project_configuration:entitlements:read

Path parameters

Query parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/entitlements/$ENTITLEMENT_ID" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: The entitlement. Returns Entitlement.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Example 200 response:

{
  "object": "entitlement",
  "id": "entl1v0bp6r0qs",
  "project_id": "proj18pzzkao",
  "lookup_key": "pro",
  "display_name": "Pro access",
  "created_at": 1790800901115,
  "state": "active"
}

Rename an entitlement#

POST /v2/projects/{project_id}/entitlements/{entitlement_id} · Auth: secret key or dashboard session · Permissions: project_configuration:entitlements:read_write

Path parameters

Request body (application/json)

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/entitlements/$ENTITLEMENT_ID" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: The entitlement. Returns Entitlement.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Delete an entitlement#

DELETE /v2/projects/{project_id}/entitlements/{entitlement_id} · Auth: secret key or dashboard session · Permissions: project_configuration:entitlements:read_write

Path parameters

Example request

curl -s -X DELETE "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/entitlements/$ENTITLEMENT_ID" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: Deleted. Returns Deleted.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Example 200 response:

{
  "object": "entitlement",
  "id": "…",
  "deleted_at": 1790801342625
}

Archive an entitlement#

POST /v2/projects/{project_id}/entitlements/{entitlement_id}/actions/archive · Auth: secret key or dashboard session · Permissions: project_configuration:entitlements:read_write

Path parameters

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/entitlements/$ENTITLEMENT_ID/actions/archive" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: The archived entitlement. Returns Entitlement.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Unarchive an entitlement#

POST /v2/projects/{project_id}/entitlements/{entitlement_id}/actions/unarchive · Auth: secret key or dashboard session · Permissions: project_configuration:entitlements:read_write

Path parameters

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/entitlements/$ENTITLEMENT_ID/actions/unarchive" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: The entitlement. Returns Entitlement.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

List an entitlement's products#

GET /v2/projects/{project_id}/entitlements/{entitlement_id}/products · Auth: secret key or dashboard session · Permissions: project_configuration:entitlements:read

Path parameters

Query parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/entitlements/$ENTITLEMENT_ID/products" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: A page of results. Returns a list of Product.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Attach products to an entitlement#

POST /v2/projects/{project_id}/entitlements/{entitlement_id}/actions/attach_products · Auth: secret key or dashboard session · Permissions: project_configuration:entitlements:read_write

Any of these products unlocks the entitlement. Every id must belong to the project, or nothing changes.

Path parameters

Request body (application/json)

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/entitlements/$ENTITLEMENT_ID/actions/attach_products" -H "Authorization: Bearer $SECRET_KEY" \
  -H "Content-Type: application/json" -d '{"product_ids":["prode0zhpfisko","prodz2c0dt6z9x"]}'

Responses

• 200: The entitlement with its products. Returns Entitlement.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Detach products from an entitlement#

POST /v2/projects/{project_id}/entitlements/{entitlement_id}/actions/detach_products · Auth: secret key or dashboard session · Permissions: project_configuration:entitlements:read_write

Path parameters

Request body (application/json)

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/entitlements/$ENTITLEMENT_ID/actions/detach_products" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: The entitlement with its products. Returns Entitlement.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Offerings#

Groups of packages the paywall shows.

List offerings#

GET /v2/projects/{project_id}/offerings · Auth: secret key or dashboard session · Permissions: project_configuration:offerings:read

Path parameters

Query parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/offerings" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: A page of results. Returns a list of Offering.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Create an offering#

POST /v2/projects/{project_id}/offerings · Auth: secret key or dashboard session · Permissions: project_configuration:offerings:read_write

The project's first offering becomes current.

Path parameters

Request body (application/json)

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/offerings" -H "Authorization: Bearer $SECRET_KEY" \
  -H "Content-Type: application/json" -d '{"lookup_key":"default","display_name":"Standard plans"}'

Responses

• 201: The offering. Returns Offering.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.
• 409: It already exists, or it conflicts with another object. Returns V2Error.

Get an offering#

GET /v2/projects/{project_id}/offerings/{offering_id} · Auth: secret key or dashboard session · Permissions: project_configuration:offerings:read

Path parameters

Query parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/offerings/$OFFERING_ID" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: The offering. Returns Offering.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Update an offering or make it current#

POST /v2/projects/{project_id}/offerings/{offering_id} · Auth: secret key or dashboard session · Permissions: project_configuration:offerings:read_write

is_current: true makes it the only current offering. An archived offering cannot be made current (422).

Path parameters

Request body (application/json)

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/offerings/$OFFERING_ID" -H "Authorization: Bearer $SECRET_KEY" \
  -H "Content-Type: application/json" -d '{"is_current":true}'

Responses

• 200: The offering. Returns Offering.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.
• 422: The request is valid but cannot be done in this state or for this store. Returns V2Error.

Delete an offering#

DELETE /v2/projects/{project_id}/offerings/{offering_id} · Auth: secret key or dashboard session · Permissions: project_configuration:offerings:read_write

Deletes its packages and clears customer overrides that point to it. An offering that a draft, running or paused experiment uses (as a variant's offering or a placement offering) answers 409 and names the experiment: stop the experiment or pick another offering in it first. A stopped experiment keeps its results and shows the deleted offering's id.

Path parameters

Example request

curl -s -X DELETE "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/offerings/$OFFERING_ID" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: Deleted. Returns Deleted.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.
• 409: It already exists, or it conflicts with another object. Returns V2Error.

Example 200 response:

{
  "object": "offering",
  "id": "…",
  "deleted_at": 1790801342625
}

Duplicate an offering#

POST /v2/projects/{project_id}/offerings/{offering_id}/actions/duplicate · Auth: secret key or dashboard session · RevenueDot extension · Permissions: project_configuration:offerings:read_write

Copies an offering with its packages, for an experiment's treatment. The copy is never current. Without packages the copy is exact: every package in order, with the same products. With packages, the list sets which packages are copied and in what order, and a package's products replaces its products (to test another price, period, trial or introductory offer). copy_paywall copies the offering's paywall, draft and published content, onto the copy.

Answers 400 when a source_package_id is not a package of this offering or repeats, a product is not in the project or repeats in a package, or copy_paywall is true and the offering has no paywall. Answers 409 when the lookup_key is taken, or two products of the same app in a package have overlapping eligibility_criteria.

Path parameters

Request body (application/json)

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/offerings/$OFFERING_ID/actions/duplicate" -H "Authorization: Bearer $SECRET_KEY" \
  -H "Content-Type: application/json" -d '{"lookup_key":"default_price","display_name":"Standard plans (price point)","packages":[{"source_package_id":"pkge1a2b3c4d5e","products":[{"product_id":"prod9k8j7h6g5f","eligibility_criteria":"all"}]},{"source_package_id":"pkge6f7g8h9i0j"}]}'

Responses

• 201: The copy, with its packages and their products expanded. Returns Offering.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.
• 409: It already exists, or it conflicts with another object. Returns V2Error.

Archive an offering#

POST /v2/projects/{project_id}/offerings/{offering_id}/actions/archive · Auth: secret key or dashboard session · Permissions: project_configuration:offerings:read_write

An offering that a draft, running or paused experiment uses cannot be archived (409); the current offering cannot be archived (422).

Path parameters

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/offerings/$OFFERING_ID/actions/archive" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: The archived offering. Returns Offering.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.
• 409: It already exists, or it conflicts with another object. Returns V2Error.
• 422: The request is valid but cannot be done in this state or for this store. Returns V2Error.

Unarchive an offering#

POST /v2/projects/{project_id}/offerings/{offering_id}/actions/unarchive · Auth: secret key or dashboard session · Permissions: project_configuration:offerings:read_write

Path parameters

Request body (application/json)

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/offerings/$OFFERING_ID/actions/unarchive" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: The offering. Returns Offering.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Packages#

One choice on the paywall, with one product per app.

List an offering's packages#

GET /v2/projects/{project_id}/offerings/{offering_id}/packages · Auth: secret key or dashboard session · Permissions: project_configuration:packages:read

Ordered by position, then creation: the order the SDK shows them in.

Path parameters

Query parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/offerings/$OFFERING_ID/packages" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: A page of results. Returns a list of Package.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Create a package#

POST /v2/projects/{project_id}/offerings/{offering_id}/packages · Auth: secret key or dashboard session · Permissions: project_configuration:packages:read_write

Use the standard lookup keys ($rc_monthly, $rc_annual, $rc_weekly, $rc_lifetime ...) so the SDK's convenience accessors work. Without position, the package goes last.

Path parameters

Request body (application/json)

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/offerings/$OFFERING_ID/packages" -H "Authorization: Bearer $SECRET_KEY" \
  -H "Content-Type: application/json" -d '{"lookup_key":"$rc_monthly","display_name":"Monthly","position":0}'

Responses

• 201: The package. Returns Package.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.
• 409: It already exists, or it conflicts with another object. Returns V2Error.

Get a package#

GET /v2/projects/{project_id}/packages/{package_id} · Auth: secret key or dashboard session · Permissions: project_configuration:packages:read

Path parameters

Query parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/packages/$PACKAGE_ID" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: The package. Returns Package.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Update a package#

POST /v2/projects/{project_id}/packages/{package_id} · Auth: secret key or dashboard session · Permissions: project_configuration:packages:read_write

Path parameters

Request body (application/json)

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/packages/$PACKAGE_ID" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: The package. Returns Package.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Delete a package#

DELETE /v2/projects/{project_id}/packages/{package_id} · Auth: secret key or dashboard session · Permissions: project_configuration:packages:read_write

Path parameters

Example request

curl -s -X DELETE "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/packages/$PACKAGE_ID" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: Deleted. Returns Deleted.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Example 200 response:

{
  "object": "package",
  "id": "…",
  "deleted_at": 1790801342625
}

List a package's products#

GET /v2/projects/{project_id}/packages/{package_id}/products · Auth: secret key or dashboard session · Permissions: project_configuration:packages:read

Path parameters

Query parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/packages/$PACKAGE_ID/products" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: A page of results. Returns a list of PackageProduct.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Attach products to a package#

POST /v2/projects/{project_id}/packages/{package_id}/actions/attach_products · Auth: secret key or dashboard session · Permissions: project_configuration:packages:read_write

One product per app, so each app's SDK finds its product. Two products of the same app can share a package only with non-overlapping eligibility_criteria (409 otherwise).

Path parameters

Request body (application/json)

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/packages/$PACKAGE_ID/actions/attach_products" -H "Authorization: Bearer $SECRET_KEY" \
  -H "Content-Type: application/json" -d '{"products":[{"product_id":"prode0zhpfisko","eligibility_criteria":"all"}]}'

Responses

• 200: The package with its products. Returns Package.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.
• 409: It already exists, or it conflicts with another object. Returns V2Error.

Detach products from a package#

POST /v2/projects/{project_id}/packages/{package_id}/actions/detach_products · Auth: secret key or dashboard session · Permissions: project_configuration:packages:read_write

Path parameters

Request body (application/json)

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/packages/$PACKAGE_ID/actions/detach_products" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: The package with its products. Returns Package.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Customers#

Customers, their attributes, entitlements, subscriptions, purchases and events.

List or search customers#

GET /v2/projects/{project_id}/customers · Auth: secret key or dashboard session · Permissions: customer_information:customers:read

Newest first (by first seen).

Path parameters

Query parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/customers" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: A page of results. Returns a list of Customer.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 402: Live data is paused: the project's owner went live more than 14 days ago without starting Pro (RevenueDot Cloud only). Sandbox reads (environment=sandbox) and secret-key reads of one customer, subscription or purchase are never paused. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Create a customer#

POST /v2/projects/{project_id}/customers · Auth: secret key or dashboard session · Permissions: customer_information:customers:read_write

Path parameters

Request body (application/json)

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/customers" -H "Authorization: Bearer $SECRET_KEY" \
  -H "Content-Type: application/json" -d '{"id":"user_42","attributes":[{"name":"$email","value":"ana@example.com"}]}'

Responses

• 201: The customer. Returns Customer.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.
• 409: It already exists, or it conflicts with another object. Returns V2Error.

Get a customer#

GET /v2/projects/{project_id}/customers/{customer_id} · Auth: secret key or dashboard session · Permissions: customer_information:customers:read

Path parameters

Query parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/customers/user_1" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: The customer. Returns Customer.
• 401: No API key, or an unknown one. Returns V2Error.
• 402: Live data is paused: the project's owner went live more than 14 days ago without starting Pro (RevenueDot Cloud only). Sandbox reads (environment=sandbox) and secret-key reads of one customer, subscription or purchase are never paused. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Example 200 response:

{
  "object": "customer",
  "id": "user_1",
  "project_id": "proj18pzzkao",
  "first_seen_at": 1790800914012,
  "last_seen_at": 1790800914034,
  "last_seen_app_version": null,
  "last_seen_country": null,
  "last_seen_platform": null,
  "last_seen_platform_version": null,
  "active_entitlements": {
    "object": "list",
    "items": [
      {
        "object": "customer.active_entitlement",
        "entitlement_id": "entl1v0bp6r0qs",
        "expires_at": 1793392914000
      }
    ],
    "next_page": null,
    "url": "/v2/projects/proj18pzzkao/customers/user_1/active_entitlements"
  },
  "experiment": null
}

Delete a customer#

DELETE /v2/projects/{project_id}/customers/{customer_id} · Auth: secret key or dashboard session · Permissions: customer_information:customers:read_write

Deletes aliases, attributes, subscriptions, purchases, transactions and events. Cannot be undone.

Path parameters

Example request

curl -s -X DELETE "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/customers/user_1" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: Deleted. Returns Deleted.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Example 200 response:

{
  "object": "customer",
  "id": "…",
  "deleted_at": 1790801342625
}

List a customer's app user ids#

GET /v2/projects/{project_id}/customers/{customer_id}/aliases · Auth: secret key or dashboard session · Permissions: customer_information:customers:read

Path parameters

Query parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/customers/user_1/aliases" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: A page of results. Returns a list of CustomerAlias.
• 401: No API key, or an unknown one. Returns V2Error.
• 402: Live data is paused: the project's owner went live more than 14 days ago without starting Pro (RevenueDot Cloud only). Sandbox reads (environment=sandbox) and secret-key reads of one customer, subscription or purchase are never paused. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

List a customer's attributes#

GET /v2/projects/{project_id}/customers/{customer_id}/attributes · Auth: secret key or dashboard session · Permissions: customer_information:customers:read

Path parameters

Query parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/customers/user_1/attributes" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: A page of results. Returns a list of CustomerAttribute.
• 401: No API key, or an unknown one. Returns V2Error.
• 402: Live data is paused: the project's owner went live more than 14 days ago without starting Pro (RevenueDot Cloud only). Sandbox reads (environment=sandbox) and secret-key reads of one customer, subscription or purchase are never paused. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Set a customer's attributes#

POST /v2/projects/{project_id}/customers/{customer_id}/attributes · Auth: secret key or dashboard session · Permissions: customer_information:customers:read_write

API writes always win over older SDK writes. A null value deletes the attribute.

Path parameters

Request body (application/json)

Example request

curl -s -X POST "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/customers/user_1/attributes" -H "Authorization: Bearer $SECRET_KEY" \
  -H "Content-Type: application/json" -d '{"attributes":[{"name":"$displayName","value":"Ana"}]}'

Responses

• 200: Every attribute of the customer. Returns a list of CustomerAttribute.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

List a customer's active entitlements#

GET /v2/projects/{project_id}/customers/{customer_id}/active_entitlements · Auth: secret key or dashboard session · Permissions: customer_information:customers:read

Path parameters

Query parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/customers/user_1/active_entitlements" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: A page of results. Returns a list of ActiveEntitlement.
• 401: No API key, or an unknown one. Returns V2Error.
• 402: Live data is paused: the project's owner went live more than 14 days ago without starting Pro (RevenueDot Cloud only). Sandbox reads (environment=sandbox) and secret-key reads of one customer, subscription or purchase are never paused. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

List a customer's subscriptions#

GET /v2/projects/{project_id}/customers/{customer_id}/subscriptions · Auth: secret key or dashboard session · Permissions: customer_information:subscriptions:read

Path parameters

Query parameters

Example request

curl -s "$REVENUEDOT_URL/v2/projects/$PROJECT_ID/customers/user_1/subscriptions" -H "Authorization: Bearer $SECRET_KEY"

Responses

• 200: A page of subscriptions. Returns a list of Subscription.
• 400: The request is invalid. Returns V2Error.
• 401: No API key, or an unknown one. Returns V2Error.
• 402: Live data is paused: the project's owner went live more than 14 days ago without starting Pro (RevenueDot Cloud only). Sandbox reads (environment=sandbox) and secret-key reads of one customer, subscription or purchase are never paused. Returns V2Error.
• 403: The key lacks a permission, or a public key was used. Returns V2Error.
• 404: Not found in this project (another project's ids also answer 404). Returns V2Error.

Example 200 response:

{
  "object": "list",
  "items": [
    {
      "object": "subscription",
      "id": "sub_k1u15wepvw0dfh25",
      "customer_id": "user_1",
      "original_customer_id": "user_1",
      "product_id": "prode0zhpfisko",
      "starts_at": 1790800914000,
      "current_period_starts_at": 1790800914000,
      "current_period_ends_at": 1793392914000,
      "ends_at": 1793392914000,
      "gives_access": true,
      "pending_payment": false,
      "auto_renewal_status": "will_renew",
      "status": "active",
      "total_revenue_in_usd": {
        "currency": "USD",
        "gross": 9.99,
        "commission": 0,
        "tax": 0,
        "proceeds": 9.99
      },
      "presented_offering_id": null,
      "entitlements": {
        "object": "list",
        "items": [
          {
            "object": "entitlement",
            "id": "entl1v0bp6r0qs",
            "project_id": "proj18pzzkao",
            "lookup_key": "pro",
            "display_name": "Pro access",
            "created_at": 1790800901115,
            "state": "active"
          }
        ],
        "next_page": null,
        "url": "/v2/projects/proj18pzzkao/subscriptions/sub_k1u15wepvw0dfh25/entitlements"
      },
      "environment": "sandbox",
      "store": "test_store",
      "store_subscription_identifier": "test_1790800914000_quickstart",
      "ownership": "purchased",
      "management_url": null
    }
  ],
  "next_page": null,
  "url": "/v2/projects/proj18pzzkao/customers/user_1/subscriptions"
}