*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.

Subscription

Representa a assinatura de um usuário a um produto de assinatura. O ID de assinatura é o mesmo do ID do usuário que se subscreveu.

Atributos

pathstring

O caminho de recursos da assinatura.

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

createTimestring
Apenas saída

O timestamp quando a assinatura foi criada. Esta cadeia de caracteres é formatada como um Timestamp.

updateTimestring
Apenas saída

O timestamp quando a assinatura foi atualizada pela última vez. Esta cadeia de caracteres é formatada como um Timestamp.

activeboolean
Apenas saída

Se a assinatura estiver ativa.

Isto é equivalente se state for igual a SUBSCRIBED_WILL_RENEW, SUBSCRIBED_WILL_NOT_RENEW ou SUBSCRIBED_RENEWAL_PAYMENT_PENDING.

willRenewboolean
Apenas saída

Se a assinatura será renovada.

Isso é equivalente se state for igual a SUBSCRIBED_WILL_RENEW ou SUBSCRIBED_RENEWAL_PAYMENT_PENDING.

lastBillingTimestring
Apenas saída

A data de registro quando a assinatura foi cobrada pela última vez. Esta cadeia de caracteres é formatada como um Timestamp.

nextRenewTimestring
Apenas saída

O timestamp quando a assinatura será automaticamente renovada a seguir. Esta cadeia de caracteres é formatada como um Timestamp.

expireTimestring
Apenas saída

A data de expiração quando a assinatura expirará ou expirou. Esta cadeia de caracteres é formatada como um Timestamp.

stateEnum<string>
Apenas saída

O estado da assinatura.

Valores possíveis:

| Valor | Descrição | | --- | --- | | ESTADO_NÃO_ESPECIFICADO | O estado da assinatura não é especificado.| | SUBSCRIBED_WILL_RENEW | A assinatura está ativa e será renovada automaticamente em next_renew_time .| | SUBSCRIBED_WILL_NOT_RENEW | A assinatura está ativa, mas não será renovada automaticamente.| | SUBSCRIBED_RENEWAL_PAYMENT_PENDING | A assinatura está ativa e dentro do período de graça de renovação pendente para confirmação de pagamento.| | EXPIRADO | A assinatura expirou.Veja expiration_details para mais informações. |. Valores possíveis:

expirationDetailsobject

Informação sobre a expiração da assinatura.

purchasePlatformEnum<string>
Apenas saída

A plataforma em que a assinatura foi comprada.

Valores possíveis:

| Valor | Descrição | | --- | --- | | COMPRA_PLATAFORMA_NÃO_ESPECIFICADA | A plataforma de compra não é especificada.| | DESKTOP | A assinatura foi comprada no site do Roblox.| | MOBILE | A assinatura foi comprada no aplicativo móvel Roblox. |. Valores possíveis:

paymentProviderEnum<string>
Apenas saída

O provedor de pagamento usado para comprar a assinatura.

Valores possíveis:

| Valor | Descrição | | --- | --- | | PAYMENT_PROVIDER_UNSPECIFIED | O provedor de pagamento não é especificado.| | STRIPE | A assinatura foi comprada usando o Stripe.| | APPLE | A assinatura foi comprada usando a Apple.| | GOOGLE | A assinatura foi comprada usando o Google.| | ROBLOX_CREDIT | A assinatura foi comprada usando o Crédito Roblox. |. Valores possíveis:

userstring
Imutável

O usuário que se subscreveu à assinatura.

URL base
https://apis.roblox.com
O 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

Obter Subscrição
Beta

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

Obtenha a assinatura.

O escopo universe.subscription-product.subscription:read permite apenas que você obtenha suas próprias assinaturas - ou seja, o ID de assinatura deve corresponder ao ID do usuário que faz o pedido - então seu melhor caso de uso é com a autenticação OAuth 2.0, em vez de uma chave de API.Para ler todas as assinaturas para um universo, use o escopo universe:write .

Escopos
universe:writeuniverse.subscription-product.subscription:read
SolicitaçãoParâmetros de endereço
universe_idstring
Obrigatório

O ID do universo.

subscription_product_idstring
Obrigatório

O ID do produto de assinatura.

subscription_idstring
Obrigatório

O ID de assinatura.

Parâmetros da consulta
viewEnum<string>

A visualização em que recuperar a assinatura.

Suporta BÁSICO e FULL.

Padrão para BASIC.

Valores possíveis:

| Valor | Descrição | | --- | --- | | VIEW_UNSPECIFIED | A visão de subscrição não é especificada; o padrão será usado.| | BÁSICO | Inclui apenas os campos active e renewing.| | COMPLETO | Inclui todos os campos. |. Valores possíveis:

RespostaSubscription
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}'
Resposta
{

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

}