API reference / Apps
List Stripe subscriptions
Subscriptions in the workspace's Stripe, newest first, with their customer, price and how they end. Filter by status, by customer, to those set to end at the period's end (endingSoon), or to those canceled since a date. Read only. Needs Stripe connected.
/api/v1/apps/stripe/subscriptionsOther ways to call it
troopy stripe subscriptionstroopy_stripe_subscriptionsQuery parameters
statusenum<string>all includes canceled ones
allactivetrialingpast_dueunpaidcanceledincompletepaused
Default "all"
customerstringA customer id, like cus_...
At most 100 characters
endingSoonboolean | enum<string>true: only those still running but set to cancel at the period's end
truefalse
canceledSincestringOnly those canceled on or after this date (looks at the 100 most recently created canceled ones)
date
limitintegerAt most 50; ask for 10 or fewer to read them all at once
Default 10 · At least 1 · At most 50
cursorstringThe next value from the previous page
At most 200 characters
Response
200 · application/jsondata*array<object>11 properties
id*stringcustomer*object3 properties
id*stringemail*string | nullname*string | nullstatus*stringactive, trialing, past_due, unpaid, canceled, incomplete, incomplete_expired or paused
items*array<object>7 properties
product*string | nullprice*stringnickname*string | nullamount*number | nullPer unit, in the currency's main unit; null for tiered or metered prices
currency*stringinterval*string | nullquantity*numbercancelAtPeriodEnd*booleanIt ends at the end of the period: a customer who is leaving
currentPeriodEnd*string | nullcanceledAt*string | nullendedAt*string | nullcancellation*object3 properties
reason*string | nullfeedback*string | nullcomment*string | nulltrialEnd*string | nullcreated*stringISO 8601 date and time
hasMore*booleannext*string | nullPass as cursor for the next page; null on the last