> ## Documentation Index
> Fetch the complete documentation index at: https://docs.slm.m1amdocs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Event Subobject

Defines a single reported Rate Plan Event, including the time stamp and billing status, and the `Account`, `AutoBill`, `AutoBillItem`, or `Product` with which the Event is associated.

`Events` are associated with `AutoBillItems`, in that a single `AutoBillItem` may contain an array of `Events`, but each `Event` is contained in only one `AutoBillItem`.

When defining an `Event`, associate it with a single, unique `AutoBillItem`. The `AutoBillItem` may be identified using any combination of the following objects’ identifiers: `Account`, `AutoBill`, `AutoBillItem`, or `Product`. Subscribe requires that at least one of the following three data members be specified: `Account`, AutoBill, or `AutoBillItem`.

When an `Event` object is returned, Subscribe will populate both the VID and the ID for each of the four objects listed above, from the information contained in the database for the specified `AutoBillItem`.

If, when reporting an `Event`, more than one `AutoBillItem` fits the description, Subscribe will return an error.

| Value | Data Type | Description |
| - | - | - |
| `accountVid` | string | Lists the VID for the Account associated with the Event. (Returned for Event fetches.) |
| `amount` | decimal | The number of Rated Units (as defined by the Rate Plan) used by this Event. |
| `autoBillItemVid` | string | Vindicia's unique name (VID) for the `Event`. Either `merchantAutoBillItemId` or `autoBillItemVid` must be defined for each Event. |
| `autoBillVid` | string | Vindicia's unique name (VID) for the `AutoBill.` |
| `billedStatus` | `BilledStatus` | A read-only object of type `BilledStatus`, which describes whether the `Event` has been billed, and which includes one of two values: - `Billed`: the Event has been included in a Billing Statement. - `Unbilled`: the Event has not yet been included in a Billing Statement. |
| `dateReceived` | dateTime | A read-only field which lists the date/time that Subscribe received the Event. |
| `description` | string | **Optional.** A description of the `Event`. |
| `merchantAccountId` | string | Lists the `merchantAccountId` associated with the `Event`. (Returned for `Event` fetches.) |
| | string | Your unique ID for the `AutoBill` associated with the `Event`. |
| `merchantAutoBillItemId` | string | Your unique ID for the `AutoBillItem` associated with the `Event`. Either `merchantAutoBillItemId` or `autoBillItemVid` must be defined for each `Event`. |
| `merchantProductId` | string | Your unique ID for the `Product` associated with the `Event`. |
| `merchantEventId` | string | **Optional.** Your unique ID for the `Event`. Each `merchantEventId` must be unique. If omitted, Subscribe will automatically populate this field. |
| `nameValues` | `NameValuePair` | **Optional.** An array of name-value pair items specific to this `Event`. See [The NameValuePair Object](The_NameValuePair_Object). |
| `productVid` | string | Vindicia's unique name (VID) for the `Product` . |
| `eventDate` | dateTime | The date/time that the `Event` was (or will be) considered billable. By default, this field is populated with the date/time from `dateReceived`. Enter a different date if necessary. |
| `VID` | string | Vindicia's Globally Unique Identifier (GUID) for this object. When creating a new `Event` object, leave this field blank; it will be automatically populated by Subscribe. |
| **Parent topic:**[RatePlan Subobjects](../topics/RatePlan_Subobjects) | | |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.