GET | list (all), fetch (individual Event)
POST | create (individual Event), update (individual Event)
Attributes
| Name | Type | Description |
|---|---|---|
| object | string | Value is “Event” |
| id | string | A merchant-specified unique identifier. Optionally, this object can be identified by its vid. |
| vid | string | A Globally Unique Identifier (GUID) for this object. This field is created by Subscribe |
| date_received | datetime | The date/time at which the event was recorded into Subscribe. |
| event_date | datetime | The date/time at which the event occurred (for billing purposes). |
| description | string | A Merchant-specified description of the event. |
| subscription_item | Subscription Item | The subscription item under which the event is to be recorded and billed. |
| account | Account | The account associated with the recorded event. |
| subscription | Subscription | The subscription associated with the recorded event. |
| product | Product | The product under which the event is to be recorded and billed. |
| amount | decimal | The amount of usage units to be billed. |
| billed_status | enum | Value can be Billed, Unbilled |
| metadata | hash | A set of key/value pairs that you can attach to an object. Useful for storing additional information. |
Example Object
{
"object": "Event",
"id": "c720b8c1ae181e75a7574e4a05bd43b865c75a64",
"vid": "c720b8c1ae181e75a7574e4a05bd43b865c75a64",
"date_received": "2020-01-13T10:46:33-08:00",
"event_date": "2020-01-13T00:00:00-08:00",
"subscription_item": {
"object": "SubscriptionItem",
"vid": "a4293a900b5b8c96b2b02893595da153c1aba0cc"
},
"account": {
"object": "Account",
"id": "Account 15",
"vid": "eead84014a7dce4121b5450d23067b0458f4fd59"
},
"subscription": {
"object": "Subscription",
"id": "Test 05",
"vid": "279ff7f98ac4a70bfcc1e5762f6badcadba15114"
},
"product": {
"object": "Product",
"id": "Basic $100 Product",
"vid": "a0a793e4498f22a827599fdcce1832fd81b9e939"
},
"billed_status": "Billed"
}