Skip to main content
PATCH
Update Subscription

Authorizations

api_key
string
header
required

Path Parameters

id
string
required

The unique ID of the subscription to update.

Example:

"sub_67890"

Body

application/json
user_id
string
required

The ID of the user whose subscription is being updated.

Example:

"user_12345"

auto_renew
boolean

Toggle for auto-renewal setting.

Example:

false

billing_cycle
string

New billing cycle if being changed. Accepted values: 'monthly', 'yearly'.

Example:

"monthly"

status
string

Set subscription status. Example values: 'active', 'paused', 'cancelled'.

Example:

"paused"

Response

Subscription successfully updated

status
string

Status of the subscription update operation.

Example:

"success"

subscription_id
string

ID of the updated subscription.

Example:

"sub_67890"

updated_fields
object

The fields that were updated in the subscription.

Example: