Square · Schema

Square Subscription

Represents a subscription purchased by a customer. Subscriptions enable sellers to generate recurring revenue by offering scheduled fulfillment of products or services with configurable billing periods, pricing, and discounts.

BookingsCatalogCheckoutCustomersDisputesEcommerceFinancial TechnologyGift CardsInventoryInvoicingLaborLocationsLoyaltyMerchantsOrdersPaymentsPoint of SaleRefundsRetailSubscriptionsTeamTerminalWebhooks

Properties

Name Type Description
id string The Square-assigned ID of the subscription.
location_id string The ID of the location associated with the subscription.
plan_variation_id string The ID of the subscribed-to subscription plan variation.
customer_id string The ID of the subscribing customer profile.
start_date string The YYYY-MM-DD-formatted date to start the subscription.
canceled_date string The YYYY-MM-DD-formatted date to cancel the subscription, when the subscription status changes to CANCELED and the subscription billing stops.
charged_through_date string The YYYY-MM-DD-formatted date up to when the subscriber is invoiced for the subscription.
status string 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
invoice_ids array The IDs of the invoices created for the subscription, listed in order when the invoices were created (newest invoices appear first).
price_override_money object A custom price which overrides the cost of a subscription plan variation with STATIC pricing.
version integer The version of the object. When updating an object, the version supplied must match the version in the database.
created_at string The timestamp when the subscription was created, in RFC 3339 format.
card_id string The ID of the subscriber's card used to charge for the subscription.
timezone string 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.
source object The origination details of the subscription.
actions array The list of scheduled actions on this subscription.
monthly_billing_anchor_date integer The day of the month on which the subscription will issue invoices and publish orders.
phases array The subscription phases that define the billing schedule.
View JSON Schema on GitHub