Payments

Pauses subscription for specified duration (Roles: user)

post/payment/subscription/pause

Request body

pauseDurationMonthsinteger required

Duration to pause subscription in months (e.g., 1, 2, or 3)

Response

Success

idstring

objectstring

collection_methodstring

cancel_at_period_endboolean

canceled_atinteger

cancel_atinteger

createdinteger

current_period_endinteger

current_period_startinteger

customerstring

days_until_dueinteger

ended_atinteger

quantityinteger

start_dateinteger

statusstring

tax_percentinteger

trial_endinteger

trial_startinteger

billing_cycle_anchorinteger

latest_invoicestring

from_teamboolean

resume_requires_paymentboolean

Present (true) only while the subscription is paused and at least one billing cycle was skipped (voided) during the pause, meaning a resume will immediately charge the full plan price for a fresh cycle.

Changes

No recorded changes to this endpoint across all 8 revisions of this API.