Skip to main content

Subscription Settings

Configure subscription numbering, customer self-service, renewal reminders, payment failure handling, recovery defaults, and trial periods. The tab is split into six sub-sections: Numbering, Customer Options, Renewals & Reminders, Failed Payments, Recovery & Win-back, and Trial Periods.

Location: Settings > Subscriptions

Numbering

FieldDescriptionDefault
number_prefixToken substituted for {PREFIX} (up to 10 chars)SUB
number_formatPattern that generates subscription numbers{PREFIX}-{YEAR}{MONTH}-{SEQ}
sequence_paddingMinimum digits in the sequence portion (3 to 7)5
sequence_resetWhen to reset the sequence: never, yearly, monthly, dailynever
number_startStarting sequence value (useful when migrating from another system)1

The Numbering panel shows live stats (total subscriptions, current sequence, next sequence) and a live-rendered preview of the next subscription number. Switching the "Use custom format" toggle lets you type a free-form format string instead of picking from the preset list.

Format Placeholders

PlaceholderReplacement
{PREFIX}The number_prefix value
{YEAR} / {YYYY}Four-digit year
{YY}Two-digit year
{MONTH} / {MM}Two-digit month
{DAY} / {DD}Two-digit day
{WEEK} / {WW}ISO week number
{QUARTER} / {Q}Quarter, Q1 through Q4
{SEQ}Sequence number padded to sequence_padding digits
{SEQ:N}Sequence padded to exactly N digits
{RANDOM:N}N random digits
{CUSTOMER}Customer ID

Customer Options

FieldDescriptionDefault
allow_pauseLet customers pause an active subscription from the account areaOff
allow_cancelLet customers cancel their own subscriptionOff
cancel_at_period_endWhen a customer cancels, schedule the cancellation for the end of the current billing period instead of immediatelyOff

Renewals & Reminders

FieldDescriptionDefault
renewal_reminder_daysSend a renewal reminder this many days before the next charge (0 to 30; 0 disables)3

Failed Payments

FieldDescriptionDefault
failed_payment_retry_daysComma-separated list of days at which to retry a failed payment, for example 1,3,51,3,5
max_failed_attemptsCancel the subscription after this many consecutive failures (1 to 10)3

Recovery & Win-back

FieldDescriptionDefault
dunning_cadence_daysComma-separated, non-decreasing day offsets for dunning emails, for example 0,3,7. First value is conventionally 0 (send immediately on failure).0,3,7
winback_discount_percentDefault percent off applied to win-back coupons (1 to 90)20
winback_valid_daysNumber of days a win-back coupon stays valid (1 to 365)30
winback_usage_limitMaximum redemptions per win-back coupon (1 means single-use)1

Subscriptions already in the dunning workflow keep the cadence stored when they started. Cadence edits only affect new failures.

Trial Periods

FieldDescriptionDefault
default_trial_periodTrial unit: none, day, week, or monthnone
default_trial_lengthNumber of default_trial_period units for new subscription products7

The trial length field only renders when the period is something other than none. Per-product trial settings override these defaults.

Subscription Statuses

Subscription state machine values surfaced throughout the admin:

StatusMeaning
PendingAwaiting the initial payment
TrialIn a free trial window
ActiveBilling normally
PausedPaused by customer or admin
On HoldRenewal payment failed, dunning in progress
Pending CancelActive but scheduled to cancel at period end
CancelledStopped billing
ExpiredReached a scheduled end date