Method: partners.subscriptions.entitle

Used by partners to entitle 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:

JSON representation 
{
  "lineItemEntitlementDetails": [
    {
      object (LineItemEntitlementDetails)
    }
  ]
}
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}'.