Postponing a Subscription Renewal Date

Function

Postpones the next renewal date of an auto-renewable subscription.

Scenario

When you launch some preferential activities within your app, for example, rewarding users with product use duration, you can call this API to postpone the users' next subscription renewal dates. After the renewal date is successfully postponed:

• The IAP server sends a postponement success notification to your app server.

• The user can continue to use the paid service and content and will not be charged during the extended period.

• The system updates the subscription renewal date, and the next billing cycle will begin on the new, postponed expiration date.

Constraints

Subscription renewal date postponements are subject to the following restrictions:

1. Only subscriptions in active state can be extended. Delaying the renewal date for expired subscriptions is not supported.

2. Renewal date postponement is not supported for subscriptions during the free trial period.

3. Each subscription can be postponed a maximum of two times within a 365-day period.

4. Each API call can postpone the subscription renewal date by 1 to 90 days.

Prototype

• Protocol: HTTPS POST

• Direction: Your server -> IAP server

• API URL: {rootUrl}/subscription/harmony/v1/application/subscription/renewal/modify

  Note: The value of rootUrl varies depending on the site. For details, please refer to Site Information.

• Data format:

  Request: Content-Type: application/json; charset=UTF-8

  Response: Content-Type: application/json; charset=UTF-8

Request Parameters

Request Header

Request Body

Request Example

POST /subscription/harmony/v1/application/subscription/renewal/modify
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ***.***.***
Accept: application/json
{
  "purchaseToken": "***.*.***",
  "purchaseOrderId": "***.*.***",
  "requestId": "******",
  "modifyReason": 0,
  "extendByDays": 10
}

Response Parameters

Response Header

Response Body

Response Example

HTTP/1.2 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 68
{
  "responseCode": "0",
  "newExpirationTime": 1597679570777
}