Summary: Methods | Inherited Methods

BillingFlowParams.Builder

public static class BillingFlowParams.Builder
extends Object

java.lang.Object
↳	com.android.billingclient.api.BillingFlowParams.Builder

Helps to construct BillingFlowParams that are used to initiate a purchase flow.

Summary

Public methods
`BillingFlowParams`	`build()` Returns `BillingFlowParams` reference to initiate a purchase flow.
`BillingFlowParams.Builder`	`setObfuscatedAccountId(String obfuscatedAccountid)` Specifies an optional obfuscated string that is uniquely associated with the user's account in your app.
`BillingFlowParams.Builder`	`setObfuscatedProfileId(String obfuscatedProfileId)` Specifies an optional obfuscated string that is uniquely associated with the user's profile in your app.
`BillingFlowParams.Builder`	`setOldSku(String oldSku, String purchaseToken)` Specifies the SKU and purchase token that the user is upgrading or downgrading from. Included in documentation by the annotations: @Annotations.HideMultiItem
`BillingFlowParams.Builder`	`setReplaceSkusProrationMode(int replaceSkusProrationMode)` Specifies the mode of proration during subscription upgrade/downgrade. Included in documentation by the annotations: @Annotations.HideMultiItem
`BillingFlowParams.Builder`	`setSkuDetails(SkuDetails skuDetails)` Specifies the `SkuDetails` of the item being purchased.
`BillingFlowParams.Builder`	`setVrPurchaseFlow(boolean isVrPurchaseFlow)` Specifies whether to launch a VR purchase flow.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Public methods

build

public BillingFlowParams build ()

Returns BillingFlowParams reference to initiate a purchase flow.

Returns
`BillingFlowParams`

setObfuscatedAccountId

public BillingFlowParams.Builder setObfuscatedAccountId (String obfuscatedAccountid)

Specifies an optional obfuscated string that is uniquely associated with the user's account in your app.

If you pass this value, Google Play can use it to detect irregular activity, such as many devices making purchases on the same account in a short period of time. Do not use this field to store any Personally Identifiable Information (PII) such as emails in cleartext. Attempting to store PII in this field will result in purchases being blocked. Google Play recommends that you use either encryption or a one-way hash to generate an obfuscated identifier to send to Google Play.

You can also retrieve this identifier via the Purchase object.

This identifier is limited to 64 characters.

Optional:

To buy in-app item
To create a new subscription
To replace an old subscription

Parameters
`obfuscatedAccountid`	`String`

Returns
`BillingFlowParams.Builder`

setObfuscatedProfileId

public BillingFlowParams.Builder setObfuscatedProfileId (String obfuscatedProfileId)

Specifies an optional obfuscated string that is uniquely associated with the user's profile in your app.

Some applications allow users to have multiple profiles within a single account. Use this method to send the user's profile identifier to Google. Setting this field requests the user's obfuscated account id to be pass via setObfuscatedAccountId(String).

You can also retrieve this identifier via the Purchase object.

This identifier is limited to 64 characters.

Optional:

To buy in-app item
To create a new subscription
To replace an old subscription

Parameters
`obfuscatedProfileId`	`String`

Returns
`BillingFlowParams.Builder`

setOldSku

public BillingFlowParams.Builder setOldSku (String oldSku, 
                String purchaseToken)

Included in documentation by the annotations: @Annotations.HideMultiItem

Specifies the SKU and purchase token that the user is upgrading or downgrading from. This will disambiguate situations where multiple accounts on the device own the same SKU.

Mandatory:

To replace an old subscription

Parameters
`oldSku`	`String`
`purchaseToken`	`String`

Returns
`BillingFlowParams.Builder`

setReplaceSkusProrationMode

public BillingFlowParams.Builder setReplaceSkusProrationMode (int replaceSkusProrationMode)

Included in documentation by the annotations: @Annotations.HideMultiItem

Specifies the mode of proration during subscription upgrade/downgrade. This value will only be effective if the old SKU is also set.

Parameters
`replaceSkusProrationMode`	`int`: One of the `BillingFlowParams.ProrationMode` constants.

Returns
`BillingFlowParams.Builder`

setSkuDetails

public BillingFlowParams.Builder setSkuDetails (SkuDetails skuDetails)

Specifies the SkuDetails of the item being purchased.

Mandatory:

To buy in-app item
To create a new subscription
To replace an old subscription

Parameters
`skuDetails`	`SkuDetails`

Returns
`BillingFlowParams.Builder`

setVrPurchaseFlow

public BillingFlowParams.Builder setVrPurchaseFlow (boolean isVrPurchaseFlow)

Specifies whether to launch a VR purchase flow.

Optional:

To buy in-app item
To create a new subscription
To replace an old subscription

Parameters
`isVrPurchaseFlow`	`boolean`

Returns
`BillingFlowParams.Builder`