Manage subscription payments

Update the subscription's payment option

This method associates a new billing option with an existing subscription's payment option by including the ID in the {subId} URI path parameter. In the request body, provide the sourceId and set isShippingSameAsBilling to true in the request body.

POSThttps://api.digitalriver.com/v1/subscriptions/{subId}/payment-option

Path parameters

subId*string

The subscription's ID.

Header parameters

Body

application/json

paymentOptionId*string

Payment option id

isShippingSameAsBillingboolean

The shipping address of subscription should be updated same as billing address. The default value is true.

Response

202400401403404

Accepted

Request

JavaScriptCurlPython

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

Response

400403404

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

Update the subscription's payment source

This method links a new payment source as a new billing option. Include the subscription's ID in the {subId} URI path parameter. In the request body, provide the sourceId and set isShippingSameAsBilling to true in the request body.

POSThttps://api.digitalriver.com/v1/subscriptions/{subId}/payment-source

Path parameters

subId*string

The subscription's ID.

Header parameters

Body

application/json

sourceId*string

Payment source id

isShippingSameAsBillingboolean

The shipping address of subscription should be updated same as billing address.The default is true.

Response

202400401403404

Accepted

Request

JavaScriptCurlPython

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

Response

400403404

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