REST Resource: subscriptions

Resource: Langganan

Template JSON untuk langganan.

Representasi 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
  }
}
Kolom
customerId

string

Properti ini akan selalu ditampilkan sebagai respons sebagai ID unik yang dihasilkan oleh Google. Dalam permintaan, properti ini dapat berupa domain primer atau ID unik yang dibuat oleh Google.
subscriptionId

string

subscriptionId adalah ID langganan dan bersifat unik untuk setiap pelanggan. Ini adalah properti wajib. Karena subscriptionId berubah saat langganan diperbarui, sebaiknya Anda tidak menggunakan ID ini sebagai kunci untuk data persisten. Gunakan subscriptionId seperti yang dijelaskan di mengambil semua langganan reseller.
skuId

string

Properti wajib. skuId adalah ID sistem unik untuk SKU produk yang ditetapkan kepada pelanggan dalam langganan. Untuk produk dan SKU yang tersedia di versi API ini, lihat ID Produk dan SKU.
creationTime

string (int64 format)

Properti creationTime adalah tanggal saat langganan dibuat. Periodenya dalam milidetik menggunakan format Epoch. Lihat contoh Pengonversi epoch.
kind

string

Mengidentifikasi resource sebagai Langganan. Nilai: reseller#subscription
seats

object (Seats)

Ini adalah properti wajib. Jumlah dan batas lisensi slot pengguna di paket.
renewalSettings

object (RenewalSettings)

Setelan perpanjangan untuk paket komitmen tahunan. Untuk informasi yang lebih mendetail, lihat opsi perpanjangan di pusat bantuan administrator.
purchaseOrderId

string

Ini adalah properti opsional. Informasi pesanan pembelian (PO) ini digunakan reseller untuk digunakan dalam pelacakan perusahaan. Jika nilai purchaseOrderId diberikan, nilai tersebut akan muncul di respons API dan muncul di invoice. Properti dapat menerima hingga 80 karakter teks biasa.
status

string

Ini adalah properti opsional.
resourceUiUrl

string

URL ke halaman Langganan pelanggan di konsol Admin. URL hanya baca dihasilkan oleh layanan API. Hal ini digunakan jika aplikasi klien Anda mengharuskan pelanggan untuk menyelesaikan tugas menggunakan halaman Langganan di konsol Admin.
billingMethod

string

Kolom hanya baca yang menampilkan metode penagihan saat ini untuk langganan.
suspensionReasons[]

string

Kolom hanya baca yang berisi enumerasi semua alasan penangguhan saat ini untuk langganan. Langganan bisa saja memiliki banyak alasan penangguhan yang terjadi secara bersamaan dan tumpang tindih. STATUS langganan adalah SUSPENDED hingga semua penangguhan yang tertunda dihapus.

Opsi yang memungkinkan mencakup:

  • PENDING_TOS_ACCEPTANCE - Pelanggan belum login dan menyetujui Persyaratan Layanan yang Dijual Kembali G Suite.
  • RENEWAL_WITH_TYPE_CANCEL - Komitmen pelanggan berakhir dan layanan mereka dibatalkan di akhir periode.
  • RESELLER_INITIATED - Penangguhan manual yang dilakukan oleh Reseller.
  • TRIAL_ENDED - Uji coba pelanggan berakhir tanpa memilih paket.
  • OTHER - Pelanggan ditangguhkan karena alasan internal Google (misalnya, penyalahgunaan atau lainnya).

customerDomain

string

Nama domain primer pelanggan
dealCode

string

Kode yang dikeluarkan Google (maks 100 karakter) untuk harga diskon pada paket langganan. Kode promo harus disertakan dalam insert permintaan untuk menerima tarif diskon. Properti ini bersifat opsional, harga reguler berlaku jika dibiarkan kosong.
skuName

string

Nama tampilan eksternal hanya baca untuk SKU produk yang ditetapkan kepada pelanggan dalam langganan. Nama SKU dapat berubah sesuai kebijaksanaan Google. Untuk produk dan SKU yang tersedia di versi API ini, lihat ID Produk dan SKU.
plan

object

Properti plan wajib diisi. Dalam versi API ini, paket G Suite merupakan paket fleksibel, paket komitmen tahunan, dan paket uji coba gratis 30 hari. Untuk informasi selengkapnya tentang paket pembayaran API, lihat Konsep API.
plan.planName

string

Properti planName wajib diisi. Ini adalah nama paket langganan. Untuk informasi selengkapnya tentang paket pembayaran Google, lihat Konsep API.

Nilai yang memungkinkan adalah:

  • ANNUAL_MONTHLY_PAY — Paket komitmen tahunan dengan pembayaran bulanan.
  • ANNUAL_YEARLY_PAY — Paket komitmen tahunan dengan pembayaran tahunan
  • FLEXIBLE — Paket fleksibel
  • TRIAL — Paket uji coba gratis 30 hari. Langganan dalam uji coba akan ditangguhkan setelah hari gratis ke-30 jika tidak ada paket pembayaran yang ditetapkan. Memanggil changePlan akan menetapkan paket pembayaran ke uji coba, tetapi tidak akan mengaktifkan paket pembayaran. Uji coba akan otomatis memulai paket pembayaran yang ditetapkan setelah hari gratis ke-30 atau segera setelah menelepon startPaidService.
  • FREE — Paket gratis bersifat eksklusif untuk SKU Cloud Identity dan tidak menimbulkan penagihan apa pun.

plan.isCommitmentPlan

boolean

Nilai boolean properti isCommitmentPlan mengidentifikasi paket sebagai paket komitmen tahunan:

  • true — Paket langganan adalah paket komitmen tahunan.
  • false — Paket bukan paket komitmen tahunan.
plan.commitmentInterval

object

Dalam versi API ini, interval paket komitmen tahunan adalah satu tahun.

plan.commitmentInterval.startTime

string (int64 format)

Interval komitmen tahunan paket startTime dalam milidetik menggunakan format UNIX Epoch. Lihat contoh Pengonversi epoch.
plan.commitmentInterval.endTime

string (int64 format)

Interval paket tahunan sebesar endTime dalam milidetik menggunakan format Epoch UNIX. Lihat contoh Pengonversi epoch.
trialSettings

object

Komitmen tahunan G Suite dan paket pembayaran fleksibel dapat dilakukan dalam uji coba gratis 30 hari. Untuk informasi selengkapnya, lihat Konsep API.
trialSettings.isInTrial

boolean

Menentukan apakah paket langganan sedang dalam uji coba gratis 30 hari atau tidak:

  • true — Paket sedang dalam uji coba.
  • false — Paket tidak dalam masa uji coba.
trialSettings.trialEndTime

string (int64 format)

Tanggal saat uji coba berakhir. Nilainya dalam milidetik menggunakan format Epoch UNIX. Lihat contoh Pengonversi epoch.
transferInfo

object

Informasi terkait transfer hanya baca untuk langganan. Untuk informasi selengkapnya, lihat mengambil langganan yang dapat ditransfer untuk pelanggan.
transferInfo.transferabilityExpirationTime

string (int64 format)

Waktu saat token transfer atau niat untuk mentransfer berakhir. Waktu dalam milidetik menggunakan format Epoch UNIX.
transferInfo.minimumTransferableSeats

integer

Saat menyisipkan langganan, ini adalah jumlah minimum slot yang tercantum pada pesanan transfer untuk produk ini. Misalnya, jika pelanggan memiliki 20 pengguna, reseller tidak dapat melakukan pemesanan transfer sebanyak 15 slot. Minimal 20 slot.
transferInfo.currentLegacySkuId

string

skuId dari langganan yang dijual kembali saat ini. Kolom ini hanya diisi jika pelanggan memiliki langganan dengan SKU lama dan resource langganan diisi dengan skuId SKU yang direkomendasikan untuk transfer.

Slot

Template JSON untuk tempat berlangganan.

Representasi JSON 
{
  "numberOfSeats": integer,
  "maximumNumberOfSeats": integer,
  "licensedNumberOfSeats": integer,
  "kind": string
}
Kolom
numberOfSeats

integer

Ini adalah properti wajib dan eksklusif untuk langganan dengan paket ANNUAL_MONTHLY_PAY dan ANNUAL_YEARLY_PAY. Properti ini menetapkan jumlah maksimum lisensi yang dapat ditetapkan kepada pengguna pada langganan. Reseller dapat menambahkan lebih banyak lisensi, tetapi setelah ditetapkan, numberOfSeats tidak dapat dikurangi hingga perpanjangan. Reseller ditagih berdasarkan nilai numberOfSeats terlepas dari jumlah lisensi pengguna yang ditetapkan.

maximumNumberOfSeats

integer

Ini adalah properti wajib dan eksklusif untuk langganan dengan paket FLEXIBLE atau TRIAL. Properti ini menetapkan jumlah maksimum pengguna berlisensi yang diizinkan pada langganan. Jumlah ini dapat ditingkatkan hingga batas maksimum yang ditentukan dalam kontrak reseller. Jumlah minimum adalah jumlah pengguna saat ini di akun pelanggan.

licensedNumberOfSeats

integer

Kolom hanya baca yang berisi jumlah pengguna saat ini yang diberi lisensi untuk produk yang ditentukan di skuId. Nilai kolom ini setara dengan jumlah numerik pengguna yang ditampilkan oleh metode Enterprise License Manager API: listForProductAndSku.
kind

string

Mengidentifikasi fasilitas sebagai setelan langganan langganan. Nilai: subscriptions#seats

SetelanPerpanjangan

Template JSON untuk setelan perpanjangan langganan.

Representasi JSON 
{
  "renewalType": string,
  "kind": string
}
Kolom
renewalType

string

Setelan perpanjangan untuk paket komitmen tahunan. Untuk informasi yang lebih mendetail, lihat opsi perpanjangan di pusat bantuan administrator. Saat memperpanjang langganan, renewalType adalah properti yang bersifat wajib.
kind

string

Mengidentifikasi resource sebagai setelan perpanjangan langganan. Nilai: subscriptions#renewalSettings

Metode

activate

 Mengaktifkan langganan yang sebelumnya ditangguhkan oleh reseller.

changePlan

 Memperbarui paket langganan.

changeRenewalSettings

 Memperbarui setelan perpanjangan lisensi pengguna.

changeSeats

 Memperbarui setelan lisensi pengguna langganan.

delete

 Membatalkan, menangguhkan, atau mentransfer langganan untuk diarahkan.

get

 Mendapatkan langganan tertentu.

insert

 Membuat atau mentransfer langganan.

list

 Daftar langganan yang dikelola oleh reseller.

startPaidService

 Segera pindahkan langganan uji coba gratis 30 hari ke langganan layanan berbayar.

suspend

 Menangguhkan langganan yang aktif.