partners

POST /v1/partners/{partnersId}/subscriptions/{subscriptionsId}: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.

Request

Base URL
https://paymentsresellersubscription.googleapis.com
Auth
OAuth 2 and OAuth 2
Implicithttps://accounts.google.com/o/oauth2/auth
Scopeshttps://www.googleapis.com/auth/sdm.service
Authorization codehttps://accounts.google.com/o/oauth2/auth
Token URLhttps://accounts.google.com/o/oauth2/token
Scopeshttps://www.googleapis.com/auth/sdm.service
TypeScript
https://skmtc.dev/google/apis/paymentsresellersubscription/docs/v1/partners/:partnersId/subscriptions/:subscriptionsId:extend/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

partnersIdstring required

subscriptionsIdstring required

Request body

requestIdstring

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. request_id should be the same as on retries of the same request. A different request_id must be used for a extension of a different cycle.

Response

Successful response

cycleEndTimestring google-datetime

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"

freeTrialEndTimestring google-datetime

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.

renewalTimestring google-datetime

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"

Changes

No recorded changes to this operation across all 4 revisions of this API.