*このコンテンツは、ベータ版のAI(人工知能)を使用して翻訳されており、エラーが含まれている可能性があります。このページを英語で表示するには、 こちら をクリックしてください。

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
出力のみ

サブスクリプションが期限切れになる、またはなった時刻。The timestamp when the subscription will, or did, expire. この文字列は 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
不変

サブスクリプションに購読したユーザー。.

ベース URL

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

購読を取得する
ベータ版

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

サブスクリプションを取得します。

スコープ は、自分のサブスクリプションを取得するだけを許可し、または、サブスクリプションIDはリクエストを行うユーザーIDと一致する必要があるので、その最良の使用ケースはAPIキーではなくOAuth 2.0認証です。宇宙のすべてのサブスクリプションを読むには、universe:write スコープを使用します。

範囲
universe:writeuniverse.subscription-product.subscription:read
リクエストパスのパラメータ
universe_idstring
必須

ユニバースID。.

subscription_product_idstring
必須

サブスクリプション製品 ID。.

subscription_idstring
必須

サブスクリプション ID。.

クエリのパラメータ
viewEnum<string>

サブスクリプションを取得するビュー。

BASIC と FULL をサポートします。

デフォルトは BASIC です。

可能な値:

| 値 | 説明 | | --- | --- | | VIEW_UNSPECIFIED | サブスクリプションビューは指定されていません;デフォルトが使用されます。| | 基本 | active および renewing フィールドのみを含む。| | FULL | すべてのフィールドを含む。 |. 可能な値:

レスポンス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"
}