Skip to content

Commit a5403cd

Browse files
committed
docs
1 parent 3cefd6f commit a5403cd

1 file changed

Lines changed: 3 additions & 34 deletions

File tree

apps/docs/content/docs/en/tools/revenuecat.mdx

Lines changed: 3 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -174,9 +174,9 @@ Grant a promotional entitlement to a subscriber
174174
| `apiKey` | string | Yes | RevenueCat secret API key \(sk_...\) |
175175
| `appUserId` | string | Yes | The app user ID of the subscriber |
176176
| `entitlementIdentifier` | string | Yes | The entitlement identifier to grant |
177-
| `duration` | string | No | Duration of the entitlement. Provide either duration or endTimeMs. One of: daily, three_day, weekly, two_week, monthly, two_month, three_month, six_month, yearly, lifetime |
177+
| `duration` | string | No | Deprecated. Duration of the entitlement. Provide either duration or endTimeMs \(endTimeMs preferred\). One of: daily, three_day, weekly, two_week, monthly, two_month, three_month, six_month, yearly, lifetime |
178178
| `endTimeMs` | number | No | Absolute end time in milliseconds since Unix epoch. Use instead of duration to grant the entitlement until a specific timestamp. |
179-
| `startTimeMs` | number | No | Optional start time in milliseconds since Unix epoch. Set to a past time to achieve custom durations shorter than daily. |
179+
| `startTimeMs` | number | No | Deprecated. Optional start time in milliseconds since Unix epoch, used with duration to determine expiration. Regardless of value, the entitlement is always granted immediately. |
180180

181181
#### Output
182182

@@ -272,7 +272,7 @@ List all offerings configured for the project
272272
| --------- | ---- | -------- | ----------- |
273273
| `apiKey` | string | Yes | RevenueCat API key |
274274
| `appUserId` | string | Yes | An app user ID to retrieve offerings for |
275-
| `platform` | string | No | Platform to filter offerings \(ios, android, stripe, etc.\) |
275+
| `platform` | string | No | X-Platform header value. One of: ios, android, amazon, stripe, roku, paddle. Required when using a legacy public API key; ignored with app-specific API keys. |
276276

277277
#### Output
278278

@@ -307,37 +307,6 @@ Update custom subscriber attributes (e.g., $email, $displayName, or custom key-v
307307
| --------- | ---- | ----------- |
308308
| `updated` | boolean | Whether the subscriber attributes were successfully updated |
309309
| `app_user_id` | string | The app user ID of the updated subscriber |
310-
| `subscriber` | object | The updated subscriber object after applying the attribute changes |
311-
|`first_seen` | string | ISO 8601 date when subscriber was first seen |
312-
|`last_seen` | string | ISO 8601 date when subscriber was last seen |
313-
|`original_app_user_id` | string | Original app user ID |
314-
|`original_application_version` | string | iOS only. First App Store version of your app the customer installed |
315-
|`original_purchase_date` | string | iOS only. Date the app was first purchased/downloaded |
316-
|`management_url` | string | URL for managing the subscriber subscriptions |
317-
|`subscriptions` | object | Map of product identifiers to subscription objects |
318-
|`store_transaction_id` | string | Store transaction identifier |
319-
|`original_transaction_id` | string | Original transaction identifier |
320-
|`purchase_date` | string | ISO 8601 purchase date |
321-
|`original_purchase_date` | string | ISO 8601 date of the original purchase |
322-
|`expires_date` | string | ISO 8601 expiration date |
323-
|`is_sandbox` | boolean | Whether this is a sandbox purchase |
324-
|`unsubscribe_detected_at` | string | ISO 8601 date when unsubscribe was detected |
325-
|`billing_issues_detected_at` | string | ISO 8601 date when billing issues were detected |
326-
|`grace_period_expires_date` | string | ISO 8601 grace period expiration date |
327-
|`ownership_type` | string | Ownership type \(purchased, family_shared\) |
328-
|`period_type` | string | Period type \(normal, trial, intro, promotional, prepaid\) |
329-
|`store` | string | Store the subscription was purchased from \(app_store, play_store, stripe, etc.\) |
330-
|`refunded_at` | string | ISO 8601 date when subscription was refunded |
331-
|`auto_resume_date` | string | ISO 8601 date when a paused subscription will auto-resume |
332-
|`product_plan_identifier` | string | Google Play base plan identifier \(for products set up after Feb 2023\) |
333-
|`entitlements` | object | Map of entitlement identifiers to entitlement objects |
334-
|`expires_date` | string | ISO 8601 expiration date \(null for non-expiring entitlements\) |
335-
|`grace_period_expires_date` | string | ISO 8601 grace period expiration date |
336-
|`product_identifier` | string | Product identifier |
337-
|`purchase_date` | string | ISO 8601 date of the latest purchase or renewal |
338-
|`non_subscriptions` | object | Map of non-subscription product identifiers to arrays of purchase objects |
339-
|`other_purchases` | object | Other purchases attached to the subscriber |
340-
|`subscriber_attributes` | object | Custom attributes set on the subscriber. Only returned when using a secret API key |
341310

342311
### `revenuecat_defer_google_subscription`
343312

0 commit comments

Comments
 (0)