Payments Reseller Subscription API
Stay organized with collections
Save and categorize content based on your preferences.
The Payments Reseller Subscription API enables a wholesale business-to-business platform for Google subscription products (such as Stadia, Nest, Google One), where third parties could resell these products to their customers. This API is used to activate and manage the Google subscriptions.
Service: paymentsresellersubscription.googleapis.com
To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.
Discovery document
A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:
Service endpoint
A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:
https://paymentsresellersubscription.googleapis.com
| Methods |
list |
GET /v1/{parent=partners/*}/products
Currently, it doesn't support YouTube products. |
| Methods |
authorizeCharge |
POST /v1/{parent=partners/*}/purchaseorders:authorizeCharge
Currently, it is used by only YouTube partners. |
| Methods |
authorizeAddon |
POST /v1/{name=partners/*/subscriptions/*}:authorizeAddon
Currently, it is used by only YouTube partners. |
authorizeSignup |
POST /v1/{parent=partners/*}/subscriptions:authorizeSignup
Currently, this API is not yet enabled. |
cancel |
POST /v1/{name=partners/*/subscriptions/*}:cancel
Cancels a subscription service either immediately or by the end of the current billing cycle for their customers. |
create |
POST /v1/{parent=partners/*}/subscriptions
Used by partners to create a subscription for their customers. |
entitle |
POST /v1/{name=partners/*/subscriptions/*}:entitle
Entitles a previously provisioned subscription to the current end user. |
extend |
POST /v1/{name=partners/*/subscriptions/*}:extend
[Opt-in only] Most partners should be on auto-extend by default. |
get |
GET /v1/{name=partners/*/subscriptions/*}
Gets a subscription by id. |
provision |
POST /v1/{parent=partners/*}/subscriptions:provision
Used by partners to provision a subscription for their customers. |
resume |
POST /v1/{name=partners/*/subscriptions/*}:resume
Resumes a suspended subscription. |
suspend |
POST /v1/{name=partners/*/subscriptions/*}:suspend
Suspends a subscription. |
undoCancel |
POST /v1/{name=partners/*/subscriptions/*}:undoCancel
Currently, it is used by Google One, Play Pass partners. |
| Methods |
generate |
POST /v1/{parent=partners/*}/userSessions:generate
This API replaces user authorized OAuth consent based APIs (Create, Entitle). |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-27 UTC.
[null,null,["Last updated 2025-03-27 UTC."],[[["\u003cp\u003eThe Payments Reseller Subscription API enables third parties to resell Google subscription products like Stadia, Nest, and Google One to their customers.\u003c/p\u003e\n"],["\u003cp\u003eThe API provides functionalities for activating, managing, and authorizing Google subscriptions, including features such as cancellations, entitlements, and promotions.\u003c/p\u003e\n"],["\u003cp\u003ePartners can utilize the API to provision, create, and manage customer subscriptions, as well as handle add-ons and cancellations.\u003c/p\u003e\n"],["\u003cp\u003eGoogle provides client libraries for easy integration, and the API is accessible via a RESTful interface with a defined service endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThe API offers various resources like products, promotions, purchase orders, subscriptions, and user sessions, each with dedicated methods for specific operations.\u003c/p\u003e\n"]]],["The Payments Reseller Subscription API facilitates the resale of Google subscription products. Partners can use the API to list available products and promotions, create and manage customer subscriptions, including provisioning, entitling, extending, and canceling. Google utilizes the API to authorize charges, add-ons, and signups with the reseller. Partners can also generate user sessions to streamline user authorization and retrieve subscription details. These actions are done via the listed REST resources.\n"],null,["# Payments Reseller Subscription API\n\nThe Payments Reseller Subscription API enables a wholesale business-to-business platform for Google subscription products (such as Stadia, Nest, Google One), where third parties could resell these products to their customers. This API is used to activate and manage the Google subscriptions.\n\n- [REST Resource: v1.partners.products](#v1.partners.products)\n- [REST Resource: v1.partners.promotions](#v1.partners.promotions)\n- [REST Resource: v1.partners.purchaseorders](#v1.partners.purchaseorders)\n- [REST Resource: v1.partners.subscriptions](#v1.partners.subscriptions)\n- [REST Resource: v1.partners.userSessions](#v1.partners.userSessions)\n\nService: paymentsresellersubscription.googleapis.com\n----------------------------------------------------\n\nTo call this service, we recommend that you use the Google-provided [client libraries](https://cloud.google.com/apis/docs/client-libraries-explained). If your application needs to use your own libraries to call this service, use the following information when you make the API requests.\n\n### Discovery document\n\nA [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:\n\n- \u003chttps://paymentsresellersubscription.googleapis.com/$discovery/rest?version=v1\u003e\n\n### Service endpoint\n\nA [service endpoint](https://cloud.google.com/apis/design/glossary#api_service_endpoint) is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:\n\n- `https://paymentsresellersubscription.googleapis.com`\n\nREST Resource: [v1.partners.products](/payments/reseller/subscription/reference/rest/v1/partners.products)\n----------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|----------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|\n| [list](/payments/reseller/subscription/reference/rest/v1/partners.products/list) | `GET /v1/{parent=partners/*}/products` Currently, it doesn't support **YouTube** products. |\n\nREST Resource: [v1.partners.promotions](/payments/reseller/subscription/reference/rest/v1/partners.promotions)\n--------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|\n| [findEligible](/payments/reseller/subscription/reference/rest/v1/partners.promotions/findEligible) | `POST /v1/{parent=partners/*}/promotions:findEligible` Currently, it is only enabeld for **YouTube**. |\n| [list](/payments/reseller/subscription/reference/rest/v1/partners.promotions/list) | `GET /v1/{parent=partners/*}/promotions` Currently, it doesn't support **YouTube** promotions. |\n\nREST Resource: [v1.partners.purchaseorders](/payments/reseller/subscription/reference/rest/v1/partners.purchaseorders)\n----------------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|--------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|\n| [authorizeCharge](/payments/reseller/subscription/reference/rest/v1/partners.purchaseorders/authorizeCharge) | `POST /v1/{parent=partners/*}/purchaseorders:authorizeCharge` Currently, it is used by only **YouTube** partners. |\n\nREST Resource: [v1.partners.subscriptions](/payments/reseller/subscription/reference/rest/v1/partners.subscriptions)\n--------------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|-------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [authorizeAddon](/payments/reseller/subscription/reference/rest/v1/partners.subscriptions/authorizeAddon) | `POST /v1/{name=partners/*/subscriptions/*}:authorizeAddon` Currently, it is used by only **YouTube** partners. |\n| [authorizeSignup](/payments/reseller/subscription/reference/rest/v1/partners.subscriptions/authorizeSignup) | `POST /v1/{parent=partners/*}/subscriptions:authorizeSignup` Currently, this API is not yet enabled. |\n| [cancel](/payments/reseller/subscription/reference/rest/v1/partners.subscriptions/cancel) | `POST /v1/{name=partners/*/subscriptions/*}:cancel` Cancels a subscription service either immediately or by the end of the current billing cycle for their customers. |\n| [create](/payments/reseller/subscription/reference/rest/v1/partners.subscriptions/create) | `POST /v1/{parent=partners/*}/subscriptions` Used by partners to create a subscription for their customers. |\n| [entitle](/payments/reseller/subscription/reference/rest/v1/partners.subscriptions/entitle) | `POST /v1/{name=partners/*/subscriptions/*}:entitle` Entitles a previously provisioned subscription to the current end user. |\n| [extend](/payments/reseller/subscription/reference/rest/v1/partners.subscriptions/extend) | `POST /v1/{name=partners/*/subscriptions/*}:extend` \\[Opt-in only\\] Most partners should be on auto-extend by default. |\n| [get](/payments/reseller/subscription/reference/rest/v1/partners.subscriptions/get) | `GET /v1/{name=partners/*/subscriptions/*}` Gets a subscription by id. |\n| [provision](/payments/reseller/subscription/reference/rest/v1/partners.subscriptions/provision) | `POST /v1/{parent=partners/*}/subscriptions:provision` Used by partners to provision a subscription for their customers. |\n| [resume](/payments/reseller/subscription/reference/rest/v1/partners.subscriptions/resume) | `POST /v1/{name=partners/*/subscriptions/*}:resume` Resumes a suspended subscription. |\n| [suspend](/payments/reseller/subscription/reference/rest/v1/partners.subscriptions/suspend) | `POST /v1/{name=partners/*/subscriptions/*}:suspend` Suspends a subscription. |\n| [undoCancel](/payments/reseller/subscription/reference/rest/v1/partners.subscriptions/undoCancel) | `POST /v1/{name=partners/*/subscriptions/*}:undoCancel` Currently, it is used by **Google One, Play Pass** partners. |\n\nREST Resource: [v1.partners.userSessions](/payments/reseller/subscription/reference/rest/v1/partners.userSessions)\n------------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|----------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|\n| [generate](/payments/reseller/subscription/reference/rest/v1/partners.userSessions/generate) | `POST /v1/{parent=partners/*}/userSessions:generate` This API replaces user authorized OAuth consent based APIs (Create, Entitle). |"]]