Method: partners.subscriptions.entitle
Stay organized with collections
Save and categorize content based on your preferences.
Entitles a previously provisioned subscription to the current end user. The end user identity is inferred from the authorized credential of the request. This API must be authorized by the end user using OAuth.
HTTP request
POST https://paymentsresellersubscription.googleapis.com/v1/{name=partners/*/subscriptions/*}:entitle
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The name of the subscription resource that is entitled to the current end user. It will have the format of "partners/{partner_id}/subscriptions/{subscriptionId}"
|
Request body
The request body contains data with the following structure:
| Fields |
lineItemEntitlementDetails[] |
object (LineItemEntitlementDetails)
Optional. The line items to be entitled. If unspecified, all line items will be entitled.
|
Response body
Response that contains the entitled subscription resource.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"subscription": {
object (Subscription)
}
} |
| Fields |
subscription |
object (Subscription)
The subscription that has user linked to it.
|
LineItemEntitlementDetails
The details of the line item to be entitled.
| JSON representation |
{
"lineItemIndex": integer,
"products": [
string
]
} |
| Fields |
lineItemIndex |
integer
Required. The index of the line item to be entitled.
|
products[] |
string
Optional. Only applicable if the line item corresponds to a hard bundle. Product resource names that identify the bundle elements to be entitled in the line item. If unspecified, all bundle elements will be entitled. The format is 'partners/{partner_id}/products/{productId}'.
|
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, authorized by end-users via OAuth, enables partners to entitle a provisioned subscription to the current user.\u003c/p\u003e\n"],["\u003cp\u003eThe request specifies the subscription name and optionally includes line item details for entitlement.\u003c/p\u003e\n"],["\u003cp\u003eA successful response returns the entitled subscription resource with the user linked.\u003c/p\u003e\n"],["\u003cp\u003ePartners can specify individual line items or bundle elements to be entitled within the request.\u003c/p\u003e\n"],["\u003cp\u003eThe API uses gRPC Transcoding and requires the subscription name as a path parameter.\u003c/p\u003e\n"]]],["This API enables partners to entitle a provisioned subscription to an end user, who is identified by the request's authorized credential. The `POST` request is sent to a specific URL with a required `name` path parameter indicating the subscription. The request body includes optional `lineItemEntitlementDetails`, specifying which line items and, for bundles, specific products to entitle. The response body, upon success, returns the entitled `subscription` resource. `lineItemIndex` is used to specify the line item, and `products` to indicate the bundle element to be entitled.\n"],null,["# Method: partners.subscriptions.entitle\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.EntitleSubscriptionResponse.SCHEMA_REPRESENTATION)\n- [LineItemEntitlementDetails](#LineItemEntitlementDetails)\n - [JSON representation](#LineItemEntitlementDetails.SCHEMA_REPRESENTATION)\n\nEntitles a previously provisioned subscription to the current end user. The end user identity is inferred from the authorized credential of the request. This API must be authorized by the end user using OAuth.\n\n### HTTP request\n\n`POST https://paymentsresellersubscription.googleapis.com/v1/{name=partners/*/subscriptions/*}:entitle`\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 that is entitled to the current end user. 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| ``` { \"lineItemEntitlementDetails\": [ { object (/payments/reseller/subscription/reference/rest/v1/partners.subscriptions/entitle#LineItemEntitlementDetails) } ] } ``` |\n\n| Fields ||\n|--------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `lineItemEntitlementDetails[]` | `object (`[LineItemEntitlementDetails](/payments/reseller/subscription/reference/rest/v1/partners.subscriptions/entitle#LineItemEntitlementDetails)`)` Optional. The line items to be entitled. If unspecified, all line items will be entitled. |\n\n### Response body\n\nResponse that contains the entitled subscription resource.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"subscription\": { object (/payments/reseller/subscription/reference/rest/v1/partners.subscriptions#Subscription) } } ``` |\n\n| Fields ||\n|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `subscription` | `object (`[Subscription](/payments/reseller/subscription/reference/rest/v1/partners.subscriptions#Subscription)`)` The subscription that has user linked to it. |\n\nLineItemEntitlementDetails\n--------------------------\n\nThe details of the line item to be entitled.\n\n| JSON representation |\n|--------------------------------------------------------------|\n| ``` { \"lineItemIndex\": integer, \"products\": [ string ] } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `lineItemIndex` | `integer` Required. The index of the line item to be entitled. |\n| `products[]` | `string` Optional. Only applicable if the line item corresponds to a hard bundle. Product resource names that identify the bundle elements to be entitled in the line item. If unspecified, all bundle elements will be entitled. The format is 'partners/{partner_id}/products/{productId}'. |"]]