2025-11-17 — Subscriptions API Breaking Change
Breaking change coming December 3, 2025: List Customers endpoint address fields will change type.
The List Customers endpoint of the Subscriptions API will update four fields in the addresses and default_address objects.
Currently, these fields are returned as a number, but according to the API specification, they should be string.
Starting December 3, 2025, these fields will always be returned as string values.
Fields Affected
| Field | Current Type | New Type |
|---|---|---|
| customers[].addresses[].platform_id | number | string |
| customers[].addresses[].platform_customer_id | number | string |
| customers[].default_address.platform_id | number | string |
| customers[].default_address.platform_customer_id | number | string |
Why is this changing?
- This update makes the returned data consistent with the public API docs.
- Corrects a data type discrepancy that may cause type errors in strict-typed languages or API clients.
Action Required
Review your integration: If your code expects these fields to be a number, update it to accept a string value.