Method: partners.subscriptions.extend

[Opt-in only] Most partners should be on auto-extend by default.

Extends a subscription service for their customers on an ongoing basis for the subscription to remain active and renewable. It should be called directly by the partner using service accounts.

HTTP request

POST https://paymentsresellersubscription.googleapis.com/v1/{name=partners/*/subscriptions/*}:extend

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the subscription resource to be extended. 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,
  "extension": {
    object (Extension)
  }
}
Fields
requestId

string

Required. Restricted to 36 ASCII characters. A random UUID is recommended. The idempotency key for the request. The ID generation logic is controlled by the partner. requestId should be the same as on retries of the same request. A different requestId must be used for a extension of a different cycle.
extension

object (Extension)

Required. Specifies details of the extension. Currently, the duration of the extension must be exactly one billing cycle of the original subscription.

Response body

Response that contains the timestamps after the extension.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "cycleEndTime": string,
  "renewalTime": string,
  "freeTrialEndTime": string
}
Fields
cycleEndTime

string (Timestamp format)

The time at which the subscription is expected to be extended, in ISO 8061 format. UTC timezone. Example, "cycleEndTime":"2019-08-31T17:28:54.564Z"

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
renewalTime

string (Timestamp format)

Output only. The time at which the subscription is expected to be renewed by Google - a new charge will be incurred and the service entitlement will be renewed. A non-immediate cancellation will take place at this time too, before which, the service entitlement for the end user will remain valid. UTC timezone in ISO 8061 format. For example: "2019-08-31T17:28:54.564Z"

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
freeTrialEndTime

string (Timestamp format)

End of the free trial period, in ISO 8061 format. UTC timezone. Example, "freeTrialEndTime":"2019-08-31T17:28:54.564Z" This time will be set the same as initial subscription creation time if no free trial period is offered to the partner.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

Extension

Describes the details of an extension request.

JSON representation 
{
  "partnerUserToken": string,
  "duration": {
    object (Duration)
  }
}
Fields
partnerUserToken

string

Required. Identifier of the end-user in partner’s system.
duration

object (Duration)

Required. Specifies the period of access the subscription should grant.