Renew a subscription

Update the subscription's renewal type

This method converts the subscription renewal type by including the subscription ID in the {subId} URI path parameter and the autoRenewal type in the request body. The renewal type change is allowed only for these subscription states: Subscribed, Pending activation, and Trial.

POSThttps://api.digitalriver.com/v1/subscriptions/{subId}/renewal-type

Path parameters

subId*string

The subscription's ID.

Header parameters

Body

application/json

autoRenewal*boolean

Auto renewal type boolean

Response

202400401403404

Accepted

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/subscriptions/{subId}/renewal-type', {
    method: 'POST',
    headers: {
      "token": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "autoRenewal": false
    }),
});
const data = await response.json();

Response

400403404

{
  "errors": {
    "error": [
      {
        "code": "validation-error",
        "subCode": "required-data-missing",
        "description": "Missing required data: companyId"
      }
    ]
  }
}

Update the subscription renewal product

This method changes the subscription renewal product by including the subscription ID in the {subId} URI path parameter and the renewalProductID in the request body.

POSThttps://api.digitalriver.com/v1/subscriptions/{subId}/renewal-product

Path parameters

subId*string

The subscription's ID.

Header parameters

Body

application/json

renewalProductId*string

Renewal product id

Response

202400401403404

Accepted

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/subscriptions/{subId}/renewal-product', {
    method: 'POST',
    headers: {
      "token": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "renewalProductId": "text"
    }),
});
const data = await response.json();

Response

400403404

{
  "errors": {
    "error": [
      {
        "code": "validation-error",
        "subCode": "required-data-missing",
        "description": "Missing required data: companyId"
      }
    ]
  }
}

Change the subscription's renewal quantity

This method modifies the subscription renewal quantity by including the subscription ID in the {subId} URI path parameter and the renewalQuantity in the request body.

POSThttps://api.digitalriver.com/v1/subscriptions/{subId}/renewal-quantity

Path parameters

subId*string

The subscription's ID.

Header parameters

Body

application/json

renewalQuantity*integer (int32)

Renewal quantity

Response

202400401403404

Accepted

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/subscriptions/{subId}/renewal-quantity', {
    method: 'POST',
    headers: {
      "token": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "renewalQuantity": 0
    }),
});
const data = await response.json();

Response

400403404

{
  "errors": {
    "error": [
      {
        "code": "validation-error",
        "subCode": "required-data-missing",
        "description": "Missing required data: companyId"
      }
    ]
  }
}

Change the subscription's renewal price

This method changes the subscription renewal price by including the subscription ID in the {subId} URI path parameter and the renewalUnitPrice in the request body.

POSThttps://api.digitalriver.com/v1/subscriptions/{subId}/renewal-price

Path parameters

subId*string

The subscription's ID.

Header parameters

Body

application/json

renewalUnitPrice*number (double)

Renewal unit price

Response

202400401403404

Accepted

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/subscriptions/{subId}/renewal-price', {
    method: 'POST',
    headers: {
      "token": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "renewalUnitPrice": 0
    }),
});
const data = await response.json();

Response

400403404

{
  "errors": {
    "error": [
      {
        "code": "validation-error",
        "subCode": "required-data-missing",
        "description": "Missing required data: companyId"
      }
    ]
  }
}