Back to Stripe
Connect Knoon AI with Stripe to automate AI workflows.
Fetch a Stripe subscription by ID and return its status and billing period.
stripeDefaultRetrieveSubscription
BETA
Internal
Permissions
There are no items to display.
Optional permissions
There are no items to display.
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| subscriptionId | mustache | Stripe subscription ID (e.g. "sub_12345"). | Yes |
Returns
| Name | Type | Description |
|---|---|---|
| id | string | Subscription ID. |
| status | string | Subscription status (e.g. active, canceled). |
| customerId | string | Stripe customer ID. |
| currentPeriodStart | string | Current period start time (ISO). |
| currentPeriodEnd | string | Current period end time (ISO). |
| cancelAtPeriodEnd | boolean | Whether the subscription is set to cancel at period end. |
| cancelAt | string | Scheduled cancel time (ISO) when set. |
| canceledAt | string | Cancellation time (ISO) when canceled. |
| trialEnd | string | Trial end time (ISO) when set. |
| latestInvoiceId | string | Latest invoice ID when available. |
| items.id | string | Subscription item ID. |
| items.priceId | string | Price ID for the item. |
| items.productId | string | Product ID for the item. |
| items.quantity | number | Item quantity. |