*Questo contenuto è tradotto usando AI (Beta) e potrebbe contenere errori. Per visualizzare questa pagina in inglese, clicca qui.

Subscription

Rappresenta l'iscrizione di un utente a un prodotto di abbonamento. L'ID di iscrizione è lo stesso dell'ID utente dell'utente che si è iscritto.

Attributi

pathstring

Il percorso delle risorse della sottoscrizione.

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

createTimestring
Solo output

L'timestamp quando la sottoscrizione è stata creata. Questa stringa è formattata come Timestamp.

updateTimestring
Solo output

L'timestamp quando l'abbonamento è stato aggiornato per l'ultima volta. Questa stringa è formattata come Timestamp.

activeboolean
Solo output

Se l'abbonamento è attivo.

Questo è equivalente a se state è uguale a SUBSCRIBED_WILL_RENEW, SUBSCRIBED_WILL_NOT_RENEW, o SUBSCRIBED_RENEWAL_PAYMENT_PENDING.

willRenewboolean
Solo output

Se l'abbonamento verrà rinnovato.

Questo è equivalente se state è uguale a SUBSCRIBED_WILL_RENEW o SUBSCRIBED_RENEWAL_PAYMENT_PENDING.

lastBillingTimestring
Solo output

L'timestamp quando l'abbonamento è stato addebitato per l'ultima volta. Questa stringa è formattata come Timestamp.

nextRenewTimestring
Solo output

L'timestamp quando la sottoscrizione verrà rinnovata automaticamente la prossima volta. Questa stringa è formattata come Timestamp.

expireTimestring
Solo output

La data e l'ora in cui la sottoscrizione scadrà, o è scaduta. Questa stringa è formattata come Timestamp.

stateEnum<string>
Solo output

Lo stato dell'abbonamento.

Valori possibili:

| Valore | Descrizione | | --- | --- | | STATO_NON SPECIFICATO | Lo stato di abbonamento non è specificato.| | SUBSCRIBED_WILL_RENEW | L'abbonamento è attivo e verrà rinnovato automaticamente a next_renew_time .| | SUBSCRIBED_WILL_NOT_RENEW | L'abbonamento è attivo ma non verrà rinnovato automaticamente.| | SUBSCRIBED_RENEWAL_PAYMENT_PENDING | L'abbonamento è attivo e nel periodo di grazia di rinnovo in attesa di conferma di pagamento.| | SCADUTO | La sottoscrizione è scaduta.Vedi expiration_details per ulteriori informazioni. |. Valori possibili:

expirationDetailsobject

Informazioni sull'esaurimento dell'abbonamento.

purchasePlatformEnum<string>
Solo output

La piattaforma su cui è stata acquistata l'iscrizione.

Valori possibili:

| Valore | Descrizione | | --- | --- | | PURCHASE_PLATFORM_UNSPECIFIED | La piattaforma di acquisto non è specificata.| | DESKTOP | L'abbonamento è stato acquistato sul sito Web di Roblox.| | MOBILE | L'abbonamento è stato acquistato sull'app mobile Roblox. |. Valori possibili:

paymentProviderEnum<string>
Solo output

Il fornitore di pagamento utilizzato per acquistare l'abbonamento.

Valori possibili:

| Valore | Descrizione | | --- | --- | | PAYMENT_PROVIDER_UNSPECIFIED | Il fornitore di pagamento non è specificato.| | STRIPE | L'abbonamento è stato acquistato utilizzando Stripe.| | APPLE | La sottoscrizione è stata acquistata utilizzando Apple.| | GOOGLE | La sottoscrizione è stata acquistata utilizzando Google.| | ROBLOX_CREDIT | L'abbonamento è stato acquistato utilizzando Roblox Credit. |. Valori possibili:

userstring
Immutabile

L'utente che si è iscritto all'abbonamento.

URL di base

https://apis.roblox.com
Risorsa 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

Ottieni l'iscrizione
Beta

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

Ottieni l'abbonamento.

L'ambito universe.subscription-product.subscription:read consente solo di ottenere le proprie sottoscrizioni - o meglio, l'ID di sottoscrizione deve corrispondere all'ID utente che fa la richiesta - quindi il suo caso d'uso migliore è con l'autenticazione OAuth 2.0 piuttosto che con una chiave API.Per leggere tutte le sottoscrizioni per un universo, usa lo scope universe:write .

Campi
universe:writeuniverse.subscription-product.subscription:read
RichiestaParametri percorso
universe_idstring
Necessario

L'ID dell'universo.

subscription_product_idstring
Necessario

L'ID del prodotto di abbonamento.

subscription_idstring
Necessario

L'ID di abbonamento.

Parametri query
viewEnum<string>

La vista in cui recuperare l'abbonamento.

Supporta BASE e FULL.

Predefinito per BASIC.

Valori possibili:

| Valore | Descrizione | | --- | --- | | VIEW_UNSPECIFIED | La vista di abbonamento non è specificata; verrà utilizzato il predefinito.| | BASIC | Comprende solo i campi active e renewing.| | FULL | Includes tutti i campi. |. Valori possibili:

RispostaSubscription
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}'
Risposta

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