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)

訂閱項目的商品層級資訊。同一筆交易中的項目，應全部採用自動續約型方案，或全部採用預付方案。

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.
  "signupPromotion": {
    object (SignupPromotion)
  }
}

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)

延後商品換貨的相關資訊。

object (SignupPromotion)

此商品的促銷活動詳細資料。只有在註冊期間套用促銷優惠時才會設定。

{
  "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

productId 會取代現有的 productId。

{

  // Union field promotion_type can be only one of the following:
  "oneTimeCode": {
    object (OneTimeCode)
  },
  "vanityCode": {
    object (VanityCode)
  }
  // End of list of possible types for union field promotion_type.
}

object (OneTimeCode)

已套用一次性代碼。

object (VanityCode)

已套用自訂代碼。

{
  "promotionCode": string
}

string

促銷代碼。