Subscription

Attributes

pathstring

createTimestring

updateTimestring

activeboolean

willRenewboolean

lastBillingTimestring

nextRenewTimestring

expireTimestring

stateEnum<string>
STATE_UNSPECIFIED, SUBSCRIBED_WILL_RENEW, SUBSCRIBED_WILL_NOT_RENEW, SUBSCRIBED_RENEWAL_PAYMENT_PENDING, EXPIRED

expirationDetailsobject

purchasePlatformEnum<string>
PURCHASE_PLATFORM_UNSPECIFIED, DESKTOP, MOBILE

paymentProviderEnum<string>
PAYMENT_PROVIDER_UNSPECIFIED, STRIPE, APPLE, GOOGLE

userstring

Base URL

https://apis.roblox.com/cloud
The Subscription Resource

{
"path": "universes/123/subscription-products/some-subscription-product-id/subscriptions/some-subscription-id",
"createTime": "2023-07-05T12:34:56Z",
"updateTime": "2023-07-05T12:34:56Z",
"active": true,
"willRenew": true,
"lastBillingTime": "2023-07-05T12:34:56Z",
"nextRenewTime": "2023-07-05T12:34:56Z",
"expireTime": "2023-07-05T12:34:56Z",
"state": "STATE_UNSPECIFIED",
"expirationDetails": {
"reason": "EXPIRATION_REASON_UNSPECIFIED"
},
"purchasePlatform": "PURCHASE_PLATFORM_UNSPECIFIED",
"paymentProvider": "PAYMENT_PROVIDER_UNSPECIFIED",
"user": "users/123"
}

Get Subscription

GET /v2/universes/{universe}/subscription-products/{subscription-product}/subscriptions/{subscription}
Scopes
universe:writeuniverse.subscription-product.subscription:read
RequestPath Parameters
universestringRequired

subscription-productstringRequired

subscriptionstringRequired

Query Parameters
viewstring

ResponseSubscription
GET /v2/universes/{universe}/subscription-products/{subscription-product}/subscriptions/{subscription}

curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe}/subscription-products/{subscription-product}/subscriptions/{subscription}?view={string}' \
-H 'x-api-key: {your-api-key}'
Response

{
"path": "universes/123/subscription-products/some-subscription-product-id/subscriptions/some-subscription-id",
"createTime": "2023-07-05T12:34:56Z",
"updateTime": "2023-07-05T12:34:56Z",
"active": true,
"willRenew": true,
"lastBillingTime": "2023-07-05T12:34:56Z",
"nextRenewTime": "2023-07-05T12:34:56Z",
"expireTime": "2023-07-05T12:34:56Z",
"state": "STATE_UNSPECIFIED",
"expirationDetails": {
"reason": "EXPIRATION_REASON_UNSPECIFIED"
},
"purchasePlatform": "PURCHASE_PLATFORM_UNSPECIFIED",
"paymentProvider": "PAYMENT_PROVIDER_UNSPECIFIED",
"user": "users/123"
}