1. Subscriptions
Documentation
  • Back to home
  • StripeKit
  • Installation
  • Getting Started
  • Choosing a Mode
  • Type Reference
  • Setup
    • Configuration
    • Timezones
    • Storage Adapter
    • Money and Currency
    • Error Handling
  • Stripe
    • Elements
  • Modules
    • Overview
    • Customers
      • Overview
      • List
      • Retrieve
      • Find or Create by Email
      • Create
      • Update
      • Sync
      • Delete
    • Payment Methods
      • Overview
      • Create Setup Intent
      • List
      • Attach
      • Detach
      • Set Default
      • Sync
    • Payments
      • Overview
      • Pay With Saved Method
      • Create
      • Retrieve
      • Confirm
      • Cancel
      • Sync
    • Checkout
      • Overview
      • Get
      • Create
      • Submit Fields
      • Apply Coupon
      • Mark Complete
    • Subscriptions
      • Overview
      • Create
      • Retrieve
      • Cancel
      • Resume
      • Toggle Collection Method
      • Update Fields
      • Apply Promotion Code
      • List By Customer
      • Find By Metadata
      • Sync
    • Invoices
      • Overview
      • Retrieve
      • List By Customer
      • List By Subscription
      • Pay With Saved Method
      • Void
      • Finalize
      • Sync
    • Coupons
      • Overview
      • Create
      • Validate
      • Apply To Subscription
      • List
      • Deactivate
    • Webhooks
      • Overview
      • Process
      • Events Reference
    • Sync
      • Overview
  1. Subscriptions

Resume

kit.subscriptions.resume()#

Undoes a scheduled cancel-at-period-end, so the subscription keeps renewing. Has no effect on a subscription that isn't scheduled to cancel, and cannot bring back a subscription that has already been cancelled immediately.

Signature#

Example request#

Example response#

Same shape as retrieve()'s response, with cancelAtPeriodEnd set to false.

Errors#

ExceptionWhen
StripeOperationErrorThe subscription ID does not exist.

Notes#

This only reverses a scheduled atPeriodEnd cancellation made via cancel(). It cannot un-cancel a subscription that was cancelled immediately (atPeriodEnd: false); Stripe does not support reactivating a fully cancelled subscription, you'll need to create a new one instead.
Previous
Cancel
Next
Toggle Collection Method
Built with