• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
Subscription

Represents a subscription to a subscription plan by a subscriber.

For an overview of the Subscription type, see Subscription object.

Properties

Name Description
id
string

Read only The Square-assigned ID of the subscription.

Max Length 255
location_id
string

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

plan_id
string

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

customer_id
string

Read only The ID of the subscribing customer profile.

start_date
string

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

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.

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.

status
string

Read only The current status of the subscription.

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

invoice_ids
string [ ]

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

price_override_money
Money

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

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.

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

card_id
string

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

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

source
SubscriptionSource

Beta

The origination details of the subscription.

actions
SubscriptionAction [ ]

Beta

The list of scheduled actions on this subscription. It is set only in the response from the RetrieveSubscription or SearchSubscriptions endpoint with the query parameter of include=actions.