Issue a credit to a subscriber

curl --request POST \ --url https://api.recurr.dev/v1/subscribers/{subscriberId}/credit \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "amount": 123, "currency": "USD", "expires_at": "2023-11-07T05:31:56Z" } '

{ "id": "cred_01HQX...", "subscriber_id": "<string>", "amount": 123, "balance": 123, "currency": "<string>", "created_at": "2023-11-07T05:31:56Z", "reason": "<string>", "expires_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

amount

integer

required

Credit amount in smallest currency unit.

currency

string

required

Example:

"USD"

reason

enum<string>

required

Available options:

goodwill,

refund_in_kind,

save_offer,

manual

expires_at

string<date-time> | null

Optional expiry; null = no expiry.

Response

201 - application/json

Credit issued

string

required

Example:

"cred_01HQX..."

subscriber_id

string

required

amount

integer

required

Original credit amount issued.

balance

integer

required

Current unused balance.

currency

string

required

created_at

string<date-time>

required

reason

string

expires_at

string<date-time> | null