action stripe_get_events {
  label: "GetEvents"
  description: "<p>List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in <a href=\"/docs/api/events/object\">event object</a> <code>api_version</code> attribute (not according to your current Stripe API version or <code>Stripe-Version</code> header).</p>"
  provider: stripe
  method: GET
  path: "/v1/events"
  encoding: form
  input: {
    type: "object"
    properties: {
      created: {
        type: "object"
      }
      delivery_success: {
        type: "boolean"
      }
      ending_before: {
        type: "string"
      }
      expand: {
        type: "array"
        items: {
          type: "string"
        }
      }
      limit: {
        type: "integer"
      }
      starting_after: {
        type: "string"
      }
      type: {
        type: "string"
      }
      types: {
        type: "array"
        items: {
          type: "string"
        }
      }
    }
    additionalProperties: false
  }
  output: {
    type: "object"
    required: ["data", "has_more", "object", "url"]
    properties: {
      data: {
        type: "array"
        items: {
          type: "object"
          description: "Events are our way of letting you know when something interesting happens in\nyour account. When an interesting event occurs, we create a new `Event`\nobject. For example, when a charge succeeds, we create a `charge.succeeded`\nevent; and when an invoice payment attempt fails, we create an\n`invoice.payment_failed` event. Note that many API requests may cause multiple\nevents to be created. For example, if you create a new subscription for a\ncustomer, you will receive both a `customer.subscription.created` event and a\n`charge.succeeded` event.\n\nEvents occur when the state of another API resource changes. The state of that\nresource at the time of the change is embedded in the event's data field. For\nexample, a `charge.succeeded` event will contain a charge, and an\n`invoice.payment_failed` event will contain an invoice.\n\nAs with other API resources, you can use endpoints to retrieve an\n[individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events)\nfrom the API. We also have a separate\n[webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the\n`Event` objects directly to an endpoint on your server. Webhooks are managed\nin your\n[account settings](https://dashboard.stripe.com/account/webhooks),\nand our [Using Webhooks](https://stripe.com/docs/webhooks) guide will help you get set up.\n\nWhen using [Connect](https://stripe.com/docs/connect), you can also receive notifications of\nevents that occur in connected accounts. For these events, there will be an\nadditional `account` attribute in the received `Event` object.\n\n**NOTE:** Right now, access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event) is\nguaranteed only for 30 days."
          required: ["created", "data", "id", "livemode", "object", "pending_webhooks", "type"]
          properties: {
            account: {
              type: "string"
              description: "The connected account that originated the event."
            }
            api_version: {
              type: "string"
              description: "The Stripe API version used to render `data`. *Note: This property is populated only for events on or after October 31, 2014*."
            }
            created: {
              type: "integer"
              format: "unix-time"
              description: "Time at which the object was created. Measured in seconds since the Unix epoch."
            }
            data: {
              type: "object"
              required: ["object"]
              properties: {
                object: {
                  type: "object"
                  description: "Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://stripe.com/docs/api#invoice_object) as the value of the object key."
                }
                previous_attributes: {
                  type: "object"
                  description: "Object containing the names of the attributes that have changed, and their previous values (sent along only with *.updated events)."
                }
              }
            }
            id: {
              type: "string"
              description: "Unique identifier for the object."
            }
            livemode: {
              type: "boolean"
              description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."
            }
            object: {
              type: "string"
              description: "String representing the object's type. Objects of the same type share the same value."
              enum: ["event"]
            }
            pending_webhooks: {
              type: "integer"
              description: "Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified."
            }
            request: {
              description: "Information on the API request that instigated the event."
              type: "object"
            }
            type: {
              type: "string"
              description: "Description of the event (e.g., `invoice.created` or `charge.refunded`)."
            }
          }
        }
      }
      has_more: {
        type: "boolean"
        description: "True if this list has another page of items after this one that can be fetched."
      }
      object: {
        type: "string"
        description: "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        enum: ["list"]
      }
      url: {
        type: "string"
        description: "The URL where this list can be accessed."
      }
    }
  }
}