Method: partners.subscriptions.authorizeAddon

  • This documentation outlines the process for using the AuthorizeSubscriptionAddon method to check with a reseller whether an add-on to a subscription is authorized.

  • The request is sent as a POST to a specific endpoint, replacing the domain name with the partner's domain.

  • The request body requires a unique requestId, details of the subscription, and details of the new line items being added.

  • The response includes an authorizationResult indicating the reseller's decision on the add-on request.

Currently, it is used by only YouTube partners.

Used by Google to check with reseller whether an add-on to the subscription is authorized.

Note: The domain name should be replaced with the partner domain name with same path as here.

HTTP request

POST https://paymentsresellersubscription.googleapis.com/v1/{name=partners/*/subscriptions/*}:authorizeAddon

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the subscription resource for which addon is being requested. It will have the format of "partners/{partner_id}/subscriptions/{subscriptionId}"

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requestId": string,
  "subscription": {
    object (Subscription)
  },
  "newLineItems": [
    {
      object (LineItem)
    }
  ]
}
Fields
requestId

string

Required. A UUID to uniquely identify the request. The idempotency key for the request. So in case of retries, requestId will be same as previous one.
subscription

object (Subscription)

Required. Details of the subscription for add-on request.
newLineItems[]

object (LineItem)

Required. Details of the new line items that are being added to the subscription.

Response body

The reseller's determination as to whether an add-on to the subscription should be approved.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "authorizationResult": enum (AuthorizationResult)
}
Fields
authorizationResult

enum (AuthorizationResult)

Required. The reseller's authorization result for subscription add-on request.