Skip to content

MSP

Membership#

Occurence: A supporter has started or is renewing a membership.

Key Data: Details about the membership being started/renewed/or lapsed. The transaction is typically associated with an additional fundraising transaction (e.g 'FCS'), which details the payment for the membership.

Export file columns#

Account ID#

Identifies the subaccount this item belongs to

Example: 94

Supporter ID#

The unique numerical database identifier for a supporter.

Example: 212200 Default: 0

Supporter Email#

The primary email address of a supporter, which will typically be used as the basis for identifying a unique supporter to which any transactions will be associated. <= 500 characters

Example: otto.nv@example.com

Date Created#

The date a supporter was created. [ISO 8601 format date]

Example: 2024-12-01

Date Modified#

The date a supporter was last modified. [ISO 8601 format date]

Example: 2024-12-01

Campaign Number#

A unique database identifier used to refer to a page, particularly in transactional data. Where records in transactional data originate outside of a page structure, for example as a result of dashboard actions or imports, this will hold a value of 0. Default: 0

Example: 10122

Campaign Type#

MSP

Campaign ID#

The internal reference name given to a page. <= 160 characters

Campaign Status#

Transaction type

Allowed values:

new membership renewal term lapsed

Campaign Data 1#

The current status of this membership [ACTIVE or LAPSED].

Allowed values:

ACTIVE LAPSED

Campaign Data 2#

A database assigned identifier for this membership.

Example: 643

Campaign Data 3#

The unique identifier given to this particular membership instance. Membership identifiers may include a user defined prefix, as defined in the dashboard membership setup.

Example: ENMPJQ6881494019

Campaign Data 4#

The transaction identifier as provided by a payment gateway. If the current transaction is a refund, then this identifier points back to the transaction being refunded. The specific formatting of the identifier will be dependent on the gateway.

Example: ND8390T284740397745210972__cus_O20rrZCTq8iTpw__ch_3NFwqEHh8CrK50QS1uUEXjck

Campaign Data 5#

An amount presented as a decimal number without any currency symbols. This amount may be omitted for pagetypes where the amount to be processed by a payment gateway needs to be calculated, for example when purchasing tickets for events or certain types of symbolic gifts.

Example: 5.0

Campaign Data 6#

The ISO 4217 code of the currency used for this transaction. When processing payments, it is important to note that currency support is gateway dependent, so be sure to check with your designated payment gateway that the selected currency is supported and has been enabled for your account.

Example: GBP

Campaign Data 7#

The frequency for this transaction, which can be a one-off payment or part of a recurring schedule.

Occurs as either:

S The payment was made as a one-off (single).

R The payment was set up according to a recurring schedule.

Campaign Data 8#

The type of membership selected <= 30 characters

Example: Individual

Campaign Data 9#

Number of Members Included in the Membership <= 10 characters

Example: 2

Campaign Data 10#

The start date of this membership [in ISO 8601 date format: YYYY-MM-DD]

Example: 2024-12-01 <= 30 characters

Campaign Data 11#

The start date of the current term [in ISO 8601 date format: YYYY-MM-DD]

Example: 2024-12-01 <= 30 characters

Campaign Data 12#

The end date of the current term [in ISO 8601 date format: YYYY-MM-DD]

Example: 2024-12-01 <= 30 characters

Campaign Data 13#

Number of days between current term start date and end date

Example: 365

Campaign Data 14#

The number of renewal terms

Campaign Data 15#

Total Cost of Membership <= 10 characters

Example: 0

Campaign Data 16#

The amount paid into this membership

Campaign Data 17#

The membership has been paid in full.

Allowed values:

Y N

Campaign Data 18#

The current state of this membership.

Allowed values:

NEW LAPSED

Campaign Data 19#

No output for this transaction type.

Campaign Data 20#

No output for this transaction type.

Campaign Data 21#

No output for this transaction type.

Campaign Data 22#

No output for this transaction type.

Campaign Data 23#

No output for this transaction type.

Campaign Data 24#

No output for this transaction type.

Campaign Data 25#

Any additional comments submitted by the user to accompany this transaction. <= 4000 characters

Example: I suffer from this illness, and would be happy to share my story if it could help.

Campaign Data 26#

Amount in USD if available - use for reporting only - converted at the time of transaction

Example: 1.3

Campaign Data 27#

Amount in GBP if available - use for reporting only - converted at the time of transaction

Example: 1.0

Campaign Data 28#

Amount in EUR if available - use for reporting only - converted at the time of transaction

Example: 1.19

Campaign Data 29#

Amount in CAD if available - use for reporting only - converted at the time of transaction

Example: 1.77

Campaign Data 30#

Amount in AUD if available - use for reporting only - converted at the time of transaction

Example: 1.91

Campaign Data 31#

The database identifier of a supporter who has been identified as the referrer for this transaction

Example: 5348788

Campaign Data 32#

Details about the user agent used when submitting the content. The string consists of key/value pairs that are separated by a ~ (tilde) character.

mobile: N or Y depending on whether the user agent identifies as a mobile device. tablet: N or Y depending on whether the user agent identifies as a type of device classed as a 'tablet'. device: The manufacturer of the type of device used by the user agent. os: The underlying operating system of a user agent. browser: The type of web-browser that was used.

Example: mobile:N~tablet:N~device:APPLE~os:Mac OS X~browser:Firefox 11

Campaign Data 33#

A URL identified as the referral origin for this transaction

Example: https://example.com/page/12272/donate/1

Campaign Data 34#

Used to note the origin of incoming page traffic, and is typically passed in links to pages using the query parameter ea.tracking.id <= 300 characters

Example: linkshare

Campaign Data 35#

An appeal code assigned to this submission.

The code can be considered transactional as it is typically submitted as part of a page submission and associated with the page transaction, however the 'latest' appeal code applied to any supporter submission is also held on the supporter's record. <= 300 characters

Example: EOY

External Reference 1#

When used outside of API page processing, this field may be populated using the URL parameters utm_source or by the generic parameter en_txn1. Content will be automatically truncated if the maximum length is exceeded, and the last three characters replaced by '...' to indicate that a string has been truncated. <= 100 characters

External Reference 2#

When used outside of API page processing, this field may be populated using the URL parameters utm_medium or by the generic parameter en_txn2. Content will be automatically truncated if the maximum length is exceeded, and the last three characters replaced by '...' to indicate that a string has been truncated. <= 100 characters

External Reference 3#

When used outside of API page processing, this field may be populated using the URL parameters utm_campaign or by the generic parameter en_txn3. Note: Content will be automatically truncated if the maximum length is exceeded, and the last three characters replaced by '...' to indicate that a string has been truncated. <= 100 characters

External Reference 4#

When used outside of API page processing, this field may be populated using the URL parameters utm_content or by the generic parameter en_txn4. Note: Content will be automatically truncated if the maximum length is exceeded, and the last three characters replaced by '...' to indicate that a string has been truncated. <= 100 characters

External Reference 5#

When used outside of API page processing, this field may be populated using the URL parameters utm_term or by the generic parameter en_txn5. Note: Content will be automatically truncated if the maximum length is exceeded, and the last three characters replaced by '...' to indicate that a string has been truncated. <= 100 characters

External Reference 6#

When used outside of API page processing, this field may also be populated by a user-defined page property [Page > Admin > Campaign References], or by the url query parameter en_txn6. When added as a page parameter, the field is referred to as Campaign Reference 1 in the dashboard settings. If a value is presented in both places, the url query parameter will take precedence. Note: Content will be automatically truncated if the maximum length is exceeded, and the last three characters replaced by '...' to indicate that a string has been truncated. <= 100 characters

External Reference 7#

When used outside of API page processing, this field may also be populated by a user-defined page property [Page > Admin > Campaign References], or by the url query parameter en_txn7. When added as a page parameter, the field is referred to as Campaign Reference 2 in the dashboard settings. If a value is presented in both places, the url query parameter will take precedence. Note: Content will be automatically truncated if the maximum length is exceeded, and the last three characters replaced by '...' to indicate that a string has been truncated. <= 100 characters

External Reference 8#

When used outside of API page processing, this field may also be populated by a user-defined page property [Page > Admin > Campaign References], or by the url query parameter en_txn8. When added as a page parameter, the field is referred to as Campaign Reference 3 in the dashboard settings. If a value is presented in both places, the url query parameter will take precedence. Note: Content will be automatically truncated if the maximum length is exceeded, and the last three characters replaced by '...' to indicate that a string has been truncated. <= 100 characters

External Reference 9#

When used outside of API page processing, this field may also be populated by a user-defined page property [Page > Admin > Campaign References], or by the url query parameter en_txn9. When added as a page parameter, the field is referred to as Campaign Reference 4 in the dashboard settings. If a value is presented in both places, the url query parameter will take precedence. Note: Content will be automatically truncated if the maximum length is exceeded, and the last three characters replaced by '...' to indicate that a string has been truncated. <= 100 characters

External Reference 10#

When used outside of API page processing, this field may also be populated by a user-defined page property [Page > Admin > Campaign References], or by the url query parameter en_txn10. When added as a page parameter, the field is referred to as Campaign Reference 5 in the dashboard settings. If a value is presented in both places, the url query parameter will take precedence. Note: Content will be automatically truncated if the maximum length is exceeded, and the last three characters replaced by '...' to indicate that a string has been truncated. <= 100 characters

Email Address#

The primary email address of a supporter, which will typically be used as the basis for identifying a unique supporter to which any transactions will be associated. <= 500 characters

Example: otto.nv@example.com

Title#

A supporter's title to be used in salutations <= 50 characters

Example: Dr

First Name#

A supporter's first name <= 500 characters

Example: Otto

Middle Name#

A supporter's middle name <= 500 characters

Example: Niemand

Last Name#

A supporter's last name <= 500 characters

Example: Normalverbraucher

Address 1#

The first line of the supporter's address <= 1000 characters

Address 2#

The second line of the supporter's address <= 1000 characters

Address 3#

The third line of the supporter's address <= 1000 characters

City#

The city in a supporter's address <= 500 characters

Example: Musterstadt

Region#

The supporter's region, state, county, province or similar <= 500 characters

Example: Musterregion

Country#

The supporter's country <= 500 characters

Example: DE

Phone Number#

The primary phone number for a supporter <= 200 characters

Example: +49 4066969123