Payment Mandates Now Include ID Field in API Version 2026-07

Shopify’s API version 2026-07 adds an id field to the PaymentMandateResource object. This field appears in responses from the mandates connection on CustomerPaymentMethod.

What Changed

The new id field matches the corresponding CustomerPaymentMethod.id value. Developers can now directly identify which payment method applies to a specific mandate scope without additional queries. The PaymentMandateResource object previously lacked this direct identifier, requiring developers to cross-reference mandate data with payment method records separately.

Impact on Subscription and Recurring Payment Apps

This change matters most for apps handling subscription billing or recurring payments. When a customer has multiple mandates associated with a single payment instrument, developers can now determine which payment method to use for each mandate scope (such as SUBSCRIPTIONS) through a single API call.

Apps that manage customer payment methods or process recurring transactions can simplify their data handling logic. The direct ID reference eliminates the need to maintain separate mapping between mandates and payment methods in application code.

Implementation Considerations

Developers using API version 2026-07 or later should update their PaymentMandateResource response handlers to include the new id field. Apps supporting multiple API versions need to handle responses both with and without this field.

The change applies only to version 2026-07 forward. Apps using earlier API versions will not see the id field in their mandate responses.

Read the full announcement →