Events
Query the available events in Stripe.
Table Specific Information
Select
Server-Side Query Support
The cmdlet uses the Stripe API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the cmdlet.
- Id, Type and AccountId support the following operator: =.
- Created supports the following operators: <, >, >=, <, <=, =.
You can select:
An event by specifying its Id:
SELECT * FROM Events WHERE Id = 'dp_12345678'
Events that happened after a specific date (Created may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range):
SELECT * FROM Events WHERE Created > '2016-01-03'
Columns
Name | Type | References | Description |
Id [KEY] | String | The Id of the event. | |
ApiVersion | String | The Stripe API version used to render data. | |
Created | Datetime | The datetime event was created. | |
ObjectId | String | The event Id. | |
ObjectName | String | The object name for which event occured. | |
Livemode | Boolean | Tells if the event is in livemode. | |
PendingWebhooks | Integer | The number of webhooks yet to be delivered successfully (return a 20x response) to the URLs you've specified. | |
RequestId | String | The Id of the API request that caused the event. | |
RequestIdempotencyKey | String | The idempotency key transmitted during the request, if any. Note: This property is populated only for events on or after May 23, 2017. | |
Type | String | The description of the event. | |
Description | String | An arbitrary string attached to the object. Often useful for displaying to users.The description field on invoice line items has a maximum character length limit of 500 | |
PreviousAttributes | String | Object containing the names of the attributes that have changed. | |
DataObject | String | Object containing the API resource relevant to the event. | |
DataObjectAmount | Integer | Data object amount. | |
DataObjectAmountCapturable | Integer | Data object capturable amount. | |
DataObjectAmountDetails | String | Data object amount details. | |
DataObjectAmountReceived | Integer | Data object received amount. | |
DataObjectApplication | String | Data object application. | |
DataObjectApplicationFeeAmount | String | Data object application fee amount. | |
DataObjectAutomaticPaymentMethods | String | Data object automatic payment methods. | |
DataObjectCanceledAt | Datetime | Canceled At. | |
DataObjectCancellationReason | String | Cancellation reason. | |
DataObjectCaptureMethod | String | Capture Method. | |
DataObjectClientSecret | String | Client secret. | |
DataObjectConfirmationMethod | String | Confirmation method. | |
DataObjectCreated | Datetime | Created timestamp. | |
DataObjectCurrency | String | Currency code. | |
DataObjectCustomer | String | Customer Id. | |
DataObjectDescription | String | Description. | |
DataObjectInvoice | String | Invoice Id of the data object. | |
DataObjectLastPaymentError | String | Last payment error. | |
DataObjectLatestCharge | String | Latest charge. | |
DataObjectLivemode | Boolean | Boolean value of livemode. | |
DataObjectMetadata | String | Metadata. | |
DataObjectNextAction | String | Next action details. | |
DataObjectOnBehalfOf | String | On behalf of. | |
DataObjectPaymentMethod | String | Payment method. | |
DataObjectPaymentMethodConfigurationDetails | String | Payment method configuration details. | |
DataObjectPaymentMethodOptions | String | Payment method options. | |
DataObjectPaymentMethodTypes | String | Payment method types. | |
DataObjectProcessing | String | Processing. | |
DataObjectReceiptEmail | String | Receipt email. | |
DataObjectReview | String | Review. | |
DataObjectSetupFutureUsage | String | Setup future usage. | |
DataObjectShipping | String | Shipping details. | |
DataObjectSource | String | Source. | |
DataObjectStatementDescriptor | String | Statement descriptor. | |
DataObjectStatementDescriptorSuffix | String | Statement descriptor suffix. | |
DataObjectStatus | String | Status. | |
DataObjectTransferData | String | Transfer data. | |
DataObjectTransferGroup | String | Transfer group. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
AccountId | String | The Id of the connected account to get events for. |