Method: partners.subscriptions.authorizeAddon
Stay organized with collections
Save and categorize content based on your preferences.
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:
| Fields |
authorizationResult |
enum (AuthorizationResult)
Required. The reseller's authorization result for subscription add-on request.
|
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-12 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-12 UTC."],[[["\u003cp\u003eThis documentation outlines the process for using the \u003ccode\u003eAuthorizeSubscriptionAddon\u003c/code\u003e method to check with a reseller whether an add-on to a subscription is authorized.\u003c/p\u003e\n"],["\u003cp\u003eThe request is sent as a \u003ccode\u003ePOST\u003c/code\u003e to a specific endpoint, replacing the domain name with the partner's domain.\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires a unique \u003ccode\u003erequestId\u003c/code\u003e, details of the subscription, and details of the new line items being added.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes an \u003ccode\u003eauthorizationResult\u003c/code\u003e indicating the reseller's decision on the add-on request.\u003c/p\u003e\n"]]],["This describes an HTTP POST request to authorize an add-on for a subscription. The request, using gRPC Transcoding, targets a specific subscription identified by its `name` path parameter. The request body, in JSON format, includes a unique `requestId`, `subscription` details, and `newLineItems` for the add-on. The response, also in JSON, contains an `authorizationResult` field indicating whether the reseller approved the add-on request. The partner domain replaces the placeholder domain in the request URL.\n"],null,["# Method: partners.subscriptions.authorizeAddon\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.AuthorizeSubscriptionAddonResponse.SCHEMA_REPRESENTATION)\n\nCurrently, it is used by only **YouTube** partners.\n\nUsed by Google to check with reseller whether an add-on to the subscription is authorized. \n\nNote: The domain name should be replaced with the partner domain name with same path as here.\n\n### HTTP request\n\n`POST https://paymentsresellersubscription.googleapis.com/v1/{name=partners/*/subscriptions/*}:authorizeAddon`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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}\" |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"requestId\": string, \"subscription\": { object (/payments/reseller/subscription/reference/rest/v1/partners.subscriptions#Subscription) }, \"newLineItems\": [ { object (/payments/reseller/subscription/reference/rest/v1/partners.subscriptions#LineItem) } ] } ``` |\n\n| Fields ||\n|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n| `subscription` | `object (`[Subscription](/payments/reseller/subscription/reference/rest/v1/partners.subscriptions#Subscription)`)` Required. Details of the subscription for add-on request. |\n| `newLineItems[]` | `object (`[LineItem](/payments/reseller/subscription/reference/rest/v1/partners.subscriptions#LineItem)`)` Required. Details of the new line items that are being added to the subscription. |\n\n### Response body\n\nThe reseller's determination as to whether an add-on to the subscription should be approved.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------|\n| ``` { \"authorizationResult\": enum (/payments/reseller/subscription/reference/rest/v1/AuthorizationResult) } ``` |\n\n| Fields ||\n|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `authorizationResult` | `enum (`[AuthorizationResult](/payments/reseller/subscription/reference/rest/v1/AuthorizationResult)`)` Required. The reseller's authorization result for subscription add-on request. |"]]