Manage a third-party subscription engine

Accept subscription information from a third-party subscription engine

This method accepts subscription information (including billing agreements) from a third-party subscription engine such as the Expired Card Optimizer (ECO) billing optimization tool.

POSThttps://api.digitalriver.com/v1/shoppers/me/carts/active (subscriptionInfo)

Body

application/json

Cart with subscriptionInfo block.

cartobject

Response

200400

Successful response.

Body

application/json

lineItemsobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/carts/active (subscriptionInfo)', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "lineItems": {
    "lineItem": [
      {
        "subscriptionInfo": {
          "autoRenewal": true,
          "terms": "subscription term",
          "freeTrial": false,
          "startTime": "2020-08-01T00:00:00.000Z",
          "endTime": "2021-08-01T00:00:00.000Z",
          "billingAgreementId": "6ed70eb4-da79-46f1-9e7d-210c043d3c9e"
        },
        "billingOptimization": {
          "subscriptionId": "555444",
          "segmentId": "12",
          "renewalAttempNumber": 3
        }
      }
    ],
    "customAttributes": {
      "attribute": [
        {
          "name": "hasExternalSubscriptionInfo",
          "type": "Boolean",
          "value": true
        }
      ]
    },
    "chargeType": "customer_initiated"
  }
}