Interface SubscriptionPurchaseV2Ext

interface SubscriptionPurchaseV2Ext {
    acknowledgementState?: null | AcknowledgementState;
    canceledStateContext?: null | CanceledStateContext;
    externalAccountIdentifiers?: null | ExternalAccountIdentifiers;
    kind: "androidpublisher#subscriptionPurchaseV2";
    latestOrderId?: null | string;
    lineItems?: null | SubscriptionPurchaseLineItem[];
    linkedPurchaseToken?: null | string;
    pausedStateContext?: null | PausedStateContext;
    regionCode?: null | string;
    startTime?: null | string;
    subscribeWithGoogleInfo?: null | SubscribeWithGoogleInfo;
    subscriptionState?: null | SubscriptionState;
    testPurchase?: unknown;
}

Hierarchy

  • SubscriptionPurchaseV2_API
    • SubscriptionPurchaseV2Ext

Properties

acknowledgementState? canceledStateContext? externalAccountIdentifiers? kind latestOrderId? lineItems? linkedPurchaseToken? pausedStateContext? regionCode? startTime? subscribeWithGoogleInfo? subscriptionState? testPurchase?

Properties

Optional acknowledgementState

acknowledgementState?: null | AcknowledgementState

The acknowledgement state of the subscription.

Optional canceledStateContext

canceledStateContext?: null | CanceledStateContext

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

Optional externalAccountIdentifiers

externalAccountIdentifiers?: null | ExternalAccountIdentifiers

User account identifier in the third-party service.

kind

kind: "androidpublisher#subscriptionPurchaseV2"

Optional latestOrderId

latestOrderId?: null | 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.

Optional lineItems

lineItems?: null | SubscriptionPurchaseLineItem[]

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

Optional linkedPurchaseToken

linkedPurchaseToken?: null | 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.

Optional pausedStateContext

pausedStateContext?: null | PausedStateContext

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

Optional regionCode

regionCode?: null | string

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

Optional startTime

startTime?: null | string

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

Optional subscribeWithGoogleInfo

subscribeWithGoogleInfo?: null | SubscribeWithGoogleInfo

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

Optional subscriptionState

subscriptionState?: null | SubscriptionState

The current state of the subscription.

Optional testPurchase

testPurchase?: unknown

Only present if this subscription purchase is a test purchase.

Settings

Member Visibility

Theme

On This Page

acknowledgementStatecanceledStateContextexternalAccountIdentifierskindlatestOrderIdlineItemslinkedPurchaseTokenpausedStateContextregionCodestartTimesubscribeWithGoogleInfosubscriptionStatetestPurchase