Method: purchases.subscriptionsv2.revoke

subscriptionsv2.revoke 為使用者撤銷訂閱購買交易。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
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。