Event types

Understand the event types supported by Digital River.

In the Commerce API, there are many event types. Most integrations only need to subscribe to a relatively small number of them. You can choose what you want to monitor from the list of the event types described below. Each of these event types provides an example payload.
Every event type uses the following format: resource.event. This makes coding easier since you know all event types use a consistent format. 
In Global Commerce, when you create a webhook or view the details of an existing webhook, you can find the latest list of event types supported in the Commerce API.
The following topics describe the supported subscription event types.
The delayed payment expired and reminder events
When the order has been submitted and is awaiting payment, Digital River creates a delayed_payment.reminder event. 
When Digital River does not receive the delayed payment, Digital River creates a delayed_payment.expired event. When you receive this notification, you can choose to send the notification to the customer.
The following example shows the payloads for various payment methods.
Boleto
Boleto payload example
"boletoBancario": {
        "documentCode",
        "document"
}
Field
Description
documentCode
The Boleto document code URL. This field is required for a successful request.
document
The Boleto numeric identifier. The shopper can use this identifier to pay Boleto through a banking app. 
The delayed payment reminder request
Webhook request
{
  "type": "delayed_payment.reminder",
  "data": {
    "object": {
      "orderId": "1032713644439",
      "placedOnDate": "2021-11-24T16:32:07.000Z",
      "products": [
        {
          "id": "5325101400",
          "externalReferenceId": "5325101400",
          "displayName": "Acme Security software",
          "sku": "PRW-00-001-12"
        }
      ],
      "billToAddress": {
        "firstName": "Jane",
        "lastName": "Doe",
        "line1": "line1",
        "line2": "line2",
        "city": "Sao Paulo",
        "postalCode": "09320-070",
        "state": "SP",
        "country": "BR",
        "countryName": "Brasil",
        "phoneNumber": "5552253720",
        "emailAddress": "[email protected]"
      },
      "shipToAddress": {
        "firstName": "Jane",
        "lastName": "Doe",
        "line1": "line1",
        "line2": "line2",
        "city": "Sao Paulo",
        "postalCode": "09320-070",
        "state": "SP",
        "country": "BR",
        "countryName": "Brasil",
        "phoneNumber": "5552253720",
        "emailAddress": "[email protected]"
      },
      "shopperId": "550619489112"",
      "locale": "pt_BR",
      "siteId": "acmeco",
      "orderTotal": 99,
      "currency": "BRL",
      "orderDiscount": 0,
      "subTotal": 86.97,
      "tax": 12.03,
      "shippingTotal": 0,
      "businessEntity": "Digital River Brazil",
      "paymentSourceType": "boletoBancario",
      "boletoBancario": {
        "documentCode": "23793381286007047838725000526100688270000009900",
        "document": "{documentUrl}"
      }
    }
  },
  "clientIds": {
    "site_id": "acmebr"
  },
  "searchableData": {
    "orderId": "1032713644439"
  }
}
The delayed payment expired request
Webhook request
{
   "type":"delayed_payment.expired",
   "data":{
      "object":{
         "orderId":"1004717881620",
         "placedOnDate":"2022-05-31T09:14:18.000Z",
         "products":[
            {
               "id":"5530211800",
               "externalReferenceId":"900800101",
               "displayName":"PPRO E2E Digital Image",
               "sku":"900800101"
            }
         ],
         "billToAddress":{
            "firstName":"Guilherme",
            "lastName":"Miranda",
            "line1":"1000 Avenida Paulista",
            "city":"Bela Vista",
            "postalCode":"01310-100",
            "state":"SP",
            "country":"BR",
            "countryName":"Brazil",
            "phoneNumber":"5531986463859",
            "emailAddress":"[email protected]"
         },
         "shipToAddress":{
            "firstName":"Guilherme",
            "lastName":"Miranda",
            "line1":"1000 Avenida Paulista",
            "city":"Bela Vista",
            "postalCode":"01310-100",
            "state":"SP",
            "country":"BR",
            "countryName":"Brazil",
            "phoneNumber":"5531986463859",
            "emailAddress":"[email protected]"
         },
         "shopperId":"514650873010",
         "locale":"pt_BR",
         "siteId":"paylive",
         "orderTotal":29.94,
         "currency":"BRL",
         "orderDiscount":0.0,
         "subTotal":26.3,
         "tax":3.64,
         "shippingTotal":0.0,
         "businessEntity":"Digital River Brazil",
         "expirationDate":"2022-06-30T09:05:05.000Z",
         "expirationDays":30,
         "paymentSourceType":"boletoBancario",
         "boletoBancario":{
            "documentCode":"23793381286006844671926000526108487940000002994",
            "document":"https://meiosdepagamentobradesco.com.br/apiboleto/Bradesco?token=QjdnVkh6YUZBODhMcVJZeFUvQ2RMbVVFSHY4azhOa1JiRlRNQW9teUFkSFpaU2hLeDUxU2NqVG5taER6R3BJcQ.."
         }
      }
   },
   "clientIds":{
      "site_id":"paylive"
   },
   "searchableData":{
      "orderId":"1004717881620"
   }
}
Konbini
 Konbini payload example
"konbini": {
  "storeId": "010",
  "receiptNumber": "7231852091080",
  "printableInvoiceUrl": "{invoiceUrl}",
  "storeName": "Seven Eleven",
  "localizedStoreName": "セブン‐イレブン",
  "storeLogoUrl": "{storeLogoUrl}"
}
Field
Description
storeId
The store identifer.
receiptNumber
The Konbini receipt number.
printableInvoiceUrl
The URL contains the store's invoice for the order.
storeName
The store's name.
localizedStoreName
The localized store name.
storeLogoUrl
The URL for the store's logo.
The delayed payment reminder request
Webhook request
{
  "type": "delayed_payment.reminder",
  "data": {
    "object": {
      "orderId": "1087747290080",
      "placedOnDate": "2022-05-31T15:58:16.963Z",
      "products": [
        {
          "id": "308180500",
          "displayName": "BP Digital",
          "sku": "BP123"
        }
      ],
      "billToAddress": {
        "firstName": "Jane",
        "lastName": "Doe",
        "companyName": "DR",
        "line1": "6-chome-22 Kagurazaka",
        "line2": "Shinjuku City",
        "city": "Tokyo-to",
        "postalCode": "162-0825",
        "state": "Tokyo",
        "country": "JP",
        "countryName": "Japan",
        "phoneNumber": "555-234-56789",
        "emailAddress": "[email protected]",
        "countyName": "Eastwood"
      },
      "shipToAddress": {
        "firstName": "Jane",
        "lastName": "Doe",
        "companyName": "DR",
        "line1": "6-chome-22 Kagurazaka",
        "line2": "Shinjuku City",
        "city": "Tokyo-to",
        "postalCode": "162-0825",
        "state": "Tokyo",
        "country": "JP",
        "countryName": "Japan",
        "phoneNumber": "555-234-56789",
        "emailAddress": "[email protected]",
        "countyName": "Eastwood"
      },
      "shopperId": "506960950289",
      "locale": "ja_JP",
      "siteId": "paytest2",
      "orderTotal": 281,
      "currency": "JPY",
      "orderDiscount": 0,
      "subTotal": 256,
      "tax": 25,
      "shippingTotal": 0,
      "businessEntity": "Digital River Ireland Ltd.",
      "expirationDate": "2022-06-30T15:58:01.000Z",
      "paymentSourceType": "konbini",
      "konbini": {
        "storeId": "010",
        "receiptNumber": "7232251882965",
        "printableInvoiceUrl": "{printableInvoiceUrl}",
        "storeName": "Seven Eleven",
        "localizedStoreName": "セブン‐イレブン",
        "storeLogoUrl": "{storeLogoUrl}"
      }
    }
  },
  "clientIds": {
    "site_id": "paytest2"
  },
  "searchableData": {
    "orderId": "1087747290080"
  }
}
The delayed payment expired request
Webhook request
{
  "type": "delayed_payment.expired",
  "data": {
    "object": {
      "orderId": "1087739480080",
      "placedOnDate": "2022-05-31T15:58:21.000Z",
      "products": [
        {
          "id": "82062200",
          "displayName": "Subscription 1 Week Manual Renewal",
          "sku": "123456"
        }
      ],
      "billToAddress": {
        "firstName": "Jane",
        "lastName": "Doe",
        "companyName": "DR",
        "line1": "6-chome-22 Kagurazaka",
        "line2": "Shinjuku City",
        "city": "Tokyo-to",
        "postalCode": "162-0825",
        "state": "Tokyo",
        "country": "JP",
        "countryName": "Japan",
        "phoneNumber": "811-234-56789",
        "emailAddress": "[email protected]",
        "countyName": "Eastwood"
      },
      "shipToAddress": {
        "firstName": "Jane",
        "lastName": "Doe",
        "line1": "10380 Bren Rd",
        "city": "Eden Prairie",
        "postalCode": "55344",
        "state": "MN",
        "country": "US",
        "countryName": "United States",
        "emailAddress": "[email protected]"
      },
      "shopperId": "506943170289",
      "locale": "ja_JP",
      "siteId": "paytest2",
      "orderTotal": 126,
      "currency": "JPY",
      "orderDiscount": 0,
      "subTotal": 126,
      "tax": 0,
      "shippingTotal": 0,
      "businessEntity": "Digital River Inc.",
      "expirationDate": "2022-06-30T15:58:07.000Z",
      "expirationDays": 30,
      "paymentSourceType": "konbini",
      "konbini": {
        "storeId": "010",
        "receiptNumber": "7232254886694",
        "printableInvoiceUrl": "[printableInvoiceUrl",
        "storeName": "Seven Eleven",
        "localizedStoreName": "セブン‐イレブン",
        "storeLogoUrl": "{storeLogoURL}"
      }
    }
  },
  "clientIds": {
    "site_id": "paytest2"
  },
  "searchableData": {
    "orderId": "1087739480080"
  }
}
Wire Transfer
Wire Transfer payload example
"wireTransfer": {
          "accountHolder": "Global Collect BV",
          "bankName": "Rabobank N.A.",
          "city": "Ontario USA",
          "country": "United States",
          "referenceId": "890709732999",
          "accountNumber": "0487369908",
          "additionalBankInformation": "ABA|122238420||Address|WESTLAKE VILLAGE, 2663 TOWNSGATE RD",
          "swiftCode": "RABOUS66XXX"
}
Field
Description
accountHolder
The name of the account holder of the destination bank account (payment service provider).
bankName
The name of the bank that will receive the payment.
city
The city where the bank branch is located.
country
The country where the bank branch is located.
referenceId
The unique reference identifier for the transaction. The shopper should include this reference identifier when wiring funds. 
Note: If the shopper doesn't provide this unique reference identifier, the payment must be manually reconciled.
accountNumber
The bank account number that will receive the payment.
additionalBankInformation
Any additional information that you need to display to the shopper.
swiftCode
The Society for Worldwide International Financial Telecommunications (SWIFT) code is associated with the bank. This field is only populated for EU countries.
The delayed payment reminder request
Webhook request
{
  "type": "delayed_payment.reminder",
  "data": {
    "object": {
      "orderId": "25949555040199",
      "placedOnDate": "2022-06-07T07:10:06.006Z",
      "products": [
        {
          "id": "12345678",
          "displayName": "Digital Product 1",
          "sku": "123123"
        }
      ],
      "billToAddress": {
        "firstName": "Jane",
        "lastName": "Doe",
        "line1": "line1",
        "city": "Belgium",
        "postalCode": "10997",
        "country": "US",
        "countryName": "United States",
        "phoneNumber": "555-456-7890",
        "emailAddress": "[email protected]"
      },
      "shipToAddress": {
        "firstName": "Jane",
        "lastName": "Doe",
        "line1": "line1",
        "city": "Belgium",
        "postalCode": "10997",
        "country": "US",
        "countryName": "United States",
        "phoneNumber": "555-456-7890",
        "emailAddress": "[email protected]"
      },
      "shopperId": "26467404580199",
      "locale": "en_US",
      "siteId": "paytest",
      "orderTotal": 1.62,
      "currency": "USD",
      "orderDiscount": 0,
      "subTotal": 1.5,
      "tax": 0.12,
      "shippingTotal": 0,
      "businessEntity": "DR globalTech Inc.",
      "expirationDate": "2022-07-07T07:10:04.000Z",
      "paymentSourceType": "wireTransfer",
      "wireTransfer": {
        "accountHolder": "Global Collect BV",
        "bankName": "Rabobank N.A.",
        "city": "Ontario USA",
        "country": "United States",
        "referenceId": "890710206969",
        "accountNumber": "0487369908",
        "additionalBankInformation": "ABA|122238420||Address|WESTLAKE VILLAGE, 2663 TOWNSGATE RD",
        "swiftCode": "RABOUS66XXX"
      }
    }
  },
  "clientIds": {
    "site_id": "paytest"
  },
  "searchableData": {
    "orderId": "25949555040199"
  }
}
The delayed payment expired request
Webhook request
{
  "type": "delayed_payment.expired",
  "data": {
    "object": {
      "orderId": "25949554420199",
      "placedOnDate": "2022-06-07T06:57:55.000Z",
      "products": [
        {
          "id": "308180500",
          "displayName": "BP Digital",
          "sku": "BP123"
        }
      ],
      "billToAddress": {
        "firstName": "Jane",
        "lastName": "Doe",
        "line1": "line1",
        "city": "Belgium",
        "postalCode": "10997",
        "country": "US",
        "countryName": "United States",
        "phoneNumber": "555-456-7890",
        "emailAddress": "[email protected]"
      },
      "shipToAddress": {
        "firstName": "Jane",
        "lastName": "Doe",
        "line1": "line1",
        "city": "Belgium",
        "postalCode": "10997",
        "country": "US",
        "countryName": "United States",
        "phoneNumber": "555-456-7890",
        "emailAddress": "[email protected]"
      },
      "shopperId": "26467403060199",
      "locale": "en_US",
      "siteId": "paytest2",
      "orderTotal": 1.08,
      "currency": "USD",
      "orderDiscount": 0,
      "subTotal": 1,
      "tax": 0.08,
      "shippingTotal": 0,
      "businessEntity": "Digital River Inc.",
      "expirationDate": "2022-07-07T06:57:53.000Z",
      "expirationDays": 30,
      "paymentSourceType": "wireTransfer",
      "wireTransfer": {
        "accountHolder": "Global Collect BV",
        "bankName": "Rabobank N.A.",
        "city": "Ontario USA",
        "country": "United States",
        "referenceId": "890710206719",
        "accountNumber": "0487369908",
        "additionalBankInformation": "ABA|122238420||Address|WESTLAKE VILLAGE, 2663 TOWNSGATE RD",
        "swiftCode": "RABOUS66XXX"
      }
    }
  },
  "clientIds": {
    "site_id": "paytest2"
  },
  "searchableData": {
    "orderId": "25949554420199"
  }
}
The subscription action processed event
When a subscription is changed, Digital River creates the subscription.action.processed. This event tells you if the subscription update succeeded or failed and provides the details of the pending actions in the payload. The actionType identifies the action applied to the subscription.
actionType
Description
activate
When you activate a shopper's subscription, the subscription state changes from pendingActivation to Subscribed. It also updates the subscription expiration date and all subscription-related data columns.
cancel
When you cancel a shopper's subscription, the subscription state changes to Cancelled.
email
When you update a shopper's subscription billing or shipping email address, you will get a notification.
Billing email address: subscription.billingOption.billAddress.emailAddress
Shipping email address: subscription.shipToAddress.emailAddress
expiration_date
When you update a shopper's subscription expiration date, the system updates the expiration date and all subscription-related data columns.
payment_option
When you update a shopper's subscription payment option, the system associates a new billing or payment option with the subscription. When updated successfully, Retry On Account Update will trigger a billing attempt if the subscription falls under the renewal window.
payment_source
When you update a shopper's subscription payment source, the system associates the new payment source with the subscription.  If there is a billing option associated with the payment source, the system will create a new billing option for the payment source. The request payload contains the sourceId and isShippingSameAsBilling flag.
perpetual_price
When you modify the subscription's perpetual price for a shopper, the system modifies the price of the subscription for the remaining subscription cycle. The system updates the perpetual price or the hold price.
reduce
When you reduce a shopper's subscription quantity or add-ons, the change is immediate.
reference_id
When you modify the subscription's external reference ID, you will receive a notification.
renewal_price
When you change the shopper's subscription price, the system updates the shopper's subscription renewal price
renewal_product
When you change the shopper's subscription renewal product, the system updates the shopper's subscription renewal product.
renewal_quantity
When you change the shopper's subscription renewal quantity, the system updates the shopper's subscription renewal quantity.
renewal_type
When you change the shopper's subscription renewal type, the system updates the shopper's subscription renewal quantity.
ship_to_address
When you change the shopper's ship to address, the system either adds or updates the shopper's ship-to address.
If the subscription update event fails, Digital River will retry the subscription update event.
Webhook request
{
   "type":"subscription.action.processed",
   "data":{
      "object":{
         "action":{
            "actionType":"ship_to_address",
            "actionStatus":"success"
         },
         "subscription":{
            "id":"13530199",
            "creationDate":"2022-06-01T09:14:48.000Z",
            "activationDate":"2022-06-01T05:00:00.000Z",
            "nextRenewalDate":"2022-07-01T05:00:00.000Z",
            "expirationDate":"2022-07-01T05:00:00.000Z",
            "graceDate":"2022-07-08T05:00:00.000Z",
            "currentQuantity":1,
            "renewalQuantity":1,
            "autoRenewal":true,
            "locale":"en_US",
            "state":"Subscribed",
            "duration":30,
            "frequency":30,
            "siteId":"sub2test",
            "shopper":{
               "id":"26195489030199"
            },
            "renewalPrice":{
               "unitPrice":10.99,
               "locked":false,
               "currency":"USD"
            },
            "term":{
               "termUnit":"MONTHS",
               "termLength":1
            },
            "product":{
               "id":"5363866300",
               "displayName":"Monthly auto renewal Subscription",
               "sku":"SUB_AUTORENEW"
            },
            "shipToAddress":{
               "id":"406032130199",
               "firstName":"Jane",
               "lastName":"Doe",
               "line1":"Abc",
               "city":"Pune",
               "postalCode":"324345",
               "countrySubdivision":"CA",
               "country":"AR",
               "countryName":"Argentina",
               "phoneNumber":"55534567890",
               "emailAddress":"[email protected]"
            },
            "paymentOption":{
               "nickName":"Default",
               "id":"4022980199",
               "isDefault":"true",
               "type":"CreditCardMethod",
               "creditCard":{
                  "expirationMonth":"4",
                  "expirationYear":"2024",
                  "displayableNumber":"************1111",
                  "type":"visa",
                  "displayName":"Visa"
               },
               "address":{
                  "id":"406032100199",
                  "firstName":"Jane",
                  "lastName":"Doe",
                  "line1":"Abc",
                  "city":"Pune",
                  "postalCode":"324345",
                  "countrySubdivision":"CA",
                  "country":"AR",
                  "countryName":"Argentina",
                  "phoneNumber":"02134567890",
                  "emailAddress":"[email protected]"
               }
            },
            "addOns":[
                
            ]
         }
      }
   },
   "clientIds":{
      "site_id":"sub2test"
   },
   "searchableData":{
      "subscriptionId":"13530199"
   }
}
The subscription automatic renewal reminder event
When an existing subscription nears the end of the subscription cycle, Digital River creates an automatic renewal reminder ( subscription.auto_reminder).
The subscription cancelled event
When an existing subscription has been cancelled, Digital River creates a subscription.cancelled event.
Webhook request
{
    "type": "subscription.cancelled",
    "data": {
        "object": {
            "id": "15547380289",
            "creationDate": "2022-03-29T06:55:05.000Z",
            "activationDate": "2022-03-29T05:00:00.000Z",
            "nextRenewalDate": "2022-04-29T05:00:00.000Z",
            "expirationDate": "2022-04-29T05:00:00.000Z",
            "graceDate": "2022-05-06T05:00:00.000Z",
            "cancellationDate": "2022-03-29T05:00:00.000Z",
            "currentQuantity": 1,
            "renewalQuantity": 1,
            "autoRenewal": true,
            "locale": "en_US",
            "state": "Cancelled",
            "duration": 31,
            "frequency": 31,
            "siteId": "sub2test",
            "shopper": {
                "id": "504455390289",
                "externalReferenceId": "ZPQRTQHL16J5"
            },
            "term": {
                "termUnit": "MONTHS",
                "termLength": 1
            },
            "product": {
                "id": "5367865200",
                "displayName": "APM_2_months_auto",
                "sku": "SUBS_COMMITMENT"
            },
            "shipToAddress": {
                "id": "330005680289",
                "firstName": "Jane",
                "lastName": "Doe",
                "companyName": "DR",
                "line1": "10380 Bren Rd W",
                "line2": "Conjunto 304",
                "line3": "Conjunto 304",
                "city": "Minnetonka",
                "postalCode": "55343",
                "countrySubdivision": "MN",
                "country": "US",
                "countryName": "United States",
                "phoneNumber": "555-253-1234",
                "emailAddress": "[email protected]",
                "countyName": "Minnetonka"
            },
            "paymentOption": {
                "nickName": "VisaUNIU910",
                "id": "16070210289",
                "isDefault": "true",
                "type": "CreditCardMethod",
                "creditCard": {
                    "expirationMonth": "3",
                    "expirationYear": "2024",
                    "displayableNumber": "************1111",
                    "type": "visa",
                    "displayName": "Visa"
                },
                "address": {
                    "id": "330108580289",
                    "firstName": "Jane",
                    "lastName": "Doe",
                    "companyName": "DR",
                    "line1": "10380 Bren Rd W",
                    "line2": "Conjunto 304",
                    "line3": "Conjunto 304",
                    "city": "Minnetonka",
                    "postalCode": "55343",
                    "countrySubdivision": "MN",
                    "country": "US",
                    "countryName": "United States",
                    "phoneNumber": "555-253-1234",
                    "emailAddress": "[email protected]",
                    "countyName": "Minnetonka"
                }
            },
            "addOns": []
        }
    },
   "clientIds":{
      "site_id":"sub2test"
   },
   "searchableData":{
      "subscriptionId":"15547380289"
   }
}
The subscription created event
When a customer purchase a new subscription, Digital River creates a subscription.created event.
During the shopping experience, a customer orders a subscription to one of your products. They may order a trial subscription or a purchased subscription.
If you created a webhook using the subscription.created event for your application (endpoint URL), Digital River notifies your application when a successful subscription acquisition event occurs.
Webhook request
{
  "type": "subscription.created",
  "data": {
    "object": {
      "id": "8457000397",
      "creationDate": "2021-07-01T05:04:47.493Z",
      "activationDate": "2021-06-30T18:30:00.000Z",
      "nextRenewalDate": "2022-06-30T18:30:00.000Z",
      "expirationDate": "2022-06-30T18:30:00.000Z",
      "graceDate": "2022-07-30T18:30:00.000Z",
      "currentQuantity": 1,
      "renewalQuantity": 1,
      "autoRenewal": true,
      "locale": "en_US",
      "state": "Subscribed",
      "duration": 365,
      "frequency": 365,
      "siteId": "sub2test",
      "shopper": {
        "id": "35504010397"
      },
      "renewalPrice": {
        "unitPrice": 95,
        "locked": false,
        "currency": "USD"
      },
      "term": {
        "termUnit": "YEARS",
        "termLength": 1
      },
      "product": {
        "id": "9964801100",
        "displayName": "Annual Auto Renewal Subscription",
        "sku": "12"
      },
      "shipToAddress": {
        "id": "76213030397",
        "firstName": "Jane",
        "lastName": "Doe",
        "companyName": "ABC",
        "line1": "Kalyani Nagar",
        "city": "Pune",
        "postalCode": "411014",
        "countrySubdivision": "AA",
        "country": "IN",
        "countryName": "India",
        "phoneNumber": "55503796942",
        "emailAddress": "[email protected]"
      },
      "paymentOption": {
        "nickName": "Default",
        "id": "6631000397",
        "isDefault": "true",
        "type": "CreditCardMethod",
        "creditCard": {
          

actionType	Description
`activate`	When you activate a shopper's subscription, the subscription state changes from `pendingActivation` to `Subscribed`. It also updates the subscription expiration date and all subscription-related data columns.
`cancel`	When you cancel a shopper's subscription, the subscription state changes to `Cancelled`.
email	When you update a shopper's subscription billing or shipping email address, you will get a notification. Billing email address: `subscription.billingOption.billAddress.emailAddress` Shipping email address: `subscription.shipToAddress.emailAddress`
`expiration_date`	When you update a shopper's subscription expiration date, the system updates the expiration date and all subscription-related data columns.
`payment_option`	When you update a shopper's subscription payment option, the system associates a new billing or payment option with the subscription. When updated successfully, Retry On Account Update will trigger a billing attempt if the subscription falls under the renewal window.
`payment_source`	When you update a shopper's subscription payment source, the system associates the new payment source with the subscription. If there is a billing option associated with the payment source, the system will create a new billing option for the payment source. The request payload contains the `sourceId` and `isShippingSameAsBilling` flag.
`perpetual_price`	When you modify the subscription's perpetual price for a shopper, the system modifies the price of the subscription for the remaining subscription cycle. The system updates the perpetual price or the hold price.
`reduce`	When you reduce a shopper's subscription quantity or add-ons, the change is immediate.
`reference_id`	When you modify the subscription's external reference ID, you will receive a notification.
`renewal_price`	When you change the shopper's subscription price, the system updates the shopper's subscription renewal price
`renewal_product`	When you change the shopper's subscription renewal product, the system updates the shopper's subscription renewal product.
`renewal_quantity`	When you change the shopper's subscription renewal quantity, the system updates the shopper's subscription renewal quantity.
`renewal_type`	When you change the shopper's subscription renewal type, the system updates the shopper's subscription renewal quantity.
`ship_to_address`	When you change the shopper's ship to address, the system either adds or updates the shopper's ship-to address.

Field	Description
`documentCode`	The Boleto document code URL. This field is required for a successful request.
`document`	The Boleto numeric identifier. The shopper can use this identifier to pay Boleto through a banking app.

Field	Description
`storeId`	The store identifer.
`receiptNumber`	The Konbini receipt number.
`printableInvoiceUrl`	The URL contains the store's invoice for the order.
`storeName`	The store's name.
`localizedStoreName`	The localized store name.
`storeLogoUrl`	The URL for the store's logo.

Field	Description
`accountHolder`	The name of the account holder of the destination bank account (payment service provider).
`bankName`	The name of the bank that will receive the payment.
`city`	The city where the bank branch is located.
`country`	The country where the bank branch is located.
`referenceId`	The unique reference identifier for the transaction. The shopper should include this reference identifier when wiring funds. Note: If the shopper doesn't provide this unique reference identifier, the payment must be manually reconciled.
`accountNumber`	The bank account number that will receive the payment.
`additionalBankInformation`	Any additional information that you need to display to the shopper.
`swiftCode`	The Society for Worldwide International Financial Telecommunications (SWIFT) code is associated with the bank. This field is only populated for EU countries.