Appendix C: Google Play Developer API Quick Reference

purchases.subscriptionsv2.get

GET

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

Get the current state of a subscription. This is the source of truth.

purchases.subscriptionsv2.revoke

POST

applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:revoke

Revoke a subscription immediately. User loses access right away.

purchases.subscriptionsv2.defer

POST

applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:defer

Defer the next billing date (min 1 day, max 1 year extension).

purchases.subscriptionsv2.cancel

POST

applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:cancel

Cancel a subscription. User retains access until expiryTime.

purchases.subscriptions.get

GET

applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}

Legacy endpoint. Use subscriptionsv2.get instead.

purchases.subscriptions.acknowledge

POST

applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:acknowledge

Acknowledge a subscription purchase.

kind

string

Always "androidpublisher#subscriptionPurchaseV2"

subscriptionState

string

Current state: ACTIVE, CANCELED, IN_GRACE_PERIOD, ON_HOLD, PAUSED, EXPIRED, PENDING

lineItems[]

array

One entry per base plan/offer in the subscription

lineItems[].productId

string

The subscription product ID

lineItems[].expiryTime

timestamp

When this line item expires

lineItems[].autoRenewingPlan

object

Present for auto renewing plans. Contains autoRenewEnabled.

lineItems[].prepaidPlan

object

Present for prepaid plans. Contains allowExtendAfterTime.

lineItems[].offerDetails

object

Offer applied to this line item. Contains offerTags[], basePlanId.

linkedPurchaseToken

string

If this purchase replaces another, the token of the replaced purchase.

startTime

timestamp

When the subscription was first purchased.

regionCode

string

ISO 3166-1 alpha-2 country code of the user.

canceledStateContext

object

Why the subscription was canceled. Contains userInitiatedCancellation, systemInitiatedCancellation, or developerInitiatedCancellation.

acknowledgementState

string

ACKNOWLEDGEMENT_STATE_PENDING or ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED

externalAccountIdentifiers

object

Contains obfuscatedExternalAccountId and obfuscatedExternalProfileId.

pausedStateContext

object

Present when paused. Contains autoResumeTime.

purchases.products.get

GET

applications/{packageName}/purchases/products/{productId}/tokens/{token}

Get the state of a one time product purchase.

purchases.productsv2.getproductpurchasev2

GET

applications/{packageName}/purchases/productsv2/tokens/{token}

Get one time product purchase using v2 API (no productId required).

purchases.products.acknowledge

POST

applications/{packageName}/purchases/products/{productId}/tokens/{token}:acknowledge

Acknowledge a one time product purchase.

purchases.products.consume

POST

applications/{packageName}/purchases/products/{productId}/tokens/{token}:consume

Consume a one time product (makes it available for repurchase).

kind

string

Always "androidpublisher#productPurchase"

purchaseTimeMillis

long

Time of purchase in milliseconds since epoch.

purchaseState

integer

0 = Purchased, 1 = Canceled, 2 = Pending

consumptionState

integer

0 = Not consumed, 1 = Consumed

orderId

string

The order ID for this transaction.

acknowledgementState

integer

0 = Not acknowledged, 1 = Acknowledged

purchaseToken

string

The purchase token.

productId

string

The product ID.

quantity

integer

Quantity purchased (for multi quantity purchases).

obfuscatedExternalAccountId

string

Obfuscated account ID set during purchase.

obfuscatedExternalProfileId

string

Obfuscated profile ID set during purchase.

regionCode

string

ISO 3166-1 alpha-2 country code.

orders.refund

POST

applications/{packageName}/orders/{orderId}:refund

Issue a full refund. Available within 3 years of purchase.

purchases.voidedpurchases.list

GET

applications/{packageName}/purchases/voidedpurchases

List voided (refunded/revoked) purchases. Supports pagination and filtering by time.

startTime

long

Milliseconds since epoch. Only return purchases voided after this time.

endTime

long

Milliseconds since epoch. Only return purchases voided before this time.

startIndex

integer

Pagination offset.

maxResults

integer

Maximum results per page (default 1000, max 1000).

type

integer

0 = Both, 1 = Subscriptions only, 2 = One time products only

includeQuantityBasedPartialRefund

boolean

Include partial quantity based refunds.

monetization.subscriptions.create

POST

applications/{packageName}/subscriptions

Create a new subscription.

monetization.subscriptions.get

GET

applications/{packageName}/subscriptions/{productId}

Get subscription details.

monetization.subscriptions.list

GET

applications/{packageName}/subscriptions

List all subscriptions.

monetization.subscriptions.patch

PATCH

applications/{packageName}/subscriptions/{productId}

Update subscription fields.

monetization.subscriptions.delete

DELETE

applications/{packageName}/subscriptions/{productId}

Delete a draft subscription.

monetization.subscriptions.batchGet

GET

applications/{packageName}/subscriptions:batchGet

Get multiple subscriptions (up to 100).

monetization.subscriptions.batchUpdate

POST

applications/{packageName}/subscriptions:batchUpdate

Update multiple subscriptions (up to 100).

monetization.subscriptions.basePlans.activate

POST

...basePlans/{basePlanId}:activate

Activate a base plan.

monetization.subscriptions.basePlans.deactivate

POST

...basePlans/{basePlanId}:deactivate

Deactivate a base plan.

monetization.subscriptions.basePlans.delete

DELETE

...basePlans/{basePlanId}

Delete a base plan.

monetization.subscriptions.basePlans.migratePrices

POST

...basePlans/{basePlanId}:migratePrices

End a legacy price cohort by migrating subscribers to the current price.

monetization.subscriptions.basePlans.batchMigratePrices

POST

...basePlans:batchMigratePrices

Batch price migration.

monetization.subscriptions.basePlans.batchUpdateStates

POST

...basePlans:batchUpdateStates

Batch activate/deactivate.

monetization.subscriptions.basePlans.offers.create

POST

...offers

Create an offer.

monetization.subscriptions.basePlans.offers.get

GET

...offers/{offerId}

Get offer details.

monetization.subscriptions.basePlans.offers.list

GET

...offers

List offers for a base plan.

monetization.subscriptions.basePlans.offers.patch

PATCH

...offers/{offerId}

Update an offer.

monetization.subscriptions.basePlans.offers.delete

DELETE

...offers/{offerId}

Delete a draft offer.

monetization.subscriptions.basePlans.offers.activate

POST

...offers/{offerId}:activate

Activate an offer.

monetization.subscriptions.basePlans.offers.deactivate

POST

...offers/{offerId}:deactivate

Deactivate an offer.

monetization.subscriptions.basePlans.offers.batchGet

GET

...offers:batchGet

Get multiple offers.

monetization.subscriptions.basePlans.offers.batchUpdate

POST

...offers:batchUpdate

Update multiple offers.

monetization.subscriptions.basePlans.offers.batchUpdateStates

POST

...offers:batchUpdateStates

Batch activate/deactivate offers.

inappproducts.insert

POST

applications/{packageName}/inappproducts

Create a one time product.

inappproducts.get

GET

applications/{packageName}/inappproducts/{sku}

Get product details.

inappproducts.list

GET

applications/{packageName}/inappproducts

List all one time products.

inappproducts.patch

PATCH

applications/{packageName}/inappproducts/{sku}

Update product fields.

inappproducts.update

PUT

applications/{packageName}/inappproducts/{sku}

Replace product entirely.

inappproducts.delete

DELETE

applications/{packageName}/inappproducts/{sku}

Delete a product.

inappproducts.batchGet

GET

applications/{packageName}/inappproducts:batchGet

Get multiple products (up to 100).

inappproducts.batchUpdate

POST

applications/{packageName}/inappproducts:batchUpdate

Update multiple products (up to 100).

inappproducts.batchDelete

POST

applications/{packageName}/inappproducts:batchDelete

Delete multiple products.

Read

Higher limits

All get, list, batchGet operations

Write

Lower limits

All create, update, patch, delete, batchUpdate operations

Sensitive

Most restricted

refund, revoke, price migration operations