paddle_resume_subscription: Resume a paused or scheduled-to-pause subscription

View source: R/subscriptions.R

paddle_resume_subscriptionR Documentation

Resume a paused or scheduled-to-pause subscription

Description

Resumes a paused subscription immediately or at a specified date. Also updates a scheduled pause if subscription is active.

Usage

paddle_resume_subscription(id, effective_from, on_resume = NULL)

Arguments

id

Character. Required. Paddle subscription ID (e.g. "sub_abc123").

effective_from

Character. Required. RFC 3339 datetime string when the resume should occur.

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_resume_subscription(
 id = "sub_123",
 effective_from = "2025-07-01T00:00:00Z"
)


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