@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

Retrieves the list of your subscription schedules.

@optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param customer [String?] Only return subscription schedules for the given customer. @optional @param completed_at [Stripe::GetAccountsCreatedParameter?] Only return subscription schedules that completed during the given date interval. @optional @param scheduled [Bool?] Only return subscription schedules that have not started yet. @optional @param canceled_at [Stripe::GetAccountsCreatedParameter?] Only return subscription schedules that were created canceled the given date interval. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return subscription schedules that were created during the given date interval. @optional @param released_at [Stripe::GetAccountsCreatedParameter?] Only return subscription schedules that were released during the given date interval. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::SubscriptionSchedulesResourceScheduleList]

<p>Retrieves the list of your subscription schedules.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param customer [String?] Only return subscription schedules for the given customer. @optional @param completed_at [Stripe::GetAccountsCreatedParameter?] Only return subscription schedules that completed during the given date interval. @optional @param scheduled [Bool?] Only return subscription schedules that have not started yet. @optional @param canceled_at [Stripe::GetAccountsCreatedParameter?] Only return subscription schedules that were created canceled the given date interval. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return subscription schedules that were created during the given date interval. @optional @param released_at [Stripe::GetAccountsCreatedParameter?] Only return subscription schedules that were released during the given date interval. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.

@required @param schedule [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::SubscriptionSchedule]

<p>Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.</p> @required @param schedule [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

<p>Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.</p> @required @param schedule [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::SubscriptionSchedule, Integer, Hash)] Stripe::SubscriptionSchedule, response status code and response headers

<p>Retrieves the list of your subscription schedules.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param customer [String?] Only return subscription schedules for the given customer. @optional @param completed_at [Stripe::GetAccountsCreatedParameter?] Only return subscription schedules that completed during the given date interval. @optional @param scheduled [Bool?] Only return subscription schedules that have not started yet. @optional @param canceled_at [Stripe::GetAccountsCreatedParameter?] Only return subscription schedules that were created canceled the given date interval. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return subscription schedules that were created during the given date interval. @optional @param released_at [Stripe::GetAccountsCreatedParameter?] Only return subscription schedules that were released during the given date interval. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::SubscriptionSchedulesResourceScheduleList, Integer, Hash)] Stripe::SubscriptionSchedulesResourceScheduleList, response status code and response headers

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

@optional @param customer [String?] The identifier of the customer to create the subscription schedule for. @optional @param default_settings [Stripe::DefaultSettingsParams?] @optional @param end_behavior [String?] Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param from_subscription [String?] Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param phases [Array(Stripe::PhaseConfigurationParams)?] List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. @optional @param start_date [Stripe::PostSubscriptionSchedulesRequestStartDate?] @return [Stripe::SubscriptionSchedule]

<p>Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.</p> @optional @param customer [String?] The identifier of the customer to create the subscription schedule for. @optional @param default_settings [Stripe::DefaultSettingsParams?] @optional @param end_behavior [String?] Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param from_subscription [String?] Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param phases [Array(Stripe::PhaseConfigurationParams)?] List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the end_date of one phase will always equal the start_date of the next phase. @optional @param start_date [Stripe::PostSubscriptionSchedulesRequestStartDate?] @return nil

Updates an existing subscription schedule.

@required @param schedule [String?] @optional @param default_settings [Stripe::DefaultSettingsParams?] @optional @param end_behavior [String?] Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param phases [Array(Stripe::PhaseConfigurationParams)?] List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted. @optional @param proration_behavior [String?] If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`. @return [Stripe::SubscriptionSchedule]

<p>Updates an existing subscription schedule.</p> @required @param schedule [String?] @optional @param default_settings [Stripe::DefaultSettingsParams?] @optional @param end_behavior [String?] Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param phases [Array(Stripe::PhaseConfigurationParams)?] List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the end_date of one phase will always equal the start_date of the next phase. Note that past phases can be omitted. @optional @param proration_behavior [String?] If the update changes the current phase, indicates whether the changes should be prorated. The default value is create_prorations. @return nil

Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.

@required @param schedule [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param invoice_now [Bool?] If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`. @optional @param prorate [Bool?] If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`. @return [Stripe::SubscriptionSchedule]

<p>Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is <code>not_started</code> or <code>active</code>.</p> @required @param schedule [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param invoice_now [Bool?] If the subscription schedule is active, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to true. @optional @param prorate [Bool?] If the subscription schedule is active, indicates if the cancellation should be prorated. Defaults to true. @return nil

<p>Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is <code>not_started</code> or <code>active</code>.</p> @required @param schedule [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param invoice_now [Bool?] If the subscription schedule is active, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to true. @optional @param prorate [Bool?] If the subscription schedule is active, indicates if the cancellation should be prorated. Defaults to true. @return [Tuple(Stripe::SubscriptionSchedule, Integer, Hash)] Stripe::SubscriptionSchedule, response status code and response headers

Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription’s ID to the released_subscription property.

@required @param schedule [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param preserve_cancel_date [Bool?] Keep any cancellation on the subscription that the schedule has set @return [Stripe::SubscriptionSchedule]

<p>Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is <code>not_started</code> or <code>active</code>. If the subscription schedule is currently associated with a subscription, releasing it will remove its <code>subscription</code> property and set the subscription’s ID to the <code>released_subscription</code> property.</p> @required @param schedule [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param preserve_cancel_date [Bool?] Keep any cancellation on the subscription that the schedule has set @return nil

<p>Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is <code>not_started</code> or <code>active</code>. If the subscription schedule is currently associated with a subscription, releasing it will remove its <code>subscription</code> property and set the subscription’s ID to the <code>released_subscription</code> property.</p> @required @param schedule [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param preserve_cancel_date [Bool?] Keep any cancellation on the subscription that the schedule has set @return [Tuple(Stripe::SubscriptionSchedule, Integer, Hash)] Stripe::SubscriptionSchedule, response status code and response headers

<p>Updates an existing subscription schedule.</p> @required @param schedule [String?] @optional @param default_settings [Stripe::DefaultSettingsParams?] @optional @param end_behavior [String?] Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param phases [Array(Stripe::PhaseConfigurationParams)?] List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the end_date of one phase will always equal the start_date of the next phase. Note that past phases can be omitted. @optional @param proration_behavior [String?] If the update changes the current phase, indicates whether the changes should be prorated. The default value is create_prorations. @return [Tuple(Stripe::SubscriptionSchedule, Integer, Hash)] Stripe::SubscriptionSchedule, response status code and response headers

<p>Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.</p> @optional @param customer [String?] The identifier of the customer to create the subscription schedule for. @optional @param default_settings [Stripe::DefaultSettingsParams?] @optional @param end_behavior [String?] Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param from_subscription [String?] Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param phases [Array(Stripe::PhaseConfigurationParams)?] List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the end_date of one phase will always equal the start_date of the next phase. @optional @param start_date [Stripe::PostSubscriptionSchedulesRequestStartDate?] @return [Tuple(Stripe::SubscriptionSchedule, Integer, Hash)] Stripe::SubscriptionSchedule, response status code and response headers