18 KiB
18 KiB
EconomyApi
All URIs are relative to https://api.vrchat.cloud/api/1
| Method | HTTP request | Description |
|---|---|---|
| getActiveLicenses | GET /economy/licenses/active | Get Active Licenses |
| getBalance | GET /user/{userId}/balance | Get Balance |
| getBalanceEarnings | GET /user/{userId}/balance/earnings | Get Balance Earnings |
| getBulkGiftPurchases | GET /user/bulk/gift/purchases | Get Bulk Gift Purchases |
| getCurrentSubscriptions | GET /auth/user/subscription | Get Current Subscriptions |
| getEconomyAccount | GET /user/{userId}/economy/account | Get Economy Account |
| getLicenseGroup | GET /licenseGroups/{licenseGroupId} | Get License Group |
| getProductListing | GET /listing/{productId} | Get Product Listing |
| getProductListingAlternate | GET /products/{productId} | Get Product Listing (alternate) |
| getProductListings | GET /user/{userId}/listings | Get User Product Listings |
| getProductPurchases | GET /economy/purchases | Get Product Purchases |
| getRecentSubscription | GET /user/subscription/recent | Get Recent Subscription |
| getSteamTransaction | GET /Steam/transactions/{transactionId} | Get Steam Transaction |
| getSteamTransactions | GET /Steam/transactions | List Steam Transactions |
| getStore | GET /economy/store | Get Store |
| getStoreShelves | GET /economy/store/shelves | Get Store Shelves |
| getSubscriptions | GET /subscriptions | List Subscriptions |
| getTiliaStatus | GET /tilia/status | Get Tilia Status |
| getTiliaTos | GET /user/{userId}/tilia/tos | Get Tilia TOS Agreement Status |
| getTokenBundles | GET /tokenBundles | List Token Bundles |
| getUserCreditsEligible | GET /users/{userId}/credits/eligible | Get User Credits Eligiblity |
| getUserSubscriptionEligible | GET /users/{userId}/subscription/eligible | Get User Subscription Eligiblity |
| purchaseProductListing | POST /economy/purchase/listing | Purchase Product Listing |
| updateTiliaTos | PUT /user/{userId}/tilia/tos | Update Tilia TOS Agreement Status |
getActiveLicenses
List getActiveLicenses()
Get Active Licenses
Gets active licenses
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
getCurrentSubscriptions
List getCurrentSubscriptions()
Get Current Subscriptions
Get a list of all current user subscriptions.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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' listings and inventory bundles. | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
getRecentSubscription
UserSubscription getRecentSubscription()
Get Recent Subscription
Get the most recent user subscription.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
getSteamTransaction
Transaction getSteamTransaction(transactionId)
Get Steam Transaction
Get a single Steam transactions by ID. This returns the exact same information as `getSteamTransactions`, 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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
getSteamTransactions
List getSteamTransactions()
List Steam Transactions
Get all own Steam transactions.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
getSubscriptions
List getSubscriptions()
List Subscriptions
List all existing Subscriptions. For example, \"vrchatplus-monthly\" and \"vrchatplus-yearly\".
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
getTiliaStatus
TiliaStatus getTiliaStatus()
Get Tilia Status
Gets the status of Tilia integration
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
getTokenBundles
List getTokenBundles()
List Token Bundles
Gets the list of token bundles
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
getUserCreditsEligible
UserCreditsEligible getUserCreditsEligible(userId, subscriptionId)
Get User Credits Eligiblity
Get the user'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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
getUserSubscriptionEligible
UserSubscriptionEligible getUserSubscriptionEligible(userId, steamId)
Get User Subscription Eligiblity
Get the user'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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
purchaseProductListing
ProductPurchase purchaseProductListing(PurchaseProductListingRequest)
Purchase Product Listing
Purchases a product listing
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| PurchaseProductListingRequest | PurchaseProductListingRequest | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
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 | [optional] |
Return type
Object
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json