Object Index
You are viewing an old version of the API
Subscription
Object Index
Represents a subscription to a subscription plan by a subscriber.
For an overview of the Subscription
type, see
Subscription object.
Properties
Name | Description |
---|---|
id
|
Read only The Square-assigned ID of the subscription. |
location_
|
Read only The ID of the location associated with the subscription. |
plan_
|
Read only The ID of the subscribed-to subscription plan. |
customer_
|
Read only The ID of the subscribing customer profile. |
start_
|
Read only The |
canceled_
|
The If this field is not set, the subscription ends according its subscription plan. This field cannot be updated, other than being cleared. |
charged_
|
Read only The 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
|
Read only The current status of the subscription. |
tax_
|
The tax amount applied when billing the subscription. The
percentage is expressed in decimal form, using a |
invoice_
|
Read only The IDs of the invoices created for the subscription, listed in order when the invoices were created (newest invoices appear first). |
price_
|
A custom price to apply for the subscription. If specified, it overrides the price configured by the subscription plan. |
version
|
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_
|
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_
|
The ID of the subscriber's card used to charge for the subscription. |
timezone
|
Read only Timezone that will be used in date calculations for the subscription.
Defaults to the timezone of the location based on |
source
Beta
|
The origination details of the subscription. |
actions
Beta
|
The list of scheduled actions on this subscription. It is set only in the response from |