SubscriptionSchedules
Retrieves the list of your subscription schedules.
Table Specific Information
Select
Server-Side Query Support
The cmdlet 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 cmdlet.
- Customer supports the following operator: =.
- CanceledAt supports the following operator: =.
- CompletedAt supports the following operator: =.
- Created supports the following operator: =.
- ReleasedAt supports the following operator: =.
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'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | Unique identifier for the object. | |
| Application | String | ID of the Connect Application that created the schedule. | |
| CanceledAt | Datetime | Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch. | |
| CompletedAt | Datetime | Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch. | |
| Created | Datetime | 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 | ID of the customer who owns the subscription schedule. | |
| MetadataAggregate | String | The set of key/value pairs that you can attach to a an object. | |
| Phases | String | Configuration for the subscription schedules phases. | |
| Status | String | The present status of the subscription schedule. | |
| Subscription | String | ID of the subscription managed by the subscription schedule. | |
| Object | String | String representing the objects 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 thats liable for tax. | |
| DefaultSettingsBillingCycleAnchor | String | Possible values are phase_start or automatic. | |
| DefaultSettingsBillingThresholds | String | Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period | |
| DefaultSettingsCollectionMethod | String | Either charge_automatically, or send_invoice. | |
| DefaultSettingsDefaultPaymentMethod | String | 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 schedules default invoice settings. | |
| DefaultSettingsOnBehalfOf | String | The account (if any) the charge was made on behalf of for charges associated with the schedules subscription. | |
| DefaultSettingsTransferData | String | The account (if any) the associated subscriptions payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscriptions invoices. | |
| EndBehavior | String | Behavior of the subscription schedule and underlying subscription when it ends. | |
| Livemode | Boolean | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
| ReleasedAt | Datetime | Time at which the subscription schedule was released. Measured in seconds since the Unix epoch. | |
| ReleasedSubscription | String | ID of the subscription once managed by the subscription schedule (if it is released). | |
| TestClock | String | ID of the test clock this subscription schedule belongs to. | |
| RenewalInterval | String | The renewal interval of the subscription schedule. |