Builder

build

open fun build(): SubscriptionPlan!

createNonrecurring

open static fun createNonrecurring(duration: Period): SubscriptionPlan.Builder

Start defining a template for a non-recurring SubscriptionPlan with a specific duration.

This is useful for describing fixed-duration plans that users can enroll in, such as a travel pass or a one-time data package. The actual start and end dates are determined upon enrollment.

Plans created with this builder should be marked with setSubscriptionStatus(int) and a status of SUBSCRIPTION_STATUS_INACTIVE.

createNonrecurring

open static fun createNonrecurring(
    start: ZonedDateTime!, 
    end: ZonedDateTime!
): SubscriptionPlan.Builder!

Start defining a SubscriptionPlan that covers a very specific window of time, and never automatically recurs.

createRecurring

open static fun createRecurring(
    start: ZonedDateTime!, 
    period: Period!
): SubscriptionPlan.Builder!

Start defining a SubscriptionPlan that starts at a specific time, and automatically recurs after each specific period of time, repeating indefinitely.

When the given period is set to exactly one month, the plan will always recur on the day of the month defined by ZonedDateTime.getDayOfMonth(). When a particular month ends before this day, the plan will recur on the last possible instant of that month.

resetNetworkTypes

open fun resetNetworkTypes(): SubscriptionPlan.Builder

Reset any network types that were set with setNetworkTypes(int[]). This will make the SubscriptionPlan apply to all network types.

setDataLimit

open fun setDataLimit(
    dataLimitBytes: Long, 
    dataLimitBehavior: Int
): SubscriptionPlan.Builder!

Set the usage threshold at which data access changes.

setDataUsage

open fun setDataUsage(
    dataUsageBytes: Long, 
    dataUsageTime: Long
): SubscriptionPlan.Builder!

Set a snapshot of currently known mobile data usage.

setDataUsageResetTime

open fun setDataUsageResetTime(dataUsageResetTime: ZonedDateTime?): SubscriptionPlan.Builder

Sets the time when the data usage allowance will reset.

This is particularly relevant for plans with a daily data allowance, as it specifies the exact moment (e.g., midnight in a specific timezone) when the usage for the next 24-hour will reset. For other types of plans, this may not be applicable.

The value provided for setDataUsage(long,long) should reflect the data consumed since the last reset time.

setId

open fun setId(id: Int): SubscriptionPlan.Builder

Sets 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.

setNetworkTypes

open fun setNetworkTypes(networkTypes: IntArray): SubscriptionPlan.Builder

Set the network types this SubscriptionPlan applies to. By default the plan will apply to all network types. An empty array means this plan applies to no network types.

setStreamingAppMaxDownlinkKbps

open fun setStreamingAppMaxDownlinkKbps(downlinkKbps: Long): SubscriptionPlan.Builder

Sets the maximum downstream bitrate for streaming applications on this subscription plan, in Kilobits per second (Kbps) defined in GSMA TS.43 9.1.3.

setStreamingAppMaxUplinkKbps

open fun setStreamingAppMaxUplinkKbps(uplinkKbps: Long): SubscriptionPlan.Builder

Sets the maximum upstream bitrate for streaming applications on this subscription plan, in Kilobits per second (Kbps) defined in GSMA TS.43 9.1.3.

setSubscriptionStatus

open fun setSubscriptionStatus(subscriptionStatus: Int): SubscriptionPlan.Builder

Set the subscription status.

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.

setSummary

open fun setSummary(summary: CharSequence?): SubscriptionPlan.Builder!

Sets 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.

setTitle

open fun setTitle(title: CharSequence?): SubscriptionPlan.Builder!

Sets 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.

setTypes

open fun setTypes(types: IntArray): SubscriptionPlan.Builder

Set the types of this subscription plan. A plan can have multiple types, and this method will return all that are applicable. For example, a plan could be both a cellular plan and a postpaid plan.