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
  }
}
Các trường
customerId

string

Thuộc tính này sẽ luôn được trả về trong phản hồi 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à giá trị nhận dạng gói thuê bao và là giá trị duy nhất cho mỗi 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, nên bạn không nên dùng mã nhận dạng này làm khoá cho dữ liệu liên tục. Sử dụng subscriptionId như được mô tả trong phần truy xuất tất cả gói thuê bao của đại lý.
skuId

string

Một 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. Tính bằng mili giây 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 dưới dạng 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à hạn mức giấy phép chỗ ngồi của người dùng trong gói.
renewalSettings

object (RenewalSettings)

Chế độ cài đặt 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à một thuộc tính không bắt buộc. Thông tin đơn đặt hàng (PO) này là để đại lý sử dụng cho việc sử dụng tính năng theo dõi công ty của họ. Nếu bạn cung cấp giá trị purchaseOrderId, giá trị đó sẽ xuất hiện trong phản hồi của API và xuất hiện trong hóa đơn. Tài sản chấp nhận tối đa 80 ký tự văn bản thuần túy.
status

string

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

string

URL đến trang Đăng ký của khách hàng trong Bảng điều khiển dành cho quản trị viên. Dịch vụ API tạo URL chỉ có thể đọc. Lệnh này được sử dụng nếu ứng dụng của bạn yêu cầu khách hàng hoàn thành một nhiệm vụ bằ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 danh sách liệt kê tất cả các lý do khiến gói thuê bao hiện tại bị tạm ngưng. Một gói thuê bao có thể có nhiều lý do tạm ngưng, đồng thời bị 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 xóa bỏ.

Các lựa chọn có thể bao gồm:

  • 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 bán lại của G Suite.
  • 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ị huỷ khi hết thời hạn.
  • RESELLER_INITIATED – Thông báo về việc tạm ngưng theo cách thủ công do Đại lý gọi.
  • TRIAL_ENDED – Thời gian dùng thử của khách hàng đã hết hạn 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ự) cho giá chiết khấu đối với các gói thuê bao. Mã ưu đãi phải được đưa vào insert yêu cầu để nhận được mức giá chiết khấu. Thuộc tính này là 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 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 riêng 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

Bạn bắt buộc phải thêm thuộc tính plan. Trong phiên bản API này, các gói G Suite là 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 các khái niệm về API.
plan.planName

string

Bạn bắt buộc phải thêm thuộc tính planName. Đây là tên 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 các khái niệm về API.

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

  • ANNUAL_MONTHLY_PAY — Gói cam kết hằng năm với các khoản thanh toán hàng tháng.
  • ANNUAL_YEARLY_PAY — Gói cam kết hằng năm với các khoản 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 dùng thử sẽ bị tạm ngưng sau ngày miễn phí thứ 30 nếu bạn chưa chỉ định gói thanh toán nào. Việc gọi changePlan sẽ chỉ định một gói thanh toán cho gói dùng thử nhưng sẽ không kích hoạt gói đó. Bản dùng thử sẽ tự động bắt đầu gói thanh toán được chỉ định sau ngày thứ 30 miễn phí hoặc ngay sau khi gọi startPaidService.
  • FREE – Gói miễn phí là dành riêng cho SKU Cloud Identity và không phải thanh toán.

plan.isCommitmentPlan

boolean

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

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

object

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

plan.commitmentInterval.startTime

string (int64 format)

Gói thời gian cam kết hằng năm là startTimekhoảng thời gian tính bằng mili giây bằng định dạng UNIX Epoch. Xem ví dụ về Trình chuyển đổi Epoch.
plan.commitmentInterval.endTime

string (int64 format)

Gói thời gian cam kết hằng năm là endTimekhoảng thời gian tính bằng mili giây bằng định dạng UNIX Epoch. Xem ví dụ về Trình chuyển đổi Epoch.
trialSettings

object

Bạn có thể dùng thử miễn phí 30 ngày các gói thanh toán linh hoạt và gói thanh toán G Suite hằng năm. Để biết thêm thông tin, hãy xem các khái niệm về API.
trialSettings.isInTrial

boolean

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

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

string (int64 format)

Ngày hết hạn dùng thử. Giá trị tính bằng mili giây 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 chỉ có thể đọc cho gói thuê bao đó. Để biết thêm thông tin, hãy xem cách truy xuất gói thuê bao có thể chuyển nhượng cho khách hàng.
transferInfo.transferabilityExpirationTime

string (int64 format)

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

integer

Khi chèn gói thuê bao, đây là số chỗ ngồi tối thiểu nêu trong đơn đặt hàng chuyển sản phẩm này. Ví dụ: nếu khách hàng có 20 người dùng, thì người bán lại không thể đặt yêu cầu chuyển 15 chỗ. Tối thiểu là 20 chỗ ngồi.
transferInfo.currentLegacySkuId

string

skuId của gói thuê bao bán lại hiện tại. Thông tin 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 skuId bằng SKU đã đề xuất để chuyển.

Ghế

Mẫu JSON cho chỗ ngồi đăng ký.

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

integer

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

maximumNumberOfSeats

integer

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

licensedNumberOfSeats

integer

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

string

Xác định tài nguyên là một chế độ cài đặt vị trí đăng ký. Giá trị: subscriptions#seats

Các chế độ cài đặt gia hạn

Mẫu JSON cho một chế độ cài đặt gia hạn gói đăng ký.

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

string

Chế độ cài đặt 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à một 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 pháp

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 các chế độ cài đặt gia hạn giấy phép của người dùng.

changeSeats

 Cập nhật chế độ cài đặt giấy phép của người dùng cho gói đăng ký.

delete

 Hủy, tạm ngưng hoặc chuyển gói đăng ký để thanh toán trực tiếp.

get

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

insert

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

list

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

startPaidService

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

suspend

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