com.squareup.square.models

Class CreateSubscriptionRequest

java.lang.Object

com.squareup.square.models.CreateSubscriptionRequest

public class CreateSubscriptionRequest
extends Object

This is a model class for CreateSubscriptionRequest type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateSubscriptionRequest.Builder Class to build instances of CreateSubscriptionRequest.

Constructor Summary

Constructors

Constructor and Description
CreateSubscriptionRequest(String locationId, String customerId, String idempotencyKey, String planVariationId, String startDate, String canceledDate, String taxPercentage, Money priceOverrideMoney, String cardId, String timezone, SubscriptionSource source, Integer monthlyBillingAnchorDate, List<Phase> phases) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCanceledDate() Getter for CanceledDate.
String	getCardId() Getter for CardId.
String	getCustomerId() Getter for CustomerId.
String	getIdempotencyKey() Getter for IdempotencyKey.
String	getLocationId() Getter for LocationId.
Integer	getMonthlyBillingAnchorDate() Getter for MonthlyBillingAnchorDate.
List<Phase>	getPhases() Getter for Phases.
String	getPlanVariationId() Getter for PlanVariationId.
Money	getPriceOverrideMoney() Getter for PriceOverrideMoney.
SubscriptionSource	getSource() Getter for Source.
String	getStartDate() Getter for StartDate.
String	getTaxPercentage() Getter for TaxPercentage.
String	getTimezone() Getter for Timezone.
int	hashCode()
CreateSubscriptionRequest.Builder	toBuilder() Builds a new CreateSubscriptionRequest.Builder object.
String	toString() Converts this CreateSubscriptionRequest into string format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateSubscriptionRequest

public CreateSubscriptionRequest(String locationId,
                                 String customerId,
                                 String idempotencyKey,
                                 String planVariationId,
                                 String startDate,
                                 String canceledDate,
                                 String taxPercentage,
                                 Money priceOverrideMoney,
                                 String cardId,
                                 String timezone,
                                 SubscriptionSource source,
                                 Integer monthlyBillingAnchorDate,
                                 List<Phase> phases)

Initialization constructor.

Parameters:

locationId - String value for locationId.

customerId - String value for customerId.

idempotencyKey - String value for idempotencyKey.

planVariationId - String value for planVariationId.

startDate - String value for startDate.

canceledDate - String value for canceledDate.

taxPercentage - String value for taxPercentage.

priceOverrideMoney - Money value for priceOverrideMoney.

cardId - String value for cardId.

timezone - String value for timezone.

source - SubscriptionSource value for source.

monthlyBillingAnchorDate - Integer value for monthlyBillingAnchorDate.

phases - List of Phase value for phases.

Method Detail

getIdempotencyKey

public String getIdempotencyKey()

Getter for IdempotencyKey. A unique string that identifies this `CreateSubscription` request. If you do not provide a unique string (or provide an empty string as the value), the endpoint treats each request as independent. For more information, see [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).

Returns:

Returns the String

getLocationId

public String getLocationId()

Getter for LocationId. The ID of the location the subscription is associated with.

Returns:

Returns the String

getPlanVariationId

public String getPlanVariationId()

Getter for PlanVariationId. The ID of the [subscription plan variation](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations#plan-variations) created using the Catalog API.

Returns:

Returns the String

getCustomerId

public String getCustomerId()

Getter for CustomerId. The ID of the [customer](entity:Customer) subscribing to the subscription plan variation.

Returns:

Returns the String

getStartDate

public String getStartDate()

Getter for StartDate. The `YYYY-MM-DD`-formatted date to start the subscription. If it is unspecified, the subscription starts immediately.

Returns:

Returns the String

getCanceledDate

public String getCanceledDate()

Getter for CanceledDate. The `YYYY-MM-DD`-formatted date when the newly created subscription is scheduled for cancellation. This date overrides the cancellation date set in the plan variation configuration. If the cancellation date is earlier than the end date of a subscription cycle, the subscription stops at the canceled date and the subscriber is sent a prorated invoice at the beginning of the canceled cycle. When the subscription plan of the newly created subscription has a fixed number of cycles and the `canceled_date` occurs before the subscription plan expires, the specified `canceled_date` sets the date when the subscription stops through the end of the last cycle.

Returns:

Returns the String

getTaxPercentage

public String getTaxPercentage()

Getter for TaxPercentage. The tax to add when billing the subscription. The percentage is expressed in decimal form, using a `'.'` as the decimal separator and without a `'%'` sign. For example, a value of 7.5 corresponds to 7.5%.

Returns:

Returns the String

getPriceOverrideMoney

public Money getPriceOverrideMoney()

Getter for PriceOverrideMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.

Returns:

Returns the Money

getCardId

public String getCardId()

Getter for CardId. The ID of the [subscriber's](entity:Customer) [card](entity:Card) to charge. If it is not specified, the subscriber receives an invoice via email with a link to pay for their subscription.

Returns:

Returns the String

getTimezone

public String getTimezone()

Getter for Timezone. The timezone that is used in date calculations for the subscription. If unset, defaults to the location timezone. If a timezone is not configured for the location, defaults to "America/New_York". Format: the IANA Timezone Database identifier for the location timezone. For a list of time zones, see [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).

Returns:

Returns the String

getSource

public SubscriptionSource getSource()

Getter for Source. The origination details of the subscription.

Returns:

Returns the SubscriptionSource

getMonthlyBillingAnchorDate

public Integer getMonthlyBillingAnchorDate()

Getter for MonthlyBillingAnchorDate. The day-of-the-month to change the billing date to.

Returns:

Returns the Integer

getPhases

public List<Phase> getPhases()

Getter for Phases. array of phases for this subscription

Returns:

Returns the List of Phase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this CreateSubscriptionRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CreateSubscriptionRequest.Builder toBuilder()

Builds a new CreateSubscriptionRequest.Builder object. Creates the instance with the state of the current model.

Returns:

a new CreateSubscriptionRequest.Builder object