# Payments Reseller Subscription API

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.

- [REST Resource: v1.partners.products](https://developers.google.com/payments/reseller/subscription/reference/rest#v1.partners.products)
- [REST Resource: v1.partners.promotions](https://developers.google.com/payments/reseller/subscription/reference/rest#v1.partners.promotions)
- [REST Resource: v1.partners.purchaseorders](https://developers.google.com/payments/reseller/subscription/reference/rest#v1.partners.purchaseorders)
- [REST Resource: v1.partners.subscriptions](https://developers.google.com/payments/reseller/subscription/reference/rest#v1.partners.subscriptions)
- [REST Resource: v1.partners.subscriptions.lineItems](https://developers.google.com/payments/reseller/subscription/reference/rest#v1.partners.subscriptions.lineItems)
- [REST Resource: v1.partners.userSessions](https://developers.google.com/payments/reseller/subscription/reference/rest#v1.partners.userSessions)

## Service: paymentsresellersubscription.googleapis.com

To 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.

### Discovery document

A [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:

- <https://paymentsresellersubscription.googleapis.com/$discovery/rest?version=v1>

### Service endpoint

A [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:

- `https://paymentsresellersubscription.googleapis.com`

## REST Resource: [v1.partners.products](https://developers.google.com/payments/reseller/subscription/reference/rest/v1/partners.products)

| Methods ||
|---|---|
| `https://developers.google.com/payments/reseller/subscription/reference/rest/v1/partners.products/list` | `GET /v1/{parent=partners/*}/products` Currently, it doesn't support **YouTube** products. |

## REST Resource: [v1.partners.promotions](https://developers.google.com/payments/reseller/subscription/reference/rest/v1/partners.promotions)

| Methods ||
|---|---|
| `https://developers.google.com/payments/reseller/subscription/reference/rest/v1/partners.promotions/findEligible` | `POST /v1/{parent=partners/*}/promotions:findEligible` Currently, it is only enabled for **YouTube**. |
| `https://developers.google.com/payments/reseller/subscription/reference/rest/v1/partners.promotions/list` | `GET /v1/{parent=partners/*}/promotions` Currently, it doesn't support **YouTube** promotions. |

## REST Resource: [v1.partners.purchaseorders](https://developers.google.com/payments/reseller/subscription/reference/rest/v1/partners.purchaseorders)

| Methods ||
|---|---|
| `https://developers.google.com/payments/reseller/subscription/reference/rest/v1/partners.purchaseorders/authorizeCharge` | `POST /v1/{parent=partners/*}/purchaseorders:authorizeCharge` Currently, it is used by only **YouTube** partners. |

## REST Resource: [v1.partners.subscriptions](https://developers.google.com/payments/reseller/subscription/reference/rest/v1/partners.subscriptions)

| Methods ||
|---|---|
| `https://developers.google.com/payments/reseller/subscription/reference/rest/v1/partners.subscriptions/authorizeAddon` | `POST /v1/{name=partners/*/subscriptions/*}:authorizeAddon` Currently, it is used by only **YouTube** partners. |
| `https://developers.google.com/payments/reseller/subscription/reference/rest/v1/partners.subscriptions/authorizeSignup` | `POST /v1/{parent=partners/*}/subscriptions:authorizeSignup` Currently, this API is not yet enabled. |
| `https://developers.google.com/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. |
| `https://developers.google.com/payments/reseller/subscription/reference/rest/v1/partners.subscriptions/create` | `POST /v1/{parent=partners/*}/subscriptions` Used by partners to create a subscription for their customers. |
| `https://developers.google.com/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. |
| `https://developers.google.com/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. |
| `https://developers.google.com/payments/reseller/subscription/reference/rest/v1/partners.subscriptions/get` | `GET /v1/{name=partners/*/subscriptions/*}` Gets a subscription by id. |
| `https://developers.google.com/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. |
| `https://developers.google.com/payments/reseller/subscription/reference/rest/v1/partners.subscriptions/resume` | `POST /v1/{name=partners/*/subscriptions/*}:resume` Resumes a suspended subscription. |
| `https://developers.google.com/payments/reseller/subscription/reference/rest/v1/partners.subscriptions/suspend` | `POST /v1/{name=partners/*/subscriptions/*}:suspend` Suspends a subscription. |
| `https://developers.google.com/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. |

## REST Resource: [v1.partners.subscriptions.lineItems](https://developers.google.com/payments/reseller/subscription/reference/rest/v1/partners.subscriptions.lineItems)

| Methods ||
|---|---|
| `https://developers.google.com/payments/reseller/subscription/reference/rest/v1/partners.subscriptions.lineItems/patch` | `PATCH /v1/{lineItem.name=partners/*/subscriptions/*/lineItems/*}` Updates a line item of a subscription. |

## REST Resource: [v1.partners.userSessions](https://developers.google.com/payments/reseller/subscription/reference/rest/v1/partners.userSessions)

| Methods ||
|---|---|
| `https://developers.google.com/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). |