/androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}

Get metadata about a subscription

{ "acknowledgementState": "ACKNOWLEDGEMENT_STATE_UNSPECIFIED", "canceledStateContext": { "developerInitiatedCancellation": {}, "replacementCancellation": {}, "systemInitiatedCancellation": {}, "userInitiatedCancellation": { "cancelSurveyResult": { "reason": "CANCEL_SURVEY_REASON_UNSPECIFIED", "reasonUserInput": "string" }, "cancelTime": "string" } }, "externalAccountIdentifiers": { "externalAccountId": "string", "obfuscatedExternalAccountId": "string", "obfuscatedExternalProfileId": "string" }, "kind": "string", "latestOrderId": "string", "lineItems": [ { "autoRenewingPlan": { "autoRenewEnabled": true }, "expiryTime": "string", "prepaidPlan": { "allowExtendAfterTime": "string" }, "productId": "string" } ], "linkedPurchaseToken": "string", "pausedStateContext": { "autoResumeTime": "string" }, "regionCode": "string", "startTime": "string", "subscribeWithGoogleInfo": { "emailAddress": "string", "familyName": "string", "givenName": "string", "profileId": "string", "profileName": "string" }, "subscriptionState": "SUBSCRIPTION_STATE_UNSPECIFIED", "testPurchase": {} }

Responses

🟢200Successful response

application/json

Body

Indicates the status of a user's subscription purchase.

acknowledgementState

enum<string>

optional

The acknowledgement state of the subscription.

Allowed values:

ACKNOWLEDGEMENT_STATE_UNSPECIFIEDACKNOWLEDGEMENT_STATE_PENDINGACKNOWLEDGEMENT_STATE_ACKNOWLEDGED

canceledStateContext

object (CanceledStateContext)

optional

Additional context around canceled subscriptions. Only present if the subscription currently has subscription_state SUBSCRIPTION_STATE_CANCELED.

developerInitiatedCancellation

object (DeveloperInitiatedCancellation)

optional

Subscription was canceled by the developer.

replacementCancellation

object (ReplacementCancellation)

optional

Subscription was replaced by a new subscription.

systemInitiatedCancellation

object (SystemInitiatedCancellation)

optional

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

userInitiatedCancellation

object (UserInitiatedCancellation)

optional

Subscription was canceled by user.

externalAccountIdentifiers

object (ExternalAccountIdentifiers)

optional

User account identifier in the third-party service.

externalAccountId

string

optional

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

obfuscatedExternalAccountId

string

optional

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.

obfuscatedExternalProfileId

string

optional

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.

kind

string

optional

This kind represents a SubscriptionPurchaseV2 object in the androidpublisher service.

latestOrderId

string

optional

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.

lineItems

array[object (SubscriptionPurchaseLineItem) {4}]

optional

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

autoRenewingPlan

object (AutoRenewingPlan)

optional

The item is auto renewing.

expiryTime

string <google-datetime>

optional

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

prepaidPlan

object (PrepaidPlan)

optional

The item is prepaid.

productId

string

optional

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

linkedPurchaseToken

string

optional

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.

pausedStateContext

object (PausedStateContext)

optional

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

autoResumeTime

string <google-datetime>

optional

Time at which the subscription will be automatically resumed.

regionCode

string

optional

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

startTime

string <google-datetime>

optional

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

subscribeWithGoogleInfo

object (SubscribeWithGoogleInfo)

optional

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

emailAddress

string

optional

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

familyName

string

optional

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

givenName

string

optional

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

profileId

string

optional

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

profileName

string

optional

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

subscriptionState

enum<string>

optional

The current state of the subscription.

Allowed values:

SUBSCRIPTION_STATE_UNSPECIFIEDSUBSCRIPTION_STATE_PENDINGSUBSCRIPTION_STATE_ACTIVESUBSCRIPTION_STATE_PAUSEDSUBSCRIPTION_STATE_IN_GRACE_PERIODSUBSCRIPTION_STATE_ON_HOLDSUBSCRIPTION_STATE_CANCELEDSUBSCRIPTION_STATE_EXPIRED

testPurchase

object (TestPurchase)

optional

Only present if this subscription purchase is a test purchase.

/androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}

Request

Responses