Setelah mengambil langganan, Anda dapat menggunakan informasi dari respons yang baik terhadap mengubah status langganan atau memperbarui langganan. Halaman ini berfokus pada berbagai cara yang dapat Anda mengambil dan memperbarui langganan.
Mengambil langganan
Untuk mengambil langganan yang berhasil dipesan atau ditransfer, gunakan
mengikuti GET
permintaan HTTP.
GET https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID
Ganti kode berikut:
CUSTOMER_ID
: 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 metode langganan reseller.
Operasi ini tidak memiliki parameter dalam isi permintaan.
Respons yang berhasil akan menampilkan status 200
HTTP
kode langganan dan setelan langganan. Pada contoh respons berikut,
Properti isInTrial
adalah false
, tetapi tidak ada
trialEndTime
, yang berarti pelanggan ini belum pernah berada di
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
: Domain primer pelanggan atau ID unik pelanggan.START_DATE
: Tanggal mulai dalam formatYYYY-MM-DD
.MAX_NUMBER
: Jumlah maksimum hasil yang ditampilkan pada halaman respons.
Operasi ini tidak memiliki parameter dalam isi permintaan.
Respons yang berhasil akan menampilkan kode status 200
HTTP dan daftar
langganan dan setelan pelanggan. Daftar langganan dapat mencakup
produk yang tidak dikelola dalam versi Reseller API ini.
Jika Anda tidak mengelola pelanggan ini tidak dikelola, error 403 "Forbidden"
dikembalikan.
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. Tujuan
customerId
wajib ada dan merupakan ID unik pelanggan yang ditampilkan saat
mengambil akun pelanggan reseller.
customerAuthToken
adalah token transfer yang diberikan oleh pelanggan Anda yang
khusus untuk ID reseller Anda. Setelah dibuat oleh pelanggan, sandi tersebut valid selama
30 hari. Untuk 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
: Domain primer pelanggan atau ID unik pelanggan.AUTH_TOKEN
: Token transfer yang disediakan oleh pelanggan yang spesifik untuk ID reseller Anda. Setelah dibuat oleh masa berlaku selama 30 hari. Untuk informasi selengkapnya tentang cara pelanggan membuat token, lihat Mentransfer akun Google Workspace ke reseller. Jika nilai ini tidak valid atau sudah tidak berlaku, respons API akan menampilkan403 "Forbidden"
error.START_DATE
: Tanggal mulai dalam formatYYYY-MM-DD
.MAX_NUMBER
: Jumlah maksimum hasil yang ditampilkan pada halaman respons.
Operasi ini tidak memiliki parameter dalam isi permintaan.
Respons yang berhasil akan menampilkan kode status 200
HTTP dan daftar
langganan yang dapat ditransfer milik pelanggan dengan tanggal habis masa berlaku transfer
dan jumlah minimum slot yang
diperlukan dalam perintah transfer. Pelanggan
mungkin menyimpan 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 dengan menggunakan metode
operasi, mentransfer semua langganan. Mentransfer setiap langganan
satu per satu akan menghasilkan error. Selain itu, operasi batch hanya mentransfer
langganan dengan status ACTIVE
. Untuk informasi selengkapnya, lihat
Mentransfer langganan.
Ambil semua langganan reseller
Untuk mengambil semua reseller yang berhasil dipesan atau ditransfer
langganan, 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
: Bagian awal nama pelanggan yang langganan yang Anda cari.TOKEN
: Token yang mengidentifikasi halaman tertentu yang akan ditampilkan oleh server.MAX_NUMBER
: Jumlah maksimum hasil yang ditampilkan pada halaman respons.
Operasi ini dapat menggunakan cakupan akses hanya baca OAuth. Tujuan
customerNamePrefix
, pageToken
, dan maxResults
adalah string kueri opsional.
Contoh berikut mengambil semua langganan reseller yang merupakan 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
Cara memperbarui paket Google Workspace berbeda-beda bergantung pada paketnya. Sebelum mengupdate rencana, pertimbangkan hal-hal berikut:
Saat Anda membuat langganan dan pelanggan memenuhi syarat, paket langganan dapat berupa uji coba 30 hari. Paket yang fleksibel dan tahunan paket pembayaran komitmen dapat berupa uji coba gratis 30 hari. Selama uji coba, Anda dapat mengubah paket pembayaran langganan menjadi paket pembayaran fleksibel atau tahunan rencana komitmen sesering yang diperlukan. Setelah uji coba berakhir dan rencana menjadi aktif, memperbarui rencana akan mengikuti aturan yang sama dengan langganan rencana aktif. Untuk segera memindahkan langganan uji coba ke rencana aktif, memulai layanan berbayar dari langganan uji coba gratis 30 hari. Untuk informasi uji coba 30 hari dan aturan kualifikasi pelanggan selengkapnya, 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 informasi lebih lanjut tentang metode yang digunakan oleh paket tersebut, lihat Produk & SKU.
Untuk memperbarui paket uji coba 30 hari atau langganan paket fleksibel ke langganan tahunan
paket komitmen, 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
: 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 metode langganan reseller.
Contoh berikut memperbarui langganan dengan subscriptionId
dengan
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 informasi terbaru
pengaturan paket langganan:
{
"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 menggunakan langganan yang berbeda properti dibandingkan memperbarui langganan paket fleksibel Google Workspace.
Memperbarui slot untuk langganan paket tahunan
Untuk memperbarui setelan lisensi pengguna langganan paket tahunan, gunakan setelan berikut
Permintaan HTTP POST
:
POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changeSeats
Ganti kode berikut:
CUSTOMER_ID
: 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 metode langganan reseller.
Contoh berikut memperbarui langganan dengan subscriptionId
123. Tujuan
customerId
adalah C0123456. Isi permintaan berbeda bergantung pada
jenis rencana:
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, 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 diperbarui
lisensi pengguna. Nilai maximumNumberOfSeats
adalah total
lisensi yang ada dan lisensi baru. Ini adalah jumlah
maksimum pengguna
lisensi yang dapat disediakan oleh akun.
{
"kind": "subscriptions#seats",
"maximumNumberOfSeats": 15
}
Respons yang berhasil akan menampilkan kode status HTTP 201
dan kode status terbaru
pengaturan lisensi langganan:
{
"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
: 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 metode 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 berikut ini:
AUTO_RENEW_YEARLY_PAY
: Di akhir interval paket komitmen tahunan, memperpanjang paket langganan secara otomatis sebagaiANNUAL_YEARLY_PAY
dengannumberOfSeats
yang sama.AUTO_RENEW_MONTHLY_PAY
: Di akhir paket komitmen tahunan otomatis, memperpanjang paket langganan sebagaiANNUAL_MONTHLY_PAY
dengannumberOfSeats
yang sama.RENEW_CURRENT_USERS_YEARLY_PAY
: Di akhir paket komitmen tahunan tambahan, perpanjang paket langganan sebagaiANNUAL_YEARLY_PAY
, tetapi gunakan jumlah total lisensi pengguna yang aktif saat ini. Ini adalah default untuk paket komitmen tahunan aktif (dibayar tahunan).RENEW_CURRENT_USERS_MONTHLY_PAY
: Di akhir paket komitmen tahunan tambahan, perpanjang paket langganan sebagaiANNUAL_MONTHLY_PAY
, tetapi gunakan jumlah total lisensi pengguna yang aktif saat ini. Ini adalah default untuk paket komitmen tahunan aktif (berbayar bulanan).RENEW_ON_PROPOSED_OFFER
: Di akhir paket komitmen saat ini perpanjangan pada proposal perpanjangan terbaru dengan numberOfSeats sebagai nomor dari lisensi pengguna yang aktif saat ini atau komitmen penawaran yang diusulkan mana saja yang lebih tinggi.SWITCH_TO_PAY_AS_YOU_GO
: Di akhir paket komitmen tahunan mengubah paket komitmen tahunan ke paket fleksibel.CANCEL
: Di akhir interval paket komitmen tahunan, langganan ditangguhkan. Untuk memahami cara mencabut penangguhan, lihat pusat bantuan administrasi.
Respons yang berhasil akan menampilkan kode status HTTP 201
dan kode status terbaru
pengaturan perpanjangan langganan:
{
"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 layanan berbayar
langganan, jika paket pembayaran sudah disiapkan untuk uji coba
langganan, 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
: 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 metode langganan reseller.
Contoh berikut mencantumkan C0123456 sebagai customerId
dan
Nilai subscriptionId
dari 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 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"
}
Mengupgrade atau mendowngrade langganan
Anda tidak dapat mendowngrade paket tahunan di tengah masa berlakunya, dan Anda tidak dapat
jadwalkan downgrade dengan menggunakan setelan perpanjangan. Sebaiknya Anda menetapkan
setelan perpanjangan untuk beralih ke FLEXIBLE
lalu mendowngrade setelah waktu perpanjangan.
Untuk mengupgrade atau mendowngrade langganan, buat langganan baru
dengan skuId
yang ingin Anda upgrade atau downgrade.
POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions
Ganti kode berikut:
CUSTOMER_ID
: Domain primer pelanggan atau ID unik pelanggan.
Panggilan ini akan menghentikan langganan sebelumnya dan membuat langganan baru.
Temukan informasi selengkapnya tentang upgrade dan downgrade dalam Produk & SKU.