public class SubscriptionSchedule extends ApiResource implements HasId, MetadataStore<SubscriptionSchedule>
Modifier and Type | Class and Description |
---|---|
static class |
SubscriptionSchedule.CurrentPhase |
static class |
SubscriptionSchedule.DefaultSettings |
static class |
SubscriptionSchedule.InvoiceSettings |
static class |
SubscriptionSchedule.Phase |
static class |
SubscriptionSchedule.PhaseItem |
static class |
SubscriptionSchedule.RenewalInterval |
ApiResource.RequestMethod, ApiResource.RequestType
CHARSET, GSON
PRETTY_PRINT_GSON
Constructor and Description |
---|
SubscriptionSchedule() |
Modifier and Type | Method and Description |
---|---|
SubscriptionSchedule |
cancel()
Cancels a subscription schedule and its associated subscription immediately (if the
subscription schedule has an active subscription).
|
SubscriptionSchedule |
cancel(java.util.Map<java.lang.String,java.lang.Object> params)
Cancels a subscription schedule and its associated subscription immediately (if the
subscription schedule has an active subscription).
|
SubscriptionSchedule |
cancel(java.util.Map<java.lang.String,java.lang.Object> params,
RequestOptions options)
Cancels a subscription schedule and its associated subscription immediately (if the
subscription schedule has an active subscription).
|
SubscriptionSchedule |
cancel(RequestOptions options)
Cancels a subscription schedule and its associated subscription immediately (if the
subscription schedule has an active subscription).
|
SubscriptionSchedule |
cancel(SubscriptionScheduleCancelParams params)
Cancels a subscription schedule and its associated subscription immediately (if the
subscription schedule has an active subscription).
|
SubscriptionSchedule |
cancel(SubscriptionScheduleCancelParams params,
RequestOptions options)
Cancels a subscription schedule and its associated subscription immediately (if the
subscription schedule has an active subscription).
|
protected boolean |
canEqual(java.lang.Object other) |
static SubscriptionSchedule |
create(java.util.Map<java.lang.String,java.lang.Object> params)
Creates a new subscription schedule object.
|
static SubscriptionSchedule |
create(java.util.Map<java.lang.String,java.lang.Object> params,
RequestOptions options)
Creates a new subscription schedule object.
|
static SubscriptionSchedule |
create(SubscriptionScheduleCreateParams params)
Creates a new subscription schedule object.
|
static SubscriptionSchedule |
create(SubscriptionScheduleCreateParams params,
RequestOptions options)
Creates a new subscription schedule object.
|
boolean |
equals(java.lang.Object o) |
java.lang.Long |
getCanceledAt()
Time at which the subscription schedule was canceled.
|
java.lang.Long |
getCompletedAt()
Time at which the subscription schedule was completed.
|
java.lang.Long |
getCreated()
Time at which the object was created.
|
SubscriptionSchedule.CurrentPhase |
getCurrentPhase()
Object representing the start and end dates for the current phase of the subscription schedule,
if it is `active`.
|
java.lang.String |
getCustomer()
Get id of expandable `customer` object.
|
Customer |
getCustomerObject()
Get expanded `customer`.
|
SubscriptionSchedule.DefaultSettings |
getDefaultSettings() |
java.lang.String |
getEndBehavior()
Behavior of the subscription schedule and underlying subscription when it ends.
|
java.lang.String |
getId()
Unique identifier for the object.
|
java.lang.Boolean |
getLivemode()
Has the value `true` if the object exists in live mode or the value `false` if the object
exists in test mode.
|
java.util.Map<java.lang.String,java.lang.String> |
getMetadata()
Set of key-value pairs that you can attach to an object.
|
java.lang.String |
getObject()
String representing the object's type.
|
java.util.List<SubscriptionSchedule.Phase> |
getPhases()
Configuration for the subscription schedule's phases.
|
java.lang.Long |
getReleasedAt()
Time at which the subscription schedule was released.
|
java.lang.String |
getReleasedSubscription()
ID of the subscription once managed by the subscription schedule (if it is released).
|
SubscriptionSchedule.RenewalInterval |
getRenewalInterval()
This field has been deprecated.
|
java.lang.String |
getStatus()
The present status of the subscription schedule.
|
java.lang.String |
getSubscription()
Get id of expandable `subscription` object.
|
Subscription |
getSubscriptionObject()
Get expanded `subscription`.
|
int |
hashCode() |
static SubscriptionScheduleCollection |
list(java.util.Map<java.lang.String,java.lang.Object> params)
Retrieves the list of your subscription schedules.
|
static SubscriptionScheduleCollection |
list(java.util.Map<java.lang.String,java.lang.Object> params,
RequestOptions options)
Retrieves the list of your subscription schedules.
|
static SubscriptionScheduleCollection |
list(SubscriptionScheduleListParams params)
Retrieves the list of your subscription schedules.
|
static SubscriptionScheduleCollection |
list(SubscriptionScheduleListParams params,
RequestOptions options)
Retrieves the list of your subscription schedules.
|
SubscriptionSchedule |
release()
Releases the subscription schedule immediately, which will stop scheduling of its phases, but
leave any existing subscription in place.
|
SubscriptionSchedule |
release(java.util.Map<java.lang.String,java.lang.Object> params)
Releases the subscription schedule immediately, which will stop scheduling of its phases, but
leave any existing subscription in place.
|
SubscriptionSchedule |
release(java.util.Map<java.lang.String,java.lang.Object> params,
RequestOptions options)
Releases the subscription schedule immediately, which will stop scheduling of its phases, but
leave any existing subscription in place.
|
SubscriptionSchedule |
release(RequestOptions options)
Releases the subscription schedule immediately, which will stop scheduling of its phases, but
leave any existing subscription in place.
|
SubscriptionSchedule |
release(SubscriptionScheduleReleaseParams params)
Releases the subscription schedule immediately, which will stop scheduling of its phases, but
leave any existing subscription in place.
|
SubscriptionSchedule |
release(SubscriptionScheduleReleaseParams params,
RequestOptions options)
Releases the subscription schedule immediately, which will stop scheduling of its phases, but
leave any existing subscription in place.
|
static SubscriptionSchedule |
retrieve(java.lang.String schedule)
Retrieves the details of an existing subscription schedule.
|
static SubscriptionSchedule |
retrieve(java.lang.String schedule,
java.util.Map<java.lang.String,java.lang.Object> params,
RequestOptions options)
Retrieves the details of an existing subscription schedule.
|
static SubscriptionSchedule |
retrieve(java.lang.String schedule,
RequestOptions options)
Retrieves the details of an existing subscription schedule.
|
static SubscriptionSchedule |
retrieve(java.lang.String schedule,
SubscriptionScheduleRetrieveParams params,
RequestOptions options)
Retrieves the details of an existing subscription schedule.
|
void |
setCanceledAt(java.lang.Long canceledAt)
Time at which the subscription schedule was canceled.
|
void |
setCompletedAt(java.lang.Long completedAt)
Time at which the subscription schedule was completed.
|
void |
setCreated(java.lang.Long created)
Time at which the object was created.
|
void |
setCurrentPhase(SubscriptionSchedule.CurrentPhase currentPhase)
Object representing the start and end dates for the current phase of the subscription schedule,
if it is `active`.
|
void |
setCustomer(java.lang.String id) |
void |
setCustomerObject(Customer expandableObject) |
void |
setDefaultSettings(SubscriptionSchedule.DefaultSettings defaultSettings) |
void |
setEndBehavior(java.lang.String endBehavior)
Behavior of the subscription schedule and underlying subscription when it ends.
|
void |
setId(java.lang.String id)
Unique identifier for the object.
|
void |
setLivemode(java.lang.Boolean livemode)
Has the value `true` if the object exists in live mode or the value `false` if the object
exists in test mode.
|
void |
setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
Set of key-value pairs that you can attach to an object.
|
void |
setObject(java.lang.String object)
String representing the object's type.
|
void |
setPhases(java.util.List<SubscriptionSchedule.Phase> phases)
Configuration for the subscription schedule's phases.
|
void |
setReleasedAt(java.lang.Long releasedAt)
Time at which the subscription schedule was released.
|
void |
setReleasedSubscription(java.lang.String releasedSubscription)
ID of the subscription once managed by the subscription schedule (if it is released).
|
void |
setRenewalInterval(SubscriptionSchedule.RenewalInterval renewalInterval)
This field has been deprecated.
|
void |
setStatus(java.lang.String status)
The present status of the subscription schedule.
|
void |
setSubscription(java.lang.String id) |
void |
setSubscriptionObject(Subscription expandableObject) |
SubscriptionSchedule |
update(java.util.Map<java.lang.String,java.lang.Object> params)
Updates an existing subscription schedule.
|
SubscriptionSchedule |
update(java.util.Map<java.lang.String,java.lang.Object> params,
RequestOptions options)
Updates an existing subscription schedule.
|
SubscriptionSchedule |
update(SubscriptionScheduleUpdateParams params)
Updates an existing subscription schedule.
|
SubscriptionSchedule |
update(SubscriptionScheduleUpdateParams params,
RequestOptions options)
Updates an existing subscription schedule.
|
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, multipartRequest, request, request, requestCollection, requestCollection, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
public java.lang.String getCustomer()
public void setCustomer(java.lang.String id)
public Customer getCustomerObject()
public void setCustomerObject(Customer expandableObject)
public java.lang.String getSubscription()
public void setSubscription(java.lang.String id)
public Subscription getSubscriptionObject()
public void setSubscriptionObject(Subscription expandableObject)
public static SubscriptionScheduleCollection list(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
StripeException
public static SubscriptionScheduleCollection list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
StripeException
public static SubscriptionScheduleCollection list(SubscriptionScheduleListParams params) throws StripeException
StripeException
public static SubscriptionScheduleCollection list(SubscriptionScheduleListParams params, RequestOptions options) throws StripeException
StripeException
public static SubscriptionSchedule create(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
StripeException
public static SubscriptionSchedule create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
StripeException
public static SubscriptionSchedule create(SubscriptionScheduleCreateParams params) throws StripeException
StripeException
public static SubscriptionSchedule create(SubscriptionScheduleCreateParams params, RequestOptions options) throws StripeException
StripeException
public static SubscriptionSchedule retrieve(java.lang.String schedule) throws StripeException
StripeException
public static SubscriptionSchedule retrieve(java.lang.String schedule, RequestOptions options) throws StripeException
StripeException
public static SubscriptionSchedule retrieve(java.lang.String schedule, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
StripeException
public static SubscriptionSchedule retrieve(java.lang.String schedule, SubscriptionScheduleRetrieveParams params, RequestOptions options) throws StripeException
StripeException
public SubscriptionSchedule update(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
update
in interface MetadataStore<SubscriptionSchedule>
StripeException
public SubscriptionSchedule update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
update
in interface MetadataStore<SubscriptionSchedule>
StripeException
public SubscriptionSchedule update(SubscriptionScheduleUpdateParams params) throws StripeException
StripeException
public SubscriptionSchedule update(SubscriptionScheduleUpdateParams params, RequestOptions options) throws StripeException
StripeException
public SubscriptionSchedule cancel() throws StripeException
not_started
or active
.StripeException
public SubscriptionSchedule cancel(RequestOptions options) throws StripeException
not_started
or active
.StripeException
public SubscriptionSchedule cancel(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
not_started
or active
.StripeException
public SubscriptionSchedule cancel(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
not_started
or active
.StripeException
public SubscriptionSchedule cancel(SubscriptionScheduleCancelParams params) throws StripeException
not_started
or active
.StripeException
public SubscriptionSchedule cancel(SubscriptionScheduleCancelParams params, RequestOptions options) throws StripeException
not_started
or active
.StripeException
public SubscriptionSchedule release() throws StripeException
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.StripeException
public SubscriptionSchedule release(RequestOptions options) throws StripeException
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.StripeException
public SubscriptionSchedule release(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
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.StripeException
public SubscriptionSchedule release(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
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.StripeException
public SubscriptionSchedule release(SubscriptionScheduleReleaseParams params) throws StripeException
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.StripeException
public SubscriptionSchedule release(SubscriptionScheduleReleaseParams params, RequestOptions options) throws StripeException
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.StripeException
public java.lang.Long getCanceledAt()
public java.lang.Long getCompletedAt()
public java.lang.Long getCreated()
public SubscriptionSchedule.CurrentPhase getCurrentPhase()
public SubscriptionSchedule.DefaultSettings getDefaultSettings()
public java.lang.String getEndBehavior()
One of `cancel`, `none`, `release`, or `renew`.
public java.lang.Boolean getLivemode()
public java.lang.String getObject()
Equal to `subscription_schedule`.
public java.util.List<SubscriptionSchedule.Phase> getPhases()
public java.lang.Long getReleasedAt()
public java.lang.String getReleasedSubscription()
public SubscriptionSchedule.RenewalInterval getRenewalInterval()
public java.lang.String getStatus()
One of `active`, `canceled`, `completed`, `not_started`, or `released`.
public void setCanceledAt(java.lang.Long canceledAt)
public void setCompletedAt(java.lang.Long completedAt)
public void setCreated(java.lang.Long created)
public void setCurrentPhase(SubscriptionSchedule.CurrentPhase currentPhase)
public void setDefaultSettings(SubscriptionSchedule.DefaultSettings defaultSettings)
public void setEndBehavior(java.lang.String endBehavior)
One of `cancel`, `none`, `release`, or `renew`.
public void setId(java.lang.String id)
public void setLivemode(java.lang.Boolean livemode)
public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
public void setObject(java.lang.String object)
Equal to `subscription_schedule`.
public void setPhases(java.util.List<SubscriptionSchedule.Phase> phases)
public void setReleasedAt(java.lang.Long releasedAt)
public void setReleasedSubscription(java.lang.String releasedSubscription)
public void setRenewalInterval(SubscriptionSchedule.RenewalInterval renewalInterval)
public void setStatus(java.lang.String status)
One of `active`, `canceled`, `completed`, `not_started`, or `released`.
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
protected boolean canEqual(java.lang.Object other)
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String getId()
public java.util.Map<java.lang.String,java.lang.String> getMetadata()
getMetadata
in interface MetadataStore<SubscriptionSchedule>