Mayson Monorepo Documentation
    Preparing search index...

    Events are generated to keep you informed of activity in your business account. APIs in the /v2 namespace generate 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 for additional data about the event. Use the related object ID in the event payload to fetch the API resource 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.

    interface EventBase {
        id: string;
        object: "v2.core.event";
        changes?: Changes;
        context?: string;
        created: string;
        livemode: boolean;
        reason?: Stripe.V2.Core.Event.Reason;
        type: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    id: string

    Unique identifier for the event.

    object: "v2.core.event"

    String representing the object's type. Objects of the same type share the same value of the object field.

    changes?: Changes

    Before and after changes for the primary related object.

    context?: string

    Authentication context needed to fetch the event or related object.

    created: string

    Time at which the object was created.

    livemode: boolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    Reason for the event.

    type: string

    The type of the event.