You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
"description" : "Retrieves the details of an event.",
27
28
"operationId" : "GetV2CoreEventsId",
28
29
"parameters" : [ {
@@ -65,6 +66,7 @@
65
66
},
66
67
"/v2/billing/meter_event_session" : {
67
68
"post" : {
69
+
"summary" : "Create a meter event session",
68
70
"description" : "Creates a meter event session to send usage on the high-throughput meter event stream. Authentication tokens are only valid for 15 minutes, so you will need to create a new meter event session when your token expires.",
"description" : "Create a new event destination.",
373
381
"operationId" : "PostV2CoreEventDestinations",
374
382
"requestBody" : {
@@ -491,6 +499,7 @@
491
499
},
492
500
"/v2/billing/meter_events" : {
493
501
"post" : {
502
+
"summary" : "Create a meter event",
494
503
"description" : "Creates a meter event. Events are validated synchronously, but are processed asynchronously. Supports up to 1,000 events per second in livemode. For higher rate-limits, please use meter event streams instead.",
495
504
"operationId" : "PostV2BillingMeterEvents",
496
505
"requestBody" : {
@@ -567,27 +576,39 @@
567
576
},
568
577
"/v2/core/events" : {
569
578
"get" : {
579
+
"summary" : "List all events",
570
580
"description" : "List events, going back up to 30 days.",
571
581
"operationId" : "GetV2CoreEvents",
572
582
"parameters" : [ {
573
-
"name" : "gt",
583
+
"name" : "created",
574
584
"in" : "query",
575
-
"description" : "Filter for events created after the specified timestamp.",
585
+
"description" : "Set of filters to query events within a range of `created` timestamps.",
576
586
"required" : false,
577
-
"style" : "simple",
578
-
"schema" : {
579
-
"type" : "string",
580
-
"format" : "date-time"
581
-
}
582
-
}, {
583
-
"name" : "gte",
584
-
"in" : "query",
585
-
"description" : "Filter for events created at or after the specified timestamp.",
586
-
"required" : false,
587
-
"style" : "simple",
587
+
"style" : "deepObject",
588
588
"schema" : {
589
-
"type" : "string",
590
-
"format" : "date-time"
589
+
"type" : "object",
590
+
"properties" : {
591
+
"gt" : {
592
+
"type" : "string",
593
+
"description" : "Filter for events created after the specified timestamp.",
594
+
"format" : "date-time"
595
+
},
596
+
"gte" : {
597
+
"type" : "string",
598
+
"description" : "Filter for events created at or after the specified timestamp.",
599
+
"format" : "date-time"
600
+
},
601
+
"lt" : {
602
+
"type" : "string",
603
+
"description" : "Filter for events created before the specified timestamp.",
604
+
"format" : "date-time"
605
+
},
606
+
"lte" : {
607
+
"type" : "string",
608
+
"description" : "Filter for events created at or before the specified timestamp.",
609
+
"format" : "date-time"
610
+
}
611
+
}
591
612
}
592
613
}, {
593
614
"name" : "limit",
@@ -598,26 +619,6 @@
598
619
"schema" : {
599
620
"type" : "integer"
600
621
}
601
-
}, {
602
-
"name" : "lt",
603
-
"in" : "query",
604
-
"description" : "Filter for events created before the specified timestamp.",
605
-
"required" : false,
606
-
"style" : "simple",
607
-
"schema" : {
608
-
"type" : "string",
609
-
"format" : "date-time"
610
-
}
611
-
}, {
612
-
"name" : "lte",
613
-
"in" : "query",
614
-
"description" : "Filter for events created at or before the specified timestamp.",
615
-
"required" : false,
616
-
"style" : "simple",
617
-
"schema" : {
618
-
"type" : "string",
619
-
"format" : "date-time"
620
-
}
621
622
}, {
622
623
"name" : "object_id",
623
624
"in" : "query",
@@ -697,6 +698,7 @@
697
698
},
698
699
"/v2/core/event_destinations/{id}" : {
699
700
"get" : {
701
+
"summary" : "Retrieve an event destination",
700
702
"description" : "Retrieves the details of an event destination.",
701
703
"operationId" : "GetV2CoreEventDestinationsId",
702
704
"parameters" : [ {
@@ -750,6 +752,7 @@
750
752
}
751
753
},
752
754
"post" : {
755
+
"summary" : "Update an event destination",
753
756
"description" : "Update the details of an event destination.",
"description" : "The payload of the event. This must contain the fields corresponding to a meter’s\n`customer_mapping.event_payload_key` (default is `stripe_customer_id`) and\n`value_settings.event_payload_key` (default is `value`). Read more about the payload."
1120
+
"description" : "The payload of the event. This must contain the fields corresponding to a meter’s\n`customer_mapping.event_payload_key` (default is `stripe_customer_id`) and\n`value_settings.event_payload_key` (default is `value`). Read more about\nthe [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).."
1117
1121
},
1118
1122
"timestamp" : {
1119
1123
"type" : "string",
@@ -1258,14 +1262,14 @@
1258
1262
"description" : "Time at which the object was created.",
1259
1263
"format" : "date-time"
1260
1264
},
1261
-
"data" : {
1262
-
"type" : "object",
1263
-
"description" : "Additional data about the event."
1264
-
},
1265
1265
"id" : {
1266
1266
"type" : "string",
1267
1267
"description" : "Unique identifier for the event."
1268
1268
},
1269
+
"livemode" : {
1270
+
"type" : "boolean",
1271
+
"description" : "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."
1272
+
},
1269
1273
"object" : {
1270
1274
"type" : "string",
1271
1275
"description" : "String representing the object's type. Objects of the same type share the same value of the object field.",
@@ -1298,32 +1302,9 @@
1298
1302
},
1299
1303
"description" : "Reason for the event."
1300
1304
},
1301
-
"related_object" : {
1302
-
"required" : [ "id", "type", "url" ],
1303
-
"type" : "object",
1304
-
"properties" : {
1305
-
"id" : {
1306
-
"type" : "string",
1307
-
"description" : "Unique identifier for the object relevant to the event."
1308
-
},
1309
-
"type" : {
1310
-
"type" : "string",
1311
-
"description" : "Object tag of the resource relevant to the event."
1312
-
},
1313
-
"url" : {
1314
-
"type" : "string",
1315
-
"description" : "URL to retrieve the resource."
1316
-
}
1317
-
},
1318
-
"description" : "Object containing the reference to API resource relevant to the event."
1319
-
},
1320
1305
"type" : {
1321
1306
"type" : "string",
1322
1307
"description" : "The type of the event."
1323
-
},
1324
-
"livemode" : {
1325
-
"type" : "boolean",
1326
-
"description" : "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."
1327
1308
}
1328
1309
},
1329
1310
"description" : "Events are generated to keep you informed of activity in your business account. APIs in the /v2 namespace generate [thin events](https://docs.stripe.com/event-destinations#benefits-of-thin-events) which have small, unversioned payloads that include a reference to the ID of the object that has changed. The Events v2 API returns these new thin events. [Retrieve the event object](https://docs.stripe.com/event-destinations#fetch-data) for additional data about the event. Use the related object ID in the event payload to [fetch the API resource](https://docs.stripe.com/event-destinations#retrieve-the-object-associated-with-thin-events) of the object associated with the event. Comparatively, events generated by most API v1 include a versioned snapshot of an API object in their payload.",
0 commit comments