Method: purchases.subscriptionsv2.revoke

subscriptionsv2.revoke でユーザーの定期購入を取り消します。

HTTP リクエスト

POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:revoke

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

パスパラメータ

パラメータ
packageName

string

必須。定期購入したアプリのパッケージ（例: 「com.some.thing」）。
token

string

必須。定期購入の購入時にユーザーのデバイスに提供されたトークン。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "revocationContext": {
    object (RevocationContext)
  }
}
フィールド
revocationContext

object (RevocationContext)

必須。定期購入取り消しに関する追加詳細。

レスポンスの本文

成功すると、レスポンスの本文は空になります。

サンプル

リクエストの例を次に示します。

curl -X POST \
  'https://androidpublisher.googleapis.com/androidpublisher/v3/applications/com.example.myapp/purchases/subscriptionsv2/tokens/sample_purchase_token:revoke' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "revocationContext": {
      "proratedRefund": {}
    }
  }'

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/androidpublisher

RevocationContext

purchases.subscriptionsv2.revoke API の取り消しのコンテキスト。

JSON 表現 
{

  // Union field RefundType can be only one of the following:
  "fullRefund": {
    object (FullRefund)
  },
  "proratedRefund": {
    object (ProratedRefund)
  },
  "itemBasedRefund": {
    object (ItemBasedRefund)
  }
  // End of list of possible types for union field RefundType.
}
フィールド
共用体フィールド RefundType。承認対象の払い戻しのタイプを判定します。払い戻しのタイプは、有効なリクエストの一部として指定する必要があります。RefundType は次のいずれかになります。
fullRefund

object (FullRefund)

省略可。定期購入の各アイテムに対する最新の請求額の全額を払い戻す必要がある場合に使用します。
proratedRefund

object (ProratedRefund)

省略可。ユーザーが定期購入に対して支払った額を、定期購入の残り期間に基づいて按分して払い戻す必要がある場合に使用します。
itemBasedRefund

object (ItemBasedRefund)

省略可。アドオン アイテムを含む定期購入で特定のアイテムを払い戻す必要がある場合に使用します。

FullRefund

この型にはフィールドがありません。

RevocationContext の払い戻しタイプが全額払い戻しかどうかを判断するのに使用します。

ProratedRefund

この型にはフィールドがありません。

RevocationContext の払い戻しタイプが按分による払い戻しかどうかを判断するのに使用します。

ItemBasedRefund

複数のアイテムを含む定期購入で取り消す特定のアイテムを決定するために使用されます。

JSON 表現 
{
  "productId": string
}
フィールド
productId

string

必須。定期購入がアドオン付きの定期購入の場合は、取り消す定期購入アイテムの商品 ID。