Method: subscriptions.delete

Membatalkan, menangguhkan, atau mentransfer langganan untuk diarahkan.

Permintaan HTTP

DELETE https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
customerId

string

Ini dapat berupa nama domain primer pelanggan atau pengenal unik pelanggan. Jika nama domain untuk pelanggan berubah, nama domain lama tidak dapat digunakan untuk mengakses pelanggan, tetapi ID unik pelanggan (seperti yang ditampilkan oleh API) selalu dapat digunakan. Sebaiknya simpan ID unik di sistem Anda jika berlaku.

subscriptionId

string

Ini adalah properti wajib. subscriptionId adalah ID langganan dan bersifat unik untuk setiap pelanggan. Karena subscriptionId berubah saat langganan diperbarui, sebaiknya Anda tidak menggunakan ID ini sebagai kunci untuk data persisten. Selain itu, subscriptionId dapat ditemukan menggunakan metode mengambil semua langganan reseller.

Parameter kueri

Parameter
deletionType

enum (DeletionType)

String kueri deletionType memungkinkan pembatalan, downgrade, atau penangguhan langganan.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, responsnya adalah respons HTTP generik yang formatnya ditentukan oleh metode.

Pesan yang merepresentasikan bagian isi HTTP arbitrer. Pesan ini hanya boleh digunakan untuk format payload yang tidak dapat direpresentasikan sebagai JSON, seperti biner mentah atau halaman HTML.

Pesan ini dapat digunakan baik dalam metode API streaming maupun non-streaming pada permintaan dan juga pada respons.

Pesan ini dapat digunakan sebagai kolom permintaan tingkat atas, yang praktis jika seseorang ingin mengekstrak parameter dari template HTTP atau URL ke dalam kolom permintaan dan juga menginginkan akses ke isi HTTP mentah.

Contoh:

message GetResourceRequest {
  // A unique request id.
  string requestId = 1;

  // The raw HTTP body is bound to this field.
  google.api.HttpBody http_body = 2;

}

service ResourceService {
  rpc GetResource(GetResourceRequest)
    returns (google.api.HttpBody);
  rpc UpdateResource(google.api.HttpBody)
    returns (google.protobuf.Empty);

}

Contoh dengan metode streaming:

service CaldavService {
  rpc GetCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);
  rpc UpdateCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);

}

Penggunaan jenis ini hanya mengubah cara penanganan isi permintaan dan respons; semua fitur lainnya tetap berfungsi tanpa perubahan.

Representasi JSON
{
  "contentType": string,
  "data": string,
  "extensions": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Kolom
contentType

string

Nilai header Jenis Konten HTTP yang menentukan jenis konten bagian isi.

data

string (bytes format)

Isi permintaan/respons HTTP sebagai biner mentah.

String berenkode base64.

extensions[]

object

Metadata respons khusus aplikasi. Harus ditetapkan dalam respons pertama untuk API streaming.

Objek yang berisi kolom jenis arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }.

Cakupan Otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/apps.order

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

JenisPenghapusan

Enumerasi
deletion_type_undefined
cancel Membatalkan langganan secara langsung. Hal ini tidak berlaku untuk langganan G Suite.
transfer_to_direct

Mentransfer langganan langsung ke Google. Pelanggan langsung ditransfer ke hubungan penagihan langsung dengan Google dan diberi waktu yang singkat tanpa gangguan layanan. Pelanggan kemudian dapat memilih untuk menyiapkan penagihan secara langsung dengan Google menggunakan kartu kredit, atau mereka dapat mentransfer ke reseller lain.