source.expiring

The source.expiring event is triggered whenever a card or source will expire at the end of the month. This event can be used to inform the client that their Payment source is about to expire and that they need to update it soon.

The payload can vary based on the payment gateway tied to your account, see all variations below:

{
  "type": "source.expiring",
  "id": "evt_hJfeFJQZEwKWqxaDT4WYIyLf",
  "created": 1679397807,
  "data": {
    "object": {
      "object": "source",
      "id": 510782,
      "object_id": "src_1Mg5DGAQMlpW1iAwE570JVmT",
      "object_gateway": "stripe",
      "address_line1_check": "pass",
      "address_zip_check": "pass",
      "brand": "Visa",
      "country": "US",
      "cvc_check": "pass",
      "dynamic_last4": null,
      "exp_month": 3,
      "exp_year": 2024,
      "funding": "credit",
      "last4": "0341",
      "name": null,
      "three_d_secure": "optional",
      "tokenization_method": null,
      "site_ids": [
        699
      ],
      "customer": {
        "id": 3408,
        "name": "Customer Name",
        "email": "[email protected]"
      }
    }
  }
}

{
  "type": "source.expiring",
  "id": "evt_hJfeFJQZEwKWqxaDT4WYIyLf",
  "created": 1679397807,
  "data": {
    "object": {
      "object": "source",
      "id": 510782,
      "object_id": "2961278608024242",
      "object_gateway": "vantiv",
      "brand": "Visa",
      "exp_month": 3,
      "exp_year": 2024,
      "last4": "0341",
      "site_ids": [
        699
      ],
      "customer": {
        "id": 3408,
        "name": "Customer Name",
        "email": "[email protected]"
      }
    }
  }
}

{
  "type": "source.expiring",
  "id": "evt_hJfeFJQZEwKWqxaDT4WYIyLf",
  "created": 1679397807,
  "data": {
    "object": {
      "object": "source",
      "id": 510782,
      "object_id": "F9BA19EA82E7B040E053AF598E0AF8AF",
      "object_gateway": "cybersource",
      "brand": "Visa",
      "exp_month": 3,
      "exp_year": 2024,
      "last4": "0341",
      "site_ids": [
        699
      ],
      "customer": {
        "id": 3408,
        "name": "Customer Name",
        "email": "[email protected]"
      }
    }
  }
}

{
  "type": "source.expiring",
  "id": "evt_hJfeFJQZEwKWqxaDT4WYIyLf",
  "created": 1679397807,
  "data": {
    "object": {
      "object": "source",
      "id": 510782,
      "object_id": "EEhL5pGvFrRIl20D%2BPJutCDx44uDhyLRVhNp6ytX7IU%3D",
      "object_gateway": "tap",
      "brand": "Visa",
      "exp_month": 3,
      "exp_year": 2024,
      "last4": "0341",
      "site_ids": [
        699
      ],
      "customer": {
        "id": 3408,
        "name": "Customer Name",
        "email": "[email protected]"
      }
    }
  }
}