Method: subscriptions.delete
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Membatalkan, menangguhkan, atau mentransfer langganan ke langsung.
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 utama pelanggan atau ID 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 ada.
|
subscriptionId |
string
Ini adalah properti yang wajib ada. subscriptionId adalah ID langganan dan bersifat unik untuk setiap pelanggan. Karena subscriptionId berubah saat langganan diperbarui, sebaiknya jangan gunakan ID ini sebagai kunci untuk data persisten. Selain itu, subscriptionId dapat ditemukan menggunakan metode ambil 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
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.
Jika berhasil, responsnya adalah respons HTTP generik yang formatnya ditentukan oleh metode.
| Representasi JSON |
{
"contentType": string,
"data": string,
"extensions": [
{
"@type": string,
field1: ...,
...
}
]
} |
| Kolom |
contentType |
string
Nilai header Content-Type HTTP yang menentukan jenis konten pada 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 tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }.
|
Cakupan otorisasi
Memerlukan cakupan OAuth berikut:
https://www.googleapis.com/auth/apps.order
Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.
DeletionType
| Enum |
deletion_type_undefined |
|
cancel |
Segera membatalkan langganan. Hal ini tidak berlaku untuk langganan G Suite. |
transfer_to_direct |
Mentransfer langganan langsung ke Google. Pelanggan akan segera ditransfer ke hubungan penagihan langsung dengan Google dan diberi waktu singkat tanpa gangguan layanan. Pelanggan kemudian dapat memilih untuk menyiapkan penagihan langsung dengan Google menggunakan kartu kredit, atau mereka dapat mentransfer ke reseller lain. |
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-07-25 UTC.
[null,null,["Terakhir diperbarui pada 2025-07-25 UTC."],[],[],null,["# Method: subscriptions.delete\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.HttpBody.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [DeletionType](#DeletionType)\n- [Try it!](#try-it)\n\nCancels, suspends, or transfers a subscription to direct.\n\n### HTTP request\n\n`DELETE https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customerId` | `string` This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable. |\n| `subscriptionId` | `string` This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the [retrieve all reseller subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#get_all_subscriptions) method. |\n\n### Query parameters\n\n| Parameters ||\n|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `deletionType` | `enum (`[DeletionType](/workspace/admin/reseller/reference/rest/v1/subscriptions/delete#DeletionType)`)` The `deletionType` query string enables the cancellation, downgrade, or suspension of a subscription. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nMessage that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page.\n\nThis message can be used both in streaming and non-streaming API methods in the request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body.\n\nExample: \n\n message GetResourceRequest {\n // A unique request id.\n string requestId = 1;\n\n // The raw HTTP body is bound to this field.\n google.api.HttpBody http_body = 2;\n\n }\n\n service ResourceService {\n rpc GetResource(GetResourceRequest)\n returns (google.api.HttpBody);\n rpc UpdateResource(google.api.HttpBody)\n returns (google.protobuf.Empty);\n\n }\n\nExample with streaming methods: \n\n service CaldavService {\n rpc GetCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n rpc UpdateCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n\n }\n\nUse of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.\n\nIf successful, the response is a generic HTTP response whose format is defined by the method.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------|\n| ``` { \"contentType\": string, \"data\": string, \"extensions\": [ { \"@type\": string, field1: ..., ... } ] } ``` |\n\n| Fields ||\n|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `contentType` | `string` The HTTP Content-Type header value specifying the content type of the body. |\n| `data` | `string (`[bytes](https://developers.google.com/discovery/v1/type-format)` format)` The HTTP request/response body as raw binary. A base64-encoded string. |\n| `extensions[]` | `object` Application specific response metadata. Must be set in the first response for streaming APIs. An object containing fields of an arbitrary type. An additional field `\"@type\"` contains a URI identifying the type. Example: `{ \"id\": 1234, \"@type\": \"types.example.com/standard/id\" }`. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/apps.order`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nDeletionType\n------------\n\n| Enums ||\n|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `deletion_type_undefined` | |\n| `cancel` | Cancels the subscription immediately. This does not apply to a G Suite subscription. |\n| `transfer_to_direct` | Transfers a subscription directly to Google. The customer is immediately transferred to a direct billing relationship with Google and is given a short amount of time with no service interruption. The customer can then choose to set up billing directly with Google by using a credit card, or they can transfer to another reseller. |"]]
