Object Index

You are viewing an old version of the API

2021-04-21

Version 2021-04-21

• All Versions

Subscription BETA

Read only The Square-assigned ID of the subscription.

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

Read only The ID of the associated subscription plan.

Read only The ID of the associated customer profile.

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

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.

Read only The current status of the subscription.

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

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

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

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.

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

The ID of the customer card that is charged for the subscription.

Read only 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.

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