Method: subscriptions.delete

ยกเลิก ระงับ หรือโอนการสมัครใช้บริการเป็นแบบชำระเงิน

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
customerId

string

ซึ่งอาจเป็นชื่อโดเมนหลักของลูกค้าหรือตัวระบุที่ไม่ซ้ำของลูกค้าก็ได้ หากชื่อโดเมนของลูกค้ามีการเปลี่ยนแปลง คุณจะไม่สามารถเข้าถึงลูกค้าโดยใช้ชื่อโดเมนเดิมได้ แต่จะใช้ตัวระบุที่ไม่ซ้ำกันของลูกค้า (ตามที่ API แสดงผล) ได้เสมอ เราขอแนะนำให้จัดเก็บตัวระบุที่ไม่ซ้ำกันในระบบของคุณ (หากมี)

subscriptionId

string

พร็อพเพอร์ตี้นี้เป็นพร็อพเพอร์ตี้ที่ต้องระบุ subscriptionId คือตัวระบุการสมัครใช้บริการที่ไม่ซ้ำกันสำหรับลูกค้าแต่ละราย เนื่องจาก subscriptionId จะเปลี่ยนแปลงเมื่อมีการอัปเดตการสมัครใช้บริการ เราจึงขอแนะนําว่าอย่าใช้รหัสนี้เป็นตัวคีย์สําหรับข้อมูลที่เก็บถาวร และคุณจะเห็น subscriptionId โดยใช้วิธีการเรียกข้อมูลการสมัครใช้บริการของตัวแทนจำหน่ายทั้งหมด

พารามิเตอร์การค้นหา

พารามิเตอร์
deletionType

enum (DeletionType)

สตริงการค้นหา deletionType เปิดใช้การยกเลิก การดาวน์เกรด หรือการระงับการสมัครใช้บริการ

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

ข้อความที่เป็นตัวแทนเนื้อหา HTTP ที่กำหนดเอง ควรใช้เป็นรูปแบบเปย์โหลดที่แสดงเป็น JSON ไม่ได้เท่านั้น เช่น ไฟล์ไบนารีข้อมูล RAW หรือหน้า HTML

ข้อความนี้ใช้ได้ทั้งในเมธอด API แบบสตรีมมิงและไม่ใช่สตรีมมิงในคำขอและในการตอบกลับ

ข้อความนี้ใช้เป็นช่องคำขอระดับบนสุดได้ ซึ่งจะสะดวกมากสำหรับผู้ที่ต้องการแยกพารามิเตอร์ออกจาก URL หรือเทมเพลต HTTP เพื่อใส่ลงในช่องคำขอและต้องการเข้าถึงเนื้อหา HTTP แบบไฟล์ข้อมูล RAW ด้วย

ตัวอย่าง

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);

}

ตัวอย่างที่ใช้เมธอดสตรีมมิง

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

}

การใช้งานประเภทนี้จะเปลี่ยนวิธีจัดการเนื้อหาของคำขอและการตอบกลับเท่านั้น ฟีเจอร์อื่นๆ ทั้งหมดจะยังทำงานเหมือนเดิม

หากดำเนินการสำเร็จ การตอบกลับจะเป็นคำตอบ HTTP ทั่วไปซึ่งรูปแบบจะกำหนดโดยเมธอด

การแสดง JSON
{
  "contentType": string,
  "data": string,
  "extensions": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
ช่อง
contentType

string

ค่าส่วนหัวประเภทเนื้อหา HTTP ที่ระบุประเภทเนื้อหาของส่วนเนื้อหา

data

string (bytes format)

เนื้อหาคำขอ/การตอบกลับ HTTP เป็นไบนารีดิบ

สตริงที่เข้ารหัส Base64

extensions[]

object

ข้อมูลเมตาการตอบกลับเฉพาะแอปพลิเคชัน ต้องตั้งค่าในการตอบกลับครั้งแรกสำหรับ API สตรีมมิง

ออบเจ็กต์ที่มีฟิลด์ประเภทใดก็ได้ ช่องเพิ่มเติม "@type" มี URI ที่ระบุประเภท ตัวอย่าง: { "id": 1234, "@type": "types.example.com/standard/id" }

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์

DeletionType

Enum
deletion_type_undefined
cancel ยกเลิกการสมัครใช้บริการทันที แต่จะไม่มีผลกับการสมัครใช้บริการ G Suite
transfer_to_direct

โอนการสมัครใช้บริการไปยัง Google โดยตรง  ระบบจะโอนลูกค้าไปยังความสัมพันธ์ด้านการเรียกเก็บเงินโดยตรงกับ Google ทันทีและลูกค้าจะได้รับเวลาสั้นๆ โดยไม่มีการหยุดชะงักของบริการ จากนั้นลูกค้าสามารถเลือกตั้งค่าการเรียกเก็บเงินกับ Google โดยตรงโดยใช้บัตรเครดิต หรือจะโอนไปยังตัวแทนจำหน่ายรายอื่นก็ได้