*Ta zawartość została przetłumaczona przy użyciu narzędzi AI (w wersji beta) i może zawierać błędy. Aby wyświetlić tę stronę w języku angielskim, kliknij tutaj.

Subscription

Reprezentuje subskrypcję użytkownika do produktu subskrypcyjnego. ID subskrypcji jest takie samo jak ID użytkownika użytkownika, który się zapisał.

Atrybuty

pathstring

Ścieżka zasobów subskrypcji.

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

createTimestring
Tylko dane wyjściowe

Data i czas utworzenia subskrypcji. Ten ciąg jest sformatowany jako Timestamp.

updateTimestring
Tylko dane wyjściowe

Data i czas aktualizacji subskrypcji po raz ostatni. Ten ciąg jest sformatowany jako Timestamp.

activeboolean
Tylko dane wyjściowe

Czy subskrypcja jest aktywna.

Jest to równoznaczne z tym, czy state jest równy SUBSCRIBED_WILL_RENEW, SUBSCRIBED_WILL_NOT_RENEW lub SUBSCRIBED_RENEWAL_PAYMENT_PENDING.

willRenewboolean
Tylko dane wyjściowe

Czy subskrypcja zostanie odnowiona.

Jest to równoznaczne z tym, czy state jest równy SUBSCRIBED_WILL_RENEW lub SUBSCRIBED_RENEWAL_PAYMENT_PENDING.

lastBillingTimestring
Tylko dane wyjściowe

Data i czas, kiedy subskrypcja została po raz ostatni rozliczona. Ten ciąg jest sformatowany jako Timestamp.

nextRenewTimestring
Tylko dane wyjściowe

Data ważności, kiedy subskrypcja zostanie następnie automatycznie odnowiona. Ten ciąg jest sformatowany jako Timestamp.

expireTimestring
Tylko dane wyjściowe

Data ważności, kiedy subskrypcja wygaśnie lub wygasła. Ten ciąg jest sformatowany jako Timestamp.

stateEnum<string>
Tylko dane wyjściowe

Stan subskrypcji.

Możliwe wartości:

| Wartość | Opis | | --- | --- | | STATE_UNSPECIFIED | Stan subskrypcji nie jest określony.| | SUBSCRIBED_WILL_RENEW | Subskrypcja jest aktywna i zostanie automatycznie odnowiona na next_renew_time .| | SUBSCRIBED_WILL_NOT_RENEW | Subskrypcja jest aktywna, ale nie zostanie automatycznie odnowiona.| | SUBSCRIBED_RENEWAL_PAYMENT_PENDING | Subskrypcja jest aktywna i w okresie przedłużenia ważności w oczekiwaniu na potwierdzenie płatności.| | WYGASŁO | Subskrypcja wygasła.Zobacz expiration_details dla więcej informacji. |. Możliwe wartości:

expirationDetailsobject

Informacje o wygaśnięciu subskrypcji.

purchasePlatformEnum<string>
Tylko dane wyjściowe

Platforma, na której zakupiono subskrypcję.

Możliwe wartości:

| Wartość | Opis | | --- | --- | | PURCHASE_PLATFORM_UNSPECIFIED | Platforma zakupowa nie jest określona.| | DESKTOP | Subskrypcja została zakupiona na stronie internetowej Roblox.| | MOBILE | Subskrypcja została zakupiona w aplikacji mobilnej Roblox. |. Możliwe wartości:

paymentProviderEnum<string>
Tylko dane wyjściowe

Dostawca płatności używany do zakupu subskrypcji.

Możliwe wartości:

| Wartość | Opis | | --- | --- | | PAYMENT_PROVIDER_UNSPECIFIED | Dostawca płatności nie jest określony.| | STRIPE | Subskrypcja została zakupiona za pomocą Stripe.| | APPLE | Subskrypcja została zakupiona za pomocą Apple.| | GOOGLE | Subskrypcja została zakupiona za pomocą Google.| | ROBLOX_CREDIT | Subskrypcja została zakupiona za pomocą kredytu Roblox. |. Możliwe wartości:

userstring
Nieodwołalny

Użytkownik, który subskrybował subskrypcję.

Podstawowy adres URL
https://apis.roblox.com
Zasób 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

Zdobądź subskrypcję
Beta

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

Zdobądź subskrypcję.

Zakres universe.subscription-product.subscription:read pozwala tylko na uzyskanie własnych subskrypcji - lub raczej ID subskrypcji musi pasować do ID użytkownika, który dokonuje żądania - więc jego najlepszy przypadek użycia jest z autoryzacją OAuth 2.0, a nie z kluczem API.Aby przeczytać wszystkie subskrypcje dla wszechświata, użyj zakresu universe:write.

Zakresy
universe:writeuniverse.subscription-product.subscription:read
ŻądanieParametry ścieżki
universe_idstring
Wymagane

ID wszechświata.

subscription_product_idstring
Wymagane

ID produktu subskrypcyjnego.

subscription_idstring
Wymagane

ID subskrypcji.

Parametry zapytania
viewEnum<string>

Widok, w którym odzyskać subskrypcję.

Wspiera podstawowe i pełne.

Domyślnie do BASIC.

Możliwe wartości:

| Wartość | Opis | | --- | --- | | VIEW_UNSPECIFIED | Widok subskrypcji nie jest określony; zostanie użyty domyślny.| | PODSTAWOWE | Obejmuje tylko pola active i renewing.| | PEŁNE | Zawiera wszystkie pola. |. Możliwe wartości:

Odpowiedź:Subscription
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}'
Odpowiedź:
{

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

}