*此內容是使用 AI（Beta 測試版）翻譯，可能含有錯誤。若要以英文檢視此頁面，請按一下這裡。

Subscription

代表用戶對訂閱產品的訂閱，訂閱ID與訂閱用戶的使用者ID相同。

特性

pathstring

訂閱的資源路徑。

格式：universes/{universe_id}/subscription-products/{subscription_product_id}/subscriptions/{subscription_id}.

createTimestring

僅限輸出

在訂閱創建時的時戳。. 此字串的格式為 Timestamp。

updateTimestring

僅限輸出

訂閱最後更新的時間戳。. 此字串的格式為 Timestamp。

activeboolean

僅限輸出

是否續訂已啟用。

這與 state 是否等於 SUBSCRIBED_WILL_RENEW、SUBSCRIBED_WILL_NOT_RENEW 或 SUBSCRIBED_RENEWAL_PAYMENT_PENDING 是否相等。.

willRenewboolean

僅限輸出

是否續訂訂閱。

這與是否 state 是否等於 SUBSCRIBED_WILL_RENEW 或 SUBSCRIBED_RENEWAL_PAYMENT_PENDING 相等。.

lastBillingTimestring

僅限輸出

訂閱最後一次發票時的時戳。. 此字串的格式為 Timestamp。

nextRenewTimestring

僅限輸出

下次續訂時間戳，當訂閱會自動續訂時。. 此字串的格式為 Timestamp。

expireTimestring

僅限輸出

訂閱會或已過期時的時戳。. 此字串的格式為 Timestamp。

stateEnum<string>

僅限輸出

訂閱狀態。

可能的值：

| 值 | 說明 | | --- | --- | | STATE_UNSPECIFIED | 訂閱狀態未指定。| | SUBSCRIBED_WILL_RENEW | 訂閱已啟用，並將在 next_renew_time 自動續訂。| | SUBSCRIBED_WILL_NOT_RENEW | 訂閱已啟用，但不會自動續訂。| | SUBSCRIBED_RENEWAL_PAYMENT_PENDING | 訂閱狀態為活動，並且正在等待付款確認的更新期間。| | 過期 | 訂閱已過期。查看 expiration_details 以獲得更多信息。|. 可能的值：

expirationDetailsobject

關於訂閱到期的資訊。.

purchasePlatformEnum<string>

僅限輸出

訂閱被購買的平台。

可能的值：

| 值 | 說明 | | --- | --- | | PURCHASE_PLATFORM_UNSPECIFIED | 購買平台未指定。| | 桌面 | 訂閱在 Roblox 網站上購買。| | 手機 | 訂閱在 Roblox 手機應用程式上購買。 |. 可能的值：

paymentProviderEnum<string>

僅限輸出

使用過去購買訂閱的付款提供商。

可能的值：

| 值 | 說明 | | --- | --- | | PAYMENT_PROVIDER_UNSPECIFIED | 付款提供商未指定。| | STRIPE | 訂閱使用 Stripe 購買。| | APPLE | 訂閱使用 Apple 購買。| | GOOGLE | 訂閱使用了 Google 購買。| | ROBLOX_CREDIT | 訂閱使用 Roblox 積分購買。|. 可能的值：

userstring

不可改變

訂閱訂閱的用戶。.

基本網址

https://apis.roblox.com

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

取得訂閱
Beta

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

取得訂閱。

只有 universe.subscription-product.subscription:read 範圍允許您獲得自己的訂閱—或者說，訂閱ID必須與用戶ID匹配，因此其最佳使用案例是使用OAuth 2.0認證而不是API鑰匙。要閱讀宇宙的所有訂閱，請使用 universe:write 範圍。

範圍

universe:writeuniverse.subscription-product.subscription:read

請求路徑參數

universe_idstring

需要

宇宙ID。.

subscription_product_idstring

需要

訂閱產品ID。.

subscription_idstring

需要

訂閱 ID。.

查詢參數

viewEnum<string>

要取回訂閱的視圖。

支持基本和完整。

預設為基本。

可能的值：

| 值 | 說明 | | --- | --- | | VIEW_UNSPECIFIED | 訂閱檢視未指定；默認將被使用。| | 基本 | 只包含 active 和 renewing 欄位。| | 滿 | 包括所有欄位。 |. 可能的值：

回應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}'

回應

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

特性

Subscription

取得訂閱Beta

取得訂閱
Beta