Method: subscriptions.delete

Huỷ, tạm ngưng hoặc chuyển một gói thuê bao sang trực tiếp.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
customerId

string

Đây có thể là tên miền chính của khách hàng hoặc giá trị nhận dạng duy nhất của khách hàng. Nếu tên miền của khách hàng thay đổi, bạn không thể sử dụng tên miền cũ để truy cập vào khách hàng đó, nhưng bạn luôn có thể sử dụng giá trị nhận dạng duy nhất của khách hàng (do API trả về). Bạn nên lưu trữ giá trị nhận dạng duy nhất trong hệ thống của mình (nếu có).
subscriptionId

string

Đây là thuộc tính bắt buộc. subscriptionId là giá trị nhận dạng gói thuê bao và là giá trị duy nhất cho mỗi khách hàng. Vì subscriptionId thay đổi khi gói thuê bao được cập nhật, nên bạn không nên sử dụng mã nhận dạng này làm khoá cho dữ liệu ổn định. Bạn có thể tìm thấy subscriptionId bằng cách sử dụng phương thức truy xuất tất cả gói thuê bao của đại lý.

Tham số truy vấn

Thông số
deletionType

enum (DeletionType)

Chuỗi truy vấn deletionType cho phép huỷ, hạ cấp hoặc tạm ngưng gói thuê bao.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Thông báo đại diện cho nội dung HTTP tùy ý. Chỉ nên sử dụng HttpBody cho các định dạng nội dung không thể biểu diễn dưới dạng JSON, chẳng hạn như trang nhị phân thô hoặc trang HTML.

Có thể sử dụng thông báo này trong cả các phương thức API phát trực tuyến và không phải phát trực tuyến trong yêu cầu cũng như phản hồi.

HttpBody có thể dùng làm trường yêu cầu cấp cao nhất. Điều này rất thuận tiện nếu người dùng muốn trích xuất các tham số từ mẫu URL hoặc HTTP vào các trường yêu cầu và cũng muốn truy cập vào phần nội dung HTTP thô.

Ví dụ:

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

}

Ví dụ với các phương thức phát trực tuyến:

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

}

Việc sử dụng loại thông báo này chỉ thay đổi cách xử lý các yêu cầu và nội dung phản hồi, tất cả các tính năng khác sẽ tiếp tục hoạt động theo cách như cũ.

Nếu thành công, phản hồi sẽ là một phản hồi HTTP chung có định dạng do phương thức xác định.

Biểu diễn dưới dạng JSON 
{
  "contentType": string,
  "data": string,
  "extensions": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Trường
contentType

string

Giá trị tiêu đề HTTP Content-Type chỉ định loại nội dung của nội dung.
data

string (bytes format)

Nội dung yêu cầu/phản hồi HTTP dưới dạng tệp nhị phân thô.

Chuỗi được mã hoá base64.
extensions[]

object

Siêu dữ liệu về phản hồi dành riêng cho ứng dụng. Phải được đặt trong phản hồi đầu tiên cho API phát trực tuyến.

Một đối tượng chứa các trường thuộc một loại tuỳ ý. Một trường bổ sung "@type" chứa URI xác định loại. Ví dụ: { "id": 1234, "@type": "types.example.com/standard/id" }.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.

DeletionType

Enum
deletion_type_undefined
cancel Huỷ gói thuê bao ngay lập tức. Điều này không áp dụng cho gói thuê bao G Suite.
transfer_to_direct

Chuyển gói thuê bao trực tiếp sang Google.  Khách hàng được chuyển ngay sang mối quan hệ thanh toán trực tiếp với Google và được cung cấp một khoảng thời gian ngắn mà không bị gián đoạn dịch vụ. Sau đó, khách hàng có thể chọn thiết lập thông tin thanh toán trực tiếp với Google bằng thẻ tín dụng hoặc chuyển sang một đại lý khác.