Send payment method link
Emails your customer a secure link to manage their saved payment methods — view, add, set a default, or remove a card or bank account. This is the same link the “Send link” button in your dashboard sends.
By default the link goes to the customer’s primary billing contact. Pass contactIds to send it to specific contacts instead, and set sendToPrimaryContact to true to include the primary billing contact as well. Each address gets its own email with its own link, once, even if it’s listed more than once.
The link is time-limited, and each call sends a fresh one. The response tells you which addresses it went to and how long it stays valid.
Authentication
Path parameters
Request
IDs of the customer’s contacts to send the link to — the id values from GET /v3/customers/{id}/contacts. Each contact must belong to this customer and have an email on file. When omitted or empty, the link goes to the primary billing contact only.
When contactIds is provided, also send the link to the customer’s primary billing contact. Ignored when contactIds is omitted or empty.
Response
Boolean with true=success, false=failure
Plain-text description of the result