Resume a paused subscription

Permission required

posthttps://api.paddle.com/subscriptions/{subscription_id}/resume

Resumes a paused subscription using its ID. Only paused subscriptions can be resumed. If an active subscription has a scheduled change to pause in the future, use this operation to set or change the resume date.

You can't resume a canceled subscription.

On resume, Paddle bills for a subscription immediately by default. Subscription billing dates are recalculated based on the resume date. Use the on_resume field to change this behavior.

If successful, Paddle returns a copy of the updated subscription entity:

When resuming a paused subscription immediately, the subscription status is active, and billing dates are updated to reflect the resume date.
When scheduling a paused subscription to resume on a date in the future, the subscription status is paused, and scheduled_change.resume_at is updated to reflect the scheduled resume date.
When changing the resume date for an active subscription that's scheduled to pause, the subscription status is active and scheduled_change.resume_at is updated to reflect the scheduled resume date.

This operation may result in an immediate charge, so responses may take longer than usual while a payment attempt is processed.

Path Parameters

subscription_idstringrequired

Paddle ID of the subscription entity to work with.

Request Body

One of:

Resume on a specific dateResume immediately

effective_fromstring<date-time>required

When this scheduled change should take effect from. RFC 3339 datetime string of when the subscription should resume.

Valid where subscriptions are active with a scheduled change to pause, or where they have the status of paused.

on_resumestring

How Paddle should set the billing period for the subscription when resuming. If omitted, defaults to start_new_billing_period.

Response

dataobject

Represents a subscription entity.

idstring

Unique Paddle ID for this subscription entity, prefixed with sub_.

statusstring

Status of this subscription. Set automatically by Paddle. Use the pause subscription or cancel subscription operations to change.

customer_idstring

Paddle ID of the customer that this subscription is for, prefixed with ctm_.

address_idstring

Paddle ID of the address that this subscription is for, prefixed with add_.

business_idstring or null

Paddle ID of the business that this subscription is for, prefixed with biz_.

currency_codestring

Supported three-letter ISO 4217 currency code. Transactions for this subscription are created in this currency. Must be USD, EUR, or GBP if collection_mode is manual.

created_atstring<date-time>

RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.

updated_atstring<date-time>

RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.

started_atstring<date-time> or null

RFC 3339 datetime string of when this subscription started. This may be different from first_billed_at if the subscription started in trial.

first_billed_atstring<date-time> or null

RFC 3339 datetime string of when this subscription was first billed. This may be different from started_at if the subscription started in trial.

next_billed_atstring<date-time> or null

RFC 3339 datetime string of when this subscription is next scheduled to be billed.

paused_atstring<date-time> or null

RFC 3339 datetime string of when this subscription was paused. Set automatically by Paddle when the pause subscription operation is used. null if not paused.

canceled_atstring<date-time> or null

RFC 3339 datetime string of when this subscription was canceled. Set automatically by Paddle when the cancel subscription operation is used. null if not canceled.

discountobject or null

Details of the discount applied to this subscription.

collection_modestring

How payment is collected for transactions created for this subscription. automatic for checkout, manual for invoices.

billing_detailsobject or null

Details for invoicing. Required if collection_mode is manual.

current_billing_periodobject or null

Current billing period for this subscription. Set automatically by Paddle based on the billing cycle. null for paused and canceled subscriptions.

billing_cycleobject

How often this subscription renews. Set automatically by Paddle based on the prices on this subscription.

scheduled_changeobject or null

Change that's scheduled to be applied to a subscription. Use the pause subscription, cancel subscription, and resume subscription operations to create scheduled changes. null if no scheduled changes.

management_urlsobject

Customer portal deep links for this subscription.

Authenticated links are only returned when your API key has Customer portal session (Write) permission. For security, the token appended to authenticated links is temporary. You shouldn't store them.

itemsarray[object]

List of items on this subscription. Only recurring items are returned.

custom_dataobject or null

Your own structured key-value data.

import_metaobject or null

Import information for this entity. null if this entity is not imported.

metaobject

Information about this response.

request_idstring

Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.

Request

1
2
3
1{
2  "effective_from": "immediately"
3}

Response

AI AssistantBeta

Ask a question to start a conversation!

If you have made a purchase through Paddle, go to paddle.net instead.

Protected by hCaptcha