Skip to main content
POST
Email customers to update their payment method

Authorizations

Authorization
string
header
required

Bearer token authentication

Body

application/json

Who to ask, and which renewal the ask is about.

tokens
string[]
required

Subscription tokens. Duplicates are collapsed before the batch runs, and the deduplicated count is what the maximum is applied to.

Required array length: 1 - 500 elements
Example:
renewal_date
string<date>
required

The renewal date being worked, as YYYY-MM-DD. Recorded against each send so the drawer can count them per day — an operator working the 14th on the 12th is asking about the 14th, not about the day they pressed send.

Example:

"2026-09-14"

Response

Every token answered as sent, skipped, or failed

One entry per token sent, across three lists.

sent_tokens
string[]
required

Customers whose mail was queued and recorded.

skipped_tokens
object[]
required

Customers passed over, each carrying why.

failed_tokens
object[]
required

Tokens that resolved to no subscription of the caller's.

meta
object | null
required