Ping an event destination v2

Send a ping event to an event destination.

Learn more about calling API v2 endpoints.

Parameters

idstringRequired
Identifier for the event destination to ping.

Returns

Response attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

datanullable object
Additional data about the event.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring
The type of the event.

Error Codes

404not_found

The resource wasn’t found.

POST /v2/core/event_destinations/:id/ping

Server-side language

curl -X POST https://api.stripe.com/v2/core/event_destinations/evt_test_65RM8sQH2oXnebF5Rpc16RJyfa2xSQLHJJh1sxm7H0KI92/ping \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-08-27.preview"

Response

{
  "id": "evt_test_65RM8sQH2oXnebF5Rpc16RJyfa2xSQLHJJh1sxm7H0KI92",
  "object": "v2.core.event",
  "context": null,
  "created": "2024-10-22T16:26:54.063Z",
  "data": null,
  "livemode": false,
  "reason": null,
  "related_object": {
    "id": "ed_test_61RM8ltWcTW4mbsxf16RJyfa2xSQLHJJh1sxm7H0KVT6",
    "type": "event_destination",
    "url": "/v2/core/event_destinations/ed_test_61RM8ltWcTW4mbsxf16RJyfa2xSQLHJJh1sxm7H0KVT6"
  },
  "type": "v2.core.event_destination.ping"
}

Types of events v2

This is a list of all public thin events we currently send for /v1 and /v2 resources, which are continually evolving and expanding. The payload of thin events is unversioned. During processing, you must fetch the versioned event from the API or fetch the resource’s current state.

Event types

Type

Filter events by type

Type

Related object: Cadence; and 13 more

v1.billing.meter.error_report_triggered

Occurs when a Meter has invalid async usage events.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v1.billing.meter.error_report_triggered"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

v1.billing.meter.no_meter_found

Occurs when a Meter's id is missing or invalid in async usage events.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v1.billing.meter.no_meter_found"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

v2.billing.cadence.billed

Occurs when a billing Cadence generates an invoice.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.cadence.billed"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.cadence.billed",
  "livemode": true,
  "related_object": {
    "id": "bc_61SJgWTDAcSAQ2Bms16RuKJoESSQUtPVJKIgeI4D24Lb",
    "type": "v2.billing.cadence",
    "url": "/v2/billing/cadences/bc_61SJgWTDAcSAQ2Bms16RuKJoESSQUtPVJKIgeI4D24Lb"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.cadence.billed",
  "livemode": true,
  "related_object": {
    "id": "bc_61SJgWTDAcSAQ2Bms16RuKJoESSQUtPVJKIgeI4D24Lb",
    "type": "v2.billing.cadence",
    "url": "/v2/billing/cadences/bc_61SJgWTDAcSAQ2Bms16RuKJoESSQUtPVJKIgeI4D24Lb"
  },
  "data": {}
}

v2.billing.cadence.canceled

Occurs when a billing Cadence is canceled.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.cadence.canceled"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJfWXBiV9sH3eqG9Z16RuKJoESSQUtPVJKIgeI4D28xU",
  "object": "v2.core.event",
  "type": "v2.billing.cadence.canceled",
  "livemode": true,
  "related_object": {
    "id": "bc_61SJfVSCzbRzP1Als16RuKJoESSQUtPVJKIgeI4D23Ka",
    "type": "v2.billing.cadence",
    "url": "/v2/billing/cadences/bc_61SJfVSCzbRzP1Als16RuKJoESSQUtPVJKIgeI4D23Ka"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJfWXBiV9sH3eqG9Z16RuKJoESSQUtPVJKIgeI4D28xU",
  "object": "v2.core.event",
  "type": "v2.billing.cadence.canceled",
  "livemode": true,
  "related_object": {
    "id": "bc_61SJfVSCzbRzP1Als16RuKJoESSQUtPVJKIgeI4D23Ka",
    "type": "v2.billing.cadence",
    "url": "/v2/billing/cadences/bc_61SJfVSCzbRzP1Als16RuKJoESSQUtPVJKIgeI4D23Ka"
  },
  "data": {}
}

v2.billing.cadence.created

Occurs when a billing Cadence is created.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.cadence.created"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SKkl34vlR6d24Hm1n16RuKJoESSQUtPVJKIgeI4D2UUi",
  "object": "v2.core.event",
  "type": "v2.billing.cadence.created",
  "livemode": true,
  "related_object": {
    "id": "bc_61SKkl26v5dA6DMUC16RuKJoESSQUtPVJKIgeI4D26uW",
    "type": "v2.billing.cadence",
    "url": "/v2/billing/cadences/bc_61SKkl26v5dA6DMUC16RuKJoESSQUtPVJKIgeI4D26uW"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SKkl34vlR6d24Hm1n16RuKJoESSQUtPVJKIgeI4D2UUi",
  "object": "v2.core.event",
  "type": "v2.billing.cadence.created",
  "livemode": true,
  "related_object": {
    "id": "bc_61SKkl26v5dA6DMUC16RuKJoESSQUtPVJKIgeI4D26uW",
    "type": "v2.billing.cadence",
    "url": "/v2/billing/cadences/bc_61SKkl26v5dA6DMUC16RuKJoESSQUtPVJKIgeI4D26uW"
  },
  "data": {
    "created": "2025-01-01T00:00:00.000Z"
  }
}

v2.billing.cadence.errored

Occurs when a billing Cadence encounters an error during a tick.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.cadence.errored"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJeVWAhU8rG2dpF8Z16RuKJoESSQUtPVJKIgeI4D27wT",
  "object": "v2.core.event",
  "type": "v2.billing.cadence.errored",
  "livemode": true,
  "related_object": {
    "id": "bc_61SJeURByaQyO0zks16RuKJoESSQUtPVJKIgeI4D22JZ",
    "type": "v2.billing.cadence",
    "url": "/v2/billing/cadences/bc_61SJeURByaQyO0zks16RuKJoESSQUtPVJKIgeI4D22JZ"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJeVWAhU8rG2dpF8Z16RuKJoESSQUtPVJKIgeI4D27wT",
  "object": "v2.core.event",
  "type": "v2.billing.cadence.errored",
  "livemode": true,
  "related_object": {
    "id": "bc_61SJeURByaQyO0zks16RuKJoESSQUtPVJKIgeI4D22JZ",
    "type": "v2.billing.cadence",
    "url": "/v2/billing/cadences/bc_61SJeURByaQyO0zks16RuKJoESSQUtPVJKIgeI4D22JZ"
  },
  "data": {}
}

v2.billing.license_fee_version.created

Occurs when a LicenseFeeVersion is created.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.license_fee_version.created"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.license_fee_version.created",
  "livemode": true,
  "related_object": {
    "id": "licfv_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.license_fee_version",
    "url": "/v2/billing/license_fees/licf_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy/versions/licfv_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.license_fee_version.created",
  "livemode": true,
  "related_object": {
    "id": "licfv_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.license_fee_version",
    "url": "/v2/billing/license_fees/licf_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy/versions/licfv_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.license_fee.created

Occurs when a LicenseFee is created.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.license_fee.created"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.license_fee.created",
  "livemode": true,
  "related_object": {
    "id": "licf_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.license_fee",
    "url": "/v2/billing/license_fees/licf_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.license_fee.created",
  "livemode": true,
  "related_object": {
    "id": "licf_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.license_fee",
    "url": "/v2/billing/license_fees/licf_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.license_fee.updated

Occurs when a LicenseFee is updated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.license_fee.updated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.license_fee.updated",
  "livemode": true,
  "related_object": {
    "id": "licf_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.license_fee",
    "url": "/v2/billing/license_fees/licf_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.license_fee.updated",
  "livemode": true,
  "related_object": {
    "id": "licf_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.license_fee",
    "url": "/v2/billing/license_fees/licf_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.licensed_item.created

Occurs when a LicensedItem is created.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.licensed_item.created"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.licensed_item.created",
  "livemode": true,
  "related_object": {
    "id": "bli_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.licensed_item",
    "url": "/v2/billing/licensed_items/bli_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.licensed_item.created",
  "livemode": true,
  "related_object": {
    "id": "bli_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.licensed_item",
    "url": "/v2/billing/licensed_items/bli_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.licensed_item.updated

Occurs when a LicensedItem is updated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.licensed_item.updated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.licensed_item.updated",
  "livemode": true,
  "related_object": {
    "id": "bli_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.licensed_item",
    "url": "/v2/billing/licensed_items/bli_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.licensed_item.updated",
  "livemode": true,
  "related_object": {
    "id": "bli_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.licensed_item",
    "url": "/v2/billing/licensed_items/bli_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.metered_item.created

Occurs when a MeteredItem is created.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.metered_item.created"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJYFLbcODkA5Zd7rZ16RuKJoESSQUtPVJKIgeI4D2BpA",
  "object": "v2.core.event",
  "type": "v2.billing.metered_item.created",
  "livemode": true,
  "reason": {
    "type": "request",
    "request": {
      "id": "req_65SJYFLbcODkA5Zd7rZ16RuKJoESSQUtPVJKIgeI4D2FpE",
      "idempotency_key": "idem_65SJYFLbcODkA5Zd7rZ16RuKJoESSQUtPVJKIgeI4D2GpH"
    }
  },
  "related_object": {
    "id": "bli_61SJYFLbcODkA5Zd7rZ16RuKJoESSQUtPVJKIgeI4D2KpL",
    "type": "v2.billing.metered_item",
    "url": "/v2/billing/metered_items/bli_61SJYFLbcODkA5Zd7rZ16RuKJoESSQUtPVJKIgeI4D2KpL"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJYFLbcODkA5Zd7rZ16RuKJoESSQUtPVJKIgeI4D2BpA",
  "object": "v2.core.event",
  "type": "v2.billing.metered_item.created",
  "livemode": true,
  "reason": {
    "type": "request",
    "request": {
      "id": "req_65SJYFLbcODkA5Zd7rZ16RuKJoESSQUtPVJKIgeI4D2FpE",
      "idempotency_key": "idem_65SJYFLbcODkA5Zd7rZ16RuKJoESSQUtPVJKIgeI4D2GpH"
    }
  },
  "related_object": {
    "id": "bli_61SJYFLbcODkA5Zd7rZ16RuKJoESSQUtPVJKIgeI4D2KpL",
    "type": "v2.billing.metered_item",
    "url": "/v2/billing/metered_items/bli_61SJYFLbcODkA5Zd7rZ16RuKJoESSQUtPVJKIgeI4D2KpL"
  },
  "data": {}
}

v2.billing.metered_item.updated

Occurs when a MeteredItem is updated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.metered_item.updated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJhYZDkX1uJ5gsI1Z16RuKJoESSQUtPVJKIgeI4D20zW",
  "object": "v2.core.event",
  "type": "v2.billing.metered_item.updated",
  "livemode": true,
  "reason": {
    "type": "request",
    "request": {
      "id": "req_65SJhXZEhB4oQ0Csu16RuKJoESSQUtPVJKIgeI4D26Fi",
      "idempotency_key": "idem_65SJhWUFiC5pR1Dtv16RuKJoESSQUtPVJKIgeI4D27Gj"
    }
  },
  "related_object": {
    "id": "bli_61SJhVUEbdTBR3Cns16RuKJoESSQUtPVJKIgeI4D25Mc",
    "type": "v2.billing.metered_item",
    "url": "/v2/billing/metered_items/bli_61SJhVUEbdTBR3Cns16RuKJoESSQUtPVJKIgeI4D25Mc"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJhYZDkX1uJ5gsI1Z16RuKJoESSQUtPVJKIgeI4D20zW",
  "object": "v2.core.event",
  "type": "v2.billing.metered_item.updated",
  "livemode": true,
  "reason": {
    "type": "request",
    "request": {
      "id": "req_65SJhXZEhB4oQ0Csu16RuKJoESSQUtPVJKIgeI4D26Fi",
      "idempotency_key": "idem_65SJhWUFiC5pR1Dtv16RuKJoESSQUtPVJKIgeI4D27Gj"
    }
  },
  "related_object": {
    "id": "bli_61SJhVUEbdTBR3Cns16RuKJoESSQUtPVJKIgeI4D25Mc",
    "type": "v2.billing.metered_item",
    "url": "/v2/billing/metered_items/bli_61SJhVUEbdTBR3Cns16RuKJoESSQUtPVJKIgeI4D25Mc"
  },
  "data": {}
}

v2.billing.pricing_plan_component.created

Occurs when a PricingPlanComponent is created.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.pricing_plan_component.created"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_component.created",
  "livemode": true,
  "related_object": {
    "id": "bppc_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_component",
    "url": "/v2/billing/pricing_plans/bpp_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy/components/bppc_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_component.created",
  "livemode": true,
  "related_object": {
    "id": "bppc_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_component",
    "url": "/v2/billing/pricing_plans/bpp_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy/components/bppc_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.pricing_plan_component.updated

Occurs when a PricingPlanComponent is updated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.pricing_plan_component.updated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_component.updated",
  "livemode": true,
  "related_object": {
    "id": "bppc_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_component",
    "url": "/v2/billing/pricing_plans/bpp_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy/components/bppc_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_component.updated",
  "livemode": true,
  "related_object": {
    "id": "bppc_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_component",
    "url": "/v2/billing/pricing_plans/bpp_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy/components/bppc_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.pricing_plan_subscription.collection_awaiting_customer_action

Occurs when a PricingPlanSubscription's collection is awaiting customer action.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.pricing_plan_subscription.collection_awaiting_customer_action"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.collection_awaiting_customer_action",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.collection_awaiting_customer_action",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.pricing_plan_subscription.collection_current

Occurs when a PricingPlanSubscription's collection is current.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.pricing_plan_subscription.collection_current"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.collection_current",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.collection_current",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.pricing_plan_subscription.collection_past_due

Occurs when a PricingPlanSubscription's collection is past due.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.pricing_plan_subscription.collection_past_due"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.collection_past_due",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.collection_past_due",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.pricing_plan_subscription.collection_paused

Occurs when a PricingPlanSubscription's collection is paused.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.pricing_plan_subscription.collection_paused"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.collection_paused",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.collection_paused",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.pricing_plan_subscription.collection_unpaid

Occurs when a PricingPlanSubscription's collection is unpaid.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.pricing_plan_subscription.collection_unpaid"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.collection_unpaid",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.collection_unpaid",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.pricing_plan_subscription.servicing_activated

Occurs when PricingPlanSubscription servicing is activated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.pricing_plan_subscription.servicing_activated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.servicing_activated",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.servicing_activated",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.pricing_plan_subscription.servicing_canceled

Occurs when PricingPlanSubscription servicing is canceled.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.pricing_plan_subscription.servicing_canceled"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.servicing_canceled",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.servicing_canceled",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.pricing_plan_subscription.servicing_paused

Occurs when PricingPlanSubscription servicing is paused.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.pricing_plan_subscription.servicing_paused"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.servicing_paused",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.servicing_paused",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.pricing_plan_version.created

Occurs when a PricingPlanVersion is created.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.pricing_plan_version.created"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_version.created",
  "livemode": true,
  "related_object": {
    "id": "bppv_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_version",
    "url": "/v2/billing/pricing_plans/bpp_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy/versions/bppv_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_version.created",
  "livemode": true,
  "related_object": {
    "id": "bppv_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_version",
    "url": "/v2/billing/pricing_plans/bpp_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy/versions/bppv_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.pricing_plan.created

Occurs when a PricingPlan is created.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.pricing_plan.created"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan.created",
  "livemode": true,
  "related_object": {
    "id": "bpp_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan",
    "url": "/v2/billing/pricing_plans/bpp_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan.created",
  "livemode": true,
  "related_object": {
    "id": "bpp_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan",
    "url": "/v2/billing/pricing_plans/bpp_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.pricing_plan.updated

Occurs when a PricingPlan is updated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.pricing_plan.updated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan.updated",
  "livemode": true,
  "related_object": {
    "id": "bpp_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan",
    "url": "/v2/billing/pricing_plans/bpp_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan.updated",
  "livemode": true,
  "related_object": {
    "id": "bpp_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan",
    "url": "/v2/billing/pricing_plans/bpp_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.rate_card_rate.created

Occurs when a RateCardRate is created.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card_rate.created"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SKjChAbYmk9HWJNpV16RuKJoESSQUtPVJKIgeI4D25PM",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_rate.created",
  "livemode": true,
  "related_object": {
    "id": "rcdr_61SKjCgnGytNLE2Rk16RuKJoESSQUtPVJKIgeI4D2B9s",
    "type": "v2.billing.rate_card_rate",
    "url": "/v2/billing/rate_cards/:rate_card_id/rates/rcdr_61SKjCgnGytNLE2Rk16RuKJoESSQUtPVJKIgeI4D2B9s"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SKjChAbYmk9HWJNpV16RuKJoESSQUtPVJKIgeI4D25PM",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_rate.created",
  "livemode": true,
  "related_object": {
    "id": "rcdr_61SKjCgnGytNLE2Rk16RuKJoESSQUtPVJKIgeI4D2B9s",
    "type": "v2.billing.rate_card_rate",
    "url": "/v2/billing/rate_cards/:rate_card_id/rates/rcdr_61SKjCgnGytNLE2Rk16RuKJoESSQUtPVJKIgeI4D2B9s"
  },
  "data": {
    "billable_item": "bli_61SKiH6IK4ZFVDmkq16RuKJoESSQUtPVJKIgeI4D2JAm",
    "created": "2025-01-01T00:00:00.000Z",
    "rate_card": "rcd_61SKiGyy91q3JVsLw16RuKJoESSQUtPVJKIgeI4D2Omu",
    "rate_card_version": "rcdv_61SKjCgYDR2qkt8vg16RuKJoESSQUtPVJKIgeI4D2Pku"
  }
}

v2.billing.rate_card_subscription.activated

Occurs when a RateCardSubscription is activated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card_subscription.activated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SKkWu5OkQpDEMaiRW16RuKJoESSQUtPVJKIgeI4D2O4u",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.activated",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SKkWtdXF98pUnZ216RuKJoESSQUtPVJKIgeI4D2IcC",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SKkWtdXF98pUnZ216RuKJoESSQUtPVJKIgeI4D2IcC"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SKkWu5OkQpDEMaiRW16RuKJoESSQUtPVJKIgeI4D2O4u",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.activated",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SKkWtdXF98pUnZ216RuKJoESSQUtPVJKIgeI4D2IcC",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SKkWtdXF98pUnZ216RuKJoESSQUtPVJKIgeI4D2IcC"
  },
  "data": {}
}

v2.billing.rate_card_subscription.canceled

Occurs when a RateCardSubscription is canceled.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card_subscription.canceled"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJdUVzgT7qF1coE7Z16RuKJoESSQUtPVJKIgeI4D26vS",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.canceled",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJdTQAyZPxN9yjs16RuKJoESSQUtPVJKIgeI4D21IY",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJdTQAyZPxN9yjs16RuKJoESSQUtPVJKIgeI4D21IY"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJdUVzgT7qF1coE7Z16RuKJoESSQUtPVJKIgeI4D26vS",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.canceled",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJdTQAyZPxN9yjs16RuKJoESSQUtPVJKIgeI4D21IY",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJdTQAyZPxN9yjs16RuKJoESSQUtPVJKIgeI4D21IY"
  },
  "data": {}
}

v2.billing.rate_card_subscription.collection_awaiting_customer_action

Occurs when a RateCardSubscription's collection is awaiting customer action.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card_subscription.collection_awaiting_customer_action"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJcTUyfS6pE0bnD6Z16RuKJoESSQUtPVJKIgeI4D25uR",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.collection_awaiting_customer_action",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJcSPzxYOwM8xis16RuKJoESSQUtPVJKIgeI4D20HX",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJcSPzxYOwM8xis16RuKJoESSQUtPVJKIgeI4D20HX"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJcTUyfS6pE0bnD6Z16RuKJoESSQUtPVJKIgeI4D25uR",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.collection_awaiting_customer_action",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJcSPzxYOwM8xis16RuKJoESSQUtPVJKIgeI4D20HX",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJcSPzxYOwM8xis16RuKJoESSQUtPVJKIgeI4D20HX"
  },
  "data": {}
}

v2.billing.rate_card_subscription.collection_current

Occurs when a RateCardSubscription's collection is current.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card_subscription.collection_current"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJbSTxeR5oD9amC5Z16RuKJoESSQUtPVJKIgeI4D24tQ",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.collection_current",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJbROywXNvL7whs16RuKJoESSQUtPVJKIgeI4D29GW",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJbROywXNvL7whs16RuKJoESSQUtPVJKIgeI4D29GW"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJbSTxeR5oD9amC5Z16RuKJoESSQUtPVJKIgeI4D24tQ",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.collection_current",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJbROywXNvL7whs16RuKJoESSQUtPVJKIgeI4D29GW",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJbROywXNvL7whs16RuKJoESSQUtPVJKIgeI4D29GW"
  },
  "data": {}
}

v2.billing.rate_card_subscription.collection_past_due

Occurs when a RateCardSubscription's collection is past due.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card_subscription.collection_past_due"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJYFLbcODkA5Zd7rZ16RuKJoESSQUtPVJKIgeI4D2BpA",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.collection_past_due",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJYD6xtUKrI0tfs16RuKJoESSQUtPVJKIgeI4D25CS",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJYD6xtUKrI0tfs16RuKJoESSQUtPVJKIgeI4D25CS"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJYFLbcODkA5Zd7rZ16RuKJoESSQUtPVJKIgeI4D2BpA",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.collection_past_due",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJYD6xtUKrI0tfs16RuKJoESSQUtPVJKIgeI4D25CS",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJYD6xtUKrI0tfs16RuKJoESSQUtPVJKIgeI4D25CS"
  },
  "data": {}
}

v2.billing.rate_card_subscription.collection_paused

Occurs when a RateCardSubscription's collection is paused.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card_subscription.collection_paused"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJaRSwdQ4nC8ZlB4Z16RuKJoESSQUtPVJKIgeI4D23sP",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.collection_paused",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJaQNxvWMuK6vgs16RuKJoESSQUtPVJKIgeI4D28FV",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJaQNxvWMuK6vgs16RuKJoESSQUtPVJKIgeI4D28FV"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJaRSwdQ4nC8ZlB4Z16RuKJoESSQUtPVJKIgeI4D23sP",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.collection_paused",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJaQNxvWMuK6vgs16RuKJoESSQUtPVJKIgeI4D28FV",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJaQNxvWMuK6vgs16RuKJoESSQUtPVJKIgeI4D28FV"
  },
  "data": {}
}

v2.billing.rate_card_subscription.collection_unpaid

Occurs when a RateCardSubscription's collection is unpaid.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card_subscription.collection_unpaid"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJZQRvdP3mB7YkA3Z16RuKJoESSQUtPVJKIgeI4D22rO",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.collection_unpaid",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJZPMwuVLtJ5ufs16RuKJoESSQUtPVJKIgeI4D27EU",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJZPMwuVLtJ5ufs16RuKJoESSQUtPVJKIgeI4D27EU"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJZQRvdP3mB7YkA3Z16RuKJoESSQUtPVJKIgeI4D22rO",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.collection_unpaid",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJZPMwuVLtJ5ufs16RuKJoESSQUtPVJKIgeI4D27EU",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJZPMwuVLtJ5ufs16RuKJoESSQUtPVJKIgeI4D27EU"
  },
  "data": {}
}

v2.billing.rate_card_subscription.servicing_activated

Occurs when RateCardSubscription servicing is activated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card_subscription.servicing_activated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SKkTii5W2uQbFXIqZ16RuKJoESSQUtPVJKIgeI4D28xE",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.servicing_activated",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SKkThVvJOfROyY416RuKJoESSQUtPVJKIgeI4D2UCm",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SKkThVvJOfROyY416RuKJoESSQUtPVJKIgeI4D2UCm"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SKkTii5W2uQbFXIqZ16RuKJoESSQUtPVJKIgeI4D28xE",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.servicing_activated",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SKkThVvJOfROyY416RuKJoESSQUtPVJKIgeI4D2UCm",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SKkThVvJOfROyY416RuKJoESSQUtPVJKIgeI4D2UCm"
  },
  "data": {}
}

v2.billing.rate_card_subscription.servicing_canceled

Occurs when RateCardSubscription servicing is canceled.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card_subscription.servicing_canceled"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJYGHqRm3bvDPUwrJ16RuKJoESSQUtPVJKIgeI4D21qN",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.servicing_canceled",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJYEFxtTKrH4tds16RuKJoESSQUtPVJKIgeI4D26DT",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJYEFxtTKrH4tds16RuKJoESSQUtPVJKIgeI4D26DT"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJYGHqRm3bvDPUwrJ16RuKJoESSQUtPVJKIgeI4D21qN",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.servicing_canceled",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJYEFxtTKrH4tds16RuKJoESSQUtPVJKIgeI4D26DT",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJYEFxtTKrH4tds16RuKJoESSQUtPVJKIgeI4D26DT"
  },
  "data": {}
}

v2.billing.rate_card_subscription.servicing_paused

Occurs when RateCardSubscription servicing is paused.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card_subscription.servicing_paused"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJYFLfEo2XvVPUgrZ16RuKJoESSQUtPVJKIgeI4D20pM",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.servicing_paused",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJYD6xtUKrI0tfs16RuKJoESSQUtPVJKIgeI4D25CS",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJYD6xtUKrI0tfs16RuKJoESSQUtPVJKIgeI4D25CS"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJYFLfEo2XvVPUgrZ16RuKJoESSQUtPVJKIgeI4D20pM",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.servicing_paused",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJYD6xtUKrI0tfs16RuKJoESSQUtPVJKIgeI4D25CS",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJYD6xtUKrI0tfs16RuKJoESSQUtPVJKIgeI4D25CS"
  },
  "data": {}
}

v2.billing.rate_card_version.created

Occurs when a RateCardVersion is created.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card_version.created"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_version.created",
  "livemode": true,
  "related_object": {
    "id": "rcdv_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.rate_card_version",
    "url": "/v2/billing/rate_cards/rcd_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy/versions/rcdv_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_version.created",
  "livemode": true,
  "related_object": {
    "id": "rcdv_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.rate_card_version",
    "url": "/v2/billing/rate_cards/rcd_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy/versions/rcdv_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.rate_card.created

Occurs when a RateCard is created.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card.created"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SKjChAbYmk9HWJNpV16RuKJoESSQUtPVJKIgeI4D25PM",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card.created",
  "livemode": true,
  "related_object": {
    "id": "rcd_61SKiGyy91q3JVsLw16RuKJoESSQUtPVJKIgeI4D2Omu",
    "type": "v2.billing.rate_card",
    "url": "/v2/billing/rate_cards/rcd_61SKiGyy91q3JVsLw16RuKJoESSQUtPVJKIgeI4D2Omu"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SKjChAbYmk9HWJNpV16RuKJoESSQUtPVJKIgeI4D25PM",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card.created",
  "livemode": true,
  "related_object": {
    "id": "rcd_61SKiGyy91q3JVsLw16RuKJoESSQUtPVJKIgeI4D2Omu",
    "type": "v2.billing.rate_card",
    "url": "/v2/billing/rate_cards/rcd_61SKiGyy91q3JVsLw16RuKJoESSQUtPVJKIgeI4D2Omu"
  },
  "data": {
    "created": "2025-01-01T00:00:00.000Z"
  }
}

v2.billing.rate_card.updated

Occurs when a RateCard is updated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card.updated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SKWWEtJRqJT7rGLEO16RuKJoESSQUtPVJKIgeI4D23dw",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card.updated",
  "livemode": true,
  "related_object": {
    "id": "rcd_61SKWRcVO6NYSaVo816RuKJoESSQUtPVJKIgeI4D2Qsi",
    "type": "v2.billing.rate_card",
    "url": "/v2/billing/rate_cards/rcd_61SKWRcVO6NYSaVo816RuKJoESSQUtPVJKIgeI4D2Qsi"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SKWWEtJRqJT7rGLEO16RuKJoESSQUtPVJKIgeI4D23dw",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card.updated",
  "livemode": true,
  "related_object": {
    "id": "rcd_61SKWRcVO6NYSaVo816RuKJoESSQUtPVJKIgeI4D2Qsi",
    "type": "v2.billing.rate_card",
    "url": "/v2/billing/rate_cards/rcd_61SKWRcVO6NYSaVo816RuKJoESSQUtPVJKIgeI4D2Qsi"
  },
  "data": {}
}

v2.core.event_destination.ping

A ping event used to test the connection to an EventDestination.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

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

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.core.event_destination.ping"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "context": null,
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
  "object": "v2.core.event",
  "reason": {
    "type": "request",
    "request": {
      "id": "req_v24sUK2aV6o01RdVU",
      "idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
    }
  },
  "related_object": {
    "id": "ed_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
    "type": "v2.core.event_destination",
    "url": "/v2/core/event_destinations/ed_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
  },
  "type": "v2.core.event_destination.ping",
  "livemode": true
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "context": null,
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
  "object": "v2.core.event",
  "reason": {
    "type": "request",
    "request": {
      "id": "req_v24sUK2aV6o01RdVU",
      "idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
    }
  },
  "related_object": {
    "id": "ed_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
    "type": "v2.core.event_destination",
    "url": "/v2/core/event_destinations/ed_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
  },
  "type": "v2.core.event_destination.ping",
  "livemode": true,
  "changes": {},
  "data": {}
}

Event Destinations v2

Set up an event destination to receive events from Stripe across multiple destination types, including webhook endpoints and Amazon EventBridge. Event destinations support receiving thin events and snapshot events.

Learn more about calling API v2 endpoints.

Endpoints

POST/v2/core/event_destinations

POST/v2/core/event_destinations/:id

GET/v2/core/event_destinations/:id

GET/v2/core/event_destinations

DELETE/v2/core/event_destinations/:id

POST/v2/core/event_destinations/:id/disable

POST/v2/core/event_destinations/:id/enable

Files

This object represents files hosted on Stripe’s servers. You can upload files with the create file request (for example, when uploading dispute evidence). Stripe also creates files independently (for example, the results of a Sigma scheduled query).

Related guide: File upload guide

Endpoints

POST/v1/files

GET/v1/files/:id

GET/v1/files

File Links

To share the contents of a File object with non-Stripe users, you can create a FileLink. FileLinks contain a URL that you can use to retrieve the contents of the file without authentication.

Endpoints

POST/v1/file_links

POST/v1/file_links/:id

GET/v1/file_links/:id

GET/v1/file_links

Ping an event destination v2

Parameters

idstringRequired

Returns

Response attributes

idstring

objectstring, value is "v2.core.event"

contextnullable string

createdtimestamp

datanullable object

livemodeboolean

reasonnullable object

related_objectnullable object

typestring

Types of events v2

Event types

Attributes

idstring

objectstring, value is "v2.core.event"

contextnullable string

createdtimestamp

livemodeboolean

reasonnullable object

related_objectnullable object

typestring, value is "v1.billing.meter.error_report_triggered"

Fetched attributes

dataobject

Attributes

idstring

objectstring, value is "v2.core.event"

contextnullable string

createdtimestamp

livemodeboolean

reasonnullable object

related_objectnullable object

typestring, value is "v1.billing.meter.no_meter_found"

Fetched attributes

dataobject

Attributes

idstring

objectstring, value is "v2.core.event"

contextnullable string

createdtimestamp

livemodeboolean

reasonnullable object

related_objectnullable object

typestring, value is "v2.billing.cadence.billed"

Fetched attributes

dataobject

Attributes

idstring

objectstring, value is "v2.core.event"

contextnullable string

createdtimestamp

livemodeboolean

reasonnullable object

related_objectnullable object

typestring, value is "v2.billing.cadence.canceled"

Fetched attributes

dataobject

Attributes

idstring

objectstring, value is "v2.core.event"

contextnullable string

createdtimestamp

livemodeboolean

reasonnullable object

related_objectnullable object

typestring, value is "v2.billing.cadence.created"

Fetched attributes

dataobject

Attributes

idstring

objectstring, value is "v2.core.event"

contextnullable string

createdtimestamp

livemodeboolean

reasonnullable object

related_objectnullable object

typestring, value is "v2.billing.cadence.errored"