import type * as Square from "../index";
/**
 * Represents a subscription purchased by a customer.
 *
 * For more information, see
 * [Manage Subscriptions](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions).
 */
export interface Subscription {
    /** The Square-assigned ID of the subscription. */
    id?: string;
    /** The ID of the location associated with the subscription. */
    locationId?: string;
    /** The ID of the subscribed-to [subscription plan variation](entity:CatalogSubscriptionPlanVariation). */
    planVariationId?: string;
    /** The ID of the subscribing [customer](entity:Customer) profile. */
    customerId?: string;
    /** The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) to start the subscription. */
    startDate?: string;
    /**
     * 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.
     */
    canceledDate?: string | null;
    /**
     * 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.
     */
    chargedThroughDate?: string;
    /**
     * The current status of the subscription.
     * See [SubscriptionStatus](#type-subscriptionstatus) for possible values
     */
    status?: Square.SubscriptionStatus;
    /**
     * 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%.
     */
    taxPercentage?: string | null;
    /**
     * The IDs of the [invoices](entity:Invoice) created for the
     * subscription, listed in order when the invoices were created
     * (newest invoices appear first).
     */
    invoiceIds?: string[];
    /**
     * 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](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#phases-and-order-templates).
     */
    priceOverrideMoney?: Square.Money;
    /**
     * 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.
     */
    version?: bigint;
    /** The timestamp when the subscription was created, in RFC 3339 format. */
    createdAt?: string;
    /**
     * The ID of the [subscriber's](entity:Customer) [card](entity:Card)
     * used to charge for the subscription.
     */
    cardId?: string | null;
    /**
     * 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`).
     */
    timezone?: string;
    /** The origination details of the subscription. */
    source?: Square.SubscriptionSource;
    /**
     * The list of scheduled actions on this subscription. It is set only in the response from
     * [RetrieveSubscription](api-endpoint:Subscriptions-RetrieveSubscription) with the query parameter
     * of `include=actions` or from
     * [SearchSubscriptions](api-endpoint:Subscriptions-SearchSubscriptions) with the input parameter
     * of `include:["actions"]`.
     */
    actions?: Square.SubscriptionAction[] | null;
    /** The day of the month on which the subscription will issue invoices and publish orders. */
    monthlyBillingAnchorDate?: number;
    /** array of phases for this subscription */
    phases?: Square.Phase[];
    /** The `YYYY-MM-DD`-formatted date when the subscription enters a terminal state. */
    completedDate?: string | null;
}