REST Resource: subscriptions

Tài nguyên: Gói thuê bao

Mẫu JSON cho một gói thuê bao.

Biểu diễn dưới dạng JSON 
{
  "customerId": string,
  "subscriptionId": string,
  "skuId": string,
  "creationTime": string,
  "kind": string,
  "seats": {
    object (Seats)
  },
  "renewalSettings": {
    object (RenewalSettings)
  },
  "purchaseOrderId": string,
  "status": string,
  "resourceUiUrl": string,
  "billingMethod": string,
  "suspensionReasons": [
    string
  ],
  "customerDomain": string,
  "dealCode": string,
  "skuName": string,
  "plan": {
    "planName": string,
    "isCommitmentPlan": boolean,
    "commitmentInterval": {
      "startTime": string,
      "endTime": string
    }
  },
  "trialSettings": {
    "isInTrial": boolean,
    "trialEndTime": string
  },
  "transferInfo": {
    "transferabilityExpirationTime": string,
    "minimumTransferableSeats": integer,
    "currentLegacySkuId": string
  }
}
Trường
customerId

string

Tài sản này sẽ luôn được trả về dưới dạng giá trị nhận dạng duy nhất do Google tạo. Trong một yêu cầu, tài sản này có thể là miền chính hoặc giá trị nhận dạng duy nhất do Google tạo.
subscriptionId

string

subscriptionId là mã nhận dạng gói thuê bao và là giá trị riêng biệt cho từng khách hàng. Đây là thuộc tính bắt buộc. Vì subscriptionId thay đổi khi gói thuê bao được cập nhật, bạn không nên sử dụng mã nhận dạng này làm khoá cho dữ liệu cố định. Sử dụng subscriptionId như mô tả trong phần truy xuất tất cả các gói thuê bao của đại lý.
skuId

string

Thuộc tính bắt buộc. skuId là giá trị nhận dạng hệ thống duy nhất cho SKU của sản phẩm được chỉ định cho khách hàng trong gói thuê bao. Đối với các sản phẩm và SKU có trong phiên bản API này, hãy xem Mã sản phẩm và SKU.
creationTime

string (int64 format)

Thuộc tính creationTime là ngày tạo gói thuê bao. Thời gian tính bằng mili giây khi sử dụng định dạng Epoch. Xem ví dụ về Trình chuyển đổi Epoch.
kind

string

Xác định tài nguyên là một Gói thuê bao. Giá trị: reseller#subscription
seats

object (Seats)

Đây là thuộc tính bắt buộc. Số lượng và giới hạn giấy phép mỗi người dùng trong gói.
renewalSettings

object (RenewalSettings)

Chế độ cài đặt việc gia hạn cho gói cam kết hằng năm. Để biết thêm thông tin chi tiết, hãy xem các tùy chọn gia hạn trong trung tâm trợ giúp quản trị viên.
purchaseOrderId

string

Đây là thuộc tính không bắt buộc. Thông tin đơn đặt hàng (PO) này là dành cho người bán lại để sử dụng cho việc sử dụng tính năng theo dõi của công ty. Nếu bạn cung cấp giá trị purchaseOrderId, thì giá trị đó sẽ xuất hiện trong phản hồi của API và xuất hiện trong hoá đơn. Thuộc tính này chấp nhận tối đa 80 ký tự văn bản thuần tuý.
status

string

Đây là thuộc tính không bắt buộc.
resourceUiUrl

string

URL dẫn đến trang Gói thuê bao của khách hàng trong Bảng điều khiển dành cho quản trị viên. URL chỉ đọc do dịch vụ API tạo. Chế độ này được dùng nếu ứng dụng của bạn yêu cầu khách hàng hoàn tất một tác vụ bằng cách sử dụng trang Gói thuê bao trong Bảng điều khiển dành cho quản trị viên.
billingMethod

string

Trường chỉ đọc trả về phương thức thanh toán hiện tại cho một gói thuê bao.
suspensionReasons[]

string

Trường chỉ đọc chứa tất cả các lý do tạm ngưng hiện tại của một gói thuê bao. Một gói thuê bao có thể có nhiều lý do tạm ngưng đồng thời, trùng lặp. STATUS của gói thuê bao là SUSPENDED cho đến khi tất cả lệnh tạm ngưng đang chờ xử lý được xoá.

Bạn có thể sử dụng các lựa chọn sau:

  • PENDING_TOS_ACCEPTANCE – Khách hàng chưa đăng nhập và chấp nhận Điều khoản dịch vụ của dịch vụ G Suite được bán lại.
  • RENEWAL_WITH_TYPE_CANCEL – Cam kết của khách hàng đã kết thúc và dịch vụ của họ đã bị hủy khi hết thời hạn.
  • RESELLER_INITIATED – Đại lý đã gọi ra thông báo tạm ngưng theo cách thủ công.
  • TRIAL_ENDED – Thời gian dùng thử của khách hàng đã hết mà không có gói nào được chọn.
  • OTHER – Khách hàng bị tạm ngưng vì lý do nội bộ của Google (ví dụ: lạm dụng hoặc lý do khác).

customerDomain

string

Tên miền chính của khách hàng
dealCode

string

Mã do Google cấp (tối đa 100 ký tự) để áp dụng giá chiết khấu cho gói thuê bao. Bạn phải đưa mã ưu đãi vào insert yêu cầu để được hưởng mức giá chiết khấu. Đây là cơ sở lưu trú không bắt buộc, giá thông thường sẽ áp dụng nếu để trống.
skuName

string

Tên hiển thị bên ngoài ở trạng thái chỉ có thể đọc cho SKU của sản phẩm được chỉ định cho khách hàng trong gói thuê bao. Tên SKU có thể thay đổi theo quyết định của Google. Đối với các sản phẩm và SKU có trong phiên bản API này, hãy xem Mã sản phẩm và SKU.
plan

object

Thuộc tính plan là bắt buộc. Trong phiên bản API này, các gói G Suite bao gồm gói linh hoạt, gói cam kết hằng năm và gói dùng thử miễn phí 30 ngày. Để biết thêm thông tin về các gói thanh toán của API, hãy xem khái niệm API.
plan.planName

string

Thuộc tính planName là bắt buộc. Đây là tên gói của gói thuê bao. Để biết thêm thông tin về các gói thanh toán của Google, hãy xem bài viết Khái niệm về API.

Bạn có thể sử dụng các giá trị sau:

  • ANNUAL_MONTHLY_PAY — Gói cam kết hằng năm thanh toán hằng tháng.
  • ANNUAL_YEARLY_PAY — Gói cam kết hằng năm thanh toán hằng năm
  • FLEXIBLE — Gói linh hoạt
  • TRIAL — Gói dùng thử miễn phí 30 ngày. Gói thuê bao đang dùng thử sẽ bị tạm ngưng sau ngày miễn phí thứ 30 nếu không có gói thanh toán nào được chỉ định. Việc gọi changePlan sẽ chỉ định một gói thanh toán cho một gói dùng thử nhưng sẽ không kích hoạt gói đó. Gói dùng thử sẽ tự động bắt đầu gói thanh toán được chỉ định sau ngày miễn phí thứ 30 hoặc ngay sau khi gọi startPaidService.
  • FREE – Gói miễn phí này chỉ dành cho SKU Cloud Identity và không phát sinh bất kỳ khoản thanh toán nào.

plan.isCommitmentPlan

boolean

Giá trị boolean của tài sản isCommitmentPlan xác định gói đó là gói cam kết hằng năm:

  • true — Gói của gói thuê bao này là gói cam kết hằng năm.
  • false — Gói này không phải là gói cam kết hằng năm.
plan.commitmentInterval

object

Trong phiên bản API này, khoảng thời gian của gói cam kết hằng năm là một năm.

plan.commitmentInterval.startTime

string (int64 format)

Khoảng thời gian startTime của gói cam kết hằng năm (tính bằng mili giây) ở định dạng UNIX Epoch. Xem ví dụ về Trình chuyển đổi Epoch.
plan.commitmentInterval.endTime

string (int64 format)

endTime của khoảng thời gian cam kết hằng năm (tính bằng mili giây) ở định dạng UNIX Epoch. Xem ví dụ về Trình chuyển đổi Epoch.
trialSettings

object

Cam kết hàng năm của G Suite và các gói thanh toán linh hoạt có thể trong thời gian dùng thử miễn phí 30 ngày. Để biết thêm thông tin, hãy xem bài viết Khái niệm về API.
trialSettings.isInTrial

boolean

Xác định xem gói thuê bao có đang trong giai đoạn dùng thử miễn phí 30 ngày hay không:

  • true — Gói này đang trong giai đoạn dùng thử.
  • false — Gói này hiện không trong giai đoạn dùng thử.
trialSettings.trialEndTime

string (int64 format)

Ngày kết thúc thời gian dùng thử. Giá trị được tính bằng mili giây khi sử dụng định dạng UNIX Epoch. Xem ví dụ về Trình chuyển đổi Epoch.
transferInfo

object

Thông tin liên quan đến việc chuyển ở chế độ chỉ đọc cho gói thuê bao. Để biết thêm thông tin, hãy xem phần truy xuất gói thuê bao có thể chuyển cho khách hàng.
transferInfo.transferabilityExpirationTime

string (int64 format)

Thời điểm mã chuyển hoặc ý định chuyển sẽ hết hạn. Thời gian tính bằng mili giây khi sử dụng định dạng UNIX Epoch.
transferInfo.minimumTransferableSeats

integer

Khi chèn gói thuê bao, đây là số giấy phép tối thiểu được liệt kê trong yêu cầu chuyển đối với sản phẩm này. Ví dụ: nếu khách hàng có 20 người dùng thì đại lý không thể đặt đơn đặt hàng chuyển nhượng 15 người dùng. Tối thiểu là 20 giấy phép.
transferInfo.currentLegacySkuId

string

skuId của gói thuê bao hiện tại được bán lại. Thuộc tính này chỉ được điền sẵn khi khách hàng có gói thuê bao có SKU cũ và tài nguyên gói thuê bao được điền sẵn skuId của SKU được đề xuất để chuyển.

Ghế ngồi

Mẫu JSON cho vị trí đăng ký.

Biểu diễn dưới dạng JSON 
{
  "numberOfSeats": integer,
  "maximumNumberOfSeats": integer,
  "licensedNumberOfSeats": integer,
  "kind": string
}
Trường
numberOfSeats

integer

Đây là thuộc tính bắt buộc và dành riêng cho các gói thuê bao có gói ANNUAL_MONTHLY_PAY và ANNUAL_YEARLY_PAY. Thuộc tính này đặt số lượng giấy phép tối đa mà bạn có thể chỉ định cho người dùng trong một gói thuê bao. Đại lý có thể thêm nhiều giấy phép hơn, nhưng sau khi đặt, bạn không thể giảm numberOfSeats trước khi gia hạn. Đại lý được lập hoá đơn dựa trên giá trị numberOfSeats bất kể đã chỉ định bao nhiêu giấy phép người dùng trong số này.

maximumNumberOfSeats

integer

Đây là thuộc tính bắt buộc và dành riêng cho các gói thuê bao có gói FLEXIBLE hoặc TRIAL. Thuộc tính này đặt số lượng người dùng được cấp phép tối đa được phép cho một gói thuê bao. Số lượng này có thể tăng lên đến giới hạn tối đa được quy định trong hợp đồng của đại lý. Số lượng tối thiểu là số lượng người dùng hiện tại trong tài khoản khách hàng.

licensedNumberOfSeats

integer

Trường chỉ đọc chứa số lượng người dùng hiện tại được cấp giấy phép của sản phẩm được xác định trong skuId. Giá trị của trường này tương đương với số người dùng được trả về bằng phương thức API Enterprise License Manager: listForProductAndSku.
kind

string

Xác định tài nguyên là chế độ cài đặt giấy phép thuê bao. Giá trị: subscriptions#seats

RenewalSettings

Mẫu JSON cho chế độ cài đặt gia hạn gói thuê bao.

Biểu diễn dưới dạng JSON 
{
  "renewalType": string,
  "kind": string
}
Trường
renewalType

string

Chế độ cài đặt việc gia hạn cho gói cam kết hằng năm. Để biết thêm thông tin chi tiết, hãy xem các tùy chọn gia hạn trong trung tâm trợ giúp quản trị viên. Khi gia hạn gói thuê bao, renewalType là thuộc tính bắt buộc.
kind

string

Xác định tài nguyên là một chế độ cài đặt gia hạn gói thuê bao. Giá trị: subscriptions#renewalSettings

Phương thức

activate

 Kích hoạt gói thuê bao đã bị đại lý tạm ngưng trước đó.

changePlan

 Cập nhật gói thuê bao.

changeRenewalSettings

 Cập nhật chế độ cài đặt gia hạn của giấy phép người dùng.

changeSeats

 Cập nhật các chế độ cài đặt về giấy phép người dùng của một gói thuê bao.

delete

 Huỷ, tạm ngưng hoặc chuyển gói thuê bao sang định dạng trực tiếp.

get

 Nhận một gói thuê bao cụ thể.

insert

 Tạo hoặc chuyển một gói thuê bao.

list

 Danh sách các gói thuê bao do đại lý quản lý.

startPaidService

 Chuyển ngay gói thuê bao dùng thử miễn phí 30 ngày sang gói thuê bao dịch vụ có tính phí.

suspend

 Tạm ngưng một gói thuê bao đang hoạt động.