Package com.stripe.service
Class SubscriptionScheduleService
java.lang.Object
com.stripe.net.ApiService
com.stripe.service.SubscriptionScheduleService
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionCancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription).cancel
(String schedule, RequestOptions options) Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription).cancel
(String schedule, SubscriptionScheduleCancelParams params) Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription).cancel
(String schedule, SubscriptionScheduleCancelParams params, RequestOptions options) Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription).create()
Creates a new subscription schedule object.create
(RequestOptions options) Creates a new subscription schedule object.Creates a new subscription schedule object.create
(SubscriptionScheduleCreateParams params, RequestOptions options) Creates a new subscription schedule object.list()
Retrieves the list of your subscription schedules.list
(RequestOptions options) Retrieves the list of your subscription schedules.list
(SubscriptionScheduleListParams params) Retrieves the list of your subscription schedules.list
(SubscriptionScheduleListParams params, RequestOptions options) Retrieves the list of your subscription schedules.Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place.release
(String schedule, RequestOptions options) Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place.release
(String schedule, SubscriptionScheduleReleaseParams params) Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place.release
(String schedule, SubscriptionScheduleReleaseParams params, RequestOptions options) Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place.Retrieves the details of an existing subscription schedule.retrieve
(String schedule, RequestOptions options) Retrieves the details of an existing subscription schedule.retrieve
(String schedule, SubscriptionScheduleRetrieveParams params) Retrieves the details of an existing subscription schedule.retrieve
(String schedule, SubscriptionScheduleRetrieveParams params, RequestOptions options) Retrieves the details of an existing subscription schedule.Updates an existing subscription schedule.update
(String schedule, RequestOptions options) Updates an existing subscription schedule.update
(String schedule, SubscriptionScheduleUpdateParams params) Updates an existing subscription schedule.update
(String schedule, SubscriptionScheduleUpdateParams params, RequestOptions options) Updates an existing subscription schedule.Methods inherited from class com.stripe.net.ApiService
getResponseGetter, request, requestStream
-
Constructor Details
-
SubscriptionScheduleService
-
-
Method Details
-
list
public StripeCollection<SubscriptionSchedule> list(SubscriptionScheduleListParams params) throws StripeException Retrieves the list of your subscription schedules.- Throws:
StripeException
-
list
Retrieves the list of your subscription schedules.- Throws:
StripeException
-
list
Retrieves the list of your subscription schedules.- Throws:
StripeException
-
list
public StripeCollection<SubscriptionSchedule> list(SubscriptionScheduleListParams params, RequestOptions options) throws StripeException Retrieves the list of your subscription schedules.- Throws:
StripeException
-
create
Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.- Throws:
StripeException
-
create
Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.- Throws:
StripeException
-
create
Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.- Throws:
StripeException
-
create
public SubscriptionSchedule create(SubscriptionScheduleCreateParams params, RequestOptions options) throws StripeException Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.- Throws:
StripeException
-
retrieve
public SubscriptionSchedule retrieve(String schedule, SubscriptionScheduleRetrieveParams params) throws StripeException 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.- Throws:
StripeException
-
retrieve
public SubscriptionSchedule retrieve(String schedule, RequestOptions options) throws StripeException 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.- Throws:
StripeException
-
retrieve
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.- Throws:
StripeException
-
retrieve
public SubscriptionSchedule retrieve(String schedule, SubscriptionScheduleRetrieveParams params, RequestOptions options) throws StripeException 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.- Throws:
StripeException
-
update
public SubscriptionSchedule update(String schedule, SubscriptionScheduleUpdateParams params) throws StripeException Updates an existing subscription schedule.- Throws:
StripeException
-
update
Updates an existing subscription schedule.- Throws:
StripeException
-
update
Updates an existing subscription schedule.- Throws:
StripeException
-
update
public SubscriptionSchedule update(String schedule, SubscriptionScheduleUpdateParams params, RequestOptions options) throws StripeException Updates an existing subscription schedule.- Throws:
StripeException
-
cancel
public SubscriptionSchedule cancel(String schedule, SubscriptionScheduleCancelParams params) throws StripeException 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 isnot_started
oractive
.- Throws:
StripeException
-
cancel
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 isnot_started
oractive
.- Throws:
StripeException
-
cancel
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 isnot_started
oractive
.- Throws:
StripeException
-
cancel
public SubscriptionSchedule cancel(String schedule, SubscriptionScheduleCancelParams params, RequestOptions options) throws StripeException 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 isnot_started
oractive
.- Throws:
StripeException
-
release
public SubscriptionSchedule release(String schedule, SubscriptionScheduleReleaseParams params) throws StripeException 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 isnot_started
oractive
. If the subscription schedule is currently associated with a subscription, releasing it will remove itssubscription
property and set the subscription’s ID to thereleased_subscription
property.- Throws:
StripeException
-
release
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 isnot_started
oractive
. If the subscription schedule is currently associated with a subscription, releasing it will remove itssubscription
property and set the subscription’s ID to thereleased_subscription
property.- Throws:
StripeException
-
release
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 isnot_started
oractive
. If the subscription schedule is currently associated with a subscription, releasing it will remove itssubscription
property and set the subscription’s ID to thereleased_subscription
property.- Throws:
StripeException
-
release
public SubscriptionSchedule release(String schedule, SubscriptionScheduleReleaseParams params, RequestOptions options) throws StripeException 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 isnot_started
oractive
. If the subscription schedule is currently associated with a subscription, releasing it will remove itssubscription
property and set the subscription’s ID to thereleased_subscription
property.- Throws:
StripeException
-