*Konten ini diterjemahkan menggunakan AI (Beta) dan mungkin mengandung kesalahan. Untuk melihat halaman ini dalam bahasa Inggris, klik di sini.

Subscription

Mewakili langganan pengguna ke produk berlangganan. ID langganan sama dengan ID pengguna pengguna yang berlangganan.

Atribut

pathstring

Jalur sumber daya dari langganan.

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

createTimestring

Hanya Output

Stempel waktu ketika langganan dibuat. String ini diformat sebagai Timestamp.

updateTimestring

Hanya Output

Stempel waktu ketika langganan terakhir diperbarui. String ini diformat sebagai Timestamp.

activeboolean

Hanya Output

Apakah langganan aktif.

Ini setara dengan apakah state sama dengan SUBSCRIBED_WILL_RENEW, SUBSCRIBED_WILL_NOT_RENEW, atau SUBSCRIBED_RENEWAL_PAYMENT_PENDING.

willRenewboolean

Hanya Output

Apakah langganan akan diperbarui.

Ini setara dengan apakah state sama dengan SUBSCRIBED_WILL_RENEW atau SUBSCRIBED_RENEWAL_PAYMENT_PENDING.

lastBillingTimestring

Hanya Output

Stempel waktu ketika langganan terakhir dibebankan. String ini diformat sebagai Timestamp.

nextRenewTimestring

Hanya Output

Stempel waktu ketika langganan akan diperbarui secara otomatis berikutnya. String ini diformat sebagai Timestamp.

expireTimestring

Hanya Output

Stempel waktu ketika langganan akan, atau telah, kedaluwarsa. String ini diformat sebagai Timestamp.

stateEnum<string>

Hanya Output

Status langganan.

Nilai yang mungkin:

| Nilai | Deskripsi | | --- | --- | | STATE_UNSPECIFIED | Negara berlangganan tidak ditentukan.| | SUBSCRIBED_WILL_RENEW | Langganan aktif dan akan diperbarui secara otomatis pada next_renew_time .| | SUBSCRIBED_WILL_NOT_RENEW | Langganan aktif tetapi tidak akan diperbarui secara otomatis.| | SUBSCRIBED_RENEWAL_PAYMENT_PENDING | Langganan aktif dan berada dalam periode grace perpanjangan pembayaran yang menunggu konfirmasi pembayaran.| | HABIS | Langganan telah kedaluwarsa.Lihat expiration_details untuk informasi lebih lanjut. |. Nilai yang mungkin:

expirationDetailsobject

Informasi tentang kedaluwarsa langganan.

purchasePlatformEnum<string>

Hanya Output

Platform di mana langganan dibeli.

Nilai yang mungkin:

| Nilai | Deskripsi | | --- | --- | | PURCHASE_PLATFORM_UNSPECIFIED | Platform pembelian tidak ditentukan.| | DESKTOP | Langganan dibeli di situs web Roblox.| | MOBILE | Langganan dibeli di aplikasi seluler Roblox. |. Nilai yang mungkin:

paymentProviderEnum<string>

Hanya Output

Penyedia pembayaran yang digunakan untuk membeli langganan.

Nilai yang mungkin:

| Nilai | Deskripsi | | --- | --- | | PAYMENT_PROVIDER_UNSPECIFIED | Penyedia pembayaran tidak ditentukan.| | STRIPE | Langganan dibeli menggunakan Stripe.| | APPLE | Langganan dibeli menggunakan Apple.| | GOOGLE | Langganan dibeli menggunakan Google.| | ROBLOX_CREDIT | Langganan dibeli menggunakan Kredit Roblox. |. Nilai yang mungkin:

userstring

Immutable

Pengguna yang berlangganan ke langganan.

Base URL

https://apis.roblox.com

Resource 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

Dapatkan Langganan
Beta

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

Dapatkan langganan.

Scope universe.subscription-product.subscription:read hanya memungkinkan Anda untuk mendapatkan langganan sendiri—atau lebih tepatnya, ID langganan harus cocok dengan ID pengguna yang membuat permintaan—jadi kasus penggunaan terbaiknya adalah dengan autentikasi OAuth 2.0 daripada kunci API.Untuk membaca semua langganan untuk sebuah alam semesta, gunakan scope universe:write.

Cakupan

universe:writeuniverse.subscription-product.subscription:read

PermintaanParameter Jalur

universe_idstring

Diperlukan

ID alam semesta.

subscription_product_idstring

Diperlukan

ID produk berlangganan.

subscription_idstring

Diperlukan

ID langganan.

Parameter Kueri

viewEnum<string>

Tampilan di mana untuk mengambil langganan.

Mendukung BASIC dan FULL.

Default ke BASIC.

Nilai yang mungkin:

| Nilai | Deskripsi | | --- | --- | | VIEW_UNSPECIFIED | Pandangan langganan tidak ditentukan; default akan digunakan.| | DASAR | Hanya termasuk bidang active dan renewing .| | PENUH | Termasuk semua bidang. |. Nilai yang mungkin:

ResponsSubscription

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

Respons

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

Atribut

Subscription

Dapatkan LanggananBeta

Dapatkan Langganan
Beta