Additional Purchase Response Items

Additional Purchase Response Items

Purchase.PaidOrderNotification.Purchase.BillingContact

object

Contact's billing information.

Purchase.PaidOrderNotification.Purchase.BillingContact.Language

string

Contact's language.

Purchase.PaidOrderNotification.Purchase.BillingContact.LanguageId

string

Two-character ID of the contact's language, see ISO 639-1.

Purchase.PaidOrderNotification.Purchase.BillingContact.Locale

string

Two-character ID of the contact's language (see ISO 639-1) followed by two-character ID of the contact's country (see ISO 3166-1 alpha-2).

Purchase.PaidOrderNotification.Purchase.BillingContact.Firstname

string

Contact's first name.

Purchase.PaidOrderNotification.Purchase.BillingContact.Lastname

string

Contact's last name.

Purchase.PaidOrderNotification.Purchase.BillingContact.Street1

string

Contact's street address.

Purchase.PaidOrderNotification.Purchase.BillingContact.PostalCode

string

Contact's postal code.

Purchase.PaidOrderNotification.Purchase.BillingContact.City

string

Contact's city.

Purchase.PaidOrderNotification.Purchase.BillingContact.Country

string

Contact's country.

Purchase.PaidOrderNotification.Purchase.BillingContact.CountryId

string

Two-character ID of the contact's country, see ISO 3166-1 alpha-2.

Purchase.PaidOrderNotification.Purchase.BillingContact.Email

string

Contact's email address.

Purchase.PaidOrderNotification.Purchase.Items.Item.CustomerPrice

object

Pricing information that the customer receives during the purchase process.

Purchase.PaidOrderNotification.Purchase.Items.Item.CustomerPrice.ProductSinglePrice

object

Basic pricing information for one unit of a product.

Purchase.PaidOrderNotification.Purchase.Items.Item.CustomerPrice.ProductSinglePrice.NetPrice

string

Price for one unit of a product, not including taxes.

Purchase.PaidOrderNotification.Purchase.Items.Item.CustomerPrice.ProductSinglePrice.VatPrice

string

Taxes for one unit of a product.

Purchase.PaidOrderNotification.Purchase.Items.Item.CustomerPrice.ProductSinglePrice.GrossPrice

string

Price for one unit of a product, including taxes.

Purchase.PaidOrderNotification.Purchase.Items.Item.CustomerPrice.ProductSinglePrice.VatPercentage

string

Tax rate (percentage).

Purchase.PaidOrderNotification.Purchase.Items.Item.CustomerPrice.ProductTotalPrice

object

Basic pricing information for all units of a product.

Purchase.PaidOrderNotification.Purchase.Items.Item.CustomerPrice.ProductTotalPrice.NetPrice

string

Price for all units of a product, not including taxes.

Purchase.PaidOrderNotification.Purchase.Items.Item.CustomerPrice.ProductTotalPrice.VatPrice

string

Taxes for all units of a product.

Purchase.PaidOrderNotification.Purchase.Items.Item.CustomerPrice.ProductTotalPrice.GrossPrice

string

Price for all units of a product, including taxes.

Purchase.PaidOrderNotification.Purchase.Items.Item.CustomerPrice.ProductTotalPrice.VatPercentage

string

Tax rate (percentage).

Purchase.PaidOrderNotification.Purchase.Items.Item.CustomerPrice.TotalSinglePrice

object

Complete pricing information for one unit.

Purchase.PaidOrderNotification.Purchase.Items.Item.CustomerPrice.TotalSinglePrice.NetPrice

string

Price for one unit of a product, not including taxes.

Purchase.PaidOrderNotification.Purchase.Items.Item.CustomerPrice.TotalSinglePrice.VatPrice

string

Taxes for one unit of a product.

Purchase.PaidOrderNotification.Purchase.Items.Item.CustomerPrice.TotalSinglePrice.GrossPrice

string

Price for one unit of a product, including taxes.

Purchase.PaidOrderNotification.Purchase.Items.Item.CustomerPrice.TotalSinglePrice.VatPercentage

string

Tax rate (percentage).

Purchase.PaidOrderNotification.Purchase.Items.Item.CustomerPrice.TotalTotalPrice

object

Complete pricing information for all units of a product.

Purchase.PaidOrderNotification.Purchase.Items.Item.CustomerPrice.TotalTotalPrice.NetPrice

string

Price for all units of a product, not including taxes.

Purchase.PaidOrderNotification.Purchase.Items.Item.CustomerPrice.TotalTotalPrice.VatPrice

string

Taxes for all units of a product.

Purchase.PaidOrderNotification.Purchase.Items.Item.CustomerPrice.TotalTotalPrice.GrossPrice

string

Price for all units of a product, including taxes.

Purchase.PaidOrderNotification.Purchase.Items.Item.CustomerPrice.TotalTotalPrice.VatPercentage

string

Tax rate (percentage).

Purchase.PaidOrderNotification.Purchase.Items.Item.Deliveries

object

Information about the delivery(s).

Purchase.PaidOrderNotification.Purchase.Items.Item.Deliveries.Key

object

Information about a delivery.

Purchase.PaidOrderNotification.Purchase.Items.Item.Deliveries.Key.DeliveryType

string

The way in which the purchase item was delivered. This field corresponds to the Products > Delivery > Delivery > Delivery type field in the Commerce Assistant.

Purchase.PaidOrderNotification.Purchase.Items.Item.Deliveries.Key.DeliveryTypeId

string

ID that corresponds to the DeliveryType.

Purchase.PaidOrderNotification.Purchase.Items.Item.Deliveries.Key.Key

string

License key specifications and delivery message (if applicable).

Purchase.PaidOrderNotification.Purchase.Items.Item.Deliveries.Key.KeyRaw

string

License key specifications.

Purchase.PaidOrderNotification.Purchase.DeliveryContact

object

Contact's delivery information.

Purchase.PaidOrderNotification.Purchase.DeliveryContact.Language

string

Contact's language.

Purchase.PaidOrderNotification.Purchase.DeliveryContact.LanguageId

string

Two-character ID of the contact's language, see ISO 639-1.

Purchase.PaidOrderNotification.Purchase.DeliveryContact.Locale

string

Two-character ID of the contact's language (see ISO 639-1) followed by two-character ID of the contact's country (see ISO 3166-1 alpha-2).

Purchase.PaidOrderNotification.Purchase.DeliveryContact.Firstname

string

Contact's first name.

Purchase.PaidOrderNotification.Purchase.DeliveryContact.Lastname

string

Contact's last name.

Purchase.PaidOrderNotification.Purchase.DeliveryContact.Street1

string

Contact's street address.

Purchase.PaidOrderNotification.Purchase.DeliveryContact.PostalCode

string

Contact's postal code.

Purchase.PaidOrderNotification.Purchase.DeliveryContact.City

string

Contact's city.

Purchase.PaidOrderNotification.Purchase.DeliveryContact.Country

string

Contact's country.

Purchase.PaidOrderNotification.Purchase.DeliveryContact.CountryId

string

Two-character ID of the contact's country, see ISO 3166-1 alpha-2.

Purchase.PaidOrderNotification.Purchase.DeliveryContact.Email

string

Contact's email address.

Purchase.PaidOrderNotification.Purchase.ExtraParameters

object

List of x-parameters used in the transaction.

Purchase.PaidOrderNotification.Purchase.ExtraParameters.ExtraParameter

object

X-parameter used in the transaction.

Purchase.PaidOrderNotification.Purchase.ExtraParameters.ExtraParameter.Key

string

Name of the parameter. Always begins with x-, such as x-source.

Purchase.PaidOrderNotification.Purchase.ExtraParameters.ExtraParameter.Value

string

Value of the parameter.

Purchase.PaidOrderNotification.Purchase.Items

object

List of purchase items.

Purchase.PaidOrderNotification.Purchase.Items.Item

object

Information about a purchase item.

Purchase.PaidOrderNotification.Purchase.Items.Item.@RunningNo

string

Running number of the item.

Purchase.PaidOrderNotification.Purchase.Items.Item.ProductId

string

ID of the product.

Purchase.PaidOrderNotification.Purchase.Items.Item.ProductName

string

Product name used in customer communication.

Purchase.PaidOrderNotification.Purchase.Items.Item.ProductNameExtension

string

Product description. Corresponds to the 'Additional name information' in the Commerce Assistant.

Purchase.PaidOrderNotification.Purchase.Items.Item.YourProductId

string

Internal product ID used in your company.

Purchase.PaidOrderNotification.Purchase.Items.Item.ProductReportingGroup

string

Type of product. For example, B2B or B2C.

Purchase.PaidOrderNotification.Purchase.Items.Item.SupportContactId

string

Unique ID for customer support.

Purchase.PaidOrderNotification.Purchase.Items.Item.SupportContact

string

Name of customer support.

Purchase.PaidOrderNotification.Purchase.Items.Item.ClientId

string

The cleverbridge ID for your company.

Purchase.PaidOrderNotification.Purchase.Items.Item.Quantity

string

Number of items.

Purchase.PaidOrderNotification.Purchase.Items.Item.YourCurrency

string

The currency on your account.

Purchase.PaidOrderNotification.Purchase.Items.Item.YourCurrencyId

string

Unique ID for the currency on your account.

Purchase.PaidOrderNotification.Purchase.Items.Item.ProfitCalculation

object

Financial figures related to the purchase.

Purchase.PaidOrderNotification.Purchase.Items.Item.ProfitCalculation.GrossRevenue

string

Money cleverbridge received from customer, including taxes.

Purchase.PaidOrderNotification.Purchase.Items.Item.ProfitCalculation.CollectedVat

string

Taxes cleverbridge received from customer.

Purchase.PaidOrderNotification.Purchase.Items.Item.ProfitCalculation.NetRevenue

string

Money cleverbridge received from customer, not including taxes.

Purchase.PaidOrderNotification.Purchase.Items.Item.ProfitCalculation.CbMarginPercentage

string

Percentage of NetRevenue that cleverbridge kept.

Purchase.PaidOrderNotification.Purchase.Items.Item.ProfitCalculation.CbMarginFix

string

Fixed amount of NetRevenue that cleverbridge kept.

Purchase.PaidOrderNotification.Purchase.Items.Item.ProfitCalculation.YourNetProfit

string

Money you received from cleverbridge, not including taxes.

Purchase.PaidOrderNotification.Purchase.Items.Item.ProfitCalculation.YourVat

string

Taxes that you must pay.

Purchase.PaidOrderNotification.Purchase.Items.Item.ProfitCalculation.YourGrossProfit

string

Money you received from cleverbridge, including taxes.

Purchase.PaidOrderNotification.Purchase.LicenseeContact

object

Contact's licensee information.

Purchase.PaidOrderNotification.Purchase.LicenseeContact.Language

string

Contact's language.

Purchase.PaidOrderNotification.Purchase.LicenseeContact.LanguageId

string

Two-character ID of the contact's language, see ISO 639-1.

Purchase.PaidOrderNotification.Purchase.LicenseeContact.Locale

string

Two-character ID of the contact's language (see ISO 639-1) followed by two-character ID of the contact's country (see ISO 3166-1 alpha-2).

Purchase.PaidOrderNotification.Purchase.LicenseeContact.Firstname

string

Contact's first name.

Purchase.PaidOrderNotification.Purchase.LicenseeContact.Lastname

string

Contact's last name.

Purchase.PaidOrderNotification.Purchase.LicenseeContact.Street1

string

Contact's street address.

Purchase.PaidOrderNotification.Purchase.LicenseeContact.PostalCode

string

Contact's postal code.

Purchase.PaidOrderNotification.Purchase.LicenseeContact.City

string

Contact's city.

Purchase.PaidOrderNotification.Purchase.LicenseeContact.Country

string

Contact's country.

Purchase.PaidOrderNotification.Purchase.LicenseeContact.CountryId

string

Two-character ID of the contact's country, see ISO 3166-1 alpha-2.

Purchase.PaidOrderNotification.Purchase.LicenseeContact.Email

string

Contact's email address.

Purchase.PaidOrderNotification.Purchase.PaymentInfo

object

Information about the payments.

Purchase.PaidOrderNotification.Purchase.PaymentInfo.Currency

string

The currency of the defined price.

Purchase.PaidOrderNotification.Purchase.PaymentInfo.CurrencyId

string

Currency code in capital letters, see ISO ISO 4217.

Purchase.PaidOrderNotification.Purchase.PaymentInfo.PaymentType

string

Payment method used.

Purchase.PaidOrderNotification.Purchase.PaymentInfo.PaymentTypeId

string

ID of the payment method.

Purchase.PaidOrderNotification.Purchase.PaymentInfo.CardLastFourDigits

string

Last four digits of the card number.

Purchase.PaidOrderNotification.Purchase.PaymentInfo.CardExpirationDate

object

Expiration date of the card.

Purchase.PaidOrderNotification.Purchase.PaymentInfo.CardExpirationDate.Month

integer

Expiration month.

Purchase.PaidOrderNotification.Purchase.PaymentInfo.CardExpirationDate.Year

integer

Expiration year.

Purchase.PaidOrderNotification.Purchase.PaymentInfo.IsPurchaseOrder

string

Whether or not a purchase order was used.

Purchase.PaidOrderNotification.Purchase

object

All information about the purchase.

Purchase.PaidOrderNotification.Purchase.@Id

string

Unique ID of the purchase.

Purchase.PaidOrderNotification.Purchase.Status

string

Current purchase status.

Purchase.PaidOrderNotification.Purchase.StatusId

string

Current purchase status notification ID. For more information, see Purchase Status.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling

object

Information about the subscription (if applicable).

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.@SubscriptionId

string

Unique ID of the subscription.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.@SubscriptionItemRunningNo

string

Running number of the item in the subscription.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.OriginalPurchaseId

string

Unique ID of the purchase.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.OriginalPurchaseItemRunningNo

string

Running number of the item in the purchase.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.IntervalNo

string

Number of the last successfully paid interval of the subscription. Counting starts at 0. For each successfully paid interval, the number is increased by one.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.GracePeriodDays

string

The number of days in which the customer can use the product during a grace period.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.StatusId

string

ID that correspondes to the Status.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.Status

string

Status of the subscription. For more information, see Subscription Statuses.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.ItemStatusId

string

ID that correspondes to the Item Status.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.ItemStatus

string

Status of the subscription item. For more information, see Subscription Statuses.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.NextBillingDate

string

Next billing date according to RFC3339. Specified in UTC.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.CancellationUrl

string

URL where the customer can find the subscription cancellation page.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.ChangePaymentSubscriptionUrl

string

URL where the customer can find the change payment method page.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.NextBillingProfit

object

Financial figures related to the NextBillingDate.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.NextBillingProfit.GrossRevenue

string

Money cleverbridge received from customer, including taxes.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.NextBillingProfit.CollectedVat

string

Taxes cleverbridge received from customer.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.NextBillingProfit.NetRevenue

string

Money cleverbridge received from customer, not including taxes.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.NextBillingProfit.CbMarginPercentage

string

Percentage of NetRevenue that cleverbridge kept.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.NextBillingProfit.CbMarginFix

string

Fixed amount of NetRevenue that cleverbridge kept.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.NextBillingProfit.YourNetProfit

string

Money you received from cleverbridge, not including taxes.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.NextBillingProfit.YourVat

string

Taxes that you must pay.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.NextBillingProfit.YourGrossProfit

string

Money you received from cleverbridge, including taxes.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.RenewalType

string

Renewal type of the subscription. With Automatic, the subscription automatically renews at the end of the billing interval using the billing information provided by the customer. With Manual, the customer must initiate the renewal at the end of the billing interval.

Purchase.PaidOrderNotification.Purchase.Items.Item.RecurringBilling.IntervalLengthInMonths

integer

Length of the customer's current subscription billing period in months.

Purchase.PaidOrderNotification.Purchase.Items.Item.YourPrice

object

Pricing information that your company set up in the cleverbridge platform.

Purchase.PaidOrderNotification.Purchase.Items.Item.YourPrice.ProductSinglePrice

object

Basic pricing information for one unit of a product.

Purchase.PaidOrderNotification.Purchase.Items.Item.YourPrice.ProductSinglePrice.NetPrice

string

Price for one unit of a product, not including taxes.

Purchase.PaidOrderNotification.Purchase.Items.Item.YourPrice.ProductSinglePrice.VatPrice

string

Taxes for one unit of a product.

Purchase.PaidOrderNotification.Purchase.Items.Item.YourPrice.ProductSinglePrice.GrossPrice

string

Price for one unit of a product, including taxes.

Purchase.PaidOrderNotification.Purchase.Items.Item.YourPrice.ProductSinglePrice.VatPercentage

string

Tax rate (percentage).

Purchase.PaidOrderNotification.Purchase.Items.Item.YourPrice.ProductTotalPrice

object

Basic pricing information for all units of a product.

Purchase.PaidOrderNotification.Purchase.Items.Item.YourPrice.ProductTotalPrice.NetPrice

string

Price for all units of a product, not including taxes.

Purchase.PaidOrderNotification.Purchase.Items.Item.YourPrice.ProductTotalPrice.VatPrice

string

Taxes for all units of a product.

Purchase.PaidOrderNotification.Purchase.Items.Item.YourPrice.ProductTotalPrice.GrossPrice

string

Price for all units of a product, including taxes.

Purchase.PaidOrderNotification.Purchase.Items.Item.YourPrice.ProductTotalPrice.VatPercentage

string

Tax rate (percentage).

Purchase.PaidOrderNotification.Purchase.Items.Item.YourPrice.TotalSinglePrice

object

Complete pricing information for one unit.

Purchase.PaidOrderNotification.Purchase.Items.Item.YourPrice.TotalSinglePrice.NetPrice

string

Price for one unit of a product, not including taxes.

Purchase.PaidOrderNotification.Purchase.Items.Item.YourPrice.TotalSinglePrice.VatPrice

string

Taxes for one unit of a product.

Purchase.PaidOrderNotification.Purchase.Items.Item.YourPrice.TotalSinglePrice.GrossPrice

string

Price for one unit of a product, including taxes.

Purchase.PaidOrderNotification.Purchase.Items.Item.YourPrice.TotalSinglePrice.VatPercentage

string

Tax rate (percentage).

Purchase.PaidOrderNotification.Purchase.Items.Item.YourPrice.TotalTotalPrice

object

Complete pricing information for all units of a product.

Purchase.PaidOrderNotification.Purchase.Items.Item.YourPrice.TotalTotalPrice.NetPrice

string

Price for all units of a product, not including taxes.

Purchase.PaidOrderNotification.Purchase.Items.Item.YourPrice.TotalTotalPrice.VatPrice

string

Taxes for all units of a product.

Purchase.PaidOrderNotification.Purchase.Items.Item.YourPrice.TotalTotalPrice.GrossPrice

string

Price for all units of a product, including taxes.

Purchase.PaidOrderNotification.Purchase.Items.Item.YourPrice.TotalTotalPrice.VatPercentage

string

Tax rate (percentage).