Mengambil & memperbarui langganan

Setelah mengambil langganan, Anda dapat menggunakan informasi dari respons yang berhasil untuk mengubah status langganan atau memperbarui langganan. Halaman ini berfokus pada berbagai cara untuk mengambil dan mengupdate langganan.

Mengambil langganan

Untuk mengambil langganan yang berhasil dipesan atau ditransfer, gunakan permintaan HTTP GET berikut.

GET https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID

Ganti kode berikut:

  • CUSTOMER_ID: Nama domain primer pelanggan atau ID unik pelanggan.
  • SUBSCRIPTION_ID: ID langganan yang unik untuk setiap pelanggan. Anda dapat mengambil nilai ini menggunakan metode Ambil semua langganan reseller.

Operasi ini tidak memiliki parameter dalam isi permintaan.

Respons yang berhasil akan menampilkan kode status HTTP 200 dan setelan langganan. Dalam contoh respons berikut, properti isInTrial adalah false tetapi tidak ada properti trialEndTime, yang berarti pelanggan ini belum pernah mengikuti uji coba gratis 30 hari dengan paket ini.

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "billingMethod": "ONLINE",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "RENEW_CURRENT_USERS_MONTHLY_PAY"
  },
  "purchaseOrderId": "example.com_annual_1",
  "status": "ACTIVE",
  "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
  "skuName": "Google Workspace Business Standard"
}

Mengambil semua langganan untuk pelanggan

Untuk mengambil semua langganan pelanggan reseller tertentu yang telah berhasil dipesan atau ditransfer, gunakan permintaan HTTP GET berikut dan sertakan token otorisasi:

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerId=CUSTOMER_ID value&pageToken=START_DATE&maxResults=MAX_NUMBER

Ganti kode berikut:

  • CUSTOMER_ID: Nama domain primer pelanggan atau ID unik pelanggan.
  • START_DATE: Tanggal mulai dalam format YYYY-MM-DD.
  • MAX_NUMBER: Jumlah hasil maksimum yang ditampilkan di halaman respons.

Operasi ini tidak memiliki parameter dalam isi permintaan.

Respons yang berhasil akan menampilkan kode status 200 HTTP serta daftar langganan dan setelan pelanggan. Daftar langganan mungkin menyertakan produk yang tidak dikelola dalam versi Reseller API ini.

Jika Anda tidak mengelola bahwa pelanggan ini tidak dikelola, error 403 "Forbidden" akan muncul.

Mengambil semua langganan yang dapat ditransfer untuk pelanggan

Untuk mengambil semua langganan pelanggan yang berpotensi dapat ditransfer ke pengelolaan reseller, gunakan permintaan HTTP GET berikut dan sertakan token otorisasi. customerId diperlukan dan merupakan ID unik pelanggan yang ditampilkan saat mengambil akun pelanggan reseller. customerAuthToken adalah token transfer yang diberikan oleh pelanggan yang dikhususkan untuk ID reseller Anda. Setelah dibuat oleh pelanggan, ID ini berlaku selama 30 hari. Untuk mengetahui informasi selengkapnya tentang cara pelanggan membuat token, lihat Mentransfer akun Google Workspace ke reseller.

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerId=CUSTOMER_ID&customerAuthToken=AUTH_TOKEN&pageToken=START_DATE&maxResults=MAX_NUMBER

Ganti kode berikut:

  • CUSTOMER_ID: Nama domain primer pelanggan atau ID unik pelanggan.
  • AUTH_TOKEN: Token transfer yang diberikan oleh pelanggan yang spesifik untuk ID reseller Anda. Setelah dibuat oleh pelanggan, ID ini berlaku selama 30 hari. Untuk mengetahui informasi selengkapnya tentang cara pelanggan membuat token, lihat Mentransfer akun Google Workspace ke reseller. Jika nilai ini tidak valid atau telah habis masa berlakunya, respons API akan menampilkan error 403 "Forbidden".
  • START_DATE: Tanggal mulai dalam format YYYY-MM-DD.
  • MAX_NUMBER: Jumlah hasil maksimum yang ditampilkan di halaman respons.

Operasi ini tidak memiliki parameter dalam isi permintaan.

Respons yang berhasil akan menampilkan kode status 200 HTTP dan daftar langganan pelanggan yang dapat ditransfer dengan tanggal habis masa berlaku token transfer dan jumlah minimum slot yang diperlukan dalam urutan transfer. Pelanggan mungkin memiliki langganan tambahan yang tidak dapat ditransfer.

{
  "kind": "reseller#subscriptions",
  "subscriptions": [
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-6543",
      "subscriptionId": "432",
      "skuId": "1010020028",
      "billingMethod": "ONLINE",
      "creationTime": "1331647980142",
      "plan": {
        "planName": "ANNUAL",
        "isCommitmentPlan": true,
        "commitmentInterval": {
          "startTime": "1331647980142",
          "endTime": "1363183980142"
        }
      },
      "seats": {
        "kind": "subscriptions#seats",
        "numberOfSeats": 10,
        "maximumNumberOfSeats": 500,
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
      },
      "transferInfo": {
        "transferabilityExpirationTime": "1333183980142",
        "minimumTransferableSeats": "20"
      },
      "purchaseOrderId": "PO_890",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-6543",
      "subscriptionId": "140",
      "skuId": "1010020028",
      "creationTime": "1329389322728",
      "plan": {
        "planName": "FLEXIBLE",
        "isCommitmentPlan": false
      },
      "seats": {
        "kind": "subscriptions#seats",
        "maximumNumberOfSeats": 50
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false,
        "trialEndTime": "1331877480016"
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
      },
      "transferInfo": {
        "transferabilityExpirationTime": "1333183780159",
        "minimumTransferableSeats": "10"
      },
      "purchaseOrderId": "",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
  ],
  "nextPageToken": "token"
}

Jika Anda berencana mentransfer langganan ini menggunakan operasi batch, transfer semua langganan. Mentransfer setiap langganan satu per satu akan menghasilkan error. Selain itu, operasi batch hanya mentransfer langganan dengan status ACTIVE. Untuk mengetahui informasi selengkapnya, lihat Mentransfer langganan.

Mengambil semua langganan reseller

Untuk mengambil semua langganan reseller yang berhasil dipesan atau ditransfer, gunakan permintaan HTTP GET berikut dan sertakan token otorisasi. 

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerNamePrefix=PREFIX &pageToken=TOKEN&maxResults=MAX_NUMBER

Ganti kode berikut:

  • PREFIX: Awal nama pelanggan yang langganannya Anda cari.
  • TOKEN: Token yang mengidentifikasi halaman hasil tertentu yang harus ditampilkan server.
  • MAX_NUMBER: Jumlah hasil maksimum yang ditampilkan di halaman respons.

Operasi ini dapat menggunakan cakupan akses hanya baca OAuth. customerNamePrefix, pageToken, dan maxResults adalah string kueri opsional.

Contoh berikut mengambil semua langganan reseller milik pelanggan yang namanya diawali dengan 'ujian':

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerNamePrefix=exam

{
  "kind": "reseller#subscriptions",
  "subscriptions": [
    {
      "kind": "subscriptions#subscription",
      "customerId": "C0123456",
      "subscriptionId": "123",
      "skuId": "1010020028",
      "creationTime": "1331647980142",
      "billingMethod": "ONLINE",
      "plan": {
        "planName": "ANNUAL",
        "isCommitmentPlan": true,
        "commitmentInterval": {
          "startTime": "1331647980142",
          "endTime": "1363183980142"
        }
      },
      "seats": {
        "kind": "subscriptions#seats",
        "numberOfSeats": 10,
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
      },
      "purchaseOrderId": "PO_135",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-5678",
      "subscriptionId": "1404686",
      "skuId": "1010020028",
      "billingMethod": "ONLINE",
      "creationTime": "1329389322728",
      "plan": {
        "planName": "FLEXIBLE",
        "isCommitmentPlan": false
      },
      "seats": {
        "kind": "subscriptions#seats",
        "maximumNumberOfSeats": 50,
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false,
        "trialEndTime": "1331877480016"
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "AUTO_RENEW"
      },
      "purchaseOrderId": "",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
  ],
  "nextPageToken": "token"
}

Memperbarui paket langganan

Memperbarui paket Google Workspace berbeda-beda bergantung pada paket. Sebelum Anda memperbarui rencana, pertimbangkan hal-hal berikut:

  • Saat Anda membuat langganan dan pelanggan memenuhi syarat, paket langganan dapat berupa uji coba 30 hari. Baik paket pembayaran komitmen fleksibel maupun tahunan dapat berupa uji coba gratis 30 hari. Selama periode uji coba, Anda dapat mengubah paket pembayaran langganan menjadi paket komitmen fleksibel atau tahunan sesering yang diperlukan. Namun setelah uji coba berakhir dan paket aktif, memperbarui paket akan mengikuti aturan yang sama seperti paket aktif langganan lainnya. Untuk segera memindahkan langganan uji coba ke paket aktif, mulai layanan berbayar dari langganan uji coba gratis 30 hari. Untuk informasi uji coba 30 hari lainnya dan aturan kualifikasi pelanggan, lihat pusat bantuan administrasi.

  • Anda dapat memperbarui paket fleksibel ke paket komitmen tahunan.

  • Anda tidak dapat memperbarui paket komitmen tahunan.

  • Tidak semua paket berfungsi dengan semua produk. Untuk mengetahui informasi selengkapnya tentang produk yang digunakan oleh paket ini, lihat Produk & SKU.

Guna memperbarui paket untuk uji coba 30 hari atau langganan paket fleksibel ke paket komitmen tahunan, gunakan permintaan HTTP POST berikut:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changePlan

Ganti kode berikut:

  • CUSTOMER_ID: Nama domain primer pelanggan atau ID unik pelanggan.
  • SUBSCRIPTION_ID: ID langganan yang unik untuk setiap pelanggan. Anda dapat mengambil nilai ini menggunakan metode Ambil semua langganan reseller.

Contoh berikut memperbarui langganan dengan subscriptionId dengan nilai 123. customerId adalah C0123456.

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changePlan

Isi permintaan memiliki hal berikut:

{
  "kind": "reseller#changePlanRequest",
  "planName": "ANNUAL_MONTHLY_PAY",
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10
  },
  "purchaseOrderId": "123_March2012"
}

Respons yang berhasil akan menampilkan kode status HTTP 201 dan menampilkan setelan paket langganan yang telah diperbarui:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "purchaseOrderId": "123_March2012",
  "status": "ACTIVE",
  "skuName": "Google Workspace Business Standard"
}

Memperbarui slot langganan

Memperbarui langganan paket komitmen tahunan akan menggunakan properti langganan yang berbeda dengan memperbarui langganan paket fleksibel Google Workspace.

Memperbarui slot untuk langganan paket tahunan

Untuk memperbarui setelan lisensi pengguna langganan paket tahunan, gunakan permintaan HTTP POST berikut:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changeSeats

Ganti kode berikut:

  • CUSTOMER_ID: Nama domain primer pelanggan atau ID unik pelanggan.
  • SUBSCRIPTION_ID: ID langganan yang unik untuk setiap pelanggan. Anda dapat mengambil nilai ini menggunakan metode Ambil semua langganan reseller.

Contoh berikut memperbarui langganan dengan 123 subscriptionId. customerId adalah C0123456. Isi permintaan berbeda-beda, bergantung pada jenis paket:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changeSeats

Langganan paket komitmen tahunan Google Workspace menggunakan isi permintaan ini untuk memperbarui jumlah lisensi pengguna. Nilai numberOfSeats adalah total. Misalnya, jika sebelumnya Anda memiliki 10 lisensi pengguna dan memiliki pesanan pelanggan untuk 5 lisensi baru, jumlah total dalam isi permintaan untuk numberOfSeats adalah 15, seperti yang ditunjukkan dalam contoh berikut:

{
    "kind": "subscriptions#seats",
    "numberOfSeats": 15
}

Memperbarui slot untuk langganan paket fleksibel

Langganan paket fleksibel Google Workspace menggunakan isi permintaan untuk memperbarui lisensi pengguna. Nilai maximumNumberOfSeats adalah total lisensi yang ada dan lisensi baru. Ini adalah jumlah maksimum lisensi pengguna yang dapat disediakan oleh akun.

{
  "kind": "subscriptions#seats",
  "maximumNumberOfSeats": 15
}

Respons yang berhasil akan menampilkan kode status HTTP 201 dan setelan lisensi langganan yang diperbarui:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "FLEXIBLE",
    "isCommitmentPlan": false
  },
  "seats": {
    "kind": "subscriptions#seats",
    "maximumNumberOfSeats": 15,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "skuName": "Google Workspace Business Standard"
}

Memperbarui setelan perpanjangan langganan

Untuk memperbarui setelan perpanjangan langganan komitmen tahunan, gunakan permintaan HTTP POST berikut:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changeRenewalSettings

Ganti kode berikut:

  • CUSTOMER_ID: Nama domain primer pelanggan atau ID unik pelanggan.
  • SUBSCRIPTION_ID: ID langganan yang unik untuk setiap pelanggan. Anda dapat mengambil nilai ini menggunakan metode Ambil semua langganan reseller.

Berikut adalah contoh isi permintaan:

{
  "kind": "subscriptions#renewalSettings",
  "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
}

Nilai properti renewalType dapat berupa salah satu dari nilai berikut:

  • AUTO_RENEW_YEARLY_PAY: Pada akhir interval paket komitmen tahunan, otomatis diperpanjang paket langganan sebagai ANNUAL_YEARLY_PAY dengan numberOfSeats yang sama.
  • AUTO_RENEW_MONTHLY_PAY: Di akhir interval paket komitmen tahunan, otomatis diperpanjang paket langganan sebagai ANNUAL_MONTHLY_PAY dengan numberOfSeats yang sama.
  • RENEW_CURRENT_USERS_YEARLY_PAY: Di akhir interval paket komitmen tahunan, perpanjang paket langganan sebagai ANNUAL_YEARLY_PAY, tetapi gunakan jumlah total lisensi pengguna aktif saat ini. Ini adalah setelan default untuk paket komitmen tahunan yang aktif (berbayar tahunan).
  • RENEW_CURRENT_USERS_MONTHLY_PAY: Di akhir interval paket komitmen tahunan, perpanjang paket langganan sebagai ANNUAL_MONTHLY_PAY, tetapi gunakan jumlah total lisensi pengguna aktif saat ini. Ini adalah setelan default untuk paket komitmen tahunan aktif (dibayar bulanan).
  • RENEW_ON_PROPOSED_OFFER: Di akhir interval paket komitmen saat ini, perpanjang proposal perpanjangan terbaru dengan numberOfSeats sebagai jumlah lisensi pengguna aktif saat ini atau komitmen penawaran yang diusulkan, mana saja yang lebih tinggi.
  • SWITCH_TO_PAY_AS_YOU_GO: Di akhir interval paket komitmen tahunan, ubah paket komitmen tahunan menjadi paket fleksibel.
  • CANCEL: Pada akhir interval paket komitmen tahunan, langganan akan ditangguhkan. Untuk memahami cara mencabut penangguhan, lihat pusat bantuan administrasi.

Respons yang berhasil akan menampilkan kode status HTTP 201 dan setelan perpanjangan langganan yang telah diperbarui:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 15,
    "licensedNumberOfSeats": 15
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "skuName": "Google Workspace Business Standard"
}

Memulai layanan berbayar dari langganan uji coba gratis

Untuk segera memindahkan langganan uji coba gratis 30 hari ke langganan layanan berbayar, jika paket pembayaran telah disiapkan untuk langganan uji coba, gunakan permintaan HTTP POST berikut. 

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/startPaidService

Ganti kode berikut:

  • CUSTOMER_ID: Nama domain primer pelanggan atau ID unik pelanggan.
  • SUBSCRIPTION_ID: ID langganan yang unik untuk setiap pelanggan. Anda dapat mengambil nilai ini menggunakan metode Ambil semua langganan reseller.

Contoh berikut memiliki C0123456 sebagai customerId dan nilai subscriptionId 123:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/startPaidService

Operasi ini tidak memiliki parameter dalam isi permintaan.

Respons yang berhasil akan menampilkan kode status HTTP 201 dan setelan langganan yang diperbarui:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 15,
    "licensedNumberOfSeats": 15
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "skuName": "Google Workspace Business Standard"
}

Mengupgrade atau mendowngrade langganan

Anda tidak dapat mendowngrade paket tahunan di tengah masa berlaku, dan tidak dapat menjadwalkan downgrade menggunakan setelan perpanjangan. Sebaiknya tetapkan setelan perpanjangan untuk beralih ke FLEXIBLE, lalu downgrade setelah waktu perpanjangan.

Untuk mengupgrade atau mendowngrade langganan, buat langganan baru dengan skuId yang menjadi tujuan upgrade atau downgrade.

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions

Ganti kode berikut:

  • CUSTOMER_ID: Nama domain primer pelanggan atau ID unik pelanggan.

Panggilan ini akan menghentikan langganan sebelumnya dan membuat langganan baru.

Temukan informasi selengkapnya tentang upgrade dan downgrade di halaman Produk & SKU.