Renew subscription

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Renew a subscription by adding a new phase to its schedule. Creates an upcoming billing period with the specified plan (can be the same or different). Does not extend the current period.

Example: A customer wants to renew early to lock in a promotional rate. Use this endpoint to add a renewal phase.


Restrictions

ConditionResult
Subscription is expiredCannot renew
Subscription is scheduledCannot renew
Subscription has pending paymentCannot renew
Subscription is agency-managedCannot renew
Subscription is a gift donorCannot renew
Subscription is Apple IAPCannot renew
Phase limit reached (10)Use replace_upcoming_phases: true to bypass

Webhook

Triggers the subscription.renewed webhook event.

Query Params
int32
required
int32
required
Body Params
int32
required
int32
required
int32
int32
boolean
string
string
enum
Defaults to send_invoice
Allowed:
string
int32
required
string
required
boolean
Defaults to false
Headers
string
required
Defaults to Bearer eyJ***
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json