Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Cancel a cadence v2

Cancel the billing cadence.

Learn more about calling API v2 endpoints.

Parameters

  • idstringRequired

    The ID of the billing Cadence to cancel.

Returns

Response attributes

  • idstring

    The ID of the billing Cadence object.

  • objectstring, value is "v2.billing.cadence"

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

  • billing_cycleobject

    The billing cycle is the object that defines future billing cycle dates.

  • createdtimestamp

    Timestamp of when 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.

  • metadatanullable map

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

  • next_billing_datenullable timestamp

    The date that the billing cadence will next bill. Null if the cadence is not active.

  • payerobject

    The payer determines the entity financially responsible for the bill.

  • settingsnullable objectPreview feature

    The settings associated with the cadence.

  • statusenum

    The current status of the cadence.

    Possible enum values
    active

    The cadence is active and can have subscriptions associated.

    canceled

    The cadence is no longer generating invoices and has been canceled.

  • test_clocknullable string

    The ID of the TestClock.

Error Codes
400billing_cadence_active

Returned when trying to cancel a billing cadence that has active subscriptions.

400billing_cadence_canceled

Returned when trying to cancel a billing cadence that has already been canceled.

404billing_cadence_not_found

Returned when the provided billing_cadence ID cannot be found.

POST /v2/billing/cadences/:id/cancel
curl -X POST https://api.stripe.com/v2/billing/cadences/bc_test_61Rc0IonJY96mpyHA16RM8VQESSQ4t1K5KYFAmKUSCie/cancel \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-08-27.preview"
Response
{
  "id": "bc_test_61Rc0IonJY96mpyHA16RM8VQESSQ4t1K5KYFAmKUSCie",
  "object": "v2.billing.cadence",
  "payer": {
    "type": "customer",
    "customer": "cus_61Rc0HZtJCE9h"
  },
  "billing_cycle": {
    "type": "month",
    "interval_count": 1,
    "month": {
      "day_of_month": 3,
      "time": {
        "hour": 1,
        "minute": 0
      }
    }
  },
  "metadata": {},
  "status": "canceled",
  "test_clock": "clock_1QScHiH5wvQ9UC0VklUiPqw4",
  "created": "2024-11-26T16:33:03.000Z",
  "livemode": true
}

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

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

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

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
# 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"
  }
}

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
# 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 LicenseFee describes quantity-based pricing such as seat-based pricing.

Learn more about calling API v2 endpoints.
Endpoints

Metered Items v2

A MeteredItem 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

Custom Pricing Units v2

The Custom Pricing Unit object.

Learn more about calling API v2 endpoints.
Endpoints