Cadence event types v2

This is a list of all public thin events we currently send for updates to Cadence, 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

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": {}
}

License Fees v2

A License Fee describes quantity-based pricing such as seat-based pricing.

Learn more about calling API v2 endpoints.

Endpoints

POST/v2/billing/license_fees

POST/v2/billing/license_fees/:id

GET/v2/billing/license_fees/:id

GET/v2/billing/license_fees/:id/versions/:id

GET/v2/billing/license_fees

GET/v2/billing/license_fees/:id/versions

License Fee Subscriptions v2

A License Fee Subscription links one License Fee to a specific Billing Cadence. While the License Fee Subscription is active, Stripe will bill the payer according to the License Fee’s pricing and the quantity subscribed.

Learn more about calling API v2 endpoints.

Endpoints

GET/v2/billing/license_fee_subscriptions/:id

Metered Items v2

A Metered Item represents any item that you bill customers for based on how much they use it, such as hourly cloud CPU usage or tokens generated by an AI service.

Learn more about calling API v2 endpoints.

Endpoints

POST/v2/billing/metered_items

POST/v2/billing/metered_items/:id

GET/v2/billing/metered_items/:id

GET/v2/billing/metered_items