*Dieser Inhalt wurde mit KI (Beta) übersetzt und kann Fehler enthalten. Um diese Seite auf Englisch zu sehen, klicke hier.

Subscription

Repräsentiert ein Abonnement eines Benutzers für ein Abonnementprodukt. Die Abonnement-ID ist identisch mit der Benutzer-ID des Benutzers, der abonniert hat.

Attribute

pathstring

Der Ressourcenpfad der Abonnenten.

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

createTimestring
Nur Ausgabe

Der Zeitpunkt, an dem die Abonnement erstellt wurde. Dieser String ist als Zeitstempel formatiert.

updateTimestring
Nur Ausgabe

Der Zeitpunkt, zu dem die Abonnenten zum letzten Mal aktualisiert wurden. Dieser String ist als Zeitstempel formatiert.

activeboolean
Nur Ausgabe

Ob die Abonnement aktiv ist.

Dies entspricht der Frage, ob state gleich SUBSCRIBED_WILL_RENEW, SUBSCRIBED_WILL_NOT_RENEW oder SUBSCRIBED_RENEWAL_PAYMENT_PENDING ist.

willRenewboolean
Nur Ausgabe

Ob das Abonnement erneuert wird.

Dies entspricht der Frage, ob state gleich SUBSCRIBED_WILL_RENEW oder SUBSCRIBED_RENEWAL_PAYMENT_PENDING ist.

lastBillingTimestring
Nur Ausgabe

Der Zeitpunkt, zu dem die Abonnement zum letzten Mal berechnet wurde. Dieser String ist als Zeitstempel formatiert.

nextRenewTimestring
Nur Ausgabe

Der Zeitstempel, wenn die Abonnement automatisch erneuert wird, nächste Mal. Dieser String ist als Zeitstempel formatiert.

expireTimestring
Nur Ausgabe

Der Zeitpunkt, an dem die Abonnementlaufzeit abläuft oder abgelaufen ist. Dieser String ist als Zeitstempel formatiert.

stateEnum<string>
Nur Ausgabe

Der Zustand der Abonnements.

Mögliche Werte:

| Wert | Beschreibung | | --- | --- | | STATE_UNSPECIFIED | Der Abonnentenzustand ist nicht spezifiziert.| | SUBSCRIBED_WILL_RENEW | Die Abonnement ist aktiv und wird automatisch bei next_renew_time erneuert.| | SUBSCRIBED_WILL_NOT_RENEW | Die Abonnement ist aktiv, wird aber nicht automatisch erneuert.| | SUBSCRIBED_RENEWAL_PAYMENT_PENDING | Die Abonnement ist aktiv und befindet sich im Renewal-Gnadenzeitraum, der Zahlungsbestätigung pendiert.| | ABGELAUFEN | Die Abonnement ist abgelaufen.Siehe expiration_details für weitere Informationen. |. Mögliche Werte:

expirationDetailsobject

Informationen über den Ablauf der Abonnementlaufzeit.

purchasePlatformEnum<string>
Nur Ausgabe

Die Plattform, auf der die Abonnement gekauft wurde.

Mögliche Werte:

| Wert | Beschreibung | | --- | --- | | PURCHASE_PLATFORM_UNSPECIFIED | Die Kaufplattform ist nicht spezifiziert.| | DESKTOP | Die Abonnement wurde auf der Roblox-Website gekauft.| | MOBILE | Die Abonnement wurde auf der Roblox-Mobil-App gekauft. |. Mögliche Werte:

paymentProviderEnum<string>
Nur Ausgabe

Der Zahlungsanbieter, der die Abonnement gekauft hat.

Mögliche Werte:

| Wert | Beschreibung | | --- | --- | | PAYMENT_PROVIDER_UNSPECIFIED | Der Zahlungsanbieter ist nicht spezifiziert.| | STRIPE | Die Abonnement wurde mit Stripe gekauft.| | APPLE | Die Abonnement wurde über Apple gekauft.| | GOOGLE | Die Abonnement wurde mit Google gekauft.| | ROBLOX_CREDIT | Die Abonnement wurde mit Roblox-Kredit gekauft. |. Mögliche Werte:

userstring
Unveränderlich

Der Benutzer, der sich für das Abonnement angemeldet hat.

Basis-URL
https://apis.roblox.com
Die Subscription-Ressource
{

  "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

Abonnement erhalten
Beta

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

Holen Sie sich das Abonnement.

Der universe.subscription-product.subscription:read Umfang erlaubt dir nur, deine eigenen Abonnements zu erhalten - oder vielmehr, die Abonnenten-ID muss der Benutzer-ID entsprechen, die die Anfrage auslöst - also ist seine beste Anwendungsfall mit der OAuth 2.0-Authentifizierung und nicht mit einem API-Schlüssel.Um alle Abonnements für ein Universum zu lesen, verwende den universe:write -Bereich.

Bereiche
universe:writeuniverse.subscription-product.subscription:read
AnfragePfadparameter
universe_idstring
Erforderlich

Die Universum-ID.

subscription_product_idstring
Erforderlich

Die Abonnementprodukt-ID.

subscription_idstring
Erforderlich

Die Abonnement-ID.

Anfrageparameter
viewEnum<string>

Die Ansicht, in der die Abonnenten abgerufen werden.

Unterstützt BASIC und FULL.

Standard auf BASIC.

Mögliche Werte:

| Wert | Beschreibung | | --- | --- | | VIEW_UNSPECIFIED | Die Abonnentansicht wird nicht angegeben; der Standard wird verwendet.| | BASE | Enthält nur die Felder active und renewing.| | VOLL | Enthält alle Felder. |. Mögliche Werte:

RückmeldungSubscription
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ückmeldung
{

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

}