Method: subscriptions.delete

定期購入の解約、一時停止、ダイレクトへの移行を行います。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
customerId

string

顧客のメインのドメイン名または顧客の一意の ID を指定できます。お客様のドメイン名が変更された場合、古いドメイン名を使用してお客様にアクセスすることはできませんが、（API から返された）お客様の一意の識別子は常に使用できます。必要に応じて、一意の識別子をシステムに保存することをおすすめします。
subscriptionId

string

これは必須のプロパティです。subscriptionId は定期購入の識別子で、お客様ごとに一意です。subscriptionId は定期購入の更新時に変更されるため、この ID を永続データのキーとして使用しないことをおすすめします。subscriptionId は、すべての販売店の定期購入を取得するメソッドを使用して確認できます。

クエリ パラメータ

パラメータ
deletionType

enum (DeletionType)

deletionType クエリ文字列を使用すると、定期購入の解約、ダウングレード、一時停止が可能になります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

任意の HTTP 本文を表すメッセージ。RAW バイナリや HTML ページなど、JSON として表現できないペイロード形式にのみ使用する必要があります。

このメッセージは、リクエストとレスポンスのストリーミングと非ストリーミング両方の API メソッドで使用できます。

最上位レベルのリクエスト フィールドとして使用でき、URL または HTTP テンプレートからリクエスト フィールドにパラメータを抽出する場合や、RAW 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 に直接請求を設定するか、別の販売パートナーに移行するかを選択できます。