StoreSubscriptionInfo¶
Inherits: RefCounted < Object
Provides subscription group metadata and status queries.
Description¶
This class wraps StoreKit subscription information and exposes the subscription group metadata for a product.
Use the status methods to query the current subscription status for a product, subscription group, or transaction ID.
Properties¶
String |
|
|
int |
|
|
String |
|
Methods¶
void |
getStatus(callback: Callable) |
void |
status_for_group_id(group_id: String, status: Callable) |
void |
status_for_transaction(transaction_id: int, status: Callable) |
Property Descriptions¶
String group_display_name = "" 🔗
String get_group_display_name()
The localized display name of the subscription group. Returns an empty string if unavailable.
int group_level = -1 🔗
int get_group_level()
The subscription group level used for upgrade/downgrade ranking. Returns -1 when unavailable.
String subscription_group_id = "" 🔗
String get_subscription_group_id()
The subscription group identifier from App Store Connect. Returns an empty string if unavailable.
Method Descriptions¶
void getStatus(callback: Callable) 🔗
Fetches the current status entries for this subscription. The callback receives a Array[StoreSubscriptionInfoStatus] on success, or a String describing the error.
void status_for_group_id(group_id: String, status: Callable) 🔗
Fetches status entries for the subscription group identifier. The callback receives a Array[StoreSubscriptionInfoStatus] on success, or a String describing the error.
void status_for_transaction(transaction_id: int, status: Callable) 🔗
Fetches the status entry for the provided transaction identifier. The callback receives a StoreSubscriptionInfoStatus when available, an empty Array[StoreSubscriptionInfoStatus] when no status is found, or a String describing the error.
On macOS, this requires macOS 15.4 or newer; earlier versions perform no action.