SubscriptionSchedules
Returns subscription schedules, including phase configurations, default settings, and lifecycle status details.
View-Specific Information
SELECT
The driver uses the Stripe API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the driver.
| Column | Supported Operators |
| Customer | = |
| CanceledAt | =, >, >=, <, <= |
| CompletedAt | =, >, >=, <, <= |
| Created | =, >, >=, <, <= |
| ReleasedAt | =, >, >=, <, <= |
You can select from SubscriptionSchedules with the following queries:
SELECT * FROM SubscriptionSchedules WHERE Id = 'sub_sched_1GhPzLJXTn'
SELECT * FROM SubscriptionSchedules WHERE Customer = 'cus_PEW7WrieLzCMkW'
SELECT * FROM SubscriptionSchedules WHERE Created = '2024-01-18 02:16:47.0'
SELECT * FROM SubscriptionSchedules WHERE CanceledAt < '2025-12-03 06:03:35.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | The unique identifier for the subscription schedule. | |
| Application | String | The Id of the Connect application that created the schedule. | |
| CanceledAt | Datetime | The time at which the subscription schedule was canceled, measured in seconds since the Unix epoch. | |
| CompletedAt | Datetime | The time at which the subscription schedule was completed, measured in seconds since the Unix epoch. | |
| Created | Datetime | The time at which the subscription schedule was created, measured in seconds since the Unix epoch. | |
| CurrentPhaseEndDate | Datetime | The end of this phase of the subscription schedule. | |
| CurrentPhaseStartDate | Datetime | The start of this phase of the subscription schedule. | |
| Customer | String |
Customers.Id | The Id of the customer who owns the subscription schedule. |
| MetadataAggregate | String | The set of key-value pairs that you can attach to the subscription schedule. | |
| Phases | String | The configuration for the phases of the subscription schedule. | |
| Status | String | The present status of the subscription schedule. | |
| Subscription | String | The Id of the subscription managed by the subscription schedule. | |
| Object | String | The string representing the object's type. Objects of the same type share the same value. | |
| DefaultSettingsApplicationFeePercent | Decimal | The percentage of the subscription invoice taken as an application fee, as a non-negative decimal between 0 and 100, with at most two decimal places. | |
| DefaultSettingsAutomaticTaxEnabled | Boolean | Indicates whether Stripe automatically computes tax on invoices created during this phase. | |
| DefaultSettingsAutomaticTaxLiability | String | The account that is liable for tax. | |
| DefaultSettingsBillingCycleAnchor | String | Determines how the billing cycle anchor is set. Possible values are phase_start or automatic. | |
| DefaultSettingsBillingThresholds | String | The thresholds at which an invoice is sent and the subscription is advanced to a new billing period. | |
| DefaultSettingsCollectionMethod | String | The method used to collect payment for the subscription. Either charge_automatically or send_invoice. | |
| DefaultSettingsDefaultPaymentMethod | String | The Id of the default payment method for the subscription schedule. | |
| DefaultSettingsDescription | String | The subscription description, meant to be displayed to the customer. | |
| DefaultSettingsInvoiceSettings | String | The default invoice settings for the subscription schedule. | |
| DefaultSettingsOnBehalfOf | String | The account, if any, on behalf of which the charge was made for charges associated with the schedule's subscription. | |
| DefaultSettingsTransferData | String | The account, if any, to which the associated subscription's payments are attributed for tax reporting and to which funds from each payment are transferred for each of the subscription's invoices. | |
| EndBehavior | String | The behavior of the subscription schedule and underlying subscription when it ends. | |
| Livemode | Boolean | Indicates whether the object exists in live mode. Has the value true if the object exists in live mode, or the value false if the object exists in test mode. | |
| ReleasedAt | Datetime | The time at which the subscription schedule was released, measured in seconds since the Unix epoch. | |
| ReleasedSubscription | String | The Id of the subscription once managed by the subscription schedule, if it is released. | |
| TestClock | String | The Id of the test clock this subscription schedule belongs to. | |
| RenewalInterval | String | The renewal interval of the subscription schedule. | |
| DefaultSettingsAutomaticTaxDisabledReason | String | The reason automatic tax was disabled, if Stripe disabled automatic tax.
The allowed values are requires_location_inputs. |