Method: subscriptions.delete

取消、暂停或将订阅转为直接订阅。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
customerId

string

这可以是客户的主域名，也可以是客户的唯一标识符。如果客户的域名发生变化，则无法使用旧域名访问该客户，但可以随时使用客户的唯一标识符（由 API 返回）。我们建议您在系统中存储唯一标识符（如果适用）。
subscriptionId

string

这是必需属性。subscriptionId 是订阅标识符，每个客户都有唯一的标识符。由于订阅更新时 subscriptionId 会发生变化，因此我们建议您不要将此 ID 用作永久性数据的键。您可以使用检索所有转销商订阅方法找到 subscriptionId。

查询参数

参数
deletionType

enum (DeletionType)

deletionType 查询字符串用于取消、降级或暂停订阅。

请求正文

请求正文必须为空。

响应正文

表示任意 HTTP 正文的消息。它应仅用于无法表示为 JSON 的负载格式，例如原始二进制文件或 HTML 网页。

此消息可同时用于请求和响应中的流式传输和非流式传输 API 方法。

它可以用作顶级请求字段，如果想要将网址或 HTTP 模板中的参数提取到请求字段中，并且还希望访问原始 HTTP 正文，这会很方便。

示例：

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 Content-Type 标头值。
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

枚举
deletion_type_undefined
cancel 立即取消订阅。这不适用于 G Suite 订阅。
transfer_to_direct

将订阅直接转移给 Google。 客户会立即转换为与 Google 建立直接结算关系，并且在短时间内不会中断服务。然后，客户可以选择使用信用卡直接与 Google 设置结算信息，也可以转移到其他转销商。