Update subscriber metadata

curl --request PATCH \ --url https://api.recurr.dev/v1/subscribers/{subscriberId} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "tags": [ "<string>" ], "metadata": {} } '

{ "id": "subscriber_01HQ...", "email_hashed": "sha256:abc123def456...", "created_at": "2023-11-07T05:31:56Z", "email": "jsmith@example.com", "subscription": { "id": "sub_01HQ...", "plan": "premium_monthly", "current_period_start": "2023-11-07T05:31:56Z", "current_period_end": "2023-11-07T05:31:56Z" }, "cohort_ids": [ "<string>" ], "tags": [ "<string>" ], "metadata": {}, "total_paid": 123, "paid_currency": "USD", "last_payment_at": "2023-11-07T05:31:56Z" }

Authorizations

Authorization

string

header

required

Your Recurr secret API key as a Bearer token: Authorization: Bearer rk_live_….

Keys are environment-scoped — rk_live_ operates on live data, rk_test_ on isolated test data (see Test mode). Create, scope, and rotate keys in your dashboard (Settings → API keys, developer role). Secret keys are server-side only — never ship them in an app binary or client JavaScript.

Headers

Idempotency-Key

string

Idempotency key for safe retries on write operations. Pass a unique key per logical request; Recurr returns the original response for duplicate keys within a 24-hour window.

Maximum string length: 255

Path Parameters

subscriberId

string

required

Body

application/json

Response

200 - application/json

Updated subscriber

string

required

Stable subscriber ID across migrations + auth providers.

Example:

"subscriber_01HQ..."

email_hashed

string

required

SHA256 hash of lower-cased trimmed email.

Example:

"sha256:abc123def456..."

created_at

string<date-time>

required

When this subscriber first activated.

string<email> | null

Raw email. Stripped if destination pii_mode is hashed_only or minimal.

subscription

object

Show child attributes

cohort_ids

string[]

Cohorts this subscriber currently belongs to.