get
https://www.pelcro.com/api/v1/core/subscriptions
Retrieve a paginated list of subscriptions.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Overview
Retrieve a paginated list of subscriptions on your site. Supports filtering and expanding relationships.
Example: You want to list all subscriptions with their plan details and latest invoice. Call this endpoint with expand=plan,latestInvoice to include the related data.
| Feature | Fields |
|---|---|
| Searchable | user_id |
| Sortable | None |
| Expandable | address, plan, coupon, defaultSource, latestInvoice, latestChurnPrediction |
Filtering by status
The status parameter accepts several comma separated values and matches any of them, so status=active,past_due returns subscriptions in either state.
Deleted subscriptions
Subscriptions that were canceled immediately are soft deleted, and this endpoint still returns them. A call with no status filter therefore includes them in both the results and meta.total.
When a status filter is applied, whether they are included depends on the status:
canceled,extendedandincomplete_expiredinclude soft deleted subscriptions.- Every other status excludes them.