View Source VRChat.Economy (vrchat v1.11.1)
API calls for all endpoints tagged Economy
.
Link to this section Summary
Functions
Get Current Subscriptions Get a list of all current user subscriptions.
Get License Group Get a single License Group by given ID.
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.
List Steam Transactions Get all own Steam transactions.
List Subscriptions List all existing Subscriptions. For example, "vrchatplus-monthly" and "vrchatplus-yearly".
Link to this section Functions
@spec get_current_subscriptions( Tesla.Env.client(), keyword() ) :: {:ok, [VRChat.Model.UserSubscription.t()]} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}
Get Current Subscriptions Get a list of all current user subscriptions.
parameters
Parameters
connection
(VRChat.Connection): Connection to serveropts
(keyword): Optional parameters
returns
Returns
{:ok, [%UserSubscription{}, ...]}
on success{:error, Tesla.Env.t}
on failure
@spec get_license_group(Tesla.Env.client(), String.t(), keyword()) :: {:ok, VRChat.Model.LicenseGroup.t()} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}
Get License Group Get a single License Group by given ID.
parameters
Parameters
connection
(VRChat.Connection): Connection to serverlicense_group_id
(String.t): Must be a valid license group ID.opts
(keyword): Optional parameters
returns
Returns
{:ok, VRChat.Model.LicenseGroup.t}
on success{:error, Tesla.Env.t}
on failure
@spec get_steam_transaction(Tesla.Env.client(), String.t(), keyword()) :: {:ok, VRChat.Model.Transaction.t()} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}
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
Parameters
connection
(VRChat.Connection): Connection to servertransaction_id
(String.t): Must be a valid transaction ID.opts
(keyword): Optional parameters
returns
Returns
{:ok, VRChat.Model.Transaction.t}
on success{:error, Tesla.Env.t}
on failure
@spec get_steam_transactions( Tesla.Env.client(), keyword() ) :: {:ok, [VRChat.Model.Transaction.t()]} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}
List Steam Transactions Get all own Steam transactions.
parameters
Parameters
connection
(VRChat.Connection): Connection to serveropts
(keyword): Optional parameters
returns
Returns
{:ok, [%Transaction{}, ...]}
on success{:error, Tesla.Env.t}
on failure
@spec get_subscriptions( Tesla.Env.client(), keyword() ) :: {:ok, [VRChat.Model.Subscription.t()]} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}
List Subscriptions List all existing Subscriptions. For example, "vrchatplus-monthly" and "vrchatplus-yearly".
parameters
Parameters
connection
(VRChat.Connection): Connection to serveropts
(keyword): Optional parameters
returns
Returns
{:ok, [%Subscription{}, ...]}
on success{:error, Tesla.Env.t}
on failure