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 idempotencyKey, String locationId, String planId, String customerId, String startDate, String canceledDate, String taxPercentage, Money priceOverrideMoney, String cardId, String timezone) 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.
String	getPlanId() Getter for PlanId.
Money	getPriceOverrideMoney() Getter for PriceOverrideMoney.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateSubscriptionRequest

public CreateSubscriptionRequest(String idempotencyKey,
                                 String locationId,
                                 String planId,
                                 String customerId,
                                 String startDate,
                                 String canceledDate,
                                 String taxPercentage,
                                 Money priceOverrideMoney,
                                 String cardId,
                                 String timezone)

Initialization constructor.

Parameters:

idempotencyKey -

locationId -

planId -

customerId -

startDate -

canceledDate -

taxPercentage -

priceOverrideMoney -

cardId -

timezone -

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/docs/working-with-apis/idempotency).

getLocationId

public String getLocationId()

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

getPlanId

public String getPlanId()

Getter for PlanId. The ID of the subscription plan. For more information, see [Subscription Plan Overview](https://developer.squareup.com/docs/docs/subscriptions/overview).

getCustomerId

public String getCustomerId()

Getter for CustomerId. The ID of the [customer](#type-customer) profile.

getStartDate

public String getStartDate()

Getter for StartDate. The start date of the subscription, in YYYY-MM-DD format. For example, 2013-01-15. If the start date is left empty, the subscription begins immediately.

getCanceledDate

public String getCanceledDate()

Getter for CanceledDate. The date when the subscription should be canceled, in YYYY-MM-DD format (for example, 2025-02-29). This overrides the plan configuration if it comes before the date the subscription would otherwise end.

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

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.

getCardId

public String getCardId()

Getter for CardId. The ID of the [customer](#type-customer) [card](#type-card) to charge. If not specified, Square sends an invoice via email. For an example to create a customer and add a card on file, see [Subscriptions Walkthrough](https://developer.squareup.com/docs/docs/subscriptions-api/walkthrough).

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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