This top-level JSON object is used when most events related to purchases or subscriptions occur, with the exception of reimbursements.
Field Name | Type | Description |
---|---|---|
meta | object | Metadata related to the notification. For more information, see Meta Object. |
purchaseId | integer | Unique ID of the purchase. |
reimbursementId | integer | Unique ID of a reimbursement. |
status | string | Current purchase status. |
statusId | string | Current purchase status ID. For more information, see Purchase Status |
billingContact | object | Customer's billing information. For more information, see Contact Object. |
deliveryContact | object | Customer's delivery information. For more information, see Contact Object. |
licenseeContact | object | Customer's licensee information. For more information, see Contact Object. |
paymentInfo | object | Information about the payment. For more information, see PaymentInfo Object. |
customerReferenceNumber | string | Your unique ID for the customer. This value is submitted by you when the customer initially purchases a product and is stored by Cleverbridge. Corresponds to the Internal customer ID in the Commerce Assistant. It can be used to identify the customer and auto-process the order. For more information, see Internal Customer Data. |
creationTime | string | Date and time when purchase was created according to RFC3339. |
paymentArriveTime | string | Date and time when payment was processed according to RFC3339. |
reimbursementTime | string | Date and time when the reimbursement was processed according to RFC3339. |
lastModificationTime | string | Date and time when the last change was made according to RFC3339. |
quoteToPurchaseTime | string | The time when a customer, who was given a quote, completed the purchase. |
subscriptionRevenueCategoryId | string | Type of subscription. For a list of possible values, see Subscription Revenue Category. |
remoteAddress | string | The IPv4-Address that corresponds with the location where the transaction was completed. For compliance reasons, the last part of the IP address has been masked with a 0. |
httpUserAgent | string | The browser used by the customer. |
httpEntryUrl | string | URL where the customer started the checkout process. |
httpReferer | string | URL the customer was referred from. |
httpAcceptLanguage | string | The Accept-Language Header as submitted by the customer's browser. |
partnerId | integer | Unique ID of the partner. |
partnerUserName | string | Unique username of the partner. |
internalCustomer | string | Your unique ID for a customer. |
internalPartner | string | Your unique ID for a partner. |
customerConfirmationPageUrl | string | URL where the customer's confirmation page is located. |
customerPdfDocumentUrl | string | URL where the PDF document sent to the customer is located. |
merchantOfRecord | string | The business model in which the transaction took place. Possible values are AG (Reseller) , Inc (Reseller) , Service Provider . |
error | object | Information about errors that occurred during the purchase process. For more information, see Error Object. |
paymentResult | object | Information about the result of the payment process. For more information, see PaymentResult Object. |
items | object | List of purchase items. For more information, see PurchaseItem Object. |
extraParameters | object | X-parameters used in the transaction. For more information, see ExtraParameters Object. |