Le chemin de ressource de l'abonnement.
Format : universes/{universe_id}/subscription-products/{subscription_product_id}/subscriptions/{subscription_id}.
*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.
Subscription
Représente l'abonnement d'un utilisateur à un produit d'abonnement. L'ID d'abonnement est le même que l'ID d'utilisateur de l'utilisateur qui s'est abonné.
Attributs
La date et l'heure de création de l'abonnement. Ce string est formatée en tant que Timestamp.
La date et l'heure de la dernière mise à jour d'abonnement. Ce string est formatée en tant que Timestamp.
Si l'abonnement est actif.
Cela correspond à savoir si state est égal à SUBSCRIBED_WILL_RENEW, SUBSCRIBED_WILL_NOT_RENEW, ou SUBSCRIBED_RENEWAL_PAYMENT_PENDING.
Si l'abonnement sera renouvelé.
C'est équivalent à savoir si state est égal à SUBSCRIBED_WILL_RENEW ou SUBSCRIBED_RENEWAL_PAYMENT_PENDING.
La date et l'heure de la dernière facturation de l'abonnement. Ce string est formatée en tant que Timestamp.
La date et l'heure à laquelle la souscription sera automatiquement renouvelée la prochaine fois. Ce string est formatée en tant que Timestamp.
La date et l'heure d'expiration de l'abonnement lorsque celui-ci expirera ou a expiré. Ce string est formatée en tant que Timestamp.
L'état de l'abonnement.
Valeurs possibles :
| Valeur | Description | | --- | --- | | ÉtAT_NON_SPECIFIÉ | L'état d'abonnement n'est pas spécifié.| | SUBSCRIBED_WILL_RENEW | L'abonnement est actif et sera automatiquement renouvelé à next_renew_time .| | SUBSCRIBED_WILL_NOT_RENEW | L'abonnement est actif mais ne sera pas renouvelé automatiquement.| | SUBSCRIBED_RENEWAL_PAYMENT_PENDING | L'abonnement est actif et dans la période de grâce de renouvellement en attente de confirmation de paiement.| | EXPIRÉ | L'abonnement a expiré.Voir expiration_details pour plus d'informations. |. Valeurs possibles :
Informations sur l'expiration de l'abonnement.
La plate-forme sur laquelle l'abonnement a été acheté.
Valeurs possibles :
| Valeur | Description | | --- | --- | | PURCHASE_PLATFORM_UNSPECIFIED | La plate-forme d'achat n'est pas spécifiée.| | DESKTOP | L'abonnement a été acheté sur le site Web de Roblox.| | MOBILE | L'abonnement a été acheté sur l'application mobile Roblox. |. Valeurs possibles :
Le fournisseur de paiement utilisé pour acheter l'abonnement.
Valeurs possibles :
| Valeur | Description | | --- | --- | | PAYMENT_PROVIDER_UNSPECIFIED | Le prestataire de paiement n'est pas spécifié.| | STRIPE | L'abonnement a été acheté à l'aide de Stripe.| | APPLE | L'abonnement a été acheté en utilisant Apple.| | GOOGLE | L'abonnement a été acheté en utilisant Google.| | ROBLOX_CREDIT | L'abonnement a été acheté en utilisant le crédit Roblox. |. Valeurs possibles :
L'utilisateur qui s'est abonné à l'abonnement.
URL de base
https://apis.roblox.comLa ressource 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
Obtenir une souscription
GET /cloud/v2/universes/{universe_id}/subscription-products/{subscription_product_id}/subscriptions/{subscription_id}
Obtenez l'abonnement.
La portée universe.subscription-product.subscription:read ne vous permet que d'obtenir vos propres abonnements — ou plutôt, l'ID d'abonnement doit correspondre à l'ID d'utilisateur qui fait la demande — donc son meilleur cas d'utilisation est avec l'authentification OAuth 2.0 plutôt qu'avec une clé API.Pour lire toutes les souscriptions pour un univers, utilisez le scope universe:write.
universe:writeuniverse.subscription-product.subscription:read
Limitations- Clés API: 500 requêtes par minute pour toutes les clés API pour un utilisateur ou un groupe
- OAuth 2.0: 3 requêtes par seconde par utilisateur de l'application
Remarque : les limites de débit peuvent être plus basses pendant les périodes de fort trafic. Certains points d'extrémité ont des limites de débit supplémentaires. En savoir plus sur les limites de taux.
L'ID de l'univers.
L'ID du produit d'abonnement.
L'ID d'abonnement.
La vue dans laquelle récupérer l'abonnement.
Il prend en charge le BASE et le FULL.
Défaut à BASIC.
Valeurs possibles :
| Valeur | Description | | --- | --- | | VIEW_UNSPECIFIED | La vue d'abonnement n'est pas spécifiée ; la valeur par défaut sera utilisée.| | BASIQUE | Inclut uniquement les champs active et renewing.| | PLEIN | Inclut tous les champs. |. Valeurs possibles :
RéponseSubscription
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}'Réponse
{
"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"
}