@forestvpn/forestvpn_api/models/subscription.ts

A package to interact api.forestvpn.com (manage vpn profiles, check usage statistics, manage locations, ...)

/* tslint:disable */
/* eslint-disable */
/**
 * ForestVPN API
 * ForestVPN - Fast, secure, and modern VPN. It offers Distributed Computing, Crypto Mining, P2P, Ad Blocking, TOR over VPN, 30+ locations, and a free version with unlimited data. 
 *
 * OpenAPI spec version: 2.0
 * Contact: support@forestvpn.com
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the class manually.
 */

import { SubscriptionItem } from './subscription-item';
import { SubscriptionSource } from './subscription-source';
import { SubscriptionStatus } from './subscription-status';
 /**
 * 
 *
 * @export
 * @interface Subscription
 */
export interface Subscription {

    /**
     * @type {string}
     * @memberof Subscription
     */
    id: string;

    /**
     * @type {SubscriptionSource}
     * @memberof Subscription
     */
    source?: SubscriptionSource;

    /**
     * @type {Date}
     * @memberof Subscription
     */
    start_date: Date;

    /**
     * If the subscription has ended, the date the subscription ended.
     *
     * @type {Date}
     * @memberof Subscription
     */
    ended_at?: Date;

    /**
     * Start of the current period that the subscription has been invoiced for.
     *
     * @type {Date}
     * @memberof Subscription
     */
    current_period_start: Date;

    /**
     * End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.
     *
     * @type {Date}
     * @memberof Subscription
     */
    current_period_end: Date;

    /**
     * If the subscription has a trial, the beginning of that trial.
     *
     * @type {Date}
     * @memberof Subscription
     */
    trial_start?: Date;

    /**
     * If the subscription has a trial, the end of that trial.
     *
     * @type {Date}
     * @memberof Subscription
     */
    trial_end?: Date;

    /**
     * A date in the future at which the subscription will automatically get canceled.
     *
     * @type {Date}
     * @memberof Subscription
     */
    cancel_at?: Date;

    /**
     * If the subscription has been canceled, the date of that cancellation.
     *
     * @type {Date}
     * @memberof Subscription
     */
    canceled_at?: Date;

    /**
     * @type {SubscriptionStatus}
     * @memberof Subscription
     */
    status: SubscriptionStatus;

    /**
     * The subscription’s description, meant to be displayable to the customer.
     *
     * @type {string}
     * @memberof Subscription
     */
    description?: string;

    /**
     * @type {Array<SubscriptionItem>}
     * @memberof Subscription
     */
    items?: Array<SubscriptionItem>;
}