AI-generated Key Takeaways
-
This API call is deprecated and
purchases.subscriptionsv2.getshould be used instead. -
The API call checks the validity of a user's subscription purchase and returns its expiry time.
-
The request uses a GET HTTP method and requires
packageName,subscriptionId, andtokenas path parameters. -
The request body is empty, and a successful response body contains an instance of
SubscriptionPurchase. -
The API requires the
https://www.googleapis.com/auth/androidpublisherOAuth scope for authorization.
Deprecated: Use purchases.subscriptionsv2.get instead. Checks whether a user's subscription purchase is valid and returns its expiry time.
HTTP request
GET https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
packageName
|
The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). |
subscriptionId
|
The purchased subscription ID (for example, 'monthly001'). |
token
|
The token provided to the user's device when the subscription was purchased. |
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of SubscriptionPurchase
.
Sample
The following is a sample request:
curl - X GET \ 'h tt ps : //androidpublisher.googleapis.com/androidpublisher/v3/applications/com.example.app/purchases/subscriptions/monthly.premium/tokens/abcdefghijklmnopqrstuvwxyz.0123456789' \ - H 'Accep t : applica t io n /jso n '
The following is a sample response:
{ "kind" : "androidpublisher#subscriptionPurchase" , "startTimeMillis" : "1678886400000" , "expiryTimeMillis" : "1710470400000" , "autoRenewing" : true , "priceCurrencyCode" : "USD" , "priceAmountMicros" : "9990000" , "introductoryPriceInfo" : { "introductoryPriceCurrencyCode" : "USD" , "introductoryPriceAmountMicros" : "4990000" , "introductoryPricePeriod" : "P1M" , "introductoryPriceCycles" : 1 }, "countryCode" : "US" , "developerPayload" : "{\"userId\": \"user12345\", \"source\": \"app-promo\"}" , "paymentState" : 1 , "cancelReason" : 0 , "userCancellationTimeMillis" : "1709251200000" , "cancelSurveyResult" : { "cancelSurveyReason" : 3 , "userInputCancelReason" : null }, "orderId" : "GPA.3344-5566-7788-99001" , "linkedPurchaseToken" : null , "purchaseType" : 0 , "priceChange" : null , "profileName" : "Jane Doe" , "emailAddress" : "jane.doe@example.com" , "givenName" : "Jane" , "familyName" : "Doe" , "profileId" : "109876543210987654321" , "acknowledgementState" : 1 , "externalAccountId" : "user-jane-doe-app-id" , "promotionType" : 1 , "promotionCode" : "WELCOME20" , "obfuscatedExternalAccountId" : "obfUaCcOunTId123" , "obfuscatedExternalProfileId" : "obfPrOfiLeId456" , "autoResumeTimeMillis" : null }
Authorization scopes
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/androidpublisher
