RecurringBillingOnHoldNotification

TThe granted grace period has ended without the payment being received for the subscription. The customer must execute payment in the next few days or face the risk of subscription deactivation.

JSON Reference

This notification uses the Purchase Model.

Examples

{
   "meta":{
      "type":"RecurringBillingOnHoldNotification",
      "date":"2019-03-25T15:15:41.3788284+00:00",
      "schemaUrl":"https://www.cleverbridge.com/JsonNotificationSchemas/RecurringBillingOnHoldNotification"
   },
   "purchaseId":169196449,
   "status":"Return Debit Waiting for Payment",
   "statusId":"WPO",
   "billingContact":{
      "language":"English",
      "languageId":"en",
      "locale":"en-US",
      "company":"Your Company Name",
      "firstname":"John",
      "lastname":"Doe",
      "companyRomanized":"Your Company Name",
      "firstnameRomanized":"John",
      "lastnameRomanized":"Doe",
      "country":"Germany",
      "countryId":"DE",
      "email":"[email protected]"
   },
   "deliveryContact":{
      "language":"English",
      "languageId":"en",
      "locale":"en-US",
      "company":"Your Company Name",
      "firstname":"John",
      "lastname":"Doe",
      "companyRomanized":"Your Company Name",
      "firstnameRomanized":"John",
      "lastnameRomanized":"Doe",
      "country":"Germany",
      "countryId":"DE",
      "email":"[email protected]"
   },
   "licenseeContact":{
      "language":"English",
      "languageId":"en",
      "locale":"en-US",
      "company":"Your Company Name",
      "firstname":"John",
      "lastname":"Doe",
      "companyRomanized":"Your Company Name",
      "firstnameRomanized":"John",
      "lastnameRomanized":"Doe",
      "country":"Germany",
      "countryId":"DE",
      "email":"[email protected]"
   },
   "paymentInfo":{
      "currency":"Euro",
      "currencyId":"EUR",
      "paymentType":"Visa",
      "paymentTypeId":"CCA_VIS",
      "isPurchaseOrder":false,
      "cardLastFourDigits":"142T",
      "cardExpirationDate":{
         "month":3,
         "year":2023
      }
   },
   "creationTime":"2019-03-25T14:30:23.402186",
   "paymentArriveTime":"2019-03-25T14:32:02.215406",
   "lastModificationTime":"2019-03-25T14:32:02.399834",
   "subscriptionRevenueCategoryId":"Signup",
   "remoteAddress":"89.1.3.0",
   "httpUserAgent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.121 Safari/537.36",
   "httpEntryUrl":"https://shop.yourcustomdomain.com/1584/?scope=checkout\u0026cart=219783,219788,%20\u0026x-source=christmas%20newsletter\u0026x-reference=A5434A",
   "httpReferer":"https://shop.yourcustomdomain.com/1584/?scope=checkout\u0026cart=219783,219788,%20\u0026x-source=christmas%20newsletter\u0026x-reference=A5434A",
   "httpAcceptLanguage":"de-DE,de;q=0.9,en-US;q=0.8,en;q=0.7",
   "internalCustomer":"UUID-YOUR-UNIQUE-ID-1234-5678",
   "customerConfirmationPageUrl":"https://shop.yourcustomdomain.com/1584/p/169196449-PmiOQDHBEVpqgwP1234",
   "customerPdfDocumentUrl":"https://shop.yourcustomdomain.com/invoice/4U733AXOIBSRQ2Ip1234/169196449.pdf",
   "merchantOfRecord":"AG",
   "items":[
      {
         "runningNumber":1,
         "productId":219783,
         "productName":"Film Now",
         "productNameExtension":"Film Now for 12 months",
         "yourProductId":"internal_id_219783",
         "yourProductName":"Film Now",
         "internalCategory":"Film",
         "clientId":1584,
         "quantity":1,
         "yourCurrency":"Euro",
         "yourCurrencyId":"EUR",
         "profitCalculation":{
            "grossRevenue":9.99,
            "collectedVat":1.60,
            "netRevenue":8.39,
            "cbMarginPercentage":0.0,
            "cbMarginFix":0.0,
            "yourNetProfit":8.39,
            "yourVat":1.60,
            "yourGrossProfit":9.99
         },
         "yourPrice":{
            "productSinglePrice":{
               "netPrice":8.39,
               "vatPrice":1.60,
               "grossPrice":9.99,
               "vatPercentage":19.0
            },
            "productTotalPrice":{
               "netPrice":8.39,
               "vatPrice":1.60,
               "grossPrice":9.99,
               "vatPercentage":19.0
            },
            "totalSinglePrice":{
               "netPrice":8.39,
               "vatPrice":1.60,
               "grossPrice":9.99,
               "vatPercentage":19.0
            },
            "totalTotalPrice":{
               "netPrice":8.39,
               "vatPrice":1.60,
               "grossPrice":9.99,
               "vatPercentage":19.0
            }
         },
         "customerPrice":{
            "productSinglePrice":{
               "netPrice":8.39,
               "vatPrice":1.60,
               "grossPrice":9.99,
               "vatPercentage":19.0
            },
            "productTotalPrice":{
               "netPrice":8.39,
               "vatPrice":1.60,
               "grossPrice":9.99,
               "vatPercentage":19.0
            },
            "totalSinglePrice":{
               "netPrice":8.39,
               "vatPrice":1.60,
               "grossPrice":9.99,
               "vatPercentage":19.0
            },
            "totalTotalPrice":{
               "netPrice":8.39,
               "vatPrice":1.60,
               "grossPrice":9.99,
               "vatPercentage":19.0
            }
         },
         "deliveries":[
            {
               "key":{
                  "key":"your-key-13455-xxx",
                  "keyRaw":"your-key-13455-xxx",
                  "deliveryType":"cleverbridge delivers key",
                  "deliveryTypeId":"cleverbridgeDeliversKey"
               }
            }
         ],
         "recurringBilling":{
            "subscriptionId":"S29415554",
            "subscriptionItemRunningNo":1,
            "subscriptionEventtypeId":"new",
            "originalPurchaseId":169196449,
            "originalPurchaseItemRunningNumber":1,
            "intervalNumber":0,
            "intervalLengthInDays":0,
            "intervalLengthInMonths":12,
            "gracePeriodDays":15,
            "statusId":"HLD",
            "status":"Hold",
            "itemStatusId":"ACT",
            "itemStatus":"Active",
            "nextBillingDate":"2018-04-04T14:02:02.215406",
            "cancellationUrl":"https://shop.yourcustomdomain.com/1584/crb/169196449-PmiOQDHBZVphgwP1234-1",
            "changePaymentSubscriptionUrl":"https://shop.yourcustomdomain.com/1584/scp/S29415554-S7thjrfLs4xh1234",
            "nextBillingProfit":{
               "grossRevenue":9.99,
               "collectedVat":1.60,
               "netRevenue":8.39,
               "cbMarginPercentage":0.0,
               "cbMarginFix":0.0,
               "yourNetProfit":8.39,
               "yourVat":1.60,
               "yourGrossProfit":9.99
            },
            "renewalType":"Automatic"
         }
      }
   ],
   "extraParameters":{
      "x-reference":"A5434A",
      "x-source":"christmas newsletter"
   }
}
<?xml version="1.0" encoding="utf-8"?>
<cbn:RecurringBillingOnHoldNotification xmlns:cbn="http://xml.cleverbridge.com/3.13.0.9/cleverbridgeNotification.xsd">
  <cbn:NotificationDate>2019-03-25T15:15:41.3788284Z</cbn:NotificationDate>
  <cbn:Purchase cbt:Id="169196449" xmlns:cbt="http://xml.cleverbridge.com/3.13.0.9/cleverbridgeTypes.xsd">
    <cbt:Status>Paid</cbt:Status>
    <cbt:StatusId>PAY</cbt:StatusId>
    <cbt:BillingContact>
      <cbt:Language>English</cbt:Language>
      <cbt:LanguageId>en</cbt:LanguageId>
      <cbt:Locale>en-US</cbt:Locale>
      <cbt:Company>Your Company Name</cbt:Company>
      <cbt:Firstname>John</cbt:Firstname>
      <cbt:Lastname>Doe</cbt:Lastname>
      <cbt:CompanyRomanized>Your Company Name</cbt:CompanyRomanized>
      <cbt:FirstnameRomanized>John</cbt:FirstnameRomanized>
      <cbt:LastnameRomanized>Doe</cbt:LastnameRomanized>
      <cbt:Country>Germany</cbt:Country>
      <cbt:CountryId>DE</cbt:CountryId>
      <cbt:Email>[email protected]</cbt:Email>
    </cbt:BillingContact>
    <cbt:DeliveryContact>
      <cbt:Language>English</cbt:Language>
      <cbt:LanguageId>en</cbt:LanguageId>
      <cbt:Locale>en-US</cbt:Locale>
      <cbt:Company>Your Company Name</cbt:Company>
      <cbt:Firstname>John</cbt:Firstname>
      <cbt:Lastname>Doe</cbt:Lastname>
      <cbt:CompanyRomanized>Your Company Name</cbt:CompanyRomanized>
      <cbt:FirstnameRomanized>John</cbt:FirstnameRomanized>
      <cbt:LastnameRomanized>Doe</cbt:LastnameRomanized>
      <cbt:Country>Germany</cbt:Country>
      <cbt:CountryId>DE</cbt:CountryId>
      <cbt:Email>[email protected]</cbt:Email>
    </cbt:DeliveryContact>
    <cbt:LicenseeContact>
      <cbt:Language>English</cbt:Language>
      <cbt:LanguageId>en</cbt:LanguageId>
      <cbt:Locale>en-US</cbt:Locale>
      <cbt:Company>Your Company Name</cbt:Company>
      <cbt:Firstname>John</cbt:Firstname>
      <cbt:Lastname>Doe</cbt:Lastname>
      <cbt:CompanyRomanized>Your Company Name</cbt:CompanyRomanized>
      <cbt:FirstnameRomanized>John</cbt:FirstnameRomanized>
      <cbt:LastnameRomanized>Doe</cbt:LastnameRomanized>
      <cbt:Country>Germany</cbt:Country>
      <cbt:CountryId>DE</cbt:CountryId>
      <cbt:Email>[email protected]</cbt:Email>
    </cbt:LicenseeContact>
    <cbt:PaymentInfo>
      <cbt:Currency>Euro</cbt:Currency>
      <cbt:CurrencyId>EUR</cbt:CurrencyId>
      <cbt:PaymentType>Visa</cbt:PaymentType>
      <cbt:PaymentTypeId>CCA_VIS</cbt:PaymentTypeId>
      <cbt:IsPurchaseOrder>false</cbt:IsPurchaseOrder>
      <cbt:CardLastFourDigits>142T</cbt:CardLastFourDigits>
      <cbt:CardExpirationDate>
        <cbt:Month>3</cbt:Month>
        <cbt:Year>2023</cbt:Year>
      </cbt:CardExpirationDate>
    </cbt:PaymentInfo>
    <cbt:CreationTime>2019-03-25T14:30:23.402186Z</cbt:CreationTime>
    <cbt:PaymentArriveTime>2019-03-25T14:32:02.215406Z</cbt:PaymentArriveTime>
    <cbt:LastModificationTime>2019-03-25T14:32:02.399834Z</cbt:LastModificationTime>
    <cbt:SubscriptionRevenueCategoryId>Signup</cbt:SubscriptionRevenueCategoryId>
    <cbt:RemoteAddress>89.1.3.0</cbt:RemoteAddress>
    <cbt:HttpUserAgent>Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.121 Safari/537.36</cbt:HttpUserAgent>
    <cbt:HttpEntryUrl>https://shop.yourcustomdomain.com/1584/?scope=checkout&amp;cart=219783,219788,%20&amp;x-source=christmas%20newsletter&amp;x-reference=A5434A</cbt:HttpEntryUrl>
    <cbt:HttpReferer>https://shop.yourcustomdomain.com/1584/?scope=checkout&amp;cart=219783,219788,%20&amp;x-source=christmas%20newsletter&amp;x-reference=A5434A</cbt:HttpReferer>
    <cbt:HttpAcceptLanguage>de-DE,de;q=0.9,en-US;q=0.8,en;q=0.7</cbt:HttpAcceptLanguage>
    <cbt:InternalCustomer>UUID-YOUR-UNIQUE-ID-1234-5678</cbt:InternalCustomer>
    <cbt:CustomerConfirmationPageUrl>https://shop.yourcustomdomain.com/1584/p/169196449-PmiOQRHBZVpqgwPS1234</cbt:CustomerConfirmationPageUrl>
    <cbt:CustomerPdfDocumentUrl>https://shop.yourcustomdomain.com/invoice/4U733AXOIBSRQ2IT1234/169196449.pdf</cbt:CustomerPdfDocumentUrl>
    <cbt:MerchantOfRecord>AG</cbt:MerchantOfRecord>
    <cbt:Items>
      <cbt:Item cbt:RunningNo="1">
        <cbt:ProductId>219783</cbt:ProductId>
        <cbt:ProductName>Film Now</cbt:ProductName>
        <cbt:ProductNameExtension>Film Now for 12 months</cbt:ProductNameExtension>
        <cbt:YourProductId>internal_id_219783</cbt:YourProductId>
        <cbt:YourProductName>Film Now</cbt:YourProductName>
        <cbt:InternalCategory>Film</cbt:InternalCategory>
        <cbt:ClientId>1584</cbt:ClientId>
        <cbt:Quantity>1</cbt:Quantity>
        <cbt:YourCurrency>Euro</cbt:YourCurrency>
        <cbt:YourCurrencyId>EUR</cbt:YourCurrencyId>
        <cbt:ProfitCalculation>
          <cbt:GrossRevenue>9.99</cbt:GrossRevenue>
          <cbt:CollectedVat>1.60</cbt:CollectedVat>
          <cbt:NetRevenue>8.39</cbt:NetRevenue>
          <cbt:CbMarginPercentage>0</cbt:CbMarginPercentage>
          <cbt:CbMarginFix>0</cbt:CbMarginFix>
          <cbt:YourNetProfit>8.39</cbt:YourNetProfit>
          <cbt:YourVat>1.60</cbt:YourVat>
          <cbt:YourGrossProfit>9.99</cbt:YourGrossProfit>
        </cbt:ProfitCalculation>
        <cbt:YourPrice>
          <cbt:ProductSinglePrice>
            <cbt:NetPrice>8.39</cbt:NetPrice>
            <cbt:VatPrice>1.60</cbt:VatPrice>
            <cbt:GrossPrice>9.99</cbt:GrossPrice>
            <cbt:VatPercentage>19</cbt:VatPercentage>
          </cbt:ProductSinglePrice>
          <cbt:ProductTotalPrice>
            <cbt:NetPrice>8.39</cbt:NetPrice>
            <cbt:VatPrice>1.60</cbt:VatPrice>
            <cbt:GrossPrice>9.99</cbt:GrossPrice>
            <cbt:VatPercentage>19</cbt:VatPercentage>
          </cbt:ProductTotalPrice>
          <cbt:TotalSinglePrice>
            <cbt:NetPrice>8.39</cbt:NetPrice>
            <cbt:VatPrice>1.60</cbt:VatPrice>
            <cbt:GrossPrice>9.99</cbt:GrossPrice>
            <cbt:VatPercentage>19</cbt:VatPercentage>
          </cbt:TotalSinglePrice>
          <cbt:TotalTotalPrice>
            <cbt:NetPrice>8.39</cbt:NetPrice>
            <cbt:VatPrice>1.60</cbt:VatPrice>
            <cbt:GrossPrice>9.99</cbt:GrossPrice>
            <cbt:VatPercentage>19</cbt:VatPercentage>
          </cbt:TotalTotalPrice>
        </cbt:YourPrice>
        <cbt:CustomerPrice>
          <cbt:ProductSinglePrice>
            <cbt:NetPrice>8.39</cbt:NetPrice>
            <cbt:VatPrice>1.60</cbt:VatPrice>
            <cbt:GrossPrice>9.99</cbt:GrossPrice>
            <cbt:VatPercentage>19</cbt:VatPercentage>
          </cbt:ProductSinglePrice>
          <cbt:ProductTotalPrice>
            <cbt:NetPrice>8.39</cbt:NetPrice>
            <cbt:VatPrice>1.60</cbt:VatPrice>
            <cbt:GrossPrice>9.99</cbt:GrossPrice>
            <cbt:VatPercentage>19</cbt:VatPercentage>
          </cbt:ProductTotalPrice>
          <cbt:TotalSinglePrice>
            <cbt:NetPrice>8.39</cbt:NetPrice>
            <cbt:VatPrice>1.60</cbt:VatPrice>
            <cbt:GrossPrice>9.99</cbt:GrossPrice>
            <cbt:VatPercentage>19</cbt:VatPercentage>
          </cbt:TotalSinglePrice>
          <cbt:TotalTotalPrice>
            <cbt:NetPrice>8.39</cbt:NetPrice>
            <cbt:VatPrice>1.60</cbt:VatPrice>
            <cbt:GrossPrice>9.99</cbt:GrossPrice>
            <cbt:VatPercentage>19</cbt:VatPercentage>
          </cbt:TotalTotalPrice>
        </cbt:CustomerPrice>
        <cbt:Deliveries>
          <cbt:Key>
            <cbt:DeliveryType>cleverbridge delivers key</cbt:DeliveryType>
            <cbt:DeliveryTypeId>cleverbridgeDeliversKey</cbt:DeliveryTypeId>
            <cbt:Key>your-key-13455-xxx</cbt:Key>
            <cbt:KeyRaw>your-key-13455-xxx</cbt:KeyRaw>
          </cbt:Key>
        </cbt:Deliveries>
        <cbt:Additionals />
        <cbt:ExtraParameters />
        <cbt:RecurringBilling cbt:SubscriptionId="S29415554" cbt:SubscriptionItemRunningNo="1">
          <cbt:SubscriptionEventtypeId>new</cbt:SubscriptionEventtypeId>
          <cbt:OriginalPurchaseId>169196449</cbt:OriginalPurchaseId>
          <cbt:OriginalPurchaseItemRunningNo>1</cbt:OriginalPurchaseItemRunningNo>
          <cbt:IntervalNo>0</cbt:IntervalNo>
          <cbt:GracePeriodDays>15</cbt:GracePeriodDays>
          <cbt:StatusId>HLD</cbt:StatusId>
          <cbt:Status>Hold</cbt:Status>
          <cbt:ItemStatusId>ACT</cbt:ItemStatusId>
          <cbt:ItemStatus>Active</cbt:ItemStatus>
          <cbt:NextBillingDate>2018-04-04T14:02:02.215406Z</cbt:NextBillingDate>
          <cbt:CancellationUrl>https://shop.yourcustomdomain.com/1584/crb/169196449-PmiOQDHBZVpjgwPS1234-1</cbt:CancellationUrl>
          <cbt:ChangePaymentSubscriptionUrl>https://shop.yourcustomdomain.com/1584/scp/S29415554-S7tpjrfLs4xl1234</cbt:ChangePaymentSubscriptionUrl>
          <cbt:NextBillingProfit>
            <cbt:GrossRevenue>9.99</cbt:GrossRevenue>
            <cbt:CollectedVat>1.60</cbt:CollectedVat>
            <cbt:NetRevenue>8.39</cbt:NetRevenue>
            <cbt:CbMarginPercentage>0</cbt:CbMarginPercentage>
            <cbt:CbMarginFix>0</cbt:CbMarginFix>
            <cbt:YourNetProfit>8.39</cbt:YourNetProfit>
            <cbt:YourVat>1.60</cbt:YourVat>
            <cbt:YourGrossProfit>9.99</cbt:YourGrossProfit>
          </cbt:NextBillingProfit>
          <cbt:RenewalType>Automatic</cbt:RenewalType>
          <cbt:IntervalLengthInMonths>12</cbt:IntervalLengthInMonths>
        </cbt:RecurringBilling>
      </cbt:Item>
    </cbt:Items>
    <cbt:ExtraParameters>
      <cbt:ExtraParameter>
        <cbt:Key>x-reference</cbt:Key>
        <cbt:Value>A5434A</cbt:Value>
      </cbt:ExtraParameter>
      <cbt:ExtraParameter>
        <cbt:Key>x-source</cbt:Key>
        <cbt:Value>christmas newsletter</cbt:Value>
      </cbt:ExtraParameter>
    </cbt:ExtraParameters>
  </cbn:Purchase>
</cbn:RecurringBillingOnHoldNotification>