paddle_pause_subscription: Pause a subscription

In paddleR: Wrapper for 'Paddle' API (Application Programming Interface)

Pause a subscription

Description

Pauses a subscription using its ID. You can pause at the end of the billing period (default), pause immediately by setting 'effective_from = "immediately"', or set a resume date.

Usage

paddle_pause_subscription(
  id,
  effective_from = NULL,
  resume_at = NULL,
  on_resume = NULL
)

Arguments

id	Character. Required. Paddle subscription ID (e.g. "sub_abc123").
effective_from	Character or NULL. Optional. One of '"next_billing_period"' or '"immediately"'. Defaults to '"next_billing_period"'.
resume_at	Character or NULL. Optional. RFC 3339 date-time string when subscription should resume.
on_resume	Character or NULL. Optional. One of '"start_new_billing_period"' or '"continue_billing_period"'.

Value

A list representing the updated subscription object.

Examples

set_paddle_mode("sandbox")
result <- paddle_pause_subscription(id = "sub_123")

paddleR documentation built on June 24, 2025, 9:07 a.m.