*Nội dung này được dịch bằng AI (Beta) và có thể có lỗi. Để xem trang này bằng tiếng Anh, hãy nhấp vào đây.

Subscription

Đại diện cho sự đăng ký của người dùng đối với một sản phẩm đăng ký. ID đăng ký giống với ID người dùng của người đăng ký.

Thuộc Tính

pathstring

Con đường tài nguyên của gói đăng ký.

Định dạng: universes/{universe_id}/subscription-products/{subscription_product_id}/subscriptions/{subscription_id}.

createTimestring
Chỉ Xuất

Thời gian chạy khi đăng ký được tạo. Chuỗi này được định dạng là Dấu thời gian.

updateTimestring
Chỉ Xuất

Thời gian chỉnh sửa lần cuối khi đăng ký được cập nhật. Chuỗi này được định dạng là Dấu thời gian.

activeboolean
Chỉ Xuất

Whether đăng ký đang hoạt động.

Điều này tương đương với việc liệu state có bằng với SUBSCRIBED_WILL_RENEW, SUBSCRIBED_WILL_NOT_RENEW hoặc SUBSCRIBED_RENEWAL_PAYMENT_PENDING hay không.

willRenewboolean
Chỉ Xuất

Liệu gói đăng ký có được gia hạn hay không.

Điều này tương đương với việc liệu state có bằng với SUBSCRIBED_WILL_RENEW hoặc SUBSCRIBED_RENEWAL_PAYMENT_PENDING không.

lastBillingTimestring
Chỉ Xuất

Thời gian chính xác khi gói đăng ký cuối cùng được thanh toán. Chuỗi này được định dạng là Dấu thời gian.

nextRenewTimestring
Chỉ Xuất

Thời gian chính xác khi gia hạn gói đăng ký tiếp theo sẽ tự động được gia hạn. Chuỗi này được định dạng là Dấu thời gian.

expireTimestring
Chỉ Xuất

Thời gian chốt khi đăng ký sẽ, hoặc đã, hết hạn. Chuỗi này được định dạng là Dấu thời gian.

stateEnum<string>
Chỉ Xuất

Tình trạng của sự đăng ký.

Các giá trị có thể:

| Giá trị | Mô tả | | --- | --- | | STATE_UNSPECIFIED | Tình trạng đăng ký không được xác định.| | SUBSCRIBED_WILL_RENEW | Hợp đồng đã được kích hoạt và sẽ được tự động gia hạn tại next_renew_time .| | SUBSCRIBED_WILL_NOT_RENEW | Hợp đồng đã được kích hoạt nhưng sẽ không được tự động gia hạn.| | SUBSCRIBED_RENEWAL_PAYMENT_PENDING | Hợp đồng đã được kích hoạt và nằm trong thời gian chờ thanh toán gia hạn.| | HẾT HẠN | Hợp đồng đã hết hạn.Xem expiration_details để biết thêm thông tin. |. Giá trị có thể:

expirationDetailsobject

Thông tin về hết hạn của gói đăng ký.

purchasePlatformEnum<string>
Chỉ Xuất

Nền tảng mà đăng ký đã được mua.

Các giá trị có thể:

| Giá trị | Mô tả | | --- | --- | | PURCHASE_PLATFORM_UNSPECIFIED | Nền tảng mua hàng không được xác định.| | MÁY TÍNH ĐỂ BÀN | Sự đăng ký đã được mua trên trang web Roblox.| | DI ĐỘNG | Gói đăng ký đã được mua trên ứng dụng di động Roblox. |. Giá trị có thể:

paymentProviderEnum<string>
Chỉ Xuất

Nhà cung cấp thanh toán đã sử dụng để mua gói đăng ký.

Các giá trị có thể:

| Giá trị | Mô tả | | --- | --- | | PAYMENT_PROVIDER_UNSPECIFIED | Nhà cung cấp thanh toán không được xác định.| | STRIPE | Hợp đồng đã được mua bằng cách sử dụng Stripe.| | APPLE | Sự đăng ký đã được mua bằng cách sử dụng Apple.| | GOOGLE | Sự đăng ký đã được mua bằng cách sử dụng Google.| | ROBLOX_CREDIT | Sự đăng ký đã được mua bằng Roblox Credit. |. Giá trị có thể:

userstring
Bất Biến

Người dùng đã đăng ký gói đăng ký.

URL Cơ Sở
https://apis.roblox.com
Tài nguyên 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

Nhận đăng ký
Bản Beta

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

Nhận đăng ký.

Phạm vi universe.subscription-product.subscription:read chỉ cho phép bạn nhận được các đăng ký riêng của mình - hoặc chính xác hơn, ID đăng ký phải phù hợp với ID người dùng tạo ra yêu cầu - vì vậy, trường hợp sử dụng tốt nhất là với xác thực OAuth 2.0 thay vì một chìa khóa API.Để đọc tất cả các đăng ký cho một vũ trụ, hãy sử dụng phạm vi universe:write.

Phạm Vi
universe:writeuniverse.subscription-product.subscription:read
Yêu CầuTham Số Đường Dẫn
universe_idstring
Bắt Buộc

ID của vũ trụ.

subscription_product_idstring
Bắt Buộc

ID sản phẩm đăng ký.

subscription_idstring
Bắt Buộc

ID đăng ký.

Tham Số Truy Vấn
viewEnum<string>

Cái nhìn trong đó để lấy lại đăng ký.

Hỗ trợ CĂN BẢN và FULL.

Mặc định là BASIC.

Các giá trị có thể:

| Giá trị | Mô tả | | --- | --- | | VIEW_UNSPECIFIED | Không xác định view đăng ký; mặc định sẽ được sử dụng.| | CĂN BẢN | Chỉ bao gồm các trường active và renewing .| | FULL | Bao gồm tất cả các trường. |. Giá trị có thể:

Phản HồiSubscription
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}'
Phản Hồi
{

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

}