> For the complete documentation index, see [llms.txt](https://onestore-dev.gitbook.io/dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://onestore-dev.gitbook.io/dev/eng/tools/billing/v21/references/classes/purchaseflowparams.md).

# PurchaseFlowParams

public class PurchaseFlowParams extends Object\
java.lang.Object    ↳ com.gaa.sdk.iap.PurchaseFlowParams

\
A parameter to purchase the in-app products.

\
**See Also:**\
[PurchaseClient.launchPurchaseFlow](/dev/eng/tools/billing/v21/references/classes/purchaseclient.md)(Activity, [PurchaseFlowParams](/dev/eng/tools/billing/v21/references/classes/purchaseflowparams.md))

\
Summary <a href="#id-en-purchaseflowparams-summary" id="id-en-purchaseflowparams-summary"></a>
----------------------------------------------------------------------------------------------

***

| **Nested classes** |                                                                                                                                                  |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| class              | <p><a href="/pages/sH74S2r0dmvy51IH6Eq5">PurchaseFlowParams.Builder<br></a>A builder that helps create a PurchaseFlowParams instance easily.</p> |

## Public methods <a href="#id-en-purchaseflowparams-publicmethods" id="id-en-purchaseflowparams-publicmethods"></a>

***

### getProductId <a href="#id-en-purchaseflowparams-getproductid" id="id-en-purchaseflowparams-getproductid"></a>

String getProductId()\
ID of the in-app products to purchase.

| **Returns:** |             |
| ------------ | ----------- |
| String       | <p><br></p> |

### getProductType <a href="#id-en-purchaseflowparams-getproducttype" id="id-en-purchaseflowparams-getproducttype"></a>

String getProductType()\
Type of the in-app products to purchase.

| **Returns:** |                                                                                                               |
| ------------ | ------------------------------------------------------------------------------------------------------------- |
| String       | [PurchaseClient.ProductType](/dev/eng/tools/billing/v21/references/annptations/purchaseclient.producttype.md) |

### getProductName <a href="#id-en-purchaseflowparams-getproductname" id="id-en-purchaseflowparams-getproductname"></a>

String getProductName()\
The name of products that will be exposed at the time of purchase (not the name of the registered products). If it is null, the registered products' name will be exposed on the purchase page.

| **Returns:** |             |
| ------------ | ----------- |
| String       | <p><br></p> |

### getGameUserId <a href="#id-en-purchaseflowparams-getgameuserid" id="id-en-purchaseflowparams-getgameuserid"></a>

String getGameUserId()\
User's ID that is able to be verified by the developer.

| **Returns:** |             |
| ------------ | ----------- |
| String       | <p><br></p> |

### isPromotionApplicable <a href="#id-en-purchaseflowparams-ispromotionapplicable" id="id-en-purchaseflowparams-ispromotionapplicable"></a>

boolean isPromotionApplicable()\
Indicates whether the promotion is applicable or not.

| **Returns:** |             |
| ------------ | ----------- |
| boolean      | <p><br></p> |

### getDeveloperPayload <a href="#id-en-purchaseflowparams-getdeveloperpayload" id="id-en-purchaseflowparams-getdeveloperpayload"></a>

String getDeveloperPayload()\
Restores the payload that is specified by the developer.

| **Returns:** |             |
| ------------ | ----------- |
| String       | <p><br></p> |

### getOldPurchaseToken <a href="#id-en-purchaseflowparams-getoldpurchasetoken" id="id-en-purchaseflowparams-getoldpurchasetoken"></a>

String getOldPurchaseToken()\
Purchase token of subscription products to be changed.

| **Returns:** |             |
| ------------ | ----------- |
| String       | <p><br></p> |

### getProrationMode() <a href="#id-en-purchaseflowparams-getprorationmode" id="id-en-purchaseflowparams-getprorationmode"></a>

int getProrationMode()\
Proration mode for upgrade or downgrade.

| **Returns:** |                                  |
| ------------ | -------------------------------- |
| int          | PurchaseFlowParams.ProrationMode |

### getQuantity() <a href="#id-en-purchaseflowparams-getquantity" id="id-en-purchaseflowparams-getquantity"></a>

int getQuantity()\
Indicates the quantity of the products.

| **Returns:** |             |
| ------------ | ----------- |
| int          | <p><br></p> |

### newBuilder <a href="#id-en-purchaseflowparams-newbuilder" id="id-en-purchaseflowparams-newbuilder"></a>

PurchaseFlowParams.Builder newBuilder()\
Generates the builder to create a PurchaseFlowParams instance.

| **Returns:**                                                                                              |             |
| --------------------------------------------------------------------------------------------------------- | ----------- |
| [PurchaseFlowParams.Builder](/dev/eng/tools/billing/v21/references/classes/purchaseflowparams.builder.md) | <p><br></p> |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://onestore-dev.gitbook.io/dev/eng/tools/billing/v21/references/classes/purchaseflowparams.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.