# EconomyApi

All URIs are relative to *https://api.vrchat.cloud/api/1*

| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**getActiveLicenses**](EconomyApi.md#getActiveLicenses) | **GET** /economy/licenses/active | Get Active Licenses |
| [**getBalance**](EconomyApi.md#getBalance) | **GET** /user/{userId}/balance | Get Balance |
| [**getBalanceEarnings**](EconomyApi.md#getBalanceEarnings) | **GET** /user/{userId}/balance/earnings | Get Balance Earnings |
| [**getBulkGiftPurchases**](EconomyApi.md#getBulkGiftPurchases) | **GET** /user/bulk/gift/purchases | Get Bulk Gift Purchases |
| [**getCurrentSubscriptions**](EconomyApi.md#getCurrentSubscriptions) | **GET** /auth/user/subscription | Get Current Subscriptions |
| [**getEconomyAccount**](EconomyApi.md#getEconomyAccount) | **GET** /user/{userId}/economy/account | Get Economy Account |
| [**getLicenseGroup**](EconomyApi.md#getLicenseGroup) | **GET** /licenseGroups/{licenseGroupId} | Get License Group |
| [**getProductListing**](EconomyApi.md#getProductListing) | **GET** /listing/{productId} | Get Product Listing |
| [**getProductListingAlternate**](EconomyApi.md#getProductListingAlternate) | **GET** /products/{productId} | Get Product Listing (alternate) |
| [**getProductListings**](EconomyApi.md#getProductListings) | **GET** /user/{userId}/listings | Get User Product Listings |
| [**getProductPurchases**](EconomyApi.md#getProductPurchases) | **GET** /economy/purchases | Get Product Purchases |
| [**getRecentSubscription**](EconomyApi.md#getRecentSubscription) | **GET** /user/subscription/recent | Get Recent Subscription |
| [**getSteamTransaction**](EconomyApi.md#getSteamTransaction) | **GET** /Steam/transactions/{transactionId} | Get Steam Transaction |
| [**getSteamTransactions**](EconomyApi.md#getSteamTransactions) | **GET** /Steam/transactions | List Steam Transactions |
| [**getStore**](EconomyApi.md#getStore) | **GET** /economy/store | Get Store |
| [**getStoreShelves**](EconomyApi.md#getStoreShelves) | **GET** /economy/store/shelves | Get Store Shelves |
| [**getSubscriptions**](EconomyApi.md#getSubscriptions) | **GET** /subscriptions | List Subscriptions |
| [**getTiliaStatus**](EconomyApi.md#getTiliaStatus) | **GET** /tilia/status | Get Tilia Status |
| [**getTiliaTos**](EconomyApi.md#getTiliaTos) | **GET** /user/{userId}/tilia/tos | Get Tilia TOS Agreement Status |
| [**getTokenBundles**](EconomyApi.md#getTokenBundles) | **GET** /tokenBundles | List Token Bundles |
| [**getUserCreditsEligible**](EconomyApi.md#getUserCreditsEligible) | **GET** /users/{userId}/credits/eligible | Get User Credits Eligiblity |
| [**getUserSubscriptionEligible**](EconomyApi.md#getUserSubscriptionEligible) | **GET** /users/{userId}/subscription/eligible | Get User Subscription Eligiblity |
| [**purchaseProductListing**](EconomyApi.md#purchaseProductListing) | **POST** /economy/purchase/listing | Purchase Product Listing |
| [**updateTiliaTos**](EconomyApi.md#updateTiliaTos) | **PUT** /user/{userId}/tilia/tos | Update Tilia TOS Agreement Status |


<a name="getActiveLicenses"></a>
# **getActiveLicenses**
> List getActiveLicenses()

Get Active Licenses

    Gets active licenses

### Parameters
This endpoint does not need any parameter.

### Return type

[**List**](../Models/License.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getBalance"></a>
# **getBalance**
> Balance getBalance(userId)

Get Balance

    Gets the balance of a user

### Parameters

|Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |

### Return type

[**Balance**](../Models/Balance.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getBalanceEarnings"></a>
# **getBalanceEarnings**
> Balance getBalanceEarnings(userId)

Get Balance Earnings

    Gets the balance of a user from earnings

### Parameters

|Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |

### Return type

[**Balance**](../Models/Balance.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getBulkGiftPurchases"></a>
# **getBulkGiftPurchases**
> List getBulkGiftPurchases(mostRecent)

Get Bulk Gift Purchases

    Get bulk gift purchases made by the user.

### Parameters

|Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **mostRecent** | **Boolean**|  | [optional] [default to null] |

### Return type

**List**

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getCurrentSubscriptions"></a>
# **getCurrentSubscriptions**
> List getCurrentSubscriptions()

Get Current Subscriptions

    Get a list of all current user subscriptions.

### Parameters
This endpoint does not need any parameter.

### Return type

[**List**](../Models/UserSubscription.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getEconomyAccount"></a>
# **getEconomyAccount**
> EconomyAccount getEconomyAccount(userId)

Get Economy Account

    Gets the economy account of a user

### Parameters

|Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |

### Return type

[**EconomyAccount**](../Models/EconomyAccount.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getLicenseGroup"></a>
# **getLicenseGroup**
> LicenseGroup getLicenseGroup(licenseGroupId)

Get License Group

    Get a single License Group by given ID.

### Parameters

|Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **licenseGroupId** | **String**| Must be a valid license group ID. | [default to null] |

### Return type

[**LicenseGroup**](../Models/LicenseGroup.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getProductListing"></a>
# **getProductListing**
> Listing getProductListing(productId, hydrate)

Get Product Listing

    Gets a product listing

### Parameters

|Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **productId** | **String**| Must be a valid product ID. | [default to null] |
| **hydrate** | **Boolean**| Populates some fields and changes types of others for certain objects. | [optional] [default to null] |

### Return type

[**Listing**](../Models/Listing.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getProductListingAlternate"></a>
# **getProductListingAlternate**
> Listing getProductListingAlternate(productId)

Get Product Listing (alternate)

    Gets a product listing

### Parameters

|Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **productId** | **String**| Must be a valid product ID. | [default to null] |

### Return type

[**Listing**](../Models/Listing.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getProductListings"></a>
# **getProductListings**
> List getProductListings(userId, n, offset, hydrate, groupId, active)

Get User Product Listings

    Gets the product listings of a given user

### Parameters

|Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **hydrate** | **Boolean**| Populates some fields and changes types of others for certain objects. | [optional] [default to null] |
| **groupId** | **String**| Must be a valid group ID. | [optional] [default to null] |
| **active** | **Boolean**| Filter for users&#39; listings and inventory bundles. | [optional] [default to null] |

### Return type

[**List**](../Models/Listing.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getProductPurchases"></a>
# **getProductPurchases**
> List getProductPurchases(buyerId, n, offset, mostRecent, sort, order)

Get Product Purchases

    Gets product purchases

### Parameters

|Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **buyerId** | **String**| Must be a valid user ID. | [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **mostRecent** | **Boolean**|  | [optional] [default to null] |
| **sort** | **String**| The sort order of the results. | [optional] [default to purchaseDate] [enum: purchaseDate] |
| **order** | **String**| Result ordering | [optional] [default to desc] [enum: asc, desc] |

### Return type

[**List**](../Models/ProductPurchase.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getRecentSubscription"></a>
# **getRecentSubscription**
> UserSubscription getRecentSubscription()

Get Recent Subscription

    Get the most recent user subscription.

### Parameters
This endpoint does not need any parameter.

### Return type

[**UserSubscription**](../Models/UserSubscription.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getSteamTransaction"></a>
# **getSteamTransaction**
> Transaction getSteamTransaction(transactionId)

Get Steam Transaction

    Get a single Steam transactions by ID. This returns the exact same information as &#x60;getSteamTransactions&#x60;, so no point in using this endpoint.

### Parameters

|Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **transactionId** | **String**| Must be a valid transaction ID. | [default to null] |

### Return type

[**Transaction**](../Models/Transaction.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getSteamTransactions"></a>
# **getSteamTransactions**
> List getSteamTransactions()

List Steam Transactions

    Get all own Steam transactions.

### Parameters
This endpoint does not need any parameter.

### Return type

[**List**](../Models/Transaction.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getStore"></a>
# **getStore**
> Store getStore(storeId, hydrateListings, hydrateProducts)

Get Store

    Gets a store

### Parameters

|Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **storeId** | **String**|  | [default to null] |
| **hydrateListings** | **Boolean**| Listings fields will be populated. | [optional] [default to null] |
| **hydrateProducts** | **Boolean**| Products fields will be populated. | [optional] [default to null] |

### Return type

[**Store**](../Models/Store.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getStoreShelves"></a>
# **getStoreShelves**
> List getStoreShelves(storeId, hydrateListings, fetch)

Get Store Shelves

    Gets the shelves for a store

### Parameters

|Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **storeId** | **String**|  | [default to null] |
| **hydrateListings** | **Boolean**| Listings fields will be populated. | [optional] [default to null] |
| **fetch** | **String**|  | [optional] [default to public] [enum: all, draft, preview, public, publicPreview] |

### Return type

[**List**](../Models/StoreShelf.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getSubscriptions"></a>
# **getSubscriptions**
> List getSubscriptions()

List Subscriptions

    List all existing Subscriptions. For example, \&quot;vrchatplus-monthly\&quot; and \&quot;vrchatplus-yearly\&quot;.

### Parameters
This endpoint does not need any parameter.

### Return type

[**List**](../Models/Subscription.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getTiliaStatus"></a>
# **getTiliaStatus**
> TiliaStatus getTiliaStatus()

Get Tilia Status

    Gets the status of Tilia integration

### Parameters
This endpoint does not need any parameter.

### Return type

[**TiliaStatus**](../Models/TiliaStatus.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getTiliaTos"></a>
# **getTiliaTos**
> TiliaTOS getTiliaTos(userId)

Get Tilia TOS Agreement Status

    Gets the status of the agreement of a user to the Tilia TOS

### Parameters

|Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |

### Return type

[**TiliaTOS**](../Models/TiliaTOS.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getTokenBundles"></a>
# **getTokenBundles**
> List getTokenBundles()

List Token Bundles

    Gets the list of token bundles

### Parameters
This endpoint does not need any parameter.

### Return type

[**List**](../Models/TokenBundle.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getUserCreditsEligible"></a>
# **getUserCreditsEligible**
> UserCreditsEligible getUserCreditsEligible(userId, subscriptionId)

Get User Credits Eligiblity

    Get the user&#39;s eligibility status for subscriptions based on available credits.

### Parameters

|Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **subscriptionId** | **String**|  | [default to null] |

### Return type

[**UserCreditsEligible**](../Models/UserCreditsEligible.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getUserSubscriptionEligible"></a>
# **getUserSubscriptionEligible**
> UserSubscriptionEligible getUserSubscriptionEligible(userId, steamId)

Get User Subscription Eligiblity

    Get the user&#39;s eligibility status for subscriptions.

### Parameters

|Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **steamId** | **String**| The Steam ID of the user. | [optional] [default to null] |

### Return type

[**UserSubscriptionEligible**](../Models/UserSubscriptionEligible.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="purchaseProductListing"></a>
# **purchaseProductListing**
> ProductPurchase purchaseProductListing(PurchaseProductListingRequest)

Purchase Product Listing

    Purchases a product listing

### Parameters

|Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **PurchaseProductListingRequest** | [**PurchaseProductListingRequest**](../Models/PurchaseProductListingRequest.md)|  | [optional] |

### Return type

[**ProductPurchase**](../Models/ProductPurchase.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

<a name="updateTiliaTos"></a>
# **updateTiliaTos**
> Object updateTiliaTos(userId, UpdateTiliaTOSRequest)

Update Tilia TOS Agreement Status

    Updates the status of the agreement of a user to the Tilia TOS

### Parameters

|Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **UpdateTiliaTOSRequest** | [**UpdateTiliaTOSRequest**](../Models/UpdateTiliaTOSRequest.md)|  | [optional] |

### Return type

**Object**

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json