Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13145259.5 KB
partners

Updates a line item of a subscription. It should be authenticated with a service account.

patch/v1/{+name}

Path parameters

namestring required

Identifier. Resource name of the line item. Format: partners/{partner}/subscriptions/{subscription}/lineItems/{lineItem}

Query parameters

updateMaskstring

Required. The list of fields to update. Only a limited set of fields can be updated. The allowed fields are the following: - product_payload.googleHomePayload.googleStructureId

Request body

lineItemFreeTrialEndTimestring google-datetime

Output only. The free trial end time will be populated after the line item is successfully processed. End time of the line item free trial period, in ISO 8061 format. For example, "2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free trial promotion is specified.

recurrenceType'LINE_ITEM_RECURRENCE_TYPE_UNSPECIFIED' | 'LINE_ITEM_RECURRENCE_TYPE_PERIODIC' | 'LINE_ITEM_RECURRENCE_TYPE_ONE_TIME'

Output only. The recurrence type of the line item.

productstring

Required. Product resource name that identifies the product associated with this line item. The format is 'partners/{partner_id}/products/{product_id}'.

state'LINE_ITEM_STATE_UNSPECIFIED' | 'LINE_ITEM_STATE_ACTIVE' | 'LINE_ITEM_STATE_INACTIVE' | 'LINE_ITEM_STATE_NEW' | 'LINE_ITEM_STATE_ACTIVATING' | 'LINE_ITEM_STATE_DEACTIVATING' | 'LINE_ITEM_STATE_WAITING_TO_DEACTIVATE' | 'LINE_ITEM_STATE_OFF_CYCLE_CHARGING'

Output only. The state of the line item.

descriptionstring

Output only. Description of this line item.

lineItemIndexinteger

Output only. A unique index of the subscription line item.

namestring

Identifier. Resource name of the line item. Format: partners/{partner}/subscriptions/{subscription}/lineItems/{lineItem}

Response

Successful response