Interface SubscriptionPurchaseExt

interface SubscriptionPurchaseExt {
    acknowledgementState?: null | number;
    autoRenewing?: null | boolean;
    autoResumeTimeMillis?: null | string;
    cancelReason?: null | number;
    cancelSurveyResult?: SubscriptionCancelSurveyResult;
    countryCode?: null | string;
    developerPayload?: null | string;
    emailAddress?: null | string;
    expiryTimeMillis?: null | string;
    externalAccountId?: null | string;
    familyName?: null | string;
    givenName?: null | string;
    introductoryPriceInfo?: IntroductoryPriceInfo;
    kind: "androidpublisher#subscriptionPurchase";
    linkedPurchaseToken?: null | string;
    obfuscatedExternalAccountId?: null | string;
    obfuscatedExternalProfileId?: null | string;
    orderId?: null | string;
    paymentState?: null | number;
    priceAmountMicros?: null | string;
    priceChange?: SubscriptionPriceChange;
    priceCurrencyCode?: null | string;
    productId?: string;
    profileId?: null | string;
    profileName?: null | string;
    promotionCode?: null | string;
    promotionType?: null | number;
    purchaseType?: null | number;
    startTimeMillis?: null | string;
    userCancellationTimeMillis?: null | string;
}

Hierarchy

  • SubscriptionPurchase_API
    • SubscriptionPurchaseExt

Properties

acknowledgementState? autoRenewing? autoResumeTimeMillis? cancelReason? cancelSurveyResult? countryCode? developerPayload? emailAddress? expiryTimeMillis? externalAccountId? familyName? givenName? introductoryPriceInfo? kind linkedPurchaseToken? obfuscatedExternalAccountId? obfuscatedExternalProfileId? orderId? paymentState? priceAmountMicros? priceChange? priceCurrencyCode? productId? profileId? profileName? promotionCode? promotionType? purchaseType? startTimeMillis? userCancellationTimeMillis?

Properties

Optional acknowledgementState

acknowledgementState?: null | number

The acknowledgement state of the subscription product. Possible values are: 0. Yet to be acknowledged 1. Acknowledged

Optional autoRenewing

autoRenewing?: null | boolean

Whether the subscription will automatically be renewed when it reaches its current expiry time.

Optional autoResumeTimeMillis

autoResumeTimeMillis?: null | string

Time at which the subscription will be automatically resumed, in milliseconds since the Epoch. Only present if the user has requested to pause the subscription.

Optional cancelReason

cancelReason?: null | number

The reason why a subscription was canceled or is not auto-renewing. Possible values are: 0. User canceled the subscription 1. Subscription was canceled by the system, for example because of a billing problem 2. Subscription was replaced with a new subscription 3. Subscription was canceled by the developer

Optional cancelSurveyResult

cancelSurveyResult?: SubscriptionCancelSurveyResult

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

Optional countryCode

countryCode?: null | string

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

Optional developerPayload

developerPayload?: null | string

A developer-specified string that contains supplemental information about an order.

Optional emailAddress

emailAddress?: null | string

The email address of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.

Optional expiryTimeMillis

expiryTimeMillis?: null | string

Time at which the subscription will expire, in milliseconds since the Epoch.

Optional externalAccountId

externalAccountId?: null | string

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

Optional familyName

familyName?: null | string

The family name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.

Optional givenName

givenName?: null | string

The given name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.

Optional introductoryPriceInfo

introductoryPriceInfo?: IntroductoryPriceInfo

Introductory price information of the subscription. This is only present when the subscription was purchased with an introductory price. This field does not indicate the subscription is currently in introductory price period.

kind

kind: "androidpublisher#subscriptionPurchase"

Optional linkedPurchaseToken

linkedPurchaseToken?: null | string

The purchase token of the originating purchase if this subscription is one of the following: 0. Re-signup of a canceled but non-lapsed subscription 1. Upgrade/downgrade from a previous subscription For example, suppose a user originally signs up and you receive purchase token X, then the user cancels and goes through the resignup flow (before their subscription lapses) and you receive purchase token Y, and finally the user upgrades their subscription and you receive purchase token Z. If you call this API with purchase token Z, this field will be set to Y. If you call this API with purchase token Y, this field will be set to X. If you call this API with purchase token X, this field will not be set.

Optional obfuscatedExternalAccountId

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

Optional obfuscatedExternalProfileId

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

Optional orderId

orderId?: null | string

The order id of the latest recurring order associated with the purchase of the subscription. If the subscription was canceled because payment was declined, this will be the order id from the payment declined order.

Optional paymentState

paymentState?: null | number

The payment state of the subscription. Possible values are: 0. Payment pending 1. Payment received 2. Free trial 3. Pending deferred upgrade/downgrade Not present for canceled, expired subscriptions.

Optional priceAmountMicros

priceAmountMicros?: null | string

Price of the subscription, For tax exclusive countries, the price doesn't include tax. For tax inclusive countries, the price includes tax. Price is expressed in micro-units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is €1.99, price_amount_micros is 1990000.

Optional priceChange

priceChange?: SubscriptionPriceChange

The latest price change information available. This is present only when there is an upcoming price change for the subscription yet to be applied. Once the subscription renews with the new price or the subscription is canceled, no price change information will be returned.

Optional priceCurrencyCode

priceCurrencyCode?: null | string

ISO 4217 currency code for the subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is "GBP".

Optional productId

productId?: string

Optional profileId

profileId?: null | string

The Google profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.

Optional profileName

profileName?: null | string

The profile name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.

Optional promotionCode

promotionCode?: null | string

The promotion code applied on this purchase. This field is only set if a vanity code promotion is applied when the subscription was purchased.

Optional promotionType

promotionType?: null | number

The type of promotion applied on this purchase. This field is only set if a promotion is applied when the subscription was purchased. Possible values are: 0. One time code 1. Vanity code

Optional purchaseType

purchaseType?: null | number

The type of purchase of the subscription. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: 0. Test (i.e. purchased from a license testing account) 1. Promo (i.e. purchased using a promo code)

Optional startTimeMillis

startTimeMillis?: null | string

Time at which the subscription was granted, in milliseconds since the Epoch.

Optional userCancellationTimeMillis

userCancellationTimeMillis?: null | string

The time at which the subscription was canceled by the user, in milliseconds since the epoch. Only present if cancelReason is 0.

Settings

Member Visibility

Theme

On This Page

acknowledgementStateautoRenewingautoResumeTimeMilliscancelReasoncancelSurveyResultcountryCodedeveloperPayloademailAddressexpiryTimeMillisexternalAccountIdfamilyNamegivenNameintroductoryPriceInfokindlinkedPurchaseTokenobfuscatedExternalAccountIdobfuscatedExternalProfileIdorderIdpaymentStatepriceAmountMicrospriceChangepriceCurrencyCodeproductIdprofileIdprofileNamepromotionCodepromotionTypepurchaseTypestartTimeMillisuserCancellationTimeMillis