Subscription (Square 37.0.0.20240118 API)

java.lang.Object
- com.squareup.square.models.Subscription

```
public class Subscription
extends Object
```
This is a model class for Subscription type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Subscription.Builder
Class to build instances of Subscription.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Subscription.Builder` Class to build instances of `Subscription`.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	Subscription(String id, String locationId, String planVariationId, String customerId, String startDate, io.apimatic.core.types.OptionalNullable<String> canceledDate, String chargedThroughDate, String status, io.apimatic.core.types.OptionalNullable<String> taxPercentage, List<String> invoiceIds, Money priceOverrideMoney, Long version, String createdAt, io.apimatic.core.types.OptionalNullable<String> cardId, String timezone, SubscriptionSource source, io.apimatic.core.types.OptionalNullable<List<SubscriptionAction>> actions, Integer monthlyBillingAnchorDate, List<Phase> phases) Initialization constructor.
	`Subscription(String id, String locationId, String planVariationId, String customerId, String startDate, String canceledDate, String chargedThroughDate, String status, String taxPercentage, List<String> invoiceIds, Money priceOverrideMoney, Long version, String createdAt, String cardId, String timezone, SubscriptionSource source, List<SubscriptionAction> actions, Integer monthlyBillingAnchorDate, List<Phase> phases)` Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`List<SubscriptionAction>`	`getActions()` Getter for Actions.
`String`	`getCanceledDate()` Getter for CanceledDate.
`String`	`getCardId()` Getter for CardId.
`String`	`getChargedThroughDate()` Getter for ChargedThroughDate.
`String`	`getCreatedAt()` Getter for CreatedAt.
`String`	`getCustomerId()` Getter for CustomerId.
`String`	`getId()` Getter for Id.
`List<String>`	`getInvoiceIds()` Getter for InvoiceIds.
`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`	`getStatus()` Getter for Status.
`String`	`getTaxPercentage()` Getter for TaxPercentage.
`String`	`getTimezone()` Getter for Timezone.
`Long`	`getVersion()` Getter for Version.
`int`	`hashCode()`
`protected io.apimatic.core.types.OptionalNullable<List<SubscriptionAction>>`	`internalGetActions()` Internal Getter for Actions.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetCanceledDate()` Internal Getter for CanceledDate.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetCardId()` Internal Getter for CardId.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetTaxPercentage()` Internal Getter for TaxPercentage.
`Subscription.Builder`	`toBuilder()` Builds a new `Subscription.Builder` object.
`String`	`toString()` Converts this Subscription into string format.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Subscription
```
public Subscription(String id,
                    String locationId,
                    String planVariationId,
                    String customerId,
                    String startDate,
                    String canceledDate,
                    String chargedThroughDate,
                    String status,
                    String taxPercentage,
                    List<String> invoiceIds,
                    Money priceOverrideMoney,
                    Long version,
                    String createdAt,
                    String cardId,
                    String timezone,
                    SubscriptionSource source,
                    List<SubscriptionAction> actions,
                    Integer monthlyBillingAnchorDate,
                    List<Phase> phases)
```
    Initialization constructor.
    
    Parameters:
    
    id - String value for id.
    
    locationId - String value for locationId.
    
    planVariationId - String value for planVariationId.
    
    customerId - String value for customerId.
    
    startDate - String value for startDate.
    
    canceledDate - String value for canceledDate.
    
    chargedThroughDate - String value for chargedThroughDate.
    
    status - String value for status.
    
    taxPercentage - String value for taxPercentage.
    
    invoiceIds - List of String value for invoiceIds.
    
    priceOverrideMoney - Money value for priceOverrideMoney.
    
    version - Long value for version.
    
    createdAt - String value for createdAt.
    
    cardId - String value for cardId.
    
    timezone - String value for timezone.
    
    source - SubscriptionSource value for source.
    
    actions - List of SubscriptionAction value for actions.
    
    monthlyBillingAnchorDate - Integer value for monthlyBillingAnchorDate.
    
    phases - List of Phase value for phases.
  - Subscription
```
protected Subscription(String id,
                       String locationId,
                       String planVariationId,
                       String customerId,
                       String startDate,
                       io.apimatic.core.types.OptionalNullable<String> canceledDate,
                       String chargedThroughDate,
                       String status,
                       io.apimatic.core.types.OptionalNullable<String> taxPercentage,
                       List<String> invoiceIds,
                       Money priceOverrideMoney,
                       Long version,
                       String createdAt,
                       io.apimatic.core.types.OptionalNullable<String> cardId,
                       String timezone,
                       SubscriptionSource source,
                       io.apimatic.core.types.OptionalNullable<List<SubscriptionAction>> actions,
                       Integer monthlyBillingAnchorDate,
                       List<Phase> phases)
```
    Initialization constructor.
    
    Parameters:
    
    id - String value for id.
    
    locationId - String value for locationId.
    
    planVariationId - String value for planVariationId.
    
    customerId - String value for customerId.
    
    startDate - String value for startDate.
    
    canceledDate - String value for canceledDate.
    
    chargedThroughDate - String value for chargedThroughDate.
    
    status - String value for status.
    
    taxPercentage - String value for taxPercentage.
    
    invoiceIds - List of String value for invoiceIds.
    
    priceOverrideMoney - Money value for priceOverrideMoney.
    
    version - Long value for version.
    
    createdAt - String value for createdAt.
    
    cardId - String value for cardId.
    
    timezone - String value for timezone.
    
    source - SubscriptionSource value for source.
    
    actions - List of SubscriptionAction value for actions.
    
    monthlyBillingAnchorDate - Integer value for monthlyBillingAnchorDate.
    
    phases - List of Phase value for phases.
- Method Detail
  - getId
```
public String getId()
```
    Getter for Id. The Square-assigned ID of the subscription.
    
    Returns:
    
    Returns the String
  - getLocationId
```
public String getLocationId()
```
    Getter for LocationId. The ID of the location associated with the subscription.
    
    Returns:
    
    Returns the String
  - getPlanVariationId
```
public String getPlanVariationId()
```
    Getter for PlanVariationId. The ID of the subscribed-to [subscription plan variation](entity:CatalogSubscriptionPlanVariation).
    
    Returns:
    
    Returns the String
  - getCustomerId
```
public String getCustomerId()
```
    Getter for CustomerId. The ID of the subscribing [customer](entity:Customer) profile.
    
    Returns:
    
    Returns the String
  - getStartDate
```
public String getStartDate()
```
    Getter for StartDate. The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) to start the subscription.
    
    Returns:
    
    Returns the String
  - internalGetCanceledDate
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetCanceledDate()
```
    Internal Getter for CanceledDate. The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) to cancel the subscription, when the subscription status changes to `CANCELED` and the subscription billing stops. If this field is not set, the subscription ends according its subscription plan. This field cannot be updated, other than being cleared.
    
    Returns:
    
    Returns the Internal String
  - getCanceledDate
```
public String getCanceledDate()
```
    Getter for CanceledDate. The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) to cancel the subscription, when the subscription status changes to `CANCELED` and the subscription billing stops. If this field is not set, the subscription ends according its subscription plan. This field cannot be updated, other than being cleared.
    
    Returns:
    
    Returns the String
  - getChargedThroughDate
```
public String getChargedThroughDate()
```
    Getter for ChargedThroughDate. The `YYYY-MM-DD`-formatted date up to when the subscriber is invoiced for the subscription. After the invoice is sent for a given billing period, this date will be the last day of the billing period. For example, suppose for the month of May a subscriber gets an invoice (or charged the card) on May 1. For the monthly billing scenario, this date is then set to May 31.
    
    Returns:
    
    Returns the String
  - getStatus
```
public String getStatus()
```
    Getter for Status. Supported subscription statuses.
    
    Returns:
    
    Returns the String
  - internalGetTaxPercentage
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetTaxPercentage()
```
    Internal Getter for TaxPercentage. The tax amount applied 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 Internal String
  - getTaxPercentage
```
public String getTaxPercentage()
```
    Getter for TaxPercentage. The tax amount applied 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
  - getInvoiceIds
```
public List<String> getInvoiceIds()
```
    Getter for InvoiceIds. The IDs of the [invoices](entity:Invoice) created for the subscription, listed in order when the invoices were created (newest invoices appear first).
    
    Returns:
    
    Returns the List of 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
  - getVersion
```
public Long getVersion()
```
    Getter for Version. The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting.
    
    Returns:
    
    Returns the Long
  - getCreatedAt
```
public String getCreatedAt()
```
    Getter for CreatedAt. The timestamp when the subscription was created, in RFC 3339 format.
    
    Returns:
    
    Returns the String
  - internalGetCardId
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetCardId()
```
    Internal Getter for CardId. The ID of the [subscriber's](entity:Customer) [card](entity:Card) used to charge for the subscription.
    
    Returns:
    
    Returns the Internal String
  - getCardId
```
public String getCardId()
```
    Getter for CardId. The ID of the [subscriber's](entity:Customer) [card](entity:Card) used to charge for the subscription.
    
    Returns:
    
    Returns the String
  - getTimezone
```
public String getTimezone()
```
    Getter for Timezone. Timezone that will be used in date calculations for the subscription. Defaults to the timezone of the location based on `location_id`. Format: the IANA Timezone Database identifier for the location timezone (for example, `America/Los_Angeles`).
    
    Returns:
    
    Returns the String
  - getSource
```
public SubscriptionSource getSource()
```
    Getter for Source. The origination details of the subscription.
    
    Returns:
    
    Returns the SubscriptionSource
  - internalGetActions
```
protected io.apimatic.core.types.OptionalNullable<List<SubscriptionAction>> internalGetActions()
```
    Internal Getter for Actions. The list of scheduled actions on this subscription. It is set only in the response from [RetrieveSubscription]($e/Subscriptions/RetrieveSubscription) with the query parameter of `include=actions` or from [SearchSubscriptions]($e/Subscriptions/SearchSubscriptions) with the input parameter of `include:["actions"]`.
    
    Returns:
    
    Returns the Internal List of SubscriptionAction
  - getActions
```
public List<SubscriptionAction> getActions()
```
    Getter for Actions. The list of scheduled actions on this subscription. It is set only in the response from [RetrieveSubscription]($e/Subscriptions/RetrieveSubscription) with the query parameter of `include=actions` or from [SearchSubscriptions]($e/Subscriptions/SearchSubscriptions) with the input parameter of `include:["actions"]`.
    
    Returns:
    
    Returns the List of SubscriptionAction
  - getMonthlyBillingAnchorDate
```
public Integer getMonthlyBillingAnchorDate()
```
    Getter for MonthlyBillingAnchorDate. The day of the month on which the subscription will issue invoices and publish orders.
    
    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 Subscription into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public Subscription.Builder toBuilder()
```
    Builds a new Subscription.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new Subscription.Builder object

Class Subscription

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Subscription

Subscription

Method Detail

getId

getLocationId

getPlanVariationId

getCustomerId

getStartDate

internalGetCanceledDate

getCanceledDate

getChargedThroughDate

getStatus

internalGetTaxPercentage

getTaxPercentage

getInvoiceIds

getPriceOverrideMoney

getVersion

getCreatedAt

internalGetCardId

getCardId

getTimezone

getSource

internalGetActions

getActions

getMonthlyBillingAnchorDate

getPhases

hashCode

equals

toString

toBuilder