SubscriptionPlan
public
final
class
SubscriptionPlan
extends Object
implements
Parcelable
| java.lang.Object | |
| ↳ | android.telephony.SubscriptionPlan |
Description of a billing relationship plan between a carrier and a specific subscriber. This information is used to present more useful UI to users, such as explaining how much mobile data they have remaining, and what will happen when they run out.
If specifying network types, the developer must supply at least one plan
that applies to all network types (default), and all additional plans
may not include a particular network type more than once.
This is enforced by SubscriptionManager when setting the plans.
Plan selection will prefer plans that have specific network types defined over plans that apply to all network types.
See also:
Summary
Nested classes | |
|---|---|
class |
SubscriptionPlan.Builder
Builder for a |
Constants | |
|---|---|
long |
BITRATE_UNKNOWN
Value indicating data rate is unknown. |
long |
BYTES_UNKNOWN
Value indicating a number of bytes is unknown. |
long |
BYTES_UNLIMITED
Value indicating a number of bytes is unlimited. |
int |
LIMIT_BEHAVIOR_BILLED
Indicates that the user will be billed for data usage beyond the limit. |
int |
LIMIT_BEHAVIOR_DISABLED
Indicates that data access is disabled when the data limit is reached. |
int |
LIMIT_BEHAVIOR_THROTTLED
Indicates that data access is throttled to a slower speed when the limit is reached. |
int |
LIMIT_BEHAVIOR_UNKNOWN
Indicates that the behavior for when a data limit is reached is unknown. |
int |
PLAN_TYPE_BUSINESS
The plan is for business or enterprise customers. |
int |
PLAN_TYPE_CELLULAR
The plan provides conventional cellular service. |
int |
PLAN_TYPE_DATA_ONLY
The plan is for data-only service. |
int |
PLAN_TYPE_FAMILY
The plan is a family plan, shared among multiple users. |
int |
PLAN_TYPE_IOT
The plan is designed for Internet of Things (IoT) devices. |
int |
PLAN_TYPE_POSTPAID
The plan is a postpaid plan. |
int |
PLAN_TYPE_PREPAID
The plan is a prepaid plan. |
int |
PLAN_TYPE_ROAMING
The plan is specifically for roaming services. |
int |
PLAN_TYPE_SATELLITE
The plan provides satellite-based service. |
int |
PLAN_TYPE_TETHERING
The plan provides a data allowance specifically for tethering or mobile hotspot usage. |
int |
SUBSCRIPTION_STATUS_ACTIVE
The subscription is active. |
int |
SUBSCRIPTION_STATUS_INACTIVE
The subscription is inactive. |
int |
SUBSCRIPTION_STATUS_SUSPENDED
The subscription is suspended. |
int |
SUBSCRIPTION_STATUS_TRIAL
The subscription is in a trial period. |
int |
SUBSCRIPTION_STATUS_UNKNOWN
The subscription status is unknown. |
long |
TIME_UNKNOWN
Value indicating a timestamp is unknown. |
int |
UNSPECIFIED_ID
Value indicating that the SubscriptionPlan ID is not specified. |
Inherited constants |
|---|
Fields | |
|---|---|
public
static
final
Creator<SubscriptionPlan> |
CREATOR
|
Public methods | |
|---|---|
Iterator<Range<ZonedDateTime>>
|
cycleIterator()
Returns an iterator that provides the data usage billing cycles for this plan, based on its recurrence rule. |
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one. |
int
|
getDataLimitBehavior()
Returns the behavior of data access when usage reaches the limit defined by
|
long
|
getDataLimitBytes()
Returns the data limit for the plan. |
long
|
getDataUsageBytes()
Returns a snapshot of the mobile data usage, in bytes, as of the time reported by
|
ZonedDateTime
|
getDataUsageResetTime()
Returns the time at which the data usage will reset. |
long
|
getDataUsageTime()
Returns the time at which |
int
|
getId()
Returns the unique integer identifier for this subscription plan. |
int[]
|
getNetworkTypes()
Returns the network types that this plan applies to. |
ZonedDateTime
|
getPlanEndDate()
Returns the end date of this subscription plan. |
int
|
getSubscriptionStatus()
Returns the status of the subscription plan. |
CharSequence
|
getSummary()
Returns a brief, human-readable summary of the subscription plan. |
CharSequence
|
getTitle()
Returns a user-visible title for this plan. |
Set<Integer>
|
getTypes()
Returns the characteristics of this subscription plan as a set of type constants. |
int
|
hashCode()
Returns a hash code value for the object. |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
|---|---|
Constants
BITRATE_UNKNOWN
public static final long BITRATE_UNKNOWN
Value indicating data rate is unknown.
Constant Value: -1 (0xffffffffffffffff)
BYTES_UNKNOWN
public static final long BYTES_UNKNOWN
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.
Constant Value: -1 (0xffffffffffffffff)
BYTES_UNLIMITED
public static final long BYTES_UNLIMITED
Value indicating a number of bytes is unlimited.
This value is used when the carrier has not specified a data limit.
Constant Value: 9223372036854775807 (0x7fffffffffffffff)
LIMIT_BEHAVIOR_BILLED
public static final int LIMIT_BEHAVIOR_BILLED
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.
Constant Value: 1 (0x00000001)
LIMIT_BEHAVIOR_DISABLED
public static final int LIMIT_BEHAVIOR_DISABLED
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.
Constant Value: 0 (0x00000000)
LIMIT_BEHAVIOR_THROTTLED
public static final int LIMIT_BEHAVIOR_THROTTLED
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.
Constant Value: 2 (0x00000002)
LIMIT_BEHAVIOR_UNKNOWN
public static final int LIMIT_BEHAVIOR_UNKNOWN
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.
Constant Value: -1 (0xffffffff)
PLAN_TYPE_BUSINESS
public static final int PLAN_TYPE_BUSINESS
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).
Constant Value: 8 (0x00000008)
PLAN_TYPE_CELLULAR
public static final int PLAN_TYPE_CELLULAR
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).
Constant Value: 1 (0x00000001)
PLAN_TYPE_DATA_ONLY
public static final int PLAN_TYPE_DATA_ONLY
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.
Constant Value: 6 (0x00000006)
PLAN_TYPE_FAMILY
public static final int PLAN_TYPE_FAMILY
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.
Constant Value: 7 (0x00000007)
PLAN_TYPE_IOT
public static final int PLAN_TYPE_IOT
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.
Constant Value: 3 (0x00000003)
PLAN_TYPE_POSTPAID
public static final int PLAN_TYPE_POSTPAID
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.
Constant Value: 4 (0x00000004)
PLAN_TYPE_PREPAID
public static final int PLAN_TYPE_PREPAID
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.
Constant Value: 5 (0x00000005)
PLAN_TYPE_ROAMING
public static final int PLAN_TYPE_ROAMING
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.
Constant Value: 9 (0x00000009)
PLAN_TYPE_SATELLITE
public static final int PLAN_TYPE_SATELLITE
The plan provides satellite-based service.
This is used for plans that deliver connectivity via satellite.
Constant Value: 2 (0x00000002)
PLAN_TYPE_TETHERING
public static final int PLAN_TYPE_TETHERING
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.
Constant Value: 10 (0x0000000a)
SUBSCRIPTION_STATUS_ACTIVE
public static final int SUBSCRIPTION_STATUS_ACTIVE
The subscription is active.
This indicates that the subscription is in good standing and all services are available to the user.
Constant Value: 1 (0x00000001)
SUBSCRIPTION_STATUS_INACTIVE
public static final int SUBSCRIPTION_STATUS_INACTIVE
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.
Constant Value: 2 (0x00000002)
SUBSCRIPTION_STATUS_SUSPENDED
public static final int SUBSCRIPTION_STATUS_SUSPENDED
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.
Constant Value: 4 (0x00000004)
SUBSCRIPTION_STATUS_TRIAL
public static final int SUBSCRIPTION_STATUS_TRIAL
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.
Constant Value: 3 (0x00000003)
SUBSCRIPTION_STATUS_UNKNOWN
public static final int SUBSCRIPTION_STATUS_UNKNOWN
The subscription status is unknown.
This is the default value, used when the carrier is unable to provide the current status of the subscription.
Constant Value: 0 (0x00000000)
TIME_UNKNOWN
public static final long TIME_UNKNOWN
Value indicating a timestamp is unknown.
Constant Value: -1 (0xffffffffffffffff)
UNSPECIFIED_ID
public static final int UNSPECIFIED_ID
Value indicating that the SubscriptionPlan ID is not specified.
Constant Value: -1 (0xffffffff)
Fields
Public methods
cycleIterator
public Iterator<Range<ZonedDateTime>> cycleIterator ()
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.
| Returns | |
|---|---|
Iterator<Range<ZonedDateTime>> |
An iterator for the plan's billing cycles. |
describeContents
public int describeContents ()
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.
| Returns | |
|---|---|
int |
a bitmask indicating the set of special object types marshaled
by this Parcelable object instance.
Value is either 0 or
|
equals
public boolean equals (Object obj)
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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.
| Parameters | |
|---|---|
obj |
Object: This value may be null. |
| Returns | |
|---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getDataLimitBehavior
public int getDataLimitBehavior ()
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.
| Returns | |
|---|---|
int |
The data limit behavior, which will be one of LIMIT_BEHAVIOR_UNKNOWN,
LIMIT_BEHAVIOR_DISABLED, LIMIT_BEHAVIOR_BILLED, or
LIMIT_BEHAVIOR_THROTTLED.
Value is one of the following: |
getDataLimitBytes
public long getDataLimitBytes ()
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.
| Returns | |
|---|---|
long |
The data limit in bytes. This may be BYTES_UNKNOWN if the limit is not
available, or BYTES_UNLIMITED if there is no limit.
Value is a non-negative number of bytes. |
getDataUsageBytes
public long getDataUsageBytes ()
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 ERROR(/#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.
| Returns | |
|---|---|
long |
The data usage in bytes, or BYTES_UNKNOWN if unavailable.
Value is a non-negative number of bytes. |
getDataUsageResetTime
public ZonedDateTime getDataUsageResetTime ()
Returns the time at which the data usage will reset.
This is distinct from the billing cycle or plan duration returned by
ERROR(/#getCycleRule()). For example, a 15-day travel plan might have a
ERROR(/#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 ERROR(/#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.
| Returns | |
|---|---|
ZonedDateTime |
|
getDataUsageTime
public long getDataUsageTime ()
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.
| Returns | |
|---|---|
long |
The time of the data usage snapshot as a Unix epoch timestamp, or
TIME_UNKNOWN if unavailable.
Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z. |
See also:
getId
public int getId ()
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.
| Returns | |
|---|---|
int |
The unique integer identifier for the plan, or UNSPECIFIED_ID if not
specified. |
getNetworkTypes
public int[] getNetworkTypes ()
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.
| Returns | |
|---|---|
int[] |
A new copy of the array of network types this plan applies to. The values will be
constants from TelephonyManager, such as TelephonyManager.NETWORK_TYPE_LTE.
This value cannot be null.
Value is one of the following:
|
getPlanEndDate
public ZonedDateTime getPlanEndDate ()
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.
| Returns | |
|---|---|
ZonedDateTime |
The plan's end date as a ZonedDateTime, or null if unavailable. |
getSubscriptionStatus
public int getSubscriptionStatus ()
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.
| Returns | |
|---|---|
int |
The subscription status, which is one of the SUBSCRIPTION_STATUS_*
constants, or SUBSCRIPTION_STATUS_UNKNOWN if not available.
Value is one of the following: |
getSummary
public CharSequence getSummary ()
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.
| Returns | |
|---|---|
CharSequence |
A short, user-friendly summary of the plan, or null if not specified. |
getTitle
public CharSequence getTitle ()
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.
| Returns | |
|---|---|
CharSequence |
The title of the plan, or null if not specified. |
getTypes
public Set<Integer> getTypes ()
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.
| Returns | |
|---|---|
Set<Integer> |
An unmodifiable Set of plan type constants, for example
PLAN_TYPE_CELLULAR or PLAN_TYPE_DATA_ONLY. The set will be empty if no
types are associated with the plan.
This value cannot be null.
Value is one of the following: |
hashCode
public int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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.
| Returns | |
|---|---|
int |
a hash code value for this object. |
toString
public String toString ()
Returns a string representation of the object.
| Returns | |
|---|---|
String |
a string representation of the object. |
writeToParcel
public void writeToParcel (Parcel dest, int flags)
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
dest |
Parcel: The Parcel in which the object should be written.
This value cannot be null. |
flags |
int: Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.
Value is either 0 or a combination of the following:
|
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2026-02-26 UTC.