REST Resource: purchases.subscriptionsv2

{
  "kind": string,
  "regionCode": string,
  "lineItems": [
    {
      object (SubscriptionPurchaseLineItem)
    }
  ],
  "startTime": string,
  "subscriptionState": enum (SubscriptionState),
  "latestOrderId": string,
  "linkedPurchaseToken": string,
  "pausedStateContext": {
    object (PausedStateContext)
  },
  "canceledStateContext": {
    object (CanceledStateContext)
  },
  "testPurchase": {
    object (TestPurchase)
  },
  "acknowledgementState": enum (AcknowledgementState),
  "externalAccountIdentifiers": {
    object (ExternalAccountIdentifiers)
  },
  "subscribeWithGoogleInfo": {
    object (SubscribeWithGoogleInfo)
  }
}

string

這個種類代表 androidpublisher 服務中的 SubscriptionPurchaseV2 物件。

string

使用者取得訂閱項目時的 ISO 3166-1 alpha-2 帳單國家/地區代碼。

object (SubscriptionPurchaseLineItem)

訂閱項目購買交易的商品層級資訊。同一筆購買交易中的商品必須全部使用 AutoRenewingPlan 或預付方案 (PrepaidPlan)。

string (Timestamp format)

訂閱的時間。未設定待處理訂閱項目 (已建立訂閱項目，但在申請過程中等待付款)。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度和最多九個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

enum (SubscriptionState)

訂閱項目的目前狀態，

string

與購買訂閱相關的最新訂單訂單 ID。針對自動續約，這是指註冊訂單的訂單 ID (如果尚未續訂) 或上次週期性訂單 ID (成功、待處理或遭拒的訂單)。如果是預付型訂閱項目，這是與所查詢購買憑證相關聯的訂單 ID。

string

舊訂閱項目的購買憑證：** 從預付轉換為自動續訂。* 從自動續訂型訂閱方案轉換為預付方案。* 為預付訂閱項目儲值。

object (PausedStateContext)

暫停訂閱項目的其他背景資訊。只有在訂閱項目目前具有 subscriptionState SUBSCRIPTION_STATE_PAUSED 時，才會顯示這項資料。

object (CanceledStateContext)

取消訂閱的其他資訊。只有在訂閱項目目前具有 subscriptionState SUBSCRIPTION_STATE_CANCELED 或 SUBSCRIPTION_STATE_EXPIRED 時，才會顯示。

object (TestPurchase)

只有在這筆訂閱交易為測試購買交易時才會顯示。

enum (AcknowledgementState)

訂閱的確認狀態。

object (ExternalAccountIdentifiers)

第三方服務中的使用者帳戶 ID。

object (SubscribeWithGoogleInfo)

與透過「透過 Google 訂閱」交易相關聯的使用者個人資料。

{
  "autoResumeTime": string
}

string (Timestamp format)

自動恢復訂閱的時間。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度和最多九個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

{

  // Union field cancellation_reason can be only one of the following:
  "userInitiatedCancellation": {
    object (UserInitiatedCancellation)
  },
  "systemInitiatedCancellation": {
    object (SystemInitiatedCancellation)
  },
  "developerInitiatedCancellation": {
    object (DeveloperInitiatedCancellation)
  },
  "replacementCancellation": {
    object (ReplacementCancellation)
  }
  // End of list of possible types for union field cancellation_reason.
}

object (UserInitiatedCancellation)

使用者已取消訂閱。

object (SystemInitiatedCancellation)

系統已取消訂閱項目 (例如帳單問題)。

object (DeveloperInitiatedCancellation)

開發人員已取消訂閱。

object (ReplacementCancellation)

訂閱方案已由新的訂閱方案取代。

{
  "cancelSurveyResult": {
    object (CancelSurveyResult)
  },
  "cancelTime": string
}

object (CancelSurveyResult)

使用者在完成訂閱取消流程時提供的資訊 (取消訂閱原因問卷調查)。

string (Timestamp format)

使用者取消訂閱的時間。超過這段時間後，使用者仍可存取該訂閱項目。使用 lineItems.expiry_time 判斷使用者是否仍具有存取權。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度和最多九個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

{
  "reason": enum (CancelSurveyReason),
  "reasonUserInput": string
}

enum (CancelSurveyReason)

使用者在取消訂閱問卷調查中選取的原因。

string

僅為 CANCEL_SURVEY_REASON_OTHERS 設定。這是使用者對問卷調查提供的任意形式回覆。

{
  "externalAccountId": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}

string

第三方服務中的使用者帳戶 ID。只有在帳戶連結是在訂閱購買流程時才會顯示。

string

經過模糊處理的 ID 版本，與應用程式中的使用者帳戶相關聯。在下列購買交易中顯示：* 如果帳戶連結是訂閱購買流程的一部分。* 可在購買時使用 https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid 指定。

string

與應用程式內使用者設定檔相關聯的 ID 經過模糊處理的版本。只有在使用者購買時，使用 https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid 進行指定時才會顯示。

{
  "profileId": string,
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string
}

string

購買訂閱項目時使用者的 Google 個人資料 ID。

string

購買訂閱項目時使用者的個人資料名稱。

string

購買訂閱項目的使用者電子郵件地址。

string

購買訂閱項目時的使用者名稱，

string

購買訂閱項目時使用者的姓氏。

{
  "productId": string,
  "expiryTime": string,

  // Union field plan_type can be only one of the following:
  "autoRenewingPlan": {
    object (AutoRenewingPlan)
  },
  "prepaidPlan": {
    object (PrepaidPlan)
  }
  // End of list of possible types for union field plan_type.
  "offerDetails": {
    object (OfferDetails)
  },

  // Union field deferred_item_change can be only one of the following:
  "deferredItemReplacement": {
    object (DeferredItemReplacement)
  }
  // End of list of possible types for union field deferred_item_change.
}

string

購買的產品 ID (例如「monthly001」)。

string (Timestamp format)

訂閱到期或即將到期的時間，除非存取權延長 (例如續訂)。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度和最多九個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

object (AutoRenewingPlan)

該項目將自動續約。

object (PrepaidPlan)

商品已預付郵資。

object (OfferDetails)

這項商品的優惠詳細資料。

object (DeferredItemReplacement)

延後商品更換資訊。

{
  "autoRenewEnabled": boolean,
  "priceChangeDetails": {
    object (SubscriptionItemPriceChangeDetails)
  },
  "installmentDetails": {
    object (InstallmentPlan)
  }
}

boolean

如果訂閱項目目前設為自動續約，例如使用者未取消訂閱

object (SubscriptionItemPriceChangeDetails)

訂閱註冊後項目最近一次價格異動的資訊。

object (InstallmentPlan)

分期付款方案的承諾使用合約，以及自動續訂方案的各州相關資訊。

{
  "newPrice": {
    object (Money)
  },
  "priceChangeMode": enum (PriceChangeMode),
  "priceChangeState": enum (PriceChangeState),
  "expectedNewPriceChargeTime": string
}

object (Money)

訂閱項目的新週期性價格。

enum (PriceChangeMode)

價格變更模式可指定訂閱項目價格的變化方式。

enum (PriceChangeState)

說明價格異動目前的狀況。

string (Timestamp format)

價格異動生效的續約時間。但因為續約時間改變 (例如暫停)，所以這可能有所變動 (未來的時間)。只有在價格異動尚未生效時，系統才會填入這個欄位。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度和最多九個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

{
  "initialCommittedPaymentsCount": integer,
  "subsequentCommittedPaymentsCount": integer,
  "remainingCommittedPaymentsCount": integer,
  "pendingCancellation": {
    object (PendingCancellation)
  }
}

integer

使用者最初簽訂的付款總額。

integer

使用者在各承諾使用期間內，承諾支付的費用總額。空白表示分期付款方案在初次簽約後會改回一般的自動續約訂閱。

integer

此續約週期內剩餘的承諾付款總數。

object (PendingCancellation)

如果顯示這項分期付款方案，表示待取消。只有在使用者完成所有承諾付款後，系統才會取消該帳戶。

{
  "allowExtendAfterTime": string
}

string (Timestamp format)

如有，則預付方案可在這段時間內儲值。過期的預付方案則不會顯示。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度和最多九個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

{
  "offerTags": [
    string
  ],
  "basePlanId": string,
  "offerId": string
}

string

與優惠相關聯的最新優惠標記。包含從基本方案沿用的標記。

string

基本方案 ID。呈現所有基本方案和優惠。

string

優惠 ID。僅適用於提供折扣優惠。

{
  "productId": string
}

string

用來取代現有產品 ID 的 productId。