Skip to content

Stripe - Get Subscriptions

This module allows you to query active and past subscriptions in Stripe. You can get a specific subscription or list multiple with filters.

  • Secret Key: Stripe secret key
ParameterTypeRequiredDescription
credentials_idcredentialYesStripe credentials
subscription_idstringNoSpecific ID (sub_xxx)
customer_idstringNoFilter by customer
price_idstringNoFilter by price
statusselectNoFilter by status
created_gtestringNoCreated after (Unix timestamp)
limitnumberNoResults limit (default: 10)
starting_afterstringNoLast object ID for pagination
  • active: Active
  • past_due: Past due
  • unpaid: Unpaid
  • canceled: Canceled
  • incomplete: Incomplete
  • incomplete_expired: Incomplete expired
  • trialing: In trial period
  • paused: Paused
{
"success": true,
"subscriptions": [...],
"count": 10,
"has_more": true,
"message": "10 suscripciones obtenidas"
}
  • id: Subscription ID (sub_xxx)
  • status: Current status
  • customer: Customer ID
  • items: Subscribed products/prices
  • current_period_start: Current period start
  • current_period_end: Current period end
  • cancel_at_period_end: Whether it will cancel at end
  • trial_start: Trial start
  • trial_end: Trial end
{
"subscription_id": "sub_1MowQVLkdIwHu7ixeRlqHVzs"
}
{
"customer_id": "cus_NffrFeUfNV2Hib",
"status": "active"
}
{
"status": "past_due",
"limit": 50
}
  • A past_due subscription will attempt to charge automatically
  • current_period_end indicates when it will renew or cancel
  • trialing subscriptions do not charge until the trial ends
  • StripeCreateSubscription - Create new subscriptions
  • StripeCancelSubscription - Cancel active subscriptions
  • StripeGetCustomers - Get subscription customer data
  • StripeGetInvoices - Get invoices generated by subscriptions