Consolidates billing mode configuration across Billing productsBreaking changes

What’s new

We’ve unified the billing_mode parameter and field format across all billing endpoints. The billing_mode parameter now uses a consistent object format with a type field, replacing the previous string format. We’ve also consolidated the billing_mode_details field into the main billing_mode object.

Why is this a breaking change?

The billing_mode parameter and field changed from accepting a string value (classic or flexible) to requiring an object with a type field (for example, {type: 'flexible'}). Additionally, the separate billing_mode_details field has been removed, and its updated_at property is now included directly in the billing_mode object.

Impact

You need to update your integration if you currently use the billing_mode parameter or access the billing_mode field in API responses.

Before:

{
  "billing_mode": "flexible",
  "billing_mode_details": {
    "updated_at": 1234567890
  }
}

After:

{
  "billing_mode": {
    "type": "flexible",
    "updated_at": 1234567890
  }
}

This change affects the following API endpoints and resources:

• Create subscriptions
• Create subscription schedules
• Checkout Sessions
• Quotes
• Create a preview invoice

Changes

Upgrade