Manage in-app subscriptions and entitlements
Integrate RevenueCat into the workflow. Manage subscribers, entitlements, offerings, and Google Play subscriptions. Retrieve customer subscription status, grant or revoke promotional entitlements, record purchases, update subscriber attributes, and manage Google Play subscription billing.
Retrieve subscriber information by app user ID
| 参数 | 类型 | 必填 | 描述 |
|---|
apiKey | string | 是 | RevenueCat secret API key (sk_...) |
appUserId | string | 是 | The app user ID of the subscriber |
| 参数 | 类型 | 描述 |
|---|
subscriber | object | The subscriber object with subscriptions and entitlements |
↳ first_seen | string | ISO 8601 date when subscriber was first seen |
↳ original_app_user_id | string | Original app user ID |
↳ original_purchase_date | string | ISO 8601 date of original purchase |
↳ management_url | string | URL for managing the subscriber subscriptions |
↳ subscriptions | object | Map of product identifiers to subscription objects |
↳ store_transaction_id | string | Store transaction identifier |
↳ original_transaction_id | string | Original transaction identifier |
↳ purchase_date | string | ISO 8601 purchase date |
↳ original_purchase_date | string | ISO 8601 date of the original purchase |
↳ expires_date | string | ISO 8601 expiration date |
↳ is_sandbox | boolean | Whether this is a sandbox purchase |
↳ unsubscribe_detected_at | string | ISO 8601 date when unsubscribe was detected |
↳ billing_issues_detected_at | string | ISO 8601 date when billing issues were detected |
↳ grace_period_expires_date | string | ISO 8601 grace period expiration date |
↳ ownership_type | string | Ownership type (purchased, family_shared) |
↳ period_type | string | Period type (normal, trial, intro, promotional, prepaid) |
↳ store | string | Store the subscription was purchased from (app_store, play_store, stripe, etc.) |
↳ refunded_at | string | ISO 8601 date when subscription was refunded |
↳ auto_resume_date | string | ISO 8601 date when a paused subscription will auto-resume |
↳ product_plan_identifier | string | Google Play base plan identifier (for products set up after Feb 2023) |
↳ entitlements | object | Map of entitlement identifiers to entitlement objects |
↳ grant_date | string | ISO 8601 grant date |
↳ expires_date | string | ISO 8601 expiration date |
↳ product_identifier | string | Product identifier |
↳ is_active | boolean | Whether the entitlement is active |
↳ will_renew | boolean | Whether the entitlement will renew |
↳ period_type | string | Period type (normal, trial, intro, promotional) |
↳ purchase_date | string | ISO 8601 date of the latest purchase or renewal |
↳ store | string | Store the entitlement was granted from |
↳ grace_period_expires_date | string | ISO 8601 grace period expiration date |
↳ non_subscriptions | object | Map of non-subscription product identifiers to arrays of purchase objects |
metadata | object | Subscriber summary metadata |
↳ app_user_id | string | The app user ID |
↳ first_seen | string | ISO 8601 date when the subscriber was first seen |
↳ active_entitlements | number | Number of active entitlements |
↳ active_subscriptions | number | Number of active subscriptions |
Permanently delete a subscriber and all associated data
| 参数 | 类型 | 必填 | 描述 |
|---|
apiKey | string | 是 | RevenueCat secret API key (sk_...) |
appUserId | string | 是 | The app user ID of the subscriber to delete |
| 参数 | 类型 | 描述 |
|---|
deleted | boolean | Whether the subscriber was deleted |
app_user_id | string | The deleted app user ID |
Record a purchase (receipt) for a subscriber via the REST API
| 参数 | 类型 | 必填 | 描述 |
|---|
apiKey | string | 是 | RevenueCat API key (public or secret) |
appUserId | string | 是 | The app user ID of the subscriber |
fetchToken | string | 是 | The receipt token or purchase token from the store (App Store receipt, Google Play purchase token, or Stripe subscription ID) |
productId | string | 是 | The product identifier for the purchase |
price | number | 否 | The price of the product in the currency specified |
currency | string | 否 | ISO 4217 currency code (e.g., USD, EUR) |
isRestore | boolean | 否 | Whether this is a restore of a previous purchase |
platform | string | 否 | Platform of the purchase (ios, android, amazon, macos, stripe). Required for Stripe and Paddle purchases. |
| 参数 | 类型 | 描述 |
|---|
subscriber | object | The updated subscriber object after recording the purchase |
↳ first_seen | string | ISO 8601 date when subscriber was first seen |
↳ original_app_user_id | string | Original app user ID |
↳ original_purchase_date | string | ISO 8601 date of original purchase |
↳ management_url | string | URL for managing the subscriber subscriptions |
↳ subscriptions | object | Map of product identifiers to subscription objects |
↳ store_transaction_id | string | Store transaction identifier |
↳ original_transaction_id | string | Original transaction identifier |
↳ purchase_date | string | ISO 8601 purchase date |
↳ original_purchase_date | string | ISO 8601 date of the original purchase |
↳ expires_date | string | ISO 8601 expiration date |
↳ is_sandbox | boolean | Whether this is a sandbox purchase |
↳ unsubscribe_detected_at | string | ISO 8601 date when unsubscribe was detected |
↳ billing_issues_detected_at | string | ISO 8601 date when billing issues were detected |
↳ grace_period_expires_date | string | ISO 8601 grace period expiration date |
↳ ownership_type | string | Ownership type (purchased, family_shared) |
↳ period_type | string | Period type (normal, trial, intro, promotional, prepaid) |
↳ store | string | Store the subscription was purchased from (app_store, play_store, stripe, etc.) |
↳ refunded_at | string | ISO 8601 date when subscription was refunded |
↳ auto_resume_date | string | ISO 8601 date when a paused subscription will auto-resume |
↳ product_plan_identifier | string | Google Play base plan identifier (for products set up after Feb 2023) |
↳ entitlements | object | Map of entitlement identifiers to entitlement objects |
↳ grant_date | string | ISO 8601 grant date |
↳ expires_date | string | ISO 8601 expiration date |
↳ product_identifier | string | Product identifier |
↳ is_active | boolean | Whether the entitlement is active |
↳ will_renew | boolean | Whether the entitlement will renew |
↳ period_type | string | Period type (normal, trial, intro, promotional) |
↳ purchase_date | string | ISO 8601 date of the latest purchase or renewal |
↳ store | string | Store the entitlement was granted from |
↳ grace_period_expires_date | string | ISO 8601 grace period expiration date |
↳ non_subscriptions | object | Map of non-subscription product identifiers to arrays of purchase objects |
Grant a promotional entitlement to a subscriber
| 参数 | 类型 | 必填 | 描述 |
|---|
apiKey | string | 是 | RevenueCat secret API key (sk_...) |
appUserId | string | 是 | The app user ID of the subscriber |
entitlementIdentifier | string | 是 | The entitlement identifier to grant |
duration | string | 是 | Duration of the entitlement (daily, three_day, weekly, monthly, two_month, three_month, six_month, yearly, lifetime) |
startTimeMs | number | 否 | Optional start time in milliseconds since Unix epoch. Set to a past time to achieve custom durations shorter than daily. |
| 参数 | 类型 | 描述 |
|---|
subscriber | object | The updated subscriber object after granting the entitlement |
↳ first_seen | string | ISO 8601 date when subscriber was first seen |
↳ original_app_user_id | string | Original app user ID |
↳ original_purchase_date | string | ISO 8601 date of original purchase |
↳ management_url | string | URL for managing the subscriber subscriptions |
↳ subscriptions | object | Map of product identifiers to subscription objects |
↳ store_transaction_id | string | Store transaction identifier |
↳ original_transaction_id | string | Original transaction identifier |
↳ purchase_date | string | ISO 8601 purchase date |
↳ original_purchase_date | string | ISO 8601 date of the original purchase |
↳ expires_date | string | ISO 8601 expiration date |
↳ is_sandbox | boolean | Whether this is a sandbox purchase |
↳ unsubscribe_detected_at | string | ISO 8601 date when unsubscribe was detected |
↳ billing_issues_detected_at | string | ISO 8601 date when billing issues were detected |
↳ grace_period_expires_date | string | ISO 8601 grace period expiration date |
↳ ownership_type | string | Ownership type (purchased, family_shared) |
↳ period_type | string | Period type (normal, trial, intro, promotional, prepaid) |
↳ store | string | Store the subscription was purchased from (app_store, play_store, stripe, etc.) |
↳ refunded_at | string | ISO 8601 date when subscription was refunded |
↳ auto_resume_date | string | ISO 8601 date when a paused subscription will auto-resume |
↳ product_plan_identifier | string | Google Play base plan identifier (for products set up after Feb 2023) |
↳ entitlements | object | Map of entitlement identifiers to entitlement objects |
↳ grant_date | string | ISO 8601 grant date |
↳ expires_date | string | ISO 8601 expiration date |
↳ product_identifier | string | Product identifier |
↳ is_active | boolean | Whether the entitlement is active |
↳ will_renew | boolean | Whether the entitlement will renew |
↳ period_type | string | Period type (normal, trial, intro, promotional) |
↳ purchase_date | string | ISO 8601 date of the latest purchase or renewal |
↳ store | string | Store the entitlement was granted from |
↳ grace_period_expires_date | string | ISO 8601 grace period expiration date |
↳ non_subscriptions | object | Map of non-subscription product identifiers to arrays of purchase objects |
Revoke all promotional entitlements for a specific entitlement identifier
| 参数 | 类型 | 必填 | 描述 |
|---|
apiKey | string | 是 | RevenueCat secret API key (sk_...) |
appUserId | string | 是 | The app user ID of the subscriber |
entitlementIdentifier | string | 是 | The entitlement identifier to revoke |
| 参数 | 类型 | 描述 |
|---|
subscriber | object | The updated subscriber object after revoking the entitlement |
↳ first_seen | string | ISO 8601 date when subscriber was first seen |
↳ original_app_user_id | string | Original app user ID |
↳ original_purchase_date | string | ISO 8601 date of original purchase |
↳ management_url | string | URL for managing the subscriber subscriptions |
↳ subscriptions | object | Map of product identifiers to subscription objects |
↳ store_transaction_id | string | Store transaction identifier |
↳ original_transaction_id | string | Original transaction identifier |
↳ purchase_date | string | ISO 8601 purchase date |
↳ original_purchase_date | string | ISO 8601 date of the original purchase |
↳ expires_date | string | ISO 8601 expiration date |
↳ is_sandbox | boolean | Whether this is a sandbox purchase |
↳ unsubscribe_detected_at | string | ISO 8601 date when unsubscribe was detected |
↳ billing_issues_detected_at | string | ISO 8601 date when billing issues were detected |
↳ grace_period_expires_date | string | ISO 8601 grace period expiration date |
↳ ownership_type | string | Ownership type (purchased, family_shared) |
↳ period_type | string | Period type (normal, trial, intro, promotional, prepaid) |
↳ store | string | Store the subscription was purchased from (app_store, play_store, stripe, etc.) |
↳ refunded_at | string | ISO 8601 date when subscription was refunded |
↳ auto_resume_date | string | ISO 8601 date when a paused subscription will auto-resume |
↳ product_plan_identifier | string | Google Play base plan identifier (for products set up after Feb 2023) |
↳ entitlements | object | Map of entitlement identifiers to entitlement objects |
↳ grant_date | string | ISO 8601 grant date |
↳ expires_date | string | ISO 8601 expiration date |
↳ product_identifier | string | Product identifier |
↳ is_active | boolean | Whether the entitlement is active |
↳ will_renew | boolean | Whether the entitlement will renew |
↳ period_type | string | Period type (normal, trial, intro, promotional) |
↳ purchase_date | string | ISO 8601 date of the latest purchase or renewal |
↳ store | string | Store the entitlement was granted from |
↳ grace_period_expires_date | string | ISO 8601 grace period expiration date |
↳ non_subscriptions | object | Map of non-subscription product identifiers to arrays of purchase objects |
List all offerings configured for the project
| 参数 | 类型 | 必填 | 描述 |
|---|
apiKey | string | 是 | RevenueCat API key |
appUserId | string | 是 | An app user ID to retrieve offerings for |
platform | string | 否 | Platform to filter offerings (ios, android, stripe, etc.) |
| 参数 | 类型 | 描述 |
|---|
current_offering_id | string | The identifier of the current offering |
offerings | array | List of offerings |
↳ identifier | string | Offering identifier |
↳ description | string | Offering description |
↳ packages | array | List of packages in the offering |
↳ identifier | string | Package identifier |
↳ platform_product_identifier | string | Platform-specific product identifier |
metadata | object | Offerings metadata |
↳ count | number | Number of offerings returned |
↳ current_offering_id | string | Current offering identifier |
Update custom subscriber attributes (e.g., $email, $displayName, or custom key-value pairs)
| 参数 | 类型 | 必填 | 描述 |
|---|
apiKey | string | 是 | RevenueCat secret API key (sk_...) |
appUserId | string | 是 | The app user ID of the subscriber |
attributes | json | 是 | JSON object of attributes to set. Each key maps to an object with a "value" field. Example: {"$email": {"value": "user@example.com"}, "$displayName": {"value": "John"}} |
| 参数 | 类型 | 描述 |
|---|
updated | boolean | Whether the subscriber attributes were successfully updated |
app_user_id | string | The app user ID of the updated subscriber |
Defer a Google Play subscription by extending its billing date by a number of days (Google Play only)
| 参数 | 类型 | 必填 | 描述 |
|---|
apiKey | string | 是 | RevenueCat secret API key (sk_...) |
appUserId | string | 是 | The app user ID of the subscriber |
productId | string | 是 | The Google Play product identifier of the subscription to defer (use the part before the colon for products set up after Feb 2023) |
extendByDays | number | 是 | Number of days to extend the subscription by (1-365) |
| 参数 | 类型 | 描述 |
|---|
subscriber | object | The updated subscriber object after deferring the Google subscription |
↳ first_seen | string | ISO 8601 date when subscriber was first seen |
↳ original_app_user_id | string | Original app user ID |
↳ original_purchase_date | string | ISO 8601 date of original purchase |
↳ management_url | string | URL for managing the subscriber subscriptions |
↳ subscriptions | object | Map of product identifiers to subscription objects |
↳ store_transaction_id | string | Store transaction identifier |
↳ original_transaction_id | string | Original transaction identifier |
↳ purchase_date | string | ISO 8601 purchase date |
↳ original_purchase_date | string | ISO 8601 date of the original purchase |
↳ expires_date | string | ISO 8601 expiration date |
↳ is_sandbox | boolean | Whether this is a sandbox purchase |
↳ unsubscribe_detected_at | string | ISO 8601 date when unsubscribe was detected |
↳ billing_issues_detected_at | string | ISO 8601 date when billing issues were detected |
↳ grace_period_expires_date | string | ISO 8601 grace period expiration date |
↳ ownership_type | string | Ownership type (purchased, family_shared) |
↳ period_type | string | Period type (normal, trial, intro, promotional, prepaid) |
↳ store | string | Store the subscription was purchased from (app_store, play_store, stripe, etc.) |
↳ refunded_at | string | ISO 8601 date when subscription was refunded |
↳ auto_resume_date | string | ISO 8601 date when a paused subscription will auto-resume |
↳ product_plan_identifier | string | Google Play base plan identifier (for products set up after Feb 2023) |
↳ entitlements | object | Map of entitlement identifiers to entitlement objects |
↳ grant_date | string | ISO 8601 grant date |
↳ expires_date | string | ISO 8601 expiration date |
↳ product_identifier | string | Product identifier |
↳ is_active | boolean | Whether the entitlement is active |
↳ will_renew | boolean | Whether the entitlement will renew |
↳ period_type | string | Period type (normal, trial, intro, promotional) |
↳ purchase_date | string | ISO 8601 date of the latest purchase or renewal |
↳ store | string | Store the entitlement was granted from |
↳ grace_period_expires_date | string | ISO 8601 grace period expiration date |
↳ non_subscriptions | object | Map of non-subscription product identifiers to arrays of purchase objects |
Refund and optionally revoke a Google Play subscription (Google Play only)
| 参数 | 类型 | 必填 | 描述 |
|---|
apiKey | string | 是 | RevenueCat secret API key (sk_...) |
appUserId | string | 是 | The app user ID of the subscriber |
productId | string | 是 | The Google Play product identifier of the subscription to refund |
| 参数 | 类型 | 描述 |
|---|
subscriber | object | The updated subscriber object after refunding the Google subscription |
↳ first_seen | string | ISO 8601 date when subscriber was first seen |
↳ original_app_user_id | string | Original app user ID |
↳ original_purchase_date | string | ISO 8601 date of original purchase |
↳ management_url | string | URL for managing the subscriber subscriptions |
↳ subscriptions | object | Map of product identifiers to subscription objects |
↳ store_transaction_id | string | Store transaction identifier |
↳ original_transaction_id | string | Original transaction identifier |
↳ purchase_date | string | ISO 8601 purchase date |
↳ original_purchase_date | string | ISO 8601 date of the original purchase |
↳ expires_date | string | ISO 8601 expiration date |
↳ is_sandbox | boolean | Whether this is a sandbox purchase |
↳ unsubscribe_detected_at | string | ISO 8601 date when unsubscribe was detected |
↳ billing_issues_detected_at | string | ISO 8601 date when billing issues were detected |
↳ grace_period_expires_date | string | ISO 8601 grace period expiration date |
↳ ownership_type | string | Ownership type (purchased, family_shared) |
↳ period_type | string | Period type (normal, trial, intro, promotional, prepaid) |
↳ store | string | Store the subscription was purchased from (app_store, play_store, stripe, etc.) |
↳ refunded_at | string | ISO 8601 date when subscription was refunded |
↳ auto_resume_date | string | ISO 8601 date when a paused subscription will auto-resume |
↳ product_plan_identifier | string | Google Play base plan identifier (for products set up after Feb 2023) |
↳ entitlements | object | Map of entitlement identifiers to entitlement objects |
↳ grant_date | string | ISO 8601 grant date |
↳ expires_date | string | ISO 8601 expiration date |
↳ product_identifier | string | Product identifier |
↳ is_active | boolean | Whether the entitlement is active |
↳ will_renew | boolean | Whether the entitlement will renew |
↳ period_type | string | Period type (normal, trial, intro, promotional) |
↳ purchase_date | string | ISO 8601 date of the latest purchase or renewal |
↳ store | string | Store the entitlement was granted from |
↳ grace_period_expires_date | string | ISO 8601 grace period expiration date |
↳ non_subscriptions | object | Map of non-subscription product identifiers to arrays of purchase objects |
Immediately revoke access to a Google Play subscription and issue a refund (Google Play only)
| 参数 | 类型 | 必填 | 描述 |
|---|
apiKey | string | 是 | RevenueCat secret API key (sk_...) |
appUserId | string | 是 | The app user ID of the subscriber |
productId | string | 是 | The Google Play product identifier of the subscription to revoke |
| 参数 | 类型 | 描述 |
|---|
subscriber | object | The updated subscriber object after revoking the Google subscription |
↳ first_seen | string | ISO 8601 date when subscriber was first seen |
↳ original_app_user_id | string | Original app user ID |
↳ original_purchase_date | string | ISO 8601 date of original purchase |
↳ management_url | string | URL for managing the subscriber subscriptions |
↳ subscriptions | object | Map of product identifiers to subscription objects |
↳ store_transaction_id | string | Store transaction identifier |
↳ original_transaction_id | string | Original transaction identifier |
↳ purchase_date | string | ISO 8601 purchase date |
↳ original_purchase_date | string | ISO 8601 date of the original purchase |
↳ expires_date | string | ISO 8601 expiration date |
↳ is_sandbox | boolean | Whether this is a sandbox purchase |
↳ unsubscribe_detected_at | string | ISO 8601 date when unsubscribe was detected |
↳ billing_issues_detected_at | string | ISO 8601 date when billing issues were detected |
↳ grace_period_expires_date | string | ISO 8601 grace period expiration date |
↳ ownership_type | string | Ownership type (purchased, family_shared) |
↳ period_type | string | Period type (normal, trial, intro, promotional, prepaid) |
↳ store | string | Store the subscription was purchased from (app_store, play_store, stripe, etc.) |
↳ refunded_at | string | ISO 8601 date when subscription was refunded |
↳ auto_resume_date | string | ISO 8601 date when a paused subscription will auto-resume |
↳ product_plan_identifier | string | Google Play base plan identifier (for products set up after Feb 2023) |
↳ entitlements | object | Map of entitlement identifiers to entitlement objects |
↳ grant_date | string | ISO 8601 grant date |
↳ expires_date | string | ISO 8601 expiration date |
↳ product_identifier | string | Product identifier |
↳ is_active | boolean | Whether the entitlement is active |
↳ will_renew | boolean | Whether the entitlement will renew |
↳ period_type | string | Period type (normal, trial, intro, promotional) |
↳ purchase_date | string | ISO 8601 date of the latest purchase or renewal |
↳ store | string | Store the entitlement was granted from |
↳ grace_period_expires_date | string | ISO 8601 grace period expiration date |
↳ non_subscriptions | object | Map of non-subscription product identifiers to arrays of purchase objects |
