v6 documentation is incomplete, want to contribute?

Get User Subscription Eligiblity

Get the user's eligibility status for subscriptions.

Requests made through this page are proxied through an intermediary server due to Cross-Origin Resource Sharing restrictions.

GET
/users/{userId}/subscription/eligible
auth<token>

Auth Token via Cookie

In: cookie

Path Parameters

userIdstring

Must be a valid user ID.

Query Parameters

steamId?string

The Steam ID of the user.

Response Body

application/json

application/json

curl -X GET "https://api.vrchat.cloud/api/1/users/string/subscription/eligible?steamId=game+night"
{
  "activeCancelledSubscription": true,
  "giftEligible": true,
  "nonExtendVendorWillLoseGiftTime": true,
  "purchaseEligible": true,
  "subscriptionEligible": true,
  "subscriptionOnAltAccount": true
}

{
  "error": {
    "message": "\"Missing Credentials\"",
    "status_code": 401
  }
}