2022-05-11
▼ ▲ androidpublisher.purchases.subscriptionsv2.get
Parameters:
packageName
Required: Yes
Type: string
Location: path
Description: The package of the application for which this subscription was purchased (for example, 'com.some.thing').
token
Type: string
Location: path
Description: Required. The token provided to the user's device when the subscription was purchased.
Required: Yes
HTTP Method: GET
Parameter Order:
Flat Path: androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}
Scopes: https://www.googleapis.com/auth/androidpublisher
Path: androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}
Description: Get metadata about a subscription
▼ ▲ androidpublisher.monetization.subscriptions.get
Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/androidpublisher
Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}
Parameters:
productId
Location: path
Type: string
Description: Required. The unique product ID of the subscription to get.
Required: Yes
packageName
Type: string
Required: Yes
Location: path
Description: Required. The parent app (package name) of the subscription to get.
Parameter Order:
Description: Reads a single subscription.
▼ ▲ androidpublisher.monetization.subscriptions.patch
Parameters:
productId
Type: string
Location: path
Description: Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length.
Required: Yes
packageName
Required: Yes
Description: Immutable. Package name of the parent app.
Location: path
Type: string
updateMask
Format: google-fieldmask
Description: Required. The list of fields to be updated.
Type: string
Location: query
regionsVersion.version
Description: Required. A string representing version of the available regions being used for the specified resource.
Type: string
Location: query
Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}
HTTP Method: PATCH
Scopes: https://www.googleapis.com/auth/androidpublisher
Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}
Parameter Order:
Description: Updates an existing subscription.
▼ ▲ androidpublisher.monetization.subscriptions.create
Path: androidpublisher/v3/applications/{packageName}/subscriptions
Description: Creates a new subscription. Newly added base plans will remain in draft state until activated.
HTTP Method: POST
Parameter Order: packageName
Parameters:
regionsVersion.version
Type: string
Location: query
Description: Required. A string representing version of the available regions being used for the specified resource.
productId
Type: string
Description: Required. The ID to use for the subscription. For the requirements on this format, see the documentation of the product_id field on the Subscription resource.
Location: query
packageName
Required: Yes
Description: Required. The parent app (package name) for which the subscription should be created. Must be equal to the package_name field on the Subscription resource.
Type: string
Location: path
Scopes: https://www.googleapis.com/auth/androidpublisher
Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions
▼ ▲ androidpublisher.monetization.subscriptions.delete
Description: Deletes a subscription. A subscription can only be deleted if it has never had a base plan published.
Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}
Scopes: https://www.googleapis.com/auth/androidpublisher
Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}
Parameters:
productId
Type: string
Description: Required. The unique product ID of the subscription to delete.
Required: Yes
Location: path
packageName
Description: Required. The parent app (package name) of the app of the subscription to delete.
Location: path
Required: Yes
Type: string
Parameter Order:
HTTP Method: DELETE
▼ ▲ androidpublisher.monetization.subscriptions.list
Scopes: https://www.googleapis.com/auth/androidpublisher
Parameter Order: packageName
Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions
Parameters:
pageSize
Location: query
Format: int32
Type: integer
Description: The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken
Location: query
Description: A page token, received from a previous `ListSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscriptions` must match the call that provided the page token.
Type: string
showArchived
Description: Whether archived subscriptions should be included in the response. Defaults to false.
Location: query
Type: boolean
packageName
Location: path
Required: Yes
Description: Required. The parent app (package name) for which the subscriptions should be read.
Type: string
Path: androidpublisher/v3/applications/{packageName}/subscriptions
Description: Lists all subscriptions under a given app.
HTTP Method: GET
▼ ▲ androidpublisher.monetization.subscriptions.archive
Parameter Order:
HTTP Method: POST
Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}:archive
Description: Archives a subscription. Can only be done if at least one base plan was active in the past, and no base plan is available for new or existing subscribers currently. This action is irreversible, and the subscription ID will remain reserved.
Parameters:
packageName
Description: Required. The parent app (package name) of the app of the subscription to delete.
Required: Yes
Type: string
Location: path
productId
Required: Yes
Location: path
Type: string
Description: Required. The unique product ID of the subscription to delete.
Scopes: https://www.googleapis.com/auth/androidpublisher
Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}:archive
▼ ▲ androidpublisher.monetization.subscriptions.basePlans.activate
Scopes: https://www.googleapis.com/auth/androidpublisher
Description: Activates a base plan. Once activated, base plans will be available to new subscribers.
HTTP Method: POST
Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:activate
Parameters:
basePlanId
Type: string
Location: path
Description: Required. The unique base plan ID of the base plan to activate.
Required: Yes
packageName
Location: path
Required: Yes
Description: Required. The parent app (package name) of the base plan to activate.
Type: string
productId
Type: string
Description: Required. The parent subscription (ID) of the base plan to activate.
Required: Yes
Location: path
Parameter Order:
Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:activate
▼ ▲ androidpublisher.monetization.subscriptions.basePlans.deactivate
Description: Deactivates a base plan. Once deactivated, the base plan will become unavailable to new subscribers, but existing subscribers will maintain their subscription
Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:deactivate
HTTP Method: POST
Parameters:
packageName
Required: Yes
Type: string
Location: path
Description: Required. The parent app (package name) of the base plan to deactivate.
productId
Location: path
Type: string
Required: Yes
Description: Required. The parent subscription (ID) of the base plan to deactivate.
basePlanId
Description: Required. The unique base plan ID of the base plan to deactivate.
Type: string
Required: Yes
Location: path
Scopes: https://www.googleapis.com/auth/androidpublisher
Parameter Order:
Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:deactivate
▼ ▲ androidpublisher.monetization.subscriptions.basePlans.delete
Scopes: https://www.googleapis.com/auth/androidpublisher
Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}
HTTP Method: DELETE
Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}
Parameter Order:
Parameters:
basePlanId
Location: path
Description: Required. The unique offer ID of the base plan to delete.
Required: Yes
Type: string
packageName
Location: path
Required: Yes
Type: string
Description: Required. The parent app (package name) of the base plan to delete.
productId
Description: Required. The parent subscription (ID) of the base plan to delete.
Type: string
Location: path
Required: Yes
Description: Deletes a base plan. Can only be done for draft base plans. This action is irreversible.
▼ ▲ androidpublisher.monetization.subscriptions.basePlans.migratePrices
Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:migratePrices
Description: Migrates subscribers who are receiving an historical subscription price to the currently-offered price for the specified region. Requests will cause price change notifications to be sent to users who are currently receiving an historical price older than the supplied timestamp. Subscribers who do not agree to the new price will have their subscription ended at the next renewal.
Parameters:
packageName
Type: string
Required: Yes
Description: Required. Package name of the parent app. Must be equal to the package_name field on the Subscription resource.
Location: path
productId
Type: string
Description: Required. The ID of the subscription to update. Must be equal to the product_id field on the Subscription resource.
Location: path
Required: Yes
basePlanId
Location: path
Type: string
Required: Yes
Description: Required. The unique base plan ID of the base plan to update prices on.
Parameter Order:
HTTP Method: POST
Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:migratePrices
▼ ▲ androidpublisher.monetization.subscriptions.basePlans.offers.get
Description: Reads a single offer
Parameter Order:
Parameters:
offerId
Type: string
Description: Required. The unique offer ID of the offer to get.
Location: path
Required: Yes
packageName
Required: Yes
Description: Required. The parent app (package name) of the offer to get.
Location: path
Type: string
productId
Type: string
Required: Yes
Location: path
Description: Required. The parent subscription (ID) of the offer to get.
basePlanId
Type: string
Description: Required. The parent base plan (ID) of the offer to get.
Required: Yes
Location: path
Scopes: https://www.googleapis.com/auth/androidpublisher
Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}
HTTP Method: GET
Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}
▼ ▲ androidpublisher.monetization.subscriptions.basePlans.offers.activate
Parameters:
packageName
Description: Required. The parent app (package name) of the offer to activate.
Location: path
Type: string
Required: Yes
basePlanId
Type: string
Description: Required. The parent base plan (ID) of the offer to activate.
Required: Yes
Location: path
offerId
Type: string
Required: Yes
Description: Required. The unique offer ID of the offer to activate.
Location: path
productId
Location: path
Description: Required. The parent subscription (ID) of the offer to activate.
Type: string
Required: Yes
HTTP Method: POST
Parameter Order:
Description: Activates a subscription offer. Once activated, subscription offers will be available to new subscribers.
Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}:activate
Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}:activate
▼ ▲ androidpublisher.monetization.subscriptions.basePlans.offers.list
Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers
Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers
Parameter Order:
Description: Lists all offers under a given subscription.
Scopes: https://www.googleapis.com/auth/androidpublisher
HTTP Method: GET
Parameters:
packageName
Type: string
Description: Required. The parent app (package name) for which the subscriptions should be read.
Location: path
Required: Yes
pageSize
Type: integer
Format: int32
Description: The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location: query
productId
Location: path
Required: Yes
Description: Required. The parent subscription (ID) for which the offers should be read.
Type: string
basePlanId
Location: path
Type: string
Required: Yes
Description: Required. The parent base plan (ID) for which the offers should be read. May be specified as '-' to read all offers under a subscription.
pageToken
Description: A page token, received from a previous `ListSubscriptionsOffers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscriptionOffers` must match the call that provided the page token.
Location: query
Type: string
▼ ▲ androidpublisher.monetization.subscriptions.basePlans.offers.deactivate
HTTP Method: POST
Parameters:
productId
Type: string
Description: Required. The parent subscription (ID) of the offer to deactivate.
Location: path
Required: Yes
packageName
Description: Required. The parent app (package name) of the offer to deactivate.
Type: string
Required: Yes
Location: path
offerId
Location: path
Required: Yes
Type: string
Description: Required. The unique offer ID of the offer to deactivate.
basePlanId
Description: Required. The parent base plan (ID) of the offer to deactivate.
Type: string
Required: Yes
Location: path
Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}:deactivate
Description: Deactivates a subscription offer. Once deactivated, existing subscribers will maintain their subscription, but the offer will become unavailable to new subscribers.
Parameter Order:
Scopes: https://www.googleapis.com/auth/androidpublisher
Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}:deactivate
▼ ▲ androidpublisher.monetization.subscriptions.basePlans.offers.patch
HTTP Method: PATCH
Description: Updates an existing subscription offer.
Scopes: https://www.googleapis.com/auth/androidpublisher
Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}
Parameter Order:
Parameters:
packageName
Location: path
Description: Required. Immutable. The package name of the app the parent subscription belongs to.
Required: Yes
Type: string
productId
Required: Yes
Location: path
Type: string
Description: Required. Immutable. The ID of the parent subscription this offer belongs to.
basePlanId
Required: Yes
Location: path
Description: Required. Immutable. The ID of the base plan to which this offer is an extension.
Type: string
updateMask
Location: query
Description: Required. The list of fields to be updated.
Format: google-fieldmask
Type: string
offerId
Description: Required. Immutable. Unique ID of this subscription offer. Must be unique within the base plan.
Required: Yes
Location: path
Type: string
regionsVersion.version
Description: Required. A string representing version of the available regions being used for the specified resource.
Type: string
Location: query
Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}
▼ ▲ androidpublisher.monetization.subscriptions.basePlans.offers.delete
Description: Deletes a subscription offer. Can only be done for draft offers. This action is irreversible.
Parameter Order:
HTTP Method: DELETE
Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}
Scopes: https://www.googleapis.com/auth/androidpublisher
Parameters:
basePlanId
Description: Required. The parent base plan (ID) of the offer to delete.
Location: path
Required: Yes
Type: string
packageName
Location: path
Description: Required. The parent app (package name) of the offer to delete.
Required: Yes
Type: string
offerId
Description: Required. The unique offer ID of the offer to delete.
Location: path
Required: Yes
Type: string
productId
Description: Required. The parent subscription (ID) of the offer to delete.
Type: string
Location: path
Required: Yes
Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}
▼ ▲ androidpublisher.monetization.subscriptions.basePlans.offers.create
Parameters:
regionsVersion.version
Location: query
Type: string
Description: Required. A string representing version of the available regions being used for the specified resource.
packageName
Description: Required. The parent app (package name) for which the offer should be created. Must be equal to the package_name field on the Subscription resource.
Location: path
Type: string
Required: Yes
productId
Location: path
Required: Yes
Type: string
Description: Required. The parent subscription (ID) for which the offer should be created. Must be equal to the product_id field on the SubscriptionOffer resource.
offerId
Description: Required. The ID to use for the offer. For the requirements on this format, see the documentation of the offer_id field on the SubscriptionOffer resource.
Location: query
Type: string
basePlanId
Location: path
Type: string
Required: Yes
Description: Required. The parent base plan (ID) for which the offer should be created. Must be equal to the base_plan_id field on the SubscriptionOffer resource.
HTTP Method: POST
Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers
Description: Creates a new subscription offer. Only auto-renewing base plans can have subscription offers. The offer state will be DRAFT until it is activated.
Scopes: https://www.googleapis.com/auth/androidpublisher
Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers
Parameter Order: