SubscriptionSchedules
Returns the subscription schedules in Stripe.
View-Specific Information
SELECT
The add-in 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 add-in.
| 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 Status = 'active'
SELECT * FROM SubscriptionSchedules WHERE CanceledAt < '2025-12-03 06:03:35.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | Unique identifier for the object. | |
| Application | String | The Id of the Connect Application that created the schedule. | |
| CanceledAt | Datetime | The date and time at which the subscription schedule was canceled, measured in seconds since the Unix epoch. | |
| CompletedAt | Datetime | The date and time at which the subscription schedule was completed, measured in seconds since the Unix epoch. | |
| Created | Datetime | The date and time at which the object 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 | The Id of the customer who owns the subscription schedule. | |
| MetadataAggregate | String | The set of key-value pairs that you can attach to an object. | |
| Phases | String | Configuration for the subscription schedule's phases. | |
| Status | String | The present status of the subscription schedule. | |
| Subscription | String | The Id of the subscription managed by the subscription schedule. | |
| Object | String | String representing the object's type. Objects of the same type share the same value. | |
| DefaultSettingsApplicationFeePercent | Decimal | A non-negative decimal between 0 and 100, with at most two decimal places. | |
| DefaultSettingsAutomaticTaxEnabled | Boolean | Whether Stripe automatically computes tax on invoices created during this phase. | |
| DefaultSettingsAutomaticTaxLiability | String | The account that's liable for tax. | |
| DefaultSettingsBillingCycleAnchor | String | Possible values are phase_start or automatic. | |
| DefaultSettingsBillingThresholds | String | Define thresholds at which an invoice is sent, and the subscription advanced to a new billing period. | |
| DefaultSettingsCollectionMethod | String | Either charge_automatically, or send_invoice. | |
| DefaultSettingsDefaultPaymentMethod | String | The Id of the default payment method for the subscription schedule. | |
| DefaultSettingsDescription | String | Subscription description, meant to be displayable to the customer. | |
| DefaultSettingsInvoiceSettings | String | The subscription schedule's default invoice settings. | |
| DefaultSettingsOnBehalfOf | String | The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. | |
| DefaultSettingsTransferData | String | The account (if any) the associated subscription's payments are attributed to for tax reporting, and where funds from each payment are transferred to for each of the subscription's invoices. | |
| EndBehavior | String | Behavior of the subscription schedule and underlying subscription when it ends. | |
| Livemode | Boolean | Indicates whether the object exists in live mode. The value is true in live mode and false in test mode. | |
| ReleasedAt | Datetime | The date and 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 | If Stripe disabled automatic tax, this enum describes why.
The allowed values are requires_location_inputs. |