A customer has successfully executed the payment for the placed order. This notification is sent when the payment is received for online payments and offline payments alike.
If you want to identify in the notification the order status, you need to look for the status and statusId parameters of the purchase. If their values are Paid and PAY, respectively, this means that the order was paid.
NoteWhen you place a test order using a Cleverbridge test credit card, a
PaidOrderNoticationis generated. However, thestatusisTest Orderand thestatusIdisTST.
The content of PaidOrderNotification differs depending on the purchase event. To define what purchase event the notification relates to, you need to look for the information included in the subscriptionEventtypeId parameter under the recurringBilling object and extraParameters available in the original purchase notification.
For possible values of subscriptionEventtypeId, see Subscription Event Type Codes.
Identification of the parameters under items might be helpful in license management.
JSON Reference
This notification uses the Purchase Model.
Examples
{
"meta": {
"type": "PaidOrderNotification",
"date": "2026-08-25T15:24:30.300684",
"schemaUrl": "https://www.cleverbridge.com/JsonNotificationSchemas/PaidOrderNotification"
},
"purchaseId": 987654321,
"configurationClientId": 1234,
"customerId": 123456789,
"status": "Paid",
"statusId": "PAY",
"billingContact": {
"language": "English",
"languageId": "en",
"locale": "en-US",
"company": "Example Company",
"firstname": "Alex",
"lastname": "Smith",
"firstnameRomanized": "Alex",
"lastnameRomanized": "Smith",
"state": "California",
"stateId": "CA",
"stateIsoCode": "US-CA",
"country": "United States",
"countryId": "US",
"email": "[email protected]"
},
"deliveryContact": {
"language": "English",
"languageId": "en",
"locale": "en-US",
"company": "Example Company",
"firstname": "Alex",
"lastname": "Smith",
"firstnameRomanized": "Alex",
"lastnameRomanized": "Smith",
"state": "California",
"stateId": "CA",
"stateIsoCode": "US-CA",
"country": "United States",
"countryId": "US",
"email": "[email protected]"
},
"licenseeContact": {
"language": "English",
"languageId": "en",
"locale": "en-US",
"company": "Example Company",
"firstname": "Alex",
"lastname": "Smith",
"firstnameRomanized": "Alex",
"lastnameRomanized": "Smith",
"state": "California",
"stateId": "CA",
"stateIsoCode": "US-CA",
"country": "United States",
"countryId": "US",
"email": "[email protected]"
},
"paymentInfo": {
"currency": "US Dollar",
"currencyId": "USD",
"paymentType": "Visa",
"paymentTypeId": "CCA_VIS",
"isPurchaseOrder": false,
"paymentAccount": "4242",
"paymentExpirationMonth": 12,
"paymentExpirationYear": 2030
},
"creationTime": "2026-08-25T15:24:30.300684",
"paymentTime": "2026-08-25T15:24:30.300684",
"lastModificationTime": "2026-08-25T15:24:30.300684",
"subscriptionRevenueCategoryId": "Signup",
"remoteAddress": "192.0.2.10",
"httpUserAgent": "Mozilla/5.0",
"httpEntryUrl": "https://shop.example.com/1234/?scope=checkout&cart=123456",
"httpReferer": "https://shop.example.com/1234/?scope=checkout&cart=123456",
"httpAcceptLanguage": "en-US,en;q=0.9",
"internalCustomer": "example-customer-id",
"customerConfirmationPageUrl": "https://shop.example.com/1234/p/987654321-example-token",
"customerConfirmationPdfUrl": "https://shop.example.com/1234/p/987654321-example-token?type=pdf",
"merchantOfRecord": "INC",
"items": [
{
"runningNumber": 1,
"productId": 123456,
"productName": "Example Product",
"productNameExtension": "Example Product for 12 months",
"yourProductId": "example-product",
"yourProductName": "Example Product",
"productReportingGroup": "Subscription Products",
"supportContactId": 1000,
"supportContact": "Support",
"clientId": 1234,
"quantity": 1,
"yourCurrency": "US Dollar",
"yourCurrencyId": "USD",
"profitCalculation": {
"grossRevenue": 108.25,
"collectedVat": 8.25,
"netRevenue": 100,
"cbMarginPercentage": 0,
"cbMarginFix": 0,
"yourNetProfit": 100,
"yourVat": 8.25,
"yourGrossProfit": 108.25
},
"yourPrice": {
"productSinglePrice": {
"netPrice": 100,
"vatPrice": 8.25,
"grossPrice": 108.25,
"vatPercentage": 8.25
},
"productTotalPrice": {
"netPrice": 100,
"vatPrice": 8.25,
"grossPrice": 108.25,
"vatPercentage": 8.25
},
"totalSinglePrice": {
"netPrice": 100,
"vatPrice": 8.25,
"grossPrice": 108.25,
"vatPercentage": 8.25
},
"totalTotalPrice": {
"netPrice": 100,
"vatPrice": 8.25,
"grossPrice": 108.25,
"vatPercentage": 8.25
}
},
"customerPrice": {
"productSinglePrice": {
"netPrice": 100,
"vatPrice": 8.25,
"grossPrice": 108.25,
"vatPercentage": 8.25
},
"productTotalPrice": {
"netPrice": 100,
"vatPrice": 8.25,
"grossPrice": 108.25,
"vatPercentage": 8.25
},
"totalSinglePrice": {
"netPrice": 100,
"vatPrice": 8.25,
"grossPrice": 108.25,
"vatPercentage": 8.25
},
"totalTotalPrice": {
"netPrice": 100,
"vatPrice": 8.25,
"grossPrice": 108.25,
"vatPercentage": 8.25
}
},
"deliveries": [
{
"service": {
"deliveryType": "Client delivers",
"deliveryTypeId": "clientDelivers"
}
}
],
"recurringBilling": {
"subscriptionId": "S12345678",
"subscriptionItemRunningNo": 1,
"subscriptionEventtypeId": "new",
"originalPurchaseId": 987654321,
"originalPurchaseItemRunningNumber": 1,
"intervalNumber": 0,
"subscriptionIntervalNumber": 0,
"intervalLengthInDays": 0,
"intervalLengthInMonths": 12,
"gracePeriodDays": 0,
"statusId": "ACT",
"status": "Active",
"itemStatusId": "ACT",
"itemStatus": "Active",
"nextBillingDate": "2027-08-25T15:24:30.300684",
"cancellationUrl": "https://shop.example.com/1234/s/S12345678?token=example-token",
"changePaymentSubscriptionUrl": "https://shop.example.com/1234/scp/S12345678?token=example-token",
"nextBillingProfit": {
"grossRevenue": 108.25,
"collectedVat": 8.25,
"netRevenue": 100,
"cbMarginPercentage": 0,
"cbMarginFix": 0,
"yourNetProfit": 100,
"yourVat": 8.25,
"yourGrossProfit": 108.25
},
"renewalType": "Automatic",
"subscriptionManagementModel": "2.0",
"billingIntervalNo": 0,
"nextRenewalDate": "2027-08-25T15:24:30.300684"
},
"yourCurrentProductId": "example-product"
}
],
"extraParameters": {
"x-iscompany": "YES"
}
}<?xml version="1.0" encoding="utf-8"?>
<cbn:PaidOrderNotification xmlns:cbn="http://xml.cleverbridge.com/3.13.0.9/cleverbridgeNotification.xsd">
<cbn:NotificationDate>2019-03-19T14:47:34.857671Z</cbn:NotificationDate>
<cbn:Purchase cbt:Id="168377690" 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-19T14:47:34.360177Z</cbt:CreationTime>
<cbt:PaymentArriveTime>2019-03-19T14:47:34.857671Z</cbt:PaymentArriveTime>
<cbt:LastModificationTime>2019-03-19T14:47:35.084112Z</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&cart=219783,219788,%20&x-source=christmas%20newsletter&x-reference=A5434A</cbt:HttpEntryUrl>
<cbt:HttpReferer>https://shop.yourcustomdomain.com/1584/?scope=checkout&cart=219783,219788,%20&x-source=christmas%20newsletter&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://www.cleverbridge.com/8/p/492274264?s=1738151323&e=1740743323&c=B5A5EDB383197E87DBE59BFA4249E82C7C4CA1XX</cbt:CustomerConfirmationPageUrl>
<cbt:CustomerPdfDocumentUrl>hhttps://www.cleverbridge.com/1584/p/491715411?s=1738151555&e=1740743555&c=22CE7204215C9C5DB8412B3D95AF79A5FC5D95XX</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="S29327383" cbt:SubscriptionItemRunningNo="1">
<cbt:SubscriptionEventtypeId>new</cbt:SubscriptionEventtypeId>
<cbt:OriginalPurchaseId>168377690</cbt:OriginalPurchaseId>
<cbt:OriginalPurchaseItemRunningNo>1</cbt:OriginalPurchaseItemRunningNo>
<cbt:IntervalNo>0</cbt:IntervalNo>
<cbt:SubscriptionIntervalNo>0</cbt:SubscriptionIntervalNo>
<cbt:GracePeriodDays>15</cbt:GracePeriodDays>
<cbt:StatusId>ACT</cbt:StatusId>
<cbt:Status>Active</cbt:Status>
<cbt:ItemStatusId>ACT</cbt:ItemStatusId>
<cbt:ItemStatus>Active</cbt:ItemStatus>
<cbt:NextBillingDate>2020-03-19T14:47:34.857671Z</cbt:NextBillingDate>
<cbt:CancellationUrl>https://shop.yourcustomdomain.com/1584/crb/168377690-PshC04s31zTWdDRn1234-1</cbt:CancellationUrl>
<cbt:ChangePaymentSubscriptionUrl>https://shop.yourcustomdomain.com/1584/scp/S29327383-05RlfQwTeCRP1234</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:Item cbt:RunningNo="2">
<cbt:ProductId>219788</cbt:ProductId>
<cbt:ProductName>New Tunes</cbt:ProductName>
<cbt:ProductNameExtension>New Tunes</cbt:ProductNameExtension>
<cbt:YourProductId>internal_id_219788</cbt:YourProductId>
<cbt:YourProductName>New Tunes</cbt:YourProductName>
<cbt:ClientId>1584</cbt:ClientId>
<cbt:Quantity>1</cbt:Quantity>
<cbt:YourCurrency>Euro</cbt:YourCurrency>
<cbt:YourCurrencyId>EUR</cbt:YourCurrencyId>
<cbt:ProfitCalculation>
<cbt:GrossRevenue>5.99</cbt:GrossRevenue>
<cbt:CollectedVat>0.96</cbt:CollectedVat>
<cbt:NetRevenue>5.03</cbt:NetRevenue>
<cbt:CbMarginPercentage>0</cbt:CbMarginPercentage>
<cbt:CbMarginFix>0</cbt:CbMarginFix>
<cbt:YourNetProfit>5.03</cbt:YourNetProfit>
<cbt:YourVat>0.96</cbt:YourVat>
<cbt:YourGrossProfit>5.99</cbt:YourGrossProfit>
</cbt:ProfitCalculation>
<cbt:YourPrice>
<cbt:ProductSinglePrice>
<cbt:NetPrice>5.03</cbt:NetPrice>
<cbt:VatPrice>0.96</cbt:VatPrice>
<cbt:GrossPrice>5.99</cbt:GrossPrice>
<cbt:VatPercentage>19</cbt:VatPercentage>
</cbt:ProductSinglePrice>
<cbt:ProductTotalPrice>
<cbt:NetPrice>5.03</cbt:NetPrice>
<cbt:VatPrice>0.96</cbt:VatPrice>
<cbt:GrossPrice>5.99</cbt:GrossPrice>
<cbt:VatPercentage>19</cbt:VatPercentage>
</cbt:ProductTotalPrice>
<cbt:TotalSinglePrice>
<cbt:NetPrice>5.03</cbt:NetPrice>
<cbt:VatPrice>0.96</cbt:VatPrice>
<cbt:GrossPrice>5.99</cbt:GrossPrice>
<cbt:VatPercentage>19</cbt:VatPercentage>
</cbt:TotalSinglePrice>
<cbt:TotalTotalPrice>
<cbt:NetPrice>5.03</cbt:NetPrice>
<cbt:VatPrice>0.96</cbt:VatPrice>
<cbt:GrossPrice>5.99</cbt:GrossPrice>
<cbt:VatPercentage>19</cbt:VatPercentage>
</cbt:TotalTotalPrice>
</cbt:YourPrice>
<cbt:CustomerPrice>
<cbt:ProductSinglePrice>
<cbt:NetPrice>5.03</cbt:NetPrice>
<cbt:VatPrice>0.96</cbt:VatPrice>
<cbt:GrossPrice>5.99</cbt:GrossPrice>
<cbt:VatPercentage>19</cbt:VatPercentage>
</cbt:ProductSinglePrice>
<cbt:ProductTotalPrice>
<cbt:NetPrice>5.03</cbt:NetPrice>
<cbt:VatPrice>0.96</cbt:VatPrice>
<cbt:GrossPrice>5.99</cbt:GrossPrice>
<cbt:VatPercentage>19</cbt:VatPercentage>
</cbt:ProductTotalPrice>
<cbt:TotalSinglePrice>
<cbt:NetPrice>5.03</cbt:NetPrice>
<cbt:VatPrice>0.96</cbt:VatPrice>
<cbt:GrossPrice>5.99</cbt:GrossPrice>
<cbt:VatPercentage>19</cbt:VatPercentage>
</cbt:TotalSinglePrice>
<cbt:TotalTotalPrice>
<cbt:NetPrice>5.03</cbt:NetPrice>
<cbt:VatPrice>0.96</cbt:VatPrice>
<cbt:GrossPrice>5.99</cbt:GrossPrice>
<cbt:VatPercentage>19</cbt:VatPercentage>
</cbt:TotalTotalPrice>
</cbt:CustomerPrice>
<cbt:Deliveries>
<cbt:Service>
<cbt:DeliveryType>cleverbridge delivers trial version by download</cbt:DeliveryType>
<cbt:DeliveryTypeId>cleverbridgeLinksToTrialDownload</cbt:DeliveryTypeId>
</cbt:Service>
</cbt:Deliveries>
<cbt:Additionals />
<cbt:ExtraParameters />
</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:PaidOrderNotification>