# Platform Events Definitions

The LFS managed package features a custom platform event published by Limio for various order types: **i42as\_\_OrderEvent\_\_e**. This event allows for additional logic to be built in the Salesforce org using a platform-event triggered flow. The fields in the event payload vary based on the order type.

This document lists all the field sets for the available order types:

## LimioOrder Payload (sendWholeOrder)

When `sendWholeOrder` is enabled in the Salesforce V3 plugin options, the `i42as__LimioOrder` field is populated with a JSON string containing a reduced version of the Limio order object. This applies to all order types that include the `i42as__LimioOrder` field.

### Default top-level fields

The LimioOrder payload includes the following top-level order fields by default:

`tracking`, `billingDetails`, `customerDetails`, `deliveryDetails`, `orderDate`, `orderItems`, `payment`, `payment_reference`, `payment_status`, `source`, `total`, `variant`, `forSubscription`, `originalOffer`, `customFields`

### Default order item fields

Each order item in `orderItems` is simplified to include:

| Field                                             | Included | Notes                                                                                 |
| ------------------------------------------------- | -------- | ------------------------------------------------------------------------------------- |
| `name`                                            | Always   |                                                                                       |
| `type`                                            | Always   |                                                                                       |
| `quantity`                                        | Always   | Number of units for the order item                                                    |
| `id`                                              | Always   |                                                                                       |
| `price` (`summary`, `currency`, `amount`)         | Always   |                                                                                       |
| `offer` (`name`, `path`, `id`, `version`, `type`) | Always   |                                                                                       |
| `offer.data.attributes.price__limio`              | Always   | Full pricing array including `value`, `type`, `currencyCode`, `repeat_interval`, etc. |
| `products` (`path`, `attributes`, `record_type`)  | Always   |                                                                                       |

### Configurable fields (orderDataOptions)

Additional fields can be preserved in the LimioOrder payload by adding `orderDataOptions` to the Salesforce V3 plugin configuration. This allows including extra data per-customer without code changes.

| Option                 | Level                                      | Description                                | Example values                            |
| ---------------------- | ------------------------------------------ | ------------------------------------------ | ----------------------------------------- |
| `fieldsToKeep`         | Top-level order                            | Overrides the default top-level field list | `["orderItems", "tracking", "country"]`   |
| `itemFields`           | Order item                                 | Additional fields on each order item       | `["parentId", "orderItemActionType"]`     |
| `productDataFields`    | Product (within order item)                | Additional fields on each product          | `["syncedFrom"]`                          |
| `offerDataFields`      | Offer data (`offer.data`)                  | Additional fields on the offer data object | `["productBundles"]`                      |
| `offerAttributeFields` | Offer attributes (`offer.data.attributes`) | Additional offer attribute fields          | `["display_price__limio", "term__limio"]` |

> **Note:** When `fieldsToKeep` is specified, it **replaces** the entire default top-level field list. All other options **add** to the defaults.

**Example configuration:**

```json
{
  "orderDataOptions": {
    "productDataFields": ["syncedFrom"],
    "offerDataFields": ["productBundles"]
  }
}
```

This example preserves `syncedFrom` on each product and `productBundles` (including `rate_plan`) on each offer's data, in addition to all the defaults.

> **Important:** `orderDataOptions` is not user-configurable. To enable or modify this configuration, contact <support@limio.com> or your Limio Implementation contact.

***

## Platform Event Field Definitions

### NEW\_ORDER

| Field                          | Data Type    | Length | Populated?   | Conditions/Details                                                                                                                                                                                                                                                                                                 |
| ------------------------------ | ------------ | ------ | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| i42as\_\_OrderType             | Text         | 40     | Yes          |                                                                                                                                                                                                                                                                                                                    |
| i42as\_\_ChangeType            | Text         | 40     | Yes          |                                                                                                                                                                                                                                                                                                                    |
| i42as\_\_OrderNumber           | Text         | 40     | Yes          |                                                                                                                                                                                                                                                                                                                    |
| i42as\_\_PurchaseDate          | DateTime     |        | Yes          |                                                                                                                                                                                                                                                                                                                    |
| i42as\_\_EffectiveDate         | DateTime     |        | Yes          |                                                                                                                                                                                                                                                                                                                    |
| i42as\_\_SubscriptionId        | Text         | 100    | Yes          |                                                                                                                                                                                                                                                                                                                    |
| i42as\_\_Source                | Text         | 40     | Yes          | Populated as "Limio".                                                                                                                                                                                                                                                                                              |
| i42as\_\_InitiatedSource       | Text         | 40     | Yes          | Either "shop" or "salesforce".                                                                                                                                                                                                                                                                                     |
| i42as\_\_OrderSource           | Text         | 40     | Yes          | Either "shop" or "salesforce".                                                                                                                                                                                                                                                                                     |
| i42as\_\_ContactId             | Text         | 18     | Conditional  | Populated in orders triggered from Salesforce.                                                                                                                                                                                                                                                                     |
| i42as\_\_AccountId             | Text         | 18     | Conditional  |                                                                                                                                                                                                                                                                                                                    |
| i42as\_\_CaseId                | Text         | 18     | Conditional  |                                                                                                                                                                                                                                                                                                                    |
| i42as\_\_GiftCode              | Text         | 40     | Conditional  | Populated if a gift code is present on the order.                                                                                                                                                                                                                                                                  |
| i42as\_\_InitiatedByLimioId    | Text         | 70     | Yes          |                                                                                                                                                                                                                                                                                                                    |
| i42as\_\_InitiatedByExternalId | Text         | 150    | Yes          |                                                                                                                                                                                                                                                                                                                    |
| i42as\_\_LimioOrder            | LongTextArea |        | Configurable | <p>Can be added to the payload upon request. See <a data-mention href="/pages/cT5goSLOjmTGW4WT373R">/pages/cT5goSLOjmTGW4WT373R</a> for more details.<br><br>You can see a typical Limio Order in our API docs ( <a href="https://docs.limio.com/api/objects-api/objects">Get Object</a> > Get Order Response)</p> |
| i42as\_\_OfferId               | Text         | 40     | Yes          |                                                                                                                                                                                                                                                                                                                    |
| i42as\_\_OfferType             | Text         | 40     | Yes          |                                                                                                                                                                                                                                                                                                                    |
| i42as\_\_TermLengthUnits       | Text         | 40     | Yes          |                                                                                                                                                                                                                                                                                                                    |
| i42as\_\_TermLengthValue       | Text         | 40     | Yes          |                                                                                                                                                                                                                                                                                                                    |
| i42as\_\_OfferDisplayName      | Text         | 100    | Conditional  | Populated if available in the offer setup.                                                                                                                                                                                                                                                                         |
| i42as\_\_DisplayPrice          | Text         | 150    | Conditional  |                                                                                                                                                                                                                                                                                                                    |
| i42as\_\_Description           | Text         | 100    | Conditional  |                                                                                                                                                                                                                                                                                                                    |
| i42as\_\_ProductCode           | Text         | 40     | Yes          |                                                                                                                                                                                                                                                                                                                    |
| i42as\_\_ProductName           | Text         | 40     | Yes          |                                                                                                                                                                                                                                                                                                                    |
| i42as\_\_StudentCourse         | Text         | 100    | Conditional  | Populated when `student_offer = true` and student fields were included at checkout.                                                                                                                                                                                                                                |
| i42as\_\_StudentUniversity     | Text         | 100    | Conditional  |                                                                                                                                                                                                                                                                                                                    |
| i42as\_\_StudentGraduationYear | Text         | 4      | Conditional  |                                                                                                                                                                                                                                                                                                                    |

### CHANGE\_OFFER

| Field                          | Data Type    | Length | Populated?   | Conditions/Details                                      |
| ------------------------------ | ------------ | ------ | ------------ | ------------------------------------------------------- |
| i42as\_\_OrderType             | Text         | 40     | Yes          |                                                         |
| i42as\_\_ChangeType            | Text         | 40     | Yes          |                                                         |
| i42as\_\_OrderNumber           | Text         | 40     | Yes          |                                                         |
| i42as\_\_PurchaseDate          | DateTime     |        | Yes          |                                                         |
| i42as\_\_EffectiveDate         | DateTime     |        | Yes          |                                                         |
| i42as\_\_Reason                | Text         | 200    | Conditional  | Populated if provided in the online order.              |
| i42as\_\_SubscriptionId        | Text         | 100    | Yes          |                                                         |
| i42as\_\_Source                | Text         | 40     | Yes          | Populated as "Limio".                                   |
| i42as\_\_OrderSource           | Text         | 40     | Yes          | Populated with either "shop" or "salesforce".           |
| i42as\_\_InitiatedSource       | Text         | 40     | Yes          | Populated with either "shop" or "salesforce".           |
| i42as\_\_ContactId             | Text         | 18     | Conditional  | Populated in orders triggered from Salesforce.          |
| i42as\_\_AccountId             | Text         | 18     | Conditional  |                                                         |
| i42as\_\_CaseId                | Text         | 18     | Conditional  |                                                         |
| i42as\_\_InitiatedByLimioId    | Text         | 70     | Yes          |                                                         |
| i42as\_\_InitiatedByExternalId | Text         | 150    | Yes          |                                                         |
| i42as\_\_LimioOrder            | LongTextArea |        | Configurable | Can be added to the payload by Limio team upon request. |
| i42as\_\_OfferId               | Text         | 40     | Yes          |                                                         |
| i42as\_\_OfferType             | Text         | 40     | Yes          |                                                         |
| i42as\_\_TermLengthUnits       | Text         | 40     | Yes          |                                                         |
| i42as\_\_TermLengthValue       | Text         | 40     | Yes          |                                                         |
| i42as\_\_OfferDisplayName      | Text         | 100    | Conditional  | Populated if available in the offer setup.              |
| i42as\_\_DisplayPrice          | Text         | 150    | Conditional  |                                                         |
| i42as\_\_Description           | Text         | 100    | Conditional  |                                                         |
| i42as\_\_ProductCode           | Text         | 40     | Yes          |                                                         |
| i42as\_\_ProductName           | Text         | 40     | Yes          |                                                         |

### CANCEL\_REQUEST

The same `CANCEL_REQUEST` event is emitted for two distinct Limio order types:

* **`cancel_subscription`** — a finalised cancellation of an active subscription.
* **`cancel_intent`** — a customer-expressed *intent* to cancel (e.g. captured by a cancel survey or save/retention flow) that has not yet been processed as a cancellation.

Subscribers should branch on `i42as__OrderType` (equivalently `i42as__ChangeType`) to distinguish the two. The `cancel_intent` variant carries only the minimum fields needed to identify the subscription and the actor; the `cancel_subscription` variant additionally carries the order reference, purchase date, cancellation reason, and Salesforce CRM identifiers (when available). The **Conditions/Details** column below indicates which fields are variant-specific.

| Field                          | Data Type    | Length | Populated?   | Conditions/Details                                                                   |
| ------------------------------ | ------------ | ------ | ------------ | ------------------------------------------------------------------------------------ |
| i42as\_\_OrderType             | Text         | 40     | Yes          | `cancel_subscription` or `cancel_intent`. Use this to discriminate the two variants. |
| i42as\_\_ChangeType            | Text         | 40     | Yes          | Mirrors `OrderType` (`cancel_subscription` or `cancel_intent`).                      |
| i42as\_\_OrderNumber           | Text         | 40     | Conditional  | `cancel_subscription` only.                                                          |
| i42as\_\_PurchaseDate          | DateTime     |        | Conditional  | `cancel_subscription` only.                                                          |
| i42as\_\_EffectiveDate         | DateTime     |        | Yes          | The requested cancellation date.                                                     |
| i42as\_\_Reason                | Text         | 200    | Conditional  | `cancel_subscription` only, when a reason is present on the order.                   |
| i42as\_\_SubscriptionId        | Text         | 100    | Yes          |                                                                                      |
| i42as\_\_Source                | Text         | 40     | Yes          | Populated as "Limio".                                                                |
| i42as\_\_OrderSource           | Text         | 40     | Yes          | Populated with either "shop" or "salesforce".                                        |
| i42as\_\_InitiatedSource       | Text         | 40     | Yes          | Populated with either "shop" or "salesforce".                                        |
| i42as\_\_ContactId             | Text         | 18     | Conditional  | `cancel_subscription` only, when the order was triggered from Salesforce.            |
| i42as\_\_AccountId             | Text         | 18     | Conditional  | `cancel_subscription` only, when the order was triggered from Salesforce.            |
| i42as\_\_CaseId                | Text         | 18     | Conditional  | `cancel_subscription` only, when the order was triggered from Salesforce.            |
| i42as\_\_InitiatedByLimioId    | Text         | 70     | Yes          |                                                                                      |
| i42as\_\_InitiatedByExternalId | Text         | 150    | Yes          |                                                                                      |
| i42as\_\_LimioOrder            | LongTextArea |        | Configurable | Can be added to the payload by Limio team upon request. Available in both variants.  |

### ADD\_OFFER

| Field                          | Data Type    | Length | Populated?   | Conditions/Details                                      |
| ------------------------------ | ------------ | ------ | ------------ | ------------------------------------------------------- |
| i42as\_\_OrderType             | Text         | 40     | Yes          |                                                         |
| i42as\_\_ChangeType            | Text         | 40     | Yes          |                                                         |
| i42as\_\_OrderNumber           | Text         | 40     | Yes          |                                                         |
| i42as\_\_OrderValue            | Number       |        | Yes          |                                                         |
| i42as\_\_OrderCurrency         | Text         | 3      | Yes          |                                                         |
| i42as\_\_Status                | Text         | 35     | Yes          |                                                         |
| i42as\_\_PurchaseDate          | DateTime     |        | Yes          |                                                         |
| i42as\_\_EffectiveDate         | DateTime     |        | Yes          |                                                         |
| i42as\_\_Reason                | Text         | 200    | Yes          |                                                         |
| i42as\_\_SubscriptionId        | Text         | 100    | Yes          |                                                         |
| i42as\_\_Source                | Text         | 40     | Yes          | Populated as "Limio".                                   |
| i42as\_\_OrderSource           | Text         | 40     | Yes          | Populated with either "shop" or "salesforce".           |
| i42as\_\_InitiatedSource       | Text         | 40     | Yes          | Populated with either "shop" or "salesforce".           |
| i42as\_\_ContactId             | Text         | 18     | Conditional  | Populated in orders triggered from Salesforce.          |
| i42as\_\_AccountId             | Text         | 18     | Conditional  |                                                         |
| i42as\_\_CaseId                | Text         | 18     | Conditional  |                                                         |
| i42as\_\_InitiatedByLimioId    | Text         | 70     | Yes          |                                                         |
| i42as\_\_InitiatedByExternalId | Text         | 150    | Yes          |                                                         |
| i42as\_\_LimioOrder            | LongTextArea |        | Configurable | Can be added to the payload by Limio team upon request. |
| i42as\_\_OfferId               | Text         | 40     | Yes          |                                                         |
| i42as\_\_OfferType             | Text         | 40     | Yes          |                                                         |
| i42as\_\_TermLengthUnits       | Text         | 40     | Yes          |                                                         |
| i42as\_\_TermLengthValue       | Text         | 40     | Yes          |                                                         |
| i42as\_\_OfferDisplayName      | Text         | 100    | Conditional  | Populated if available in the offer setup.              |
| i42as\_\_DisplayPrice          | Text         | 150    | Conditional  |                                                         |
| i42as\_\_Description           | Text         | 100    | Conditional  |                                                         |
| i42as\_\_ProductCode           | Text         | 40     | Yes          |                                                         |
| i42as\_\_ProductName           | Text         | 40     | Yes          |                                                         |

### CHANGE\_PAYMENT\_REQUEST

| Field                          | Data Type    | Length | Populated?   | Conditions/Details                                      |
| ------------------------------ | ------------ | ------ | ------------ | ------------------------------------------------------- |
| i42as\_\_OrderType             | Text         | 40     | Yes          |                                                         |
| i42as\_\_ChangeType            | Text         | 40     | Yes          |                                                         |
| i42as\_\_OrderNumber           | Text         | 40     | Yes          |                                                         |
| i42as\_\_PurchaseDate          | DateTime     |        | Yes          |                                                         |
| i42as\_\_EffectiveDate         | DateTime     |        | Yes          |                                                         |
| i42as\_\_SubscriptionId        | Text         | 100    | Yes          |                                                         |
| i42as\_\_Source                | Text         | 40     | Yes          | Populated as "Limio".                                   |
| i42as\_\_OrderSource           | Text         | 40     | Yes          | Populated with either "shop" or "salesforce".           |
| i42as\_\_InitiatedSource       | Text         | 40     | Yes          | Populated with either "shop" or "salesforce".           |
| i42as\_\_ContactId             | Text         | 18     | Conditional  | Populated in orders triggered from Salesforce           |
| i42as\_\_AccountId             | Text         | 18     | Conditional  |                                                         |
| i42as\_\_CaseId                | Text         | 18     | Conditional  |                                                         |
| i42as\_\_InitiatedByLimioId    | Text         | 70     | Yes          |                                                         |
| i42as\_\_InitiatedByExternalId | Text         | 150    | Yes          |                                                         |
| i42as\_\_LimioOrder            | LongTextArea |        | Configurable | Can be added to the payload by Limio team upon request. |

### NEW\_GIFT\_ORDER

| Field                          | Data Type    | Length | Populated?   | Conditions/Details                                      |
| ------------------------------ | ------------ | ------ | ------------ | ------------------------------------------------------- |
| i42as\_\_OrderType             | Text         | 40     | Yes          |                                                         |
| i42as\_\_ChangeType            | Text         | 40     | Yes          |                                                         |
| i42as\_\_OrderNumber           | Text         | 40     | Yes          |                                                         |
| i42as\_\_OrderValue            | Number       |        | Yes          |                                                         |
| i42as\_\_PurchaseDate          | DateTime     |        | Yes          |                                                         |
| i42as\_\_EffectiveDate         | DateTime     |        | Yes          |                                                         |
| i42as\_\_SubscriptionId        | Text         | 100    | Yes          |                                                         |
| i42as\_\_Source                | Text         | 40     | Yes          | Populated as "Limio".                                   |
| i42as\_\_OrderSource           | Text         | 40     | Yes          | Populated with either "shop" or "salesforce".           |
| i42as\_\_InitiatedSource       | Text         | 40     | Yes          | Populated with either "shop" or "salesforce".           |
| i42as\_\_ContactId             | Text         | 18     | Conditional  | Populated in orders triggered from Salesforce.          |
| i42as\_\_AccountId             | Text         | 18     | Conditional  |                                                         |
| i42as\_\_CaseId                | Text         | 18     | Conditional  |                                                         |
| i42as\_\_InitiatedByLimioId    | Text         | 70     | Yes          |                                                         |
| i42as\_\_InitiatedByExternalId | Text         | 150    | Yes          |                                                         |
| i42as\_\_LimioOrder            | LongTextArea |        | Configurable | Can be added to the payload by Limio team upon request. |
| i42as\_\_OfferId               | Text         | 40     | Yes          |                                                         |
| i42as\_\_OfferType             | Text         | 40     | Yes          |                                                         |
| i42as\_\_TermLengthUnits       | Text         | 40     | Yes          |                                                         |
| i42as\_\_TermLengthValue       | Text         | 40     | Yes          |                                                         |
| i42as\_\_OfferDisplayName      | Text         | 100    | Conditional  | Populated if available in the offer setup.              |
| i42as\_\_DisplayPrice          | Text         | 150    | Conditional  |                                                         |
| i42as\_\_Description           | Text         | 100    | Conditional  |                                                         |
| i42as\_\_ProductCode           | Text         | 40     | Yes          |                                                         |
| i42as\_\_ProductName           | Text         | 40     | Yes          |                                                         |
| i42as\_\_purchaserContactId    | Text         | 100    | Yes          |                                                         |
| i42as\_\_purchaserFirstName    | Text         | 100    | Yes          |                                                         |
| i42as\_\_purchaserLastName     | Text         | 100    | Yes          |                                                         |
| i42as\_\_purchaserEmail        | Text         | 100    | Yes          |                                                         |
| i42as\_\_purchaserCountryCode  | Text         | 50     | Yes          |                                                         |
| i42as\_\_recipientFirstName    | Text         | 100    | Yes          |                                                         |
| i42as\_\_recipientLastName     | Text         | 100    | Yes          |                                                         |
| i42as\_\_recipientEmail        | Text         | 100    | Yes          |                                                         |
| i42as\_\_deliveryDate          | Text         | 25     | Conditional  | Populated if included in the order.                     |
| i42as\_\_giftMessage           | Text         | 255    | Conditional  |                                                         |
| i42as\_\_VoucherExpiryDate     | Text         | 25     | Yes          |                                                         |
| i42as\_\_redemptionCode        | Text         | 11     | Yes          |                                                         |
| i42as\_\_recipientAddressLine1 | Text         | 100    | Conditional  | Populated if included in the order.                     |
| i42as\_\_recipientAddressLine2 | Text         | 100    | Conditional  |                                                         |
| i42as\_\_recipientState        | Text         | 100    | Conditional  |                                                         |
| i42as\_\_recipientCity         | Text         | 100    | Conditional  |                                                         |
| i42as\_\_recipientPostcode     | Text         | 100    | Conditional  |                                                         |
| i42as\_\_recipientCountryCode  | Text         | 50     | Conditional  |                                                         |

### REFUND

| Field                          | Data Type    | Length | Populated?   | Conditions/Details                                      |
| ------------------------------ | ------------ | ------ | ------------ | ------------------------------------------------------- |
| i42as\_\_OrderType             | Text         | 40     | Yes          |                                                         |
| i42as\_\_ChangeType            | Text         | 40     | Yes          |                                                         |
| i42as\_\_OrderNumber           | Text         | 40     | Yes          |                                                         |
| i42as\_\_PurchaseDate          | DateTime     |        | Yes          |                                                         |
| i42as\_\_EffectiveDate         | DateTime     |        | Yes          |                                                         |
| i42as\_\_Reason                | Text         | 200    | Conditional  | Populated if present in the order.                      |
| i42as\_\_SubscriptionId        | Text         | 100    | Yes          |                                                         |
| i42as\_\_Source                | Text         | 40     | Yes          | Populated as "Limio".                                   |
| i42as\_\_OrderSource           | Text         | 40     | Yes          | Populated with either "shop" or "salesforce".           |
| i42as\_\_InitiatedSource       | Text         | 40     | Yes          | Populated with either "shop" or "salesforce".           |
| i42as\_\_ContactId             | Text         | 18     | Conditional  | Populated in orders triggered from Salesforce.          |
| i42as\_\_AccountId             | Text         | 18     | Conditional  |                                                         |
| i42as\_\_CaseId                | Text         | 18     | Conditional  |                                                         |
| i42as\_\_InitiatedByLimioId    | Text         | 70     | Yes          |                                                         |
| i42as\_\_InitiatedByExternalId | Text         | 150    | Yes          |                                                         |
| i42as\_\_LimioOrder            | LongTextArea |        | Configurable | Can be added to the payload by Limio team upon request. |
| i42as\_\_OfferId               | Text         | 40     | Yes          |                                                         |

### REQUEST\_RENEWAL

| Field Name                      | Data Type    | Length | Populated?   | Conditions/Details                                                                  |
| ------------------------------- | ------------ | ------ | ------------ | ----------------------------------------------------------------------------------- |
| i42as\_\_OrderType              | Text         | 40     | Yes          |                                                                                     |
| i42as\_\_ChangeType             | Text         | 40     | Yes          |                                                                                     |
| i42as\_\_OrderNumber            | Text         | 40     | Yes          |                                                                                     |
| i42as\_\_OrderValue             | Number       |        | Yes          |                                                                                     |
| i42as\_\_OrderCurrency          | Text         | 3      | Yes          |                                                                                     |
| i42as\_\_Status                 | Text         | 40     | Yes          |                                                                                     |
| i42as\_\_PurchaseDate           | DateTime     |        | Yes          |                                                                                     |
| i42as\_\_EffectiveDate          | DateTime     |        | Yes          |                                                                                     |
| i42as\_\_SubscriptionId         | Text         | 100    | Yes          |                                                                                     |
| i42as\_\_Source                 | Text         | 40     | Yes          | Populated as "Limio".                                                               |
| i42as\_\_OrderSource            | Text         | 40     | Yes          | Populated with either "shop" or "salesforce".                                       |
| i42as\_\_InitiatedSource        | Text         | 40     | Yes          | Populated with either "shop" or "salesforce".                                       |
| i42as\_\_ContactId              | Text         | 18     | Conditional  | Populated in orders triggered from Salesforce.                                      |
| i42as\_\_AccountId              | Text         | 18     | Conditional  |                                                                                     |
| i42as\_\_CaseId                 | Text         | 18     | Conditional  |                                                                                     |
| i42as\_\_InitiatedByLimioId     | Text         | 70     | Yes          |                                                                                     |
| i42as\_\_InitiatedByExternalId  | Text         | 150    | Yes          |                                                                                     |
| i42as\_\_LimioOrder             | LongTextArea |        | Configurable | Can be added to the payload by Limio team upon request.                             |
| i42as\_\_OfferId                | Text         | 40     | Yes          |                                                                                     |
| i42as\_\_OfferType              | Text         | 40     | Yes          |                                                                                     |
| i42as\_\_TermLengthUnits        | Text         | 40     | Yes          |                                                                                     |
| i42as\_\_TermLengthValue        | Text         | 40     | Yes          |                                                                                     |
| i42as\_\_OfferDisplayName       | Text         | 100    | Conditional  | Populated if available in the offer setup                                           |
| i42as\_\_DisplayPrice           | Text         | 150    | Conditional  |                                                                                     |
| i42as\_\_Description            | Text         | 100    | Conditional  |                                                                                     |
| i42as\_\_ProductCode            | Text         | 40     | Yes          |                                                                                     |
| i42as\_\_PreviousSubscriptionId | Text         | 30     | Yes          |                                                                                     |
| i42as\_\_CountryCode            | Text         | 30     | Yes          |                                                                                     |
| i42as\_\_StudentCourse          | Text         | 100    | Conditional  | Populated when `student_offer = true` and student fields were included at checkout. |
| i42as\_\_StudentUniversity      | Text         | 100    | Conditional  |                                                                                     |
| i42as\_\_StudentGraduationYear  | Text         | 4      | Conditional  |                                                                                     |

### CHANGED\_DELIVERY\_ADDRESS

| Field Name                     | Data Type    | Length | Populated?   | Conditions/Details                                      |
| ------------------------------ | ------------ | ------ | ------------ | ------------------------------------------------------- |
| i42as\_\_OrderType             | Text         | 40     | Yes          |                                                         |
| i42as\_\_ChangeType            | Text         | 40     | Yes          |                                                         |
| i42as\_\_PurchaseDate          | DateTime     | 40     | Yes          |                                                         |
| i42as\_\_EffectiveDate         | DateTime     |        | Yes          |                                                         |
| i42as\_\_SubscriptionId        | Text         | 100    | Yes          |                                                         |
| i42as\_\_Source                | Text         | 40     | Yes          | Populated as "Limio".                                   |
| i42as\_\_OrderSource           | Text         | 40     | Yes          | Populated with either "shop" or "salesforce".           |
| i42as\_\_InitiatedSource       | Text         | 40     | Yes          | Populated with either "shop" or "salesforce".           |
| i42as\_\_ContactId             | Text         | 18     | Conditional  | Populated in orders triggered from Salesforce           |
| i42as\_\_AccountId             | Text         | 18     | Conditional  |                                                         |
| i42as\_\_CaseId                | Text         | 18     | Conditional  |                                                         |
| i42as\_\_InitiatedByLimioId    | Text         | 70     | Yes          |                                                         |
| i42as\_\_InitiatedByExternalId | Text         | 150    | Yes          |                                                         |
| i42as\_\_LimioOrder            | LongTextArea |        | Configurable | Can be added to the payload by Limio team upon request. |
| i42as\_\_EventTimestamp\_\_c   | Text         | 25     | Yes          |                                                         |

### UPDATE\_CUSTOMER

| Field Name                     | Data Type    | Length | Populated?   | Conditions/Details                                      |
| ------------------------------ | ------------ | ------ | ------------ | ------------------------------------------------------- |
| i42as\_\_OrderType             | Text         | 40     | Yes          |                                                         |
| i42as\_\_ChangeType            | Text         | 40     | Yes          |                                                         |
| i42as\_\_OrderNumber           | Text         | 40     | Yes          |                                                         |
| i42as\_\_PurchaseDate          | DateTime     |        | Yes          |                                                         |
| i42as\_\_Source                | Text         | 40     | Yes          | Populated as "Limio".                                   |
| i42as\_\_OrderSource           | Text         | 40     | Yes          | Populated with either "shop" or "salesforce".           |
| i42as\_\_InitiatedSource       | Text         | 40     | Yes          | Populated with either "shop" or "salesforce".           |
| i42as\_\_InitiatedByLimioId    | Text         | 70     | Yes          |                                                         |
| i42as\_\_InitiatedByExternalId | Text         | 150    | Yes          |                                                         |
| i42as\_\_LimioOrder            | LongTextArea |        | Configurable | Can be added to the payload by Limio team upon request. |

### UPDATE\_SUBSCRIPTION

| Field Name                     | Data Type    | Length | Populated?   | Conditions/Details                                       |
| ------------------------------ | ------------ | ------ | ------------ | -------------------------------------------------------- |
| i42as\_\_OrderType             | Text         | 40     | Yes          |                                                          |
| i42as\_\_ChangeType            | Text         | 40     | Yes          |                                                          |
| i42as\_\_OrderNumber           | Text         | 40     | Yes          |                                                          |
| i42as\_\_PurchaseDate          | DateTime     |        | Yes          |                                                          |
| i42as\_\_Source                | Text         | 40     | Yes          | Populated as "Limio".                                    |
| i42as\_\_OrderSource           | Text         | 40     | Yes          | Populated with either "shop" or "salesforce".            |
| i42as\_\_InitiatedSource       | Text         | 40     | Yes          | Populated with either "shop" or "salesforce".            |
| i42as\_\_InitiatedByLimioId    | Text         | 70     | Yes          |                                                          |
| i42as\_\_InitiatedByExternalId | Text         | 150    | Yes          |                                                          |
| i42as\_\_SubscriptionId        | Text         | 100    | Yes          |                                                          |
| i42as\_\_NewPrice              | Text         | 40     | Yes          |                                                          |
| i42as\_\_NewTermLength         | Number       |        | Yes          |                                                          |
| i42as\_\_NewTermType           | Text         | 40     | Yes          | Populated with either "days", "weeks", "moths" or "years |
| i42as\_\_PreviousPrice         | Text         | 40     | Yes          |                                                          |
| i42as\_\_PreviousTermLength    | Number       |        | Yes          |                                                          |
| i42as\_\_PreviousTermType      | Text         | 40     | Yes          | Populated with either "days", "weeks", "moths" or "years |
| i42as\_\_Currency              | Text         | 3      | Yes          |                                                          |
| i42as\_\_LimioOrder            | LongTextArea |        | Configurable | Can be added to the payload by Limio team upon request.  |

### DATA\_CAPTURE

| Field Name          | Data Type    | Length | Populated?  | Conditions/Details                                                                                                                                                                              |
| ------------------- | ------------ | ------ | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| i42as\_\_Type       | Text         | 40     | Yes         | Populated as "DATA\_CAPTURE".                                                                                                                                                                   |
| i42as\_\_LimioOrder | LongTextArea |        | Yes         | Contains JSON string of the form data submitted by the customer (e.g., `{"firstName": "John", "companySize": "50-100"}`). Only the form field values are included, not the full order metadata. |
| i42as\_\_AccountId  | Text         | 18     | Conditional | Populated if the customer has an existing Salesforce Account (from previous purchase or if logged in).                                                                                          |
| i42as\_\_ContactId  | Text         | 18     | Conditional | Populated if the customer has an existing Salesforce Contact.                                                                                                                                   |

**Note:** This event is generated when customers submit a Data Capture event from the Data Capture Form component, typically used for collecting additional information without creating a subscription (e.g., post-order data collection, change/cancel requests, feedback forms).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.limio.com/integrations/populating-salesforce-data/platform-events-flexible/platform-events-definitions.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
