Use this page with AI

Copy this into your coding assistant and add your request.

Read https://openiap.dev/docs/types/active-subscription and https://openiap.dev/llms.txt. Follow the reading instructions, detailed reference, and linked guides relevant to my task before making changes.
Inspect my existing project and reuse its framework and conventions. Ask me for missing product decisions. Implement the requested behavior and run the applicable checks.
Show the working result, the commands and actual test results, and any remaining limitations. Keep your explanation brief.

My request: [describe what customers should be able to do]

ActiveSubscription

ActiveSubscription#

Represents an active subscription returned by getActiveSubscriptions(). Provides a unified view of subscription status across platforms.

Cross-platform shape returned by getActiveSubscriptions. iOS: derived from Transaction.currentEntitlements filtered to subscription products (Apple docs). Android: derived from BillingClient.queryPurchasesAsync(SUBS) (Google docs).

Native references: Apple · Product.SubscriptionInfo.Status · Google · Sell subscriptions

Common Fields#

Name	Type	Summary
`productId`	`string`	Subscription product identifier
`isActive`	`boolean`	Whether the subscription is currently active
`transactionId`	`string`	Transaction identifier for backend validation
`purchaseToken`	`string?`	JWS token (iOS) or purchase token (Android) for server validation
`transactionDate`	`number`	Transaction timestamp (epoch ms)
`currentPlanId`	`string?`	Unified plan identifier. On Android: basePlanId (e.g., "premium"). On iOS: productId (e.g., "com.example.premium_monthly"). ⚠️ Android: May be inaccurate for multi-plan subscriptions because Google Play Billing's `Purchase` object does not expose `basePlanId` directly — it has to be inferred. See limitation.

Platform-Specific Fields#

iOS Fields#

Name	Type	Summary
`expirationDateIOS`	`number?`	Expiration timestamp (epoch ms)
`environmentIOS`	`("Production" \| "Sandbox" \| "Xcode")?`	StoreKit environment
`daysUntilExpirationIOS`	`number?`	Days until expiration
`renewalInfoIOS`	`RenewalInfoIOS?`	Subscription renewal details

Android example

Android Fields#

Name	Type	Summary
`autoRenewingAndroid`	`boolean?`	Store-reported renewal status; null when unavailable.
`basePlanIdAndroid`	`string?`	Base plan identifier. ⚠️ May be inaccurate for multi-plan subscriptions. See limitation.
`purchaseTokenAndroid`	`string?`	Purchase token for upgrade/downgrade operations

Usage Example#

swift

// Check for pending upgrades
if let pendingProductId = subscription.renewalInfoIOS?.pendingUpgradeProductId {
    print("Upgrade pending to: \(pendingProductId)")
}

// Check if subscription is cancelled
if subscription.renewalInfoIOS?.willAutoRenew == false {
    print("Subscription will not auto-renew")
}

Kotlin example

// Android: read auto-renew status straight off the active subscription.
// (renewalInfoIOS is iOS-only — see the Swift / KMP tabs for that flow.)
if (subscription.autoRenewingAndroid == false) {
    println("Subscription will not auto-renew")
}

// Use the upgrade/downgrade flow via requestPurchase — Android does not
// surface a pending upgrade product id directly.
subscription.basePlanIdAndroid?.let { basePlanId ->
    println("Active base plan: $basePlanId")
}

TypeScript example

// Check for pending upgrades
if (subscription.renewalInfoIOS?.pendingUpgradeProductId) {
  console.log('Upgrade pending to:', subscription.renewalInfoIOS.pendingUpgradeProductId);
}

// Check if subscription is cancelled
if (subscription.renewalInfoIOS?.willAutoRenew === false) {
  console.log('Subscription will not auto-renew');
}

Dart example

dart

// Check for pending upgrades
if (subscription.renewalInfoIOS?.pendingUpgradeProductId != null) {
  print('Upgrade pending to: ${subscription.renewalInfoIOS!.pendingUpgradeProductId}');
}

// Check if subscription is cancelled
if (subscription.renewalInfoIOS?.willAutoRenew == false) {
  print('Subscription will not auto-renew');
}

C# (MAUI) example

using OpenIap;
using OpenIap.Maui;

// Android: read auto-renew status straight off the active subscription.
// (renewalInfoIOS is iOS-only — see the Swift / KMP tabs for that flow.)
if (subscription.AutoRenewingAndroid == false)
{
    Console.WriteLine("Subscription will not auto-renew");
}

// Use the upgrade/downgrade flow via requestPurchase — Android does not
// surface a pending upgrade product id directly.
if (subscription.BasePlanIdAndroid is { } basePlanId)
{
    Console.WriteLine(quot;Active base plan: {basePlanId}");
}

GDScript example

# Check for pending upgrades
if subscription.renewal_info_ios != null:
    if subscription.renewal_info_ios.pending_upgrade_product_id != "":
        print("Upgrade pending to: %s" % subscription.renewal_info_ios.pending_upgrade_product_id)

# Check if subscription is cancelled
if subscription.renewal_info_ios != null:
    if subscription.renewal_info_ios.will_auto_renew == false:
        print("Subscription will not auto-renew")