<- Object

Object

Subscription

Represents a subscription purchased by a customer.

For more information, see Manage Subscriptions.

Link to section

Properties

Link to section

id

string

Read only The Square-assigned ID of the subscription.

Max Length
255
Link to section

location_id

string

Read only The ID of the location associated with the subscription.

Link to section

plan_variation_id

string

Read only The ID of the subscribed-to subscription plan variation.

Link to section

customer_id

string

Read only The ID of the subscribing customer profile.

Link to section

start_date

string

Read only The YYYY-MM-DD-formatted date (for example, 2013-01-15) to start the subscription.

Link to section

canceled_date

string

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.

Link to section

charged_through_date

string

Read only 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.

Link to section

status

string

Read only The current status of the subscription.

Link to section

tax_percentage

string

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

Link to section

invoice_ids

string [ ]

Read only The IDs of the invoices created for the subscription, listed in order when the invoices were created (newest invoices appear first).

Link to section

price_override_money

A custom price to apply for the subscription. If specified, it overrides the price configured by the subscription plan.

Link to section

version

integer(64-bit)

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.

Link to section

created_at

string

Read only The timestamp when the subscription was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

card_id

string

The ID of the subscriber's card used to charge for the subscription.

Link to section

timezone

string

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

Link to section

source

Beta

The origination details of the subscription.

Link to section

actions

Beta

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"].

Link to section

phases

Read only array of phases for this subscription