stripekit::EventEnvelope Struct Reference

A Stripe event, as delivered by a webhook. More...

#include <Models.h>

Public Attributes
std::string	id
	Stripe event identifier, of the form "evt_...".
std::string	type
	What happened, for example "invoice.paid".
std::string	api_version
	Stripe API version the payload is formatted for.
std::int64_t	created_unix = 0
	Unix timestamp of when the event occurred in Stripe.
bool	livemode = false
	True when the event belongs to a live Stripe account.
std::string	request_id
	Id of the API request that caused the event, when there was one.
std::string	account
	Connected account the event belongs to, when using Stripe Connect.
std::string	payload_json
	Stripe's raw JSON for the whole event.

Detailed Description

A Stripe event, as delivered by a webhook.

type says what happened; payload_json holds Stripe's raw JSON for the event, which is where to look for any detail StripeKit does not model.

See also

https://docs.stripe.com/api/events/object

Webhooks

Definition at line 196 of file Models.h.

Member Data Documentation

id

std::string stripekit::EventEnvelope::id

Stripe event identifier, of the form "evt_...".

Definition at line 198 of file Models.h.

type

std::string stripekit::EventEnvelope::type

What happened, for example "invoice.paid".

Definition at line 201 of file Models.h.

api_version

std::string stripekit::EventEnvelope::api_version

Stripe API version the payload is formatted for.

Definition at line 204 of file Models.h.

created_unix

std::int64_t stripekit::EventEnvelope::created_unix = 0

Unix timestamp of when the event occurred in Stripe.

Definition at line 207 of file Models.h.

livemode

bool stripekit::EventEnvelope::livemode = false

True when the event belongs to a live Stripe account.

Definition at line 210 of file Models.h.

request_id

std::string stripekit::EventEnvelope::request_id

Id of the API request that caused the event, when there was one.

Definition at line 213 of file Models.h.

account

std::string stripekit::EventEnvelope::account

Connected account the event belongs to, when using Stripe Connect.

Definition at line 216 of file Models.h.

payload_json

std::string stripekit::EventEnvelope::payload_json

Stripe's raw JSON for the whole event.

Parse this when the handler needs a field the models above do not carry.

Definition at line 223 of file Models.h.

---

The documentation for this struct was generated from the following file:

• include/StripeKit/Models.h