Key | Field | Type | Description | Requiredness | Default value |
1 | product | product.Product | Product type
| required | |
2 | paymentFrequency | PaymentFrequency | If the payment is a one off or recurring
| required | |
3 | currency | string | Currency code (ISO 4217 3-character, upper-case, eg USD, GBP)
| required | |
4 | amount | double | Contributed amount in units of the currency received
| required | |
6 | paymentProvider | PaymentProvider | The payment provider the user paid with
| optional | |
7 | campaignCode | set<string > | The campaign code of the campaign that the user came from
| optional | |
8 | abTests | abtest.AbTestInfo | The ab tests the user was in on dotcom
| optional | |
9 | countryCode | string | ISO-3166-aplha-2 country code representing where the user is from. It is either the country of the card used, or the country of the contributor s address
| optional | |
10 | referrerPageViewId | string | Page view id of the page the reader was on that lead them through to the contribution page e.g. by clicking on the Contribute Now button in the Epic component
| optional | |
11 | referrerUrl | string | Url of the page the reader was on that lead them through to the contribution page e.g. by clicking on the Contribute Now button in the Epic component
| optional | |
12 | componentId | string | An ID that can be used to distinguish different instances of a given component type
| optional | |
14 | componentTypeV2 | componentevent.ComponentType | The type of component that the acquisition came from
| optional | |
15 | source | AcquisitionSource | The source of the acquisition
| optional | |
16 | printOptions | printoptions.PrintOptions | Extra parameters only applicable to print products
| optional | |
19 | platform | platform.Platform | Platform on which the acquisition occurred e.g. Contributions, S&C
| optional | |
20 | discountLengthInMonths | i16 | Length of the discount in months
| optional | |
21 | discountPercentage | double | Amount of discount, as a percentage
| optional | |
22 | promoCode | string | Promo code for the acquisition. Only applicable to subscriptions.
| optional | |
23 | labels | set<string > | Any additional labels.
In particular, extra information that is needed to calculate Annualised Value
for this Acquisition (e.g. promotions like Guardian Weekly Six For Six) can go here.
| optional | |
24 | identityId | string | The identity id of a user
| optional | |
25 | queryParameters | set<queryparameter.QueryParameter > | Query string parameters associated with an acquisition
| optional | |