discord.js/src/structures/Subscription.js

A powerful library for interacting with the Discord API

'use strict';

const Base = require('./Base');

/**
 * Represents a Subscription
 * @extends {Base}
 */
class Subscription extends Base {
  constructor(client, data) {
    super(client);

    /**
     * The id of the subscription
     * @type {Snowflake}
     */
    this.id = data.id;

    /**
     * The id of the user who subscribed
     * @type {Snowflake}
     */
    this.userId = data.user_id;

    this._patch(data);
  }

  _patch(data) {
    /**
     * The SKU ids subscribed to
     * @type {Snowflake[]}
     */
    this.skuIds = data.sku_ids;

    /**
     * The entitlement ids granted for this subscription
     * @type {Snowflake[]}
     */
    this.entitlementIds = data.entitlement_ids;

    /**
     * The timestamp the current subscription period will start at
     * @type {number}
     */
    this.currentPeriodStartTimestamp = Date.parse(data.current_period_start);

    /**
     * The timestamp the current subscription period will end at
     * @type {number}
     */
    this.currentPeriodEndTimestamp = Date.parse(data.current_period_end);

    /**
     * The current status of the subscription
     * @type {SubscriptionStatus}
     */
    this.status = data.status;

    if ('renewal_sku_ids' in data) {
      /**
       * The SKU ids that this user will be subscribed to at renewal
       * @type {?Snowflake[]}
       */
      this.renewalSkuIds = data.renewal_sku_ids;
    }

    if ('canceled_at' in data) {
      /**
       * The timestamp of when the subscription was canceled
       * @type {?number}
       */
      this.canceledTimestamp = data.canceled_at ? Date.parse(data.canceled_at) : null;
    } else {
      this.canceledTimestamp ??= null;
    }

    if ('country' in data) {
      /**
       * ISO 3166-1 alpha-2 country code of the payment source used to purchase the subscription.
       * Missing unless queried with a private OAuth scope.
       * @type {?string}
       */
      this.country = data.country;
    } else {
      this.country ??= null;
    }
  }

  /**
   * The time the subscription was canceled
   * @type {?Date}
   * @readonly
   */
  get canceledAt() {
    return this.canceledTimestamp && new Date(this.canceledTimestamp);
  }

  /**
   * The time the current subscription period will start at
   * @type {Date}
   * @readonly
   */
  get currentPeriodStartAt() {
    return new Date(this.currentPeriodStartTimestamp);
  }

  /**
   * The time the current subscription period will end at
   * @type {Date}
   * @readonly
   */
  get currentPeriodEndAt() {
    return new Date(this.currentPeriodEndTimestamp);
  }
}

exports.Subscription = Subscription;