Skip to content

Latest commit

 

History

History
23 lines (20 loc) · 3.28 KB

Subscription.md

File metadata and controls

23 lines (20 loc) · 3.28 KB
Raw

Subscription

Properties

Name Type Description Notes
Id string The Square-assigned ID of the subscription. [optional] [default to null]
LocationId string The ID of the location associated with the subscription. [optional] [default to null]
PlanId string The ID of the associated `subscription plan`. [optional] [default to null]
CustomerId string The ID of the associated `customer` profile. [optional] [default to null]
StartDate string The start date of the subscription, in YYYY-MM-DD format (for example, 2013-01-15). [optional] [default to null]
CanceledDate 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] [default to null]
Status string The current status of the subscription. See SubscriptionStatus for possible values [optional] [default to null]
TaxPercentage 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] [default to null]
InvoiceIds []string The IDs of the `invoices` created for the subscription, listed in order when the invoices were created (oldest invoices appear first). [optional] [default to null]
PriceOverrideMoney *Money [optional] [default to null]
Version int64 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] [default to null]
CreatedAt string The timestamp when the subscription was created, in RFC 3339 format. [optional] [default to null]
CardId string The ID of the `customer](#type-customer) [card` that is charged for the subscription. [optional] [default to null]
PaidUntilDate 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] [default to null]
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] [default to null]

[Back to Model list] [Back to API list] [Back to README]