subscription.md

Subscription

Represents a subscription purchased by a customer.

For more information, see Manage Subscriptions.

Structure

Subscription

Fields

Name	Type	Tags	Description	Getter	Setter
id	?string	Optional	The Square-assigned ID of the subscription. Constraints: Maximum Length: 255	getId(): ?string	setId(?string id): void
locationId	?string	Optional	The ID of the location associated with the subscription.	getLocationId(): ?string	setLocationId(?string locationId): void
planVariationId	?string	Optional	The ID of the subscribed-to subscription plan variation.	getPlanVariationId(): ?string	setPlanVariationId(?string planVariationId): void
customerId	?string	Optional	The ID of the subscribing customer profile.	getCustomerId(): ?string	setCustomerId(?string customerId): void
startDate	?string	Optional	The YYYY-MM-DD-formatted date (for example, 2013-01-15) to start the subscription.	getStartDate(): ?string	setStartDate(?string startDate): void
canceledDate	?string	Optional	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.	getCanceledDate(): ?string	setCanceledDate(?string canceledDate): void
chargedThroughDate	?string	Optional	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.	getChargedThroughDate(): ?string	setChargedThroughDate(?string chargedThroughDate): void
status	?string(SubscriptionStatus)	Optional	Supported subscription statuses.	getStatus(): ?string	setStatus(?string status): void
taxPercentage	?string	Optional	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%.	getTaxPercentage(): ?string	setTaxPercentage(?string taxPercentage): void
invoiceIds	?(string[])	Optional	The IDs of the invoices created for the subscription, listed in order when the invoices were created (newest invoices appear first).	getInvoiceIds(): ?array	setInvoiceIds(?array invoiceIds): void
priceOverrideMoney	?Money	Optional	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 for more information.	getPriceOverrideMoney(): ?Money	setPriceOverrideMoney(?Money priceOverrideMoney): void
version	?int	Optional	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.	getVersion(): ?int	setVersion(?int version): void
createdAt	?string	Optional	The timestamp when the subscription was created, in RFC 3339 format.	getCreatedAt(): ?string	setCreatedAt(?string createdAt): void
cardId	?string	Optional	The ID of the subscriber's card used to charge for the subscription.	getCardId(): ?string	setCardId(?string cardId): void
timezone	?string	Optional	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).	getTimezone(): ?string	setTimezone(?string timezone): void
source	?SubscriptionSource	Optional	The origination details of the subscription.	getSource(): ?SubscriptionSource	setSource(?SubscriptionSource source): void
actions	?(SubscriptionAction[])	Optional	The list of scheduled actions on this subscription. It is set only in the response from RetrieveSubscription with the query parameter of include=actions or from SearchSubscriptions with the input parameter of include:["actions"].	getActions(): ?array	setActions(?array actions): void
monthlyBillingAnchorDate	?int	Optional	The day of the month on which the subscription will issue invoices and publish orders.	getMonthlyBillingAnchorDate(): ?int	setMonthlyBillingAnchorDate(?int monthlyBillingAnchorDate): void
phases	?(Phase[])	Optional	array of phases for this subscription	getPhases(): ?array	setPhases(?array phases): void

Example (as JSON)

{
  "id": "id4",
  "location_id": "location_id8",
  "plan_variation_id": "plan_variation_id8",
  "customer_id": "customer_id2",
  "start_date": "start_date8"
}