*Este contenido se traduce usando la IA (Beta) y puede contener errores. Para ver esta página en inglés, haz clic en aquí.

Subscription

Representa la suscripción de un usuario a un producto de suscripción. El ID de suscripción es el mismo que el ID de usuario del usuario que se suscribió.

Atributos

pathstring

El camino de recursos de la suscripción.

Formato: universes/{universe_id}/subscription-products/{subscription_product_id}/subscriptions/{subscription_id}.

createTimestring
Solo salida

La fecha y hora en que se creó la suscripción. Esta cadena está formateada como Timestamp.

updateTimestring
Solo salida

La fecha y hora en que se actualizó por última vez la suscripción. Esta cadena está formateada como Timestamp.

activeboolean
Solo salida

Si la suscripción está activa.

Esto es equivalente a si state es igual a SUBSCRIBED_WILL_RENEW, SUBSCRIBED_WILL_NOT_RENEW, o SUBSCRIBED_RENEWAL_PAYMENT_PENDING.

willRenewboolean
Solo salida

Si la suscripción se renovará.

Esto es equivalente a si state es igual a SUBSCRIBED_WILL_RENEW o SUBSCRIBED_RENEWAL_PAYMENT_PENDING.

lastBillingTimestring
Solo salida

La fecha y hora en que se facturó por última vez la suscripción. Esta cadena está formateada como Timestamp.

nextRenewTimestring
Solo salida

La fecha y hora en que la suscripción se renovará automáticamente la próxima vez. Esta cadena está formateada como Timestamp.

expireTimestring
Solo salida

La fecha y hora en que la suscripción expirará o expiró. Esta cadena está formateada como Timestamp.

stateEnum<string>
Solo salida

El estado de la suscripción.

Posibles valores:

| Valor | Descripción | | --- | --- | | ESTADO_NO_ESPECIFICADO | El estado de la suscripción no se especifica.| | SUBSCRIBED_WILL_RENEW | La suscripción está activa y se renovará automáticamente en next_renew_time .| | SUBSCRIBED_WILL_NOT_RENEW | La suscripción está activa pero no se renovará automáticamente.| | SUBSCRIBED_RENEWAL_PAYMENT_PENDING | La suscripción está activa y dentro del período de gracia de renovación pendiente de confirmación de pago.| | EXPIRADO | La suscripción ha expirado.Vea expiration_details para más información. |. Valores posibles:

expirationDetailsobject

Información sobre la expiración de la suscripción.

purchasePlatformEnum<string>
Solo salida

La plataforma en la que se compró la suscripción.

Posibles valores:

| Valor | Descripción | | --- | --- | | COMPRA_PLATAFORMA_NO_ESPECIFICADA | La plataforma de compra no se especifica.| | DESKTOP | La suscripción se compró en el sitio web de Roblox.| | MÓVIL | La suscripción se compró en la aplicación móvil de Roblox. |. Valores posibles:

paymentProviderEnum<string>
Solo salida

El proveedor de pago que se utilizó para comprar la suscripción.

Posibles valores:

| Valor | Descripción | | --- | --- | | PAYMENT_PROVIDER_UNSPECIFIED | El proveedor de pago no se especifica.| | STRIPE | La suscripción se compró usando Stripe.| | APPLE | La suscripción se compró usando Apple.| | GOOGLE | La suscripción se compró usando Google.| | ROBLOX_CREDIT | La suscripción se compró usando el crédito de Roblox. |. Valores posibles:

userstring
Inmutable

El usuario que se suscribió a la suscripción.

URL base

https://apis.roblox.com
El recurso Subscription

{
"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"
}

Subscription

Obtener suscripción
Beta

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

Obtener la suscripción.

El alcance universe.subscription-product.subscription:read sólo te permite obtener tus propias suscripciones, o mejor dicho, el ID de suscripción debe coincidir con el ID de usuario que realiza la solicitud, por lo que su mejor caso de uso es con la autenticación de OAuth 2.0 en lugar de una clave de API.Para leer todas las suscripciones para un universo, use el alcance universe:write .

Ámbitos
universe:writeuniverse.subscription-product.subscription:read
SolicitudParámetros de ruta
universe_idstring
Obligatorio

La identificación del universo.

subscription_product_idstring
Obligatorio

El ID del producto de suscripción.

subscription_idstring
Obligatorio

El ID de suscripción.

Parámetros de consulta
viewEnum<string>

La vista en la que recuperar la suscripción.

Soporta BÁSICO y FULL.

Por defecto a BASIC.

Posibles valores:

| Valor | Descripción | | --- | --- | | VIEW_UNSPECIFIED | La vista de suscripción no se especifica; se usará el predeterminado.| | BÁSICO | Incluye solo los campos active y renewing.| | LLENO | Incluye todos los campos. |. Valores posibles:

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

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

{
"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"
}