GET /cloud/v2/universes/{universe_id}/subscription-products/{subscription_product_id}/subscriptions/{subscription_id} — openapi

Get Subscription

Get the subscription.

The universe.subscription-product.subscription:read scope only allows reading subscriptions of the user making the request. Because of this, the subscription ID must match the user ID of the user making the request. Note that this scope might be more relevant for OAuth 2.0 apps.

To read all subscriptions made by users for a particular universe, use the universe:write scope instead.

Endpoint

Method: GET

Path: /cloud/v2/universes/{universe_id}/subscription-products/{subscription_product_id}/subscriptions/{subscription_id}

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universe_id	path	true	The universe ID.
subscription_product_id	path	true	The subscription-product ID.
subscription_id	path	true	The subscription ID.
view	query	false	The view in which to retrieve the subscription. Supports BASIC and FULL. Defaults to BASIC. Possible values: \| Value \| Description \| \| --- \| --- \| \| VIEW_UNSPECIFIED \| The subscription view is not specified; the default will be used. \| \| BASIC \| Includes only the `active` and `renewing` fields. \| \| FULL \| Includes all fields. \|

[
  {
    "name": "universe_id",
    "in": "path",
    "description": "The universe ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "subscription_product_id",
    "in": "path",
    "description": "The subscription-product ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "subscription_id",
    "in": "path",
    "description": "The subscription ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "view",
    "in": "query",
    "description": "The view in which to retrieve the subscription.\n\nSupports BASIC and FULL.\n\nDefaults to BASIC.\n\nPossible values:\n\n  | Value | Description |\n  | --- | --- |\n  | VIEW_UNSPECIFIED | The subscription view is not specified; the default will be used. |\n  | BASIC | Includes only the `active` and `renewing` fields. |\n  | FULL | Includes all fields. |",
    "schema": {
      "example": "VIEW_UNSPECIFIED",
      "enum": [
        "VIEW_UNSPECIFIED",
        "BASIC",
        "FULL"
      ],
      "type": "string",
      "format": "enum"
    }
  }
]

Responses

Status	Description
200	OK

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Subscription"
        }
      }
    }
  }
}

Authentication

{
  "security": [
    {
      "roblox-api-key": []
    },
    {
      "roblox-oauth2": []
    }
  ],
  "securitySchemes": {
    "roblox-api-key": {
      "type": "apiKey",
      "description": "A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.",
      "name": "x-api-key",
      "in": "header"
    },
    "roblox-legacy-cookie": {
      "type": "apiKey",
      "description": "A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.",
      "in": "cookie",
      "name": ".ROBLOSECURITY"
    },
    "roblox-oauth2": {
      "type": "oauth2",
      "description": "Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.",
      "flows": {
        "authorizationCode": {
          "authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
          "tokenUrl": "https://apis.roblox.com/oauth/v1/token",
          "refreshUrl": "https://apis.roblox.com/oauth/v1/token",
          "scopes": {}
        }
      }
    }
  }
}

Subscription

Complete Operation Definition

{
  "tags": [
    "Users"
  ],
  "summary": "Get Subscription",
  "description": "Get the subscription.\n\nThe `universe.subscription-product.subscription:read` scope only allows\nreading subscriptions of the user making the request. Because of this, the\nsubscription ID must match the user ID of the user making the request. Note\nthat this scope might be more relevant for OAuth 2.0 apps.\n\nTo read all subscriptions made by users for a particular universe, use the\n`universe:write` scope instead.",
  "operationId": "Cloud_GetSubscription",
  "parameters": [
    {
      "name": "universe_id",
      "in": "path",
      "description": "The universe ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "subscription_product_id",
      "in": "path",
      "description": "The subscription-product ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "subscription_id",
      "in": "path",
      "description": "The subscription ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "view",
      "in": "query",
      "description": "The view in which to retrieve the subscription.\n\nSupports BASIC and FULL.\n\nDefaults to BASIC.\n\nPossible values:\n\n  | Value | Description |\n  | --- | --- |\n  | VIEW_UNSPECIFIED | The subscription view is not specified; the default will be used. |\n  | BASIC | Includes only the `active` and `renewing` fields. |\n  | FULL | Includes all fields. |",
      "schema": {
        "example": "VIEW_UNSPECIFIED",
        "enum": [
          "VIEW_UNSPECIFIED",
          "BASIC",
          "FULL"
        ],
        "type": "string",
        "format": "enum"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Subscription"
          }
        }
      }
    }
  },
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "x-roblox-scopes": [
    {
      "name": "universe:write"
    },
    {
      "name": "universe.subscription-product.subscription:read"
    }
  ],
  "x-roblox-docs": {
    "category": "Monetization",
    "methodProperties": {
      "scopes": [
        "universe:write",
        "universe.subscription-product.subscription:read"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/Subscription",
      "name": "Subscription"
    }
  },
  "x-roblox-stability": "BETA",
  "x-roblox-rate-limits": {
    "perApiKeyOwner": {
      "period": "MINUTE",
      "maxInPeriod": 500
    },
    "perOauth2Authorization": {
      "period": "SECOND",
      "maxInPeriod": 3
    }
  },
  "security": [
    {
      "roblox-api-key": []
    },
    {
      "roblox-oauth2": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/users#Cloud_GetSubscription"
  }
}