Skip to content

Latest commit

 

History

History
27 lines (22 loc) · 3.25 KB

Subscription.md

File metadata and controls

27 lines (22 loc) · 3.25 KB
Raw

SquareConnect.Subscription

Description

Note: This model is in beta.

Represents a customer subscription to a subscription plan. For an overview of the Subscription type, see Subscription object.

Properties

Name Type Description Notes
id String The Square-assigned ID of the subscription. [optional]
location_id String The ID of the location associated with the subscription. [optional]
plan_id String The ID of the associated `subscription plan`. [optional]
customer_id String The ID of the associated `customer` profile. [optional]
start_date String The start date of the subscription, in YYYY-MM-DD format (for example, 2013-01-15). [optional]
canceled_date String The subscription cancellation date, in YYYY-MM-DD format (for example, 2013-01-15). On this date, the subscription status changes to `CANCELED` and the subscription billing stops. If you don't set this field, the subscription plan dictates if and when subscription ends. You cannot update this field, you can only clear it. [optional]
status String The current status of the subscription. See SubscriptionStatus for possible values [optional]
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%. [optional]
invoice_ids [String] The IDs of the `invoices` created for the subscription, listed in order when the invoices were created (oldest invoices appear first). [optional]
price_override_money Money A custom price to apply for the subscription. If specified, it overrides the price configured by the subscription plan. [optional]
version Number 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. [optional]
created_at String The timestamp when the subscription was created, in RFC 3339 format. [optional]
card_id String The ID of the `customer](#type-customer) [card` that is charged for the subscription. [optional]
paid_until_date String The date up to which the customer is invoiced for the subscription, in YYYY-MM-DD format (for example, 2013-01-15). After the invoice is paid 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 customer gets an invoice (or charged the card) on May 1. For the monthly billing scenario, this date is then set to May 31. [optional]
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 for the location timezone (for example, `America/Los_Angeles`). [optional]