Represents a subscription purchased by a customer.
<- Object
Object
Represents a subscription purchased by a customer.
For more information, see Manage Subscriptions.
Read only The ID of the subscribed-to subscription plan variation.
Read only The ID of the subscribing customer profile.
Read only The YYYY-MM-DD-formatted date (for example, 2013-01-15) to start the subscription.
The YYYY-MM-DD-formatted date (for example, 2013-01-15) to cancel the subscription, when the subscription status changes to CANCELED and the subscription billing stops.
If this field is not set, the subscription ends according its subscription plan.
This field cannot be updated, other than being cleared.
Read only The YYYY-MM-DD-formatted date up to when the subscriber is invoiced for the subscription.
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.
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 (newest invoices appear first).
A custom price which overrides the cost of a subscription plan variation with STATIC pricing. This field does not affect itemized subscriptions with RELATIVE pricing. Instead, you should edit the Subscription's order template.
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 subscriber's card used to charge for the subscription.
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).
The list of scheduled actions on this subscription. It is set only in the response from
RetrieveSubscription with the query parameter of include=actions or from SearchSubscriptions with the input parameter of include:["actions"].
Read only The day of the month on which the subscription will issue invoices and publish orders.