Package com.stripe.service

Class SubscriptionScheduleService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.SubscriptionScheduleService

public final class SubscriptionScheduleService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
SubscriptionScheduleService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
SubscriptionSchedule	cancel(String schedule)	Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription).
SubscriptionSchedule	cancel(String schedule, RequestOptions options)	Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription).
SubscriptionSchedule	cancel(String schedule, SubscriptionScheduleCancelParams params)	Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription).
SubscriptionSchedule	cancel(String schedule, SubscriptionScheduleCancelParams params, RequestOptions options)	Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription).
SubscriptionSchedule	create()	Creates a new subscription schedule object.
SubscriptionSchedule	create(RequestOptions options)	Creates a new subscription schedule object.
SubscriptionSchedule	create(SubscriptionScheduleCreateParams params)	Creates a new subscription schedule object.
SubscriptionSchedule	create(SubscriptionScheduleCreateParams params, RequestOptions options)	Creates a new subscription schedule object.
StripeCollection<SubscriptionSchedule>	list()	Retrieves the list of your subscription schedules.
StripeCollection<SubscriptionSchedule>	list(RequestOptions options)	Retrieves the list of your subscription schedules.
StripeCollection<SubscriptionSchedule>	list(SubscriptionScheduleListParams params)	Retrieves the list of your subscription schedules.
StripeCollection<SubscriptionSchedule>	list(SubscriptionScheduleListParams params, RequestOptions options)	Retrieves the list of your subscription schedules.
SubscriptionSchedule	release(String schedule)	Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place.
SubscriptionSchedule	release(String schedule, RequestOptions options)	Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place.
SubscriptionSchedule	release(String schedule, SubscriptionScheduleReleaseParams params)	Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place.
SubscriptionSchedule	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.
SubscriptionSchedule	retrieve(String schedule)	Retrieves the details of an existing subscription schedule.
SubscriptionSchedule	retrieve(String schedule, RequestOptions options)	Retrieves the details of an existing subscription schedule.
SubscriptionSchedule	retrieve(String schedule, SubscriptionScheduleRetrieveParams params)	Retrieves the details of an existing subscription schedule.
SubscriptionSchedule	retrieve(String schedule, SubscriptionScheduleRetrieveParams params, RequestOptions options)	Retrieves the details of an existing subscription schedule.
SubscriptionSchedule	update(String schedule)	Updates an existing subscription schedule.
SubscriptionSchedule	update(String schedule, RequestOptions options)	Updates an existing subscription schedule.
SubscriptionSchedule	update(String schedule, SubscriptionScheduleUpdateParams params)	Updates an existing subscription schedule.
SubscriptionSchedule	update(String schedule, SubscriptionScheduleUpdateParams params, RequestOptions options)	Updates an existing subscription schedule.

Methods inherited from class com.stripe.net.ApiService

getResponseGetter, request, requestStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SubscriptionScheduleService

public SubscriptionScheduleService(StripeResponseGetter responseGetter)

Method Details

list

public StripeCollection<SubscriptionSchedule> list(SubscriptionScheduleListParams params)
                                            throws StripeException

Retrieves the list of your subscription schedules.

Throws:

StripeException

list

public StripeCollection<SubscriptionSchedule> list(RequestOptions options)
                                            throws StripeException

Retrieves the list of your subscription schedules.

Throws:

StripeException

list

public StripeCollection<SubscriptionSchedule> list()
                                            throws StripeException

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

public SubscriptionSchedule create(SubscriptionScheduleCreateParams params)
                            throws StripeException

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

Throws:

StripeException

create

public SubscriptionSchedule create(RequestOptions options)
                            throws StripeException

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

Throws:

StripeException

create

public SubscriptionSchedule create()
                            throws StripeException

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

public SubscriptionSchedule retrieve(String schedule)
                              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,
 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

public SubscriptionSchedule update(String schedule,
 RequestOptions options)
                            throws StripeException

Updates an existing subscription schedule.

Throws:

StripeException

update

public SubscriptionSchedule update(String schedule)
                            throws StripeException

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 is not_started or active.

Throws:

StripeException

cancel

public SubscriptionSchedule cancel(String schedule,
 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 is not_started or active.

Throws:

StripeException

cancel

public SubscriptionSchedule cancel(String schedule)
                            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 is not_started or active.

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 is not_started or active.

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 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.

Throws:

StripeException

release

public SubscriptionSchedule release(String schedule,
 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 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.

Throws:

StripeException

release

public SubscriptionSchedule release(String schedule)
                             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 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.

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 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.

Throws:

StripeException