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
Subscriptions
Retrieve
kit.subscriptions.retrieve()
#
Fetches a subscription by ID.
Signature
#
Example request
#
Example response
#
Same shape as
create()
's response, with
userId
set to whatever you passed in (or
null
if omitted).
Errors
#
Exception
When
StripeOperationError
The subscription ID does not exist.
Notes
#
This call does not write to your storage adapter. Use
sync()
if you also want the result persisted.
Previous
Create
Next
Cancel