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

This kind represents a SubscriptionPurchaseV2 object in the androidpublisher service.

string

ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted.

object (SubscriptionPurchaseLineItem)

Item-level info for a subscription purchase. The items in the same purchase should be either all with AutoRenewingPlan or all with PrepaidPlan.

string (Timestamp format)

Time at which the subscription was granted. Not set for pending subscriptions (subscription was created but awaiting payment during signup).

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

enum (SubscriptionState)

The current state of the subscription.

string

The order id of the latest order associated with the purchase of the subscription. For autoRenewing subscription, this is the order id of signup order if it is not renewed yet, or the last recurring order id (success, pending, or declined order). For prepaid subscription, this is the order id associated with the queried purchase token.

string

The purchase token of the old subscription if this subscription is one of the following: * Re-signup of a canceled but non-lapsed subscription * Upgrade/downgrade from a previous subscription. * Convert from prepaid to auto renewing subscription. * Convert from an auto renewing subscription to prepaid. * Topup a prepaid subscription.

object (PausedStateContext)

Additional context around paused subscriptions. Only present if the subscription currently has subscriptionState SUBSCRIPTION_STATE_PAUSED.

object (CanceledStateContext)

Additional context around canceled subscriptions. Only present if the subscription currently has subscriptionState SUBSCRIPTION_STATE_CANCELED or SUBSCRIPTION_STATE_EXPIRED.

object (TestPurchase)

Only present if this subscription purchase is a test purchase.

enum (AcknowledgementState)

The acknowledgement state of the subscription.

object (ExternalAccountIdentifiers)

User account identifier in the third-party service.

object (SubscribeWithGoogleInfo)

User profile associated with purchases made with 'Subscribe with Google'.

{
  "autoResumeTime": string
}

string (Timestamp format)

Time at which the subscription will be automatically resumed.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "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)

Subscription was canceled by user.

object (SystemInitiatedCancellation)

Subscription was canceled by the system, for example because of a billing problem.

object (DeveloperInitiatedCancellation)

Subscription was canceled by the developer.

object (ReplacementCancellation)

Subscription was replaced by a new subscription.

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

object (CancelSurveyResult)

Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey).

string (Timestamp format)

The time at which the subscription was canceled by the user. The user might still have access to the subscription after this time. Use lineItems.expiry_time to determine if a user still has access.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

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

enum (CancelSurveyReason)

The reason the user selected in the cancel survey.

string

Only set for CANCEL_SURVEY_REASON_OTHERS. This is the user's freeform response to the survey.

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

string

User account identifier in the third-party service. Only present if account linking happened as part of the subscription purchase flow.

string

An obfuscated version of the id that is uniquely associated with the user's account in your app. Present for the following purchases: * If account linking happened as part of the subscription purchase flow. * It was specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid when the purchase was made.

string

An obfuscated version of the id that is uniquely associated with the user's profile in your app. Only present if specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid when the purchase was made.

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

string

The Google profile id of the user when the subscription was purchased.

string

The profile name of the user when the subscription was purchased.

string

The email address of the user when the subscription was purchased.

string

The given name of the user when the subscription was purchased.

string

The family name of the user when the subscription was purchased.

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

The purchased product ID (for example, 'monthly001').

string (Timestamp format)

Time at which the subscription expired or will expire unless the access is extended (ex. renews).

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

object (AutoRenewingPlan)

The item is auto renewing.

object (PrepaidPlan)

The item is prepaid.

object (OfferDetails)

The offer details for this item.

object (DeferredItemReplacement)

Information for deferred item replacement.

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

boolean

If the subscription is currently set to auto-renew, e.g. the user has not canceled the subscription

object (SubscriptionItemPriceChangeDetails)

The information of the last price change for the item since subscription signup.

object (InstallmentPlan)

The installment plan commitment and state related info for the auto renewing plan.

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

object (Money)

New recurring price for the subscription item.

enum (PriceChangeMode)

Price change mode specifies how the subscription item price is changing.

enum (PriceChangeState)

State the price change is currently in.

string (Timestamp format)

The renewal time at which the price change will become effective for the user. This is subject to change(to a future time) due to cases where the renewal time shifts like pause. This field is only populated if the price change has not taken effect.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

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

integer

Total number of payments the user is initially committed for.

integer

Total number of payments the user will be committed for after each commitment period. Empty means the installment plan will fall back to a normal auto-renew subscription after initial commitment.

integer

Total number of committed payments remaining to be paid for in this renewal cycle.

object (PendingCancellation)

If present, this installment plan is pending to be canceled. The cancellation will happen only after the user finished all committed payments.

{
  "allowExtendAfterTime": string
}

string (Timestamp format)

If present, this is the time after which top up purchases are allowed for the prepaid plan. Will not be present for expired prepaid plans.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

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

string

The latest offer tags associated with the offer. It includes tags inherited from the base plan.

string

The base plan ID. Present for all base plan and offers.

string

The offer ID. Only present for discounted offers.

{
  "productId": string
}

string

The productId going to replace the existing productId.