# Get Purchase History / Restore Purchases

## Get Purchase History

You must be able to restore your users purchases at the click of a button. This is an iOS App Store policy.

<details>

<summary>Learn more about the data this API call returns</summary>

The following is the format of data returned by this block

```javascript
//iOS
[{
purchaseTime:234234234234,
originalPurchaseTime:23423423423423,
purchaseState: 2,
orderId:"adsfasfdf",
originalOrderId:"232adfa",
acknowledged: true,
productId:"rasdf",
transactionReceipt:"LONG STRING"
}]






//Android
[{
"packageName":"edu.fit.jgibb",
"productID":"new_sub",
"acknowledged":true,
"purchaseToken":"LONG STRING",
"purchaseState":1,
"orderId":"GPA.3388-2344-2345-65433",
"purchaseTIme":23423423423423424
}]
```

Notes about purchaseState:

0 = PURCHASING - The transaction is being processed.&#x20;

1 =  PURCHASED - The App Store successfully processed payment.&#x20;

2 = FAILED - The transaction failed.

3 = RESTORED - iOS OnlyThis transaction restores content previously purchased by the user. Read the originalTransaction properties to obtain information about the original purchase. InAppPurchaseState.RESTORED ＝ 3

4 = DEFERRED - iOS OnlyThe transaction has been received, but its final status is pending external action such as the Ask to Buy feature where a child initiates a new purchase and has to wait for the family organizer's approval. Update your UI to show the deferred state, and wait for another callback that indicates the final status.&#x20;

</details>

<div align="left"><figure><img src="/files/B1dfJuhh25ir07AhydIO" alt=""><figcaption></figcaption></figure></div>

<figure><img src="/files/yemvBWPFq7FPbXj0agQI" alt=""><figcaption></figcaption></figure>

A quick note on the blocks above. users have asked where the individualPurchaes variable comes from.&#x20;

{% embed url="<https://www.loom.com/share/c31d13e14cac44858556fb67a6d5a74c>" %}

### Get purchase history step-by-step

{% tabs %}
{% tab title="1" %}
First show the hider to block user interaction, then call <mark style="color:purple;">`Get Purchase History`</mark>&#x20;

<div align="left"><figure><img src="/files/5XvY0eybcpBfYJRX5o3O" alt=""><figcaption></figcaption></figure></div>

<mark style="color:green;">`List of Purchase info`</mark> will output a list of objects that are formatted like this:

```
[{
purchaseTime:234234234234, //this will be Epoch time in miliseconds
originalPurchaseTime:23423423423423, //this value is formatted as above
purchaseState: 2,
orderId:"adsfasfdf",
originalOrderId:"232adfa",
acknowledged: true,
productId:"YOUR_PRODUCT_IDs_WILL_BE_HERE", 
transactionReceipt:"THIS_IS_A_VERY_LONG_STRING"
}]

[{
purchaseTime:234234234234, //this will be Epoch time in miliseconds
originalPurchaseTime:23423423423423, //this value is formatted as above
purchaseState: 2,
orderId:"adsfasfdf",
originalOrderId:"232adfa",
acknowledged: true,
productId:"YOUR_PRODUCT_IDs_WILL_BE_HERE", 
transactionReceipt:"THIS_IS_A_VERY_LONG_STRING"
}]
```

[more info on Epoch time](https://www.epochconverter.com/)
{% endtab %}

{% tab title="2" %}
Assign a temporary variable as an empty list.

<div align="left"><figure><img src="/files/PRiOwFQe1wufzkUycXo4" alt=""><figcaption></figcaption></figure></div>
{% endtab %}

{% tab title="3" %}
If there's not an error, pass the `List of Purchase Info` to the `Restore Previous Purchases` function, else handle the error<mark style="color:green;">`.`</mark>

<div align="left"><figure><img src="/files/DLaUeu2hOJ4HEDqsSUgj" alt=""><figcaption></figcaption></figure></div>
{% endtab %}

{% tab title="4" %}
Handling restoration will look different for each app, however in general it should follow this general format.

<div align="left"><figure><img src="/files/IUkcxP5taSSrZ4R5fa7Z" alt=""><figcaption></figcaption></figure></div>

Notice the \_listOfPurchases variable. you can create that by clicking the cog wheel, dragging an `input name`  block into the `inputs` receiver, and giving it a meaningful name
{% endtab %}

{% tab title="5" %}
Loop through the list of purchases.  You can access this variable by right clicking on the function body and selecting `create _listOfPurchases`&#x20;

<div align="left"><figure><img src="/files/ZtYt5CMuljqCVg9mbVUX" alt=""><figcaption></figcaption></figure></div>

Notice that the 'for each item' variable name is 'individualPurchase'. See how to change those variable names below. <br>

![](https://media.giphy.com/media/kE1w8kzJ4YXwhoy4q1/giphy.gif)
{% endtab %}

{% tab title="6" %}
in the loop, you will first check if that purchases product\_id matches one of your known products, and then the purchaseState to ensure the product's purchase is still valid.&#x20;

<div align="left"><figure><img src="/files/apDiTCPOC2GhjgwrTpqF" alt=""><figcaption></figcaption></figure></div>

There should be one of these for each item you have in your app using an if/else if/else allowing for 1 check per product.&#x20;
{% endtab %}

{% tab title="7" %}
if the item passed the checks in **step 6,** check if `purchasedItems` list contains that purchase and if not, add it to the list.&#x20;

<div align="left"><figure><img src="/files/vRWJftWrLfyQ8NhQDkQC" alt=""><figcaption></figcaption></figure></div>
{% endtab %}

{% tab title="8" %}
The final step is to save the state of the purchase locally so that you do not need to verify purchases every day. It is recommended to regularly [check that subscriptions are still valid](#verify-ios-transaction-and-purchase-status).&#x20;

<div align="left"><figure><img src="/files/dfFYlPU60FrzdqBalJQW" alt=""><figcaption></figcaption></figure></div>

In this example, we store a T/F value for the purchase as well as the transactionReceipt. This allows the app to permit/block access to the purchased item and allows the app to check if the purchase is still valid again in the future.&#x20;
{% endtab %}

{% tab title="9" %}
In our example, we display an alert to the user to display the  restored purchases. This is not required, though highly recommended as your users will appreciate that information. ***The main purpose of a workflow like this would be to be able to\*\*\*\*&#x20;**<mark style="color:green;">**restore purchases**</mark>**&#x20;\*\*\*\*if the user has to reinstall the app or changes phone***
{% endtab %}
{% endtabs %}

##


---

# Agent Instructions: 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:

```
GET https://docs.thunkable.com/~/changes/wHhkjLVeheBnfbpghRnw/in-app-purchases/get-purchase-history-restore-purchases.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.