SubscriptionPlan

BITRATE_UNKNOWN

static val BITRATE_UNKNOWN: Long

Value indicating data rate is unknown.

Value: -1L

BYTES_UNKNOWN

static val BYTES_UNKNOWN: Long

Value indicating a number of bytes is unknown.

This value is used when the carrier has not provided a specific data limit or usage value.

Value: -1L

BYTES_UNLIMITED

static val BYTES_UNLIMITED: Long

Value indicating a number of bytes is unlimited.

This value is used when the carrier has not specified a data limit.

Value: 9223372036854775807L

LIMIT_BEHAVIOR_BILLED

static val LIMIT_BEHAVIOR_BILLED: Int

Indicates that the user will be billed for data usage beyond the limit.

When the user exceeds their data limit, they will incur overage charges. Data access continues, but at an additional cost.

Value: 1

LIMIT_BEHAVIOR_DISABLED

static val LIMIT_BEHAVIOR_DISABLED: Int

Indicates that data access is disabled when the data limit is reached.

Once the user's data usage hits the defined limit, their mobile data connection will be turned off until the next billing cycle begins.

Value: 0

LIMIT_BEHAVIOR_THROTTLED

static val LIMIT_BEHAVIOR_THROTTLED: Int

Indicates that data access is throttled to a slower speed when the limit is reached.

After the user consumes their high-speed data allowance, the data connection remains active but is reduced to a lower bandwidth for the remainder of the billing cycle.

Value: 2

LIMIT_BEHAVIOR_UNKNOWN

static val LIMIT_BEHAVIOR_UNKNOWN: Int

Indicates that the behavior for when a data limit is reached is unknown.

This is the default value and should be used when the carrier has not specified what happens when the user's data usage exceeds the limit.

Value: -1

PLAN_TYPE_BUSINESS

static val PLAN_TYPE_BUSINESS: Int

The plan is for business or enterprise customers.

This type indicates that the plan may include features tailored for corporate use, such as dedicated support, static IP addresses, or specific service-level agreements (SLAs).

Value: 8

PLAN_TYPE_CELLULAR

static val PLAN_TYPE_CELLULAR: Int

The plan provides conventional cellular service.

This type is for standard mobile plans that offer data, voice, and messaging services over terrestrial cellular networks (e.g., 4G LTE, 5G).

Value: 1

PLAN_TYPE_DATA_ONLY

static val PLAN_TYPE_DATA_ONLY: Int

The plan is for data-only service.

This type indicates that the plan provides only mobile data connectivity and does not include traditional voice or SMS services. It is commonly used for tablets, mobile hotspots, or as a secondary data line.

Value: 6

PLAN_TYPE_FAMILY

static val PLAN_TYPE_FAMILY: Int

The plan is a family plan, shared among multiple users.

This type indicates that data limits and usage may be pooled across several subscriptions. Data management applications can use this to provide a consolidated view of the shared usage for all members of the family plan.

Value: 7

PLAN_TYPE_IOT

static val PLAN_TYPE_IOT: Int

The plan is designed for Internet of Things (IoT) devices.

These plans are typically tailored for devices with low data consumption and specific network requirements, such as smart sensors or asset trackers.

Value: 3

PLAN_TYPE_POSTPAID

static val PLAN_TYPE_POSTPAID: Int

The plan is a postpaid plan.

With a postpaid plan, the user consumes services and is billed at the end of each billing cycle for the usage incurred.

Value: 4

PLAN_TYPE_PREPAID

static val PLAN_TYPE_PREPAID: Int

The plan is a prepaid plan.

With a prepaid plan, the user pays for services in advance, and the service is available until the paid balance is depleted or the service period expires.

Value: 5

PLAN_TYPE_ROAMING

static val PLAN_TYPE_ROAMING: Int

The plan is specifically for roaming services.

This type is used for plans or add-ons designed for international or out-of-network usage. It helps the system and applications to better inform the user about potential costs or usage restrictions while roaming.

Value: 9

PLAN_TYPE_SATELLITE

static val PLAN_TYPE_SATELLITE: Int

The plan provides satellite-based service.

This is used for plans that deliver connectivity via satellite.

Value: 2

PLAN_TYPE_TETHERING

static val PLAN_TYPE_TETHERING: Int

The plan provides a data allowance specifically for tethering or mobile hotspot usage.

This type is used for plans or add-ons that allocate a specific amount of data for use when the device is acting as a mobile hotspot. Many carriers offer a separate, often smaller, data cap for tethering, which is distinct from the on-device data limit. This allows the system and data management applications to track usage against this specific allowance and inform the user of their remaining hotspot data.

Value: 10

SUBSCRIPTION_STATUS_ACTIVE

static val SUBSCRIPTION_STATUS_ACTIVE: Int

The subscription is active.

This indicates that the subscription is in good standing and all services are available to the user.

Value: 1

SUBSCRIPTION_STATUS_INACTIVE

static val SUBSCRIPTION_STATUS_INACTIVE: Int

The subscription is inactive.

This status means the subscription is not currently in service. This could be because it has been canceled, has expired, or has not yet been activated.

Value: 2

SUBSCRIPTION_STATUS_SUSPENDED

static val SUBSCRIPTION_STATUS_SUSPENDED: Int

The subscription is suspended.

A suspended subscription has been temporarily disabled. This can occur due to billing issues, a user's request, or a violation of the carrier's terms of service. Services are unavailable, but the subscription can typically be reactivated.

Value: 4

SUBSCRIPTION_STATUS_TRIAL

static val SUBSCRIPTION_STATUS_TRIAL: Int

The subscription is in a trial period.

This indicates that the user is on a promotional or trial plan, which may have different features or limitations than a standard subscription. After the trial period ends, the status will typically change to active or inactive.

Value: 3

SUBSCRIPTION_STATUS_UNKNOWN

static val SUBSCRIPTION_STATUS_UNKNOWN: Int

The subscription status is unknown.

This is the default value, used when the carrier is unable to provide the current status of the subscription.

Value: 0

TIME_UNKNOWN

static val TIME_UNKNOWN: Long

Value indicating a timestamp is unknown.

Value: -1L

UNSPECIFIED_ID

static val UNSPECIFIED_ID: Int

Value indicating that the SubscriptionPlan ID is not specified.

Value: -1

cycleIterator

fun cycleIterator(): MutableIterator<Range<ZonedDateTime!>!>!

Returns an iterator that provides the data usage billing cycles for this plan, based on its recurrence rule.

The iterator starts from the cycle that is currently active and walks backwards through time. Each cycle is represented as a Range of ZonedDateTime objects, indicating the start and end of that period.

describeContents

fun describeContents(): Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

equals

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

getDataLimitBehavior

fun getDataLimitBehavior(): Int

Returns the behavior of data access when usage reaches the limit defined by getDataLimitBytes().

This defines what happens to the user's data connection once they have consumed the amount of data specified in the data limit. For example, the carrier might throttle the connection to a slower speed, disable it entirely, or start billing for overage.

getDataLimitBytes

fun getDataLimitBytes(): Long

Returns the data limit for the plan.

This is the usage threshold, in bytes, at which data access changes according to the behavior defined by getDataLimitBehavior(). For example, once data usage reaches this limit, the connection might be throttled or disabled.
Value is a non-negative number of bytes.

getDataUsageBytes

fun getDataUsageBytes(): Long

Returns a snapshot of the mobile data usage, in bytes, as of the time reported by getDataUsageTime().

The usage reported here corresponds to the data consumption within the current billing cycle defined by #getCycleRule(). If the plan specifies different limits for various network types, this value represents the total usage across all applicable networks.
Value is a non-negative number of bytes.

getDataUsageResetTime

fun getDataUsageResetTime(): ZonedDateTime?

Returns the time at which the data usage will reset.

This is distinct from the billing cycle or plan duration returned by #getCycleRule(). For example, a 15-day travel plan might have a #getCycleRule() covering the entire 15-day duration, but a daily data limit of 1GB. In this case, getDataUsageResetTime() would indicate the time (e.g., midnight) when that daily 1GB limit resets, while #getCycleRule() defines when the plan itself expires.

This is particularly relevant for plans with a daily data allowance. The value provided for getDataUsageBytes() must reflect the data consumed since this reset time.

It may be null if this information is not available or not applicable to the plan.

getDataUsageTime

fun getDataUsageTime(): Long

Returns the time at which getDataUsageBytes() was measured, in milliseconds since the Unix epoch.

This timestamp indicates how recent the data usage information is. It allows applications to decide whether the usage value is current enough for their needs.
Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.

getId

fun getId(): Int

Returns the unique integer identifier for this subscription plan.

This ID is provided by the carrier and can be used to uniquely identify this plan, particularly when interacting with entitlement server for enrolling.

It may be UNSPECIFIED_ID if no ID is specified.

getNetworkTypes

fun getNetworkTypes(): IntArray

Returns the network types that this plan applies to.

A "default" plan, which applies to any network type not explicitly covered by another plan, will include all possible network types in the returned array. Each subscription should have at most one default plan.

A RAT-specific plan will return an array containing only the network types it applies to, for example, TelephonyManager.NETWORK_TYPE_LTE.

getPlanEndDate

fun getPlanEndDate(): ZonedDateTime?

Returns the end date of this subscription plan.

This indicates the specific date and time when the plan is no longer valid. For recurring plans that do not have a defined end, this will be null.

getSubscriptionStatus

fun getSubscriptionStatus(): Int

Returns the status of the subscription plan.

This indicates the current state of the subscription, such as whether it is active, suspended, or in a trial period. This status provides context on the plan's availability and can be used to inform the user about their subscription's lifecycle.

getSummary

fun getSummary(): CharSequence?

Returns a brief, human-readable summary of the subscription plan.

This could include details about the plan's features, such as "10GB of high-speed data" or "Unlimited talk and text". This summary is intended for display to the user.

getTitle

fun getTitle(): CharSequence?

Returns a user-visible title for this plan.

This title is provided by the carrier to identify the subscription plan, for example, "Unlimited+" or "Family plan". It is intended for display to the user.

getTypes

fun getTypes(): MutableSet<Int!>

Returns the characteristics of this subscription plan as a set of type constants. A plan can have multiple types that describe its nature. For example, a plan might be both a PLAN_TYPE_CELLULAR and a PLAN_TYPE_POSTPAID plan.

The returned set allows for efficient checks of plan characteristics using Set.contains(Object) and Set.containsAll(java.util.Collection).

The types can be used to understand the plan's attributes and tailor an application's behavior. For instance, a data management app could display different UI elements for a PLAN_TYPE_PREPAID versus a PLAN_TYPE_POSTPAID plan.

hashCode

fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

toString

fun toString(): String

Returns a string representation of the object.

writeToParcel

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

CREATOR

static val CREATOR: Parcelable.Creator<SubscriptionPlan!>