Skip to main content
POST
Confirm the cardholder notice was sent

Authorizations

Authorization
string
header
required

Secret, platform or publishable API key. Platform keys require Payments-Account.

Headers

payments-account
string

Required for platform keys; refused for secret/publishable keys.

payments-version
enum<string>
Available options:
2026-11-01
idempotency-key
string
required
Required string length: 1 - 255

Path Parameters

id
string
required
Pattern: ^rcy_[0-9a-hjkmnp-tv-z]{26}$

Body

application/json

The body is of type object.

Response

Renewal cycle with its tries.

amount
integer
required

Integer amount in the currency minor unit.

Required range: 0 <= x <= 2147483647
card_update_until
string<date-time> | null
required
concluded_at
string<date-time> | null
required
created_at
string<date-time>
required
currency
string
required
customer
string
required
due_at
string<date-time>
required
ending
enum<string> | null
required
Available options:
cancel,
pause,
null
id
string
required
Pattern: ^rcy_[0-9a-hjkmnp-tv-z]{26}$
mode
enum<string>
required
Available options:
live,
test
next_try_at
string<date-time> | null
required
notice_sent_at
string<date-time> | null
required
object
enum<string>
required
Available options:
renewal_cycle
outcome_reason
string | null
required
payment_method
string
required
period_ref
string
required
policy_version
string | null
required
status
enum<string>
required
Available options:
scheduled,
trying,
waiting_retry,
waiting_card_update,
waiting_customer,
waiting_merchant,
succeeded,
failed,
canceled
store
string
required
subscription_group_id
string | null
required
subscription_id
string | null
required
test_clock
string | null
required
Pattern: ^clk_[0-9a-hjkmnp-tv-z]{26}$
tries
object[]
required