Method: partners.subscriptions.authorizeSignup
Stay organized with collections
Save and categorize content based on your preferences.
Currently, this API is not yet enabled.
Used by Google to check with reseller whether the subscription signup 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/{parent=partners/*}/subscriptions:authorizeSignup
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The parent resource name, which is the identifier of the partner. It will have the format of "partners/{partner_id}".
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"requestId": string,
"subscription": {
object (Subscription)
}
} |
| Fields |
requestId |
string
Required. A random 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 signup.
|
Response body
The reseller's determination as to whether the subscription signup should be approved.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"authorizationResult": enum (AuthorizationResult),
"subscriptionId": string
} |
| Fields |
authorizationResult |
enum (AuthorizationResult)
Required. The reseller's authorization result for subscription signup request.
|
subscriptionId |
string
Sets the id only if the authorization is approved. The id assigned by the partner for the authorized subscription. The subscription notification from Cloud pubsub notification message will contain the resource name with this id.
|
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.
[null,null,["Last updated 2025-03-12 UTC."],[[["\u003cp\u003eThis API is used by Google to check with resellers whether a subscription signup is authorized.\u003c/p\u003e\n"],["\u003cp\u003eThe reseller needs to provide an authorization result in the response, approving or denying the signup.\u003c/p\u003e\n"],["\u003cp\u003eA unique request ID is required for idempotency in case of retries.\u003c/p\u003e\n"],["\u003cp\u003eIf authorized, the reseller should provide a subscription ID in the response.\u003c/p\u003e\n"],["\u003cp\u003eThe request includes details of the subscription signup and uses the \u003ccode\u003ePOST\u003c/code\u003e method.\u003c/p\u003e\n"]]],["This content outlines a `POST` request to authorize subscription signups via the URL `https://paymentsresellersubscription.googleapis.com/v1/{parent=partners/*}/subscriptions:authorizeSignup`. The request includes a required `parent` path parameter (partner ID), a request body with `requestId` and `subscription` details, and will be a JSON format. The response body, also JSON, contains the `authorizationResult` (approved or not) and the assigned `subscriptionId` if approved. This action is to check with a reseller if the subscription can be authorized.\n"],null,["# Method: partners.subscriptions.authorizeSignup\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.AuthorizeSubscriptionSignupResponse.SCHEMA_REPRESENTATION)\n\nCurrently, this API is not yet enabled.\n\nUsed by Google to check with reseller whether the subscription signup 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/{parent=partners/*}/subscriptions:authorizeSignup`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The parent resource name, which is the identifier of the partner. It will have the format of \"partners/{partner_id}\". |\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) } } ``` |\n\n| Fields ||\n|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `requestId` | `string` Required. A random 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 signup. |\n\n### Response body\n\nThe reseller's determination as to whether the subscription signup 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), \"subscriptionId\": string } ``` |\n\n| Fields ||\n|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `authorizationResult` | `enum (`[AuthorizationResult](/payments/reseller/subscription/reference/rest/v1/AuthorizationResult)`)` Required. The reseller's authorization result for subscription signup request. |\n| `subscriptionId` | `string` Sets the id only if the authorization is approved. The id assigned by the partner for the authorized subscription. The subscription notification from Cloud pubsub notification message will contain the resource name with this id. |"]]