Merge pull request #754 from inplayer-org/feature/subscription-plan-switch

New Subscribe method that changes the subscription plan

Author: vkochovski

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Change Log
 
 All notable changes to this project will be documented in this file.
+# [3.12.5] - 03-17-2022
+
+### Changes
+
+- Add new method in Subscription that changes the existing subscription plan. The change can either be a downgrade or an upgrade.
 
 # [3.12.4] - 03-17-2022
 

index.d.ts

@@ -850,6 +850,15 @@ export declare interface CancelSubscription {
   status: string;
   timestamp: number;
 }
+
+export interface ChangeSubscriptionPlanRequestBody {
+  access_fee_id: number;
+  inplayer_token: string;
+}
+
+export interface ChangeSubscriptionPlanResponse {
+  message: string;
+}
 export declare class Subscription {
   // eslint-disable-next-line no-shadow
   constructor(config: Record<string, unknown>, Account: Account);
@@ -866,6 +875,9 @@ export declare class Subscription {
   createSubscription(
     data: CreateSubscriptionData
   ): Promise<AxiosResponse<CommonResponse>>;
+  changeSubscriptionPlan(
+    data: ChangeSubscriptionPlanRequestBody
+): Promise<AxiosResponse<ChangeSubscriptionPlanResponse>>;
 }
 
 export interface DiscountData {
@@ -939,6 +951,7 @@ export interface ApiEndpoints {
   getSubscription: (id: string) => string;
   subscribe: string;
   cancelSubscription: (url: string) => string;
+  changeSubscriptionPlan: (accessFeeId: number, inplayerToken: string) => string;
   // Voucher
   getDiscount: string;
   // Branding

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inplayer-org/inplayer.js",
-  "version": "3.12.4",
+  "version": "3.12.5",
   "author": "InPlayer",
   "license": "MIT",
   "description": "A Javascript SDK for Inplayer's RESTful API",

src/constants/index.ts

@@ -99,6 +99,7 @@ export const API = {
   cancelSubscription: (url: string): string => `${url}`,
   subscribe: '/subscriptions',
   subscribeV2: '/v2/subscriptions',
+  subscriptionPlanChange: '/v2/subscriptions/stripe:switch',
 
   // Vouchers
   getDiscount: '/vouchers/discount',

src/endpoints/subscription.ts

@@ -8,6 +8,8 @@ import {
   IdealPaymentRequestBody,
   GetDefaultCard,
   SetDefaultCard,
+  ChangeSubscriptionPlanRequestBody,
+  ChangeSubscriptionPlanResponse,
 } from '../models/ISubscription';
 import { CommonResponse } from '../models/CommonInterfaces';
 import { ApiConfig, Request } from '../models/Config';
@@ -248,6 +250,46 @@ class Subscription extends BaseExtend {
     });
   }
 
+  /**
+   * Changes the subscription plan for a given asset.
+   * @method post
+   * @async
+   * @param {Object} data - {
+   *  access_fee_id: number,
+   *  inplayer_token: number
+   * }
+   * @example
+   *     InPlayer.Subscription
+   *     .changeSubscriptionPlan({
+   *          access_fee_id: 1,
+   *          inplayer_token: 'S-xxxxx-ST'
+   *        }
+   *     )
+   *     .then(data => console.log(data));
+   * @return {Object}
+   */
+  async changeSubscriptionPlan({
+    access_fee_id,
+    inplayer_token,
+  }: {
+    access_fee_id: number,
+    inplayer_token: string,
+   }): Promise<AxiosResponse<ChangeSubscriptionPlanResponse>> {
+    const body: ChangeSubscriptionPlanRequestBody = {
+      access_fee_id,
+      inplayer_token,
+    };
+
+    const tokenObject = await this.request.getToken();
+
+    return this.request.authenticatedPost(API.subscriptionPlanChange, qs.stringify(body), {
+      headers: {
+        Authorization: `Bearer ${tokenObject.token}`,
+        'Content-Type': 'application/x-www-form-urlencoded',
+      },
+    });
+  }
+
   /**
    * Process a request for direct debit subscribe
    * @method directDebitSubscribe

src/models/Config.ts

@@ -73,6 +73,7 @@ export interface ApiEndpoints {
   cancelSubscription: (url: string) => string;
   subscribe: string;
   subscribeV2: string;
+  changeSubscriptionPlan: (access_fee_id: number, inplayer_token: string) => string;
   // Voucher
   getDiscount: string;
   // Restrictions

src/models/IAsset&Access.ts

@@ -34,6 +34,7 @@ export interface Item {
   template_id: number | null;
   created_at: number;
   update_at: number;
+  plan_switch_enabled: boolean;
 }
 
 export interface AccessType {

src/models/ISubscription.ts

@@ -82,6 +82,11 @@ export interface CreateSubscriptionRequestBody {
     is_gift?: boolean;
 }
 
+export interface ChangeSubscriptionPlanRequestBody {
+    access_fee_id: number;
+    inplayer_token: string;
+}
+
 export interface IdealPaymentRequestBody {
     payment_method: 'ideal';
     access_fee_id: number;
@@ -119,6 +124,10 @@ export interface SetDefaultCardPerCurrencyData {
   currency: string;
 }
 
+export interface ChangeSubscriptionPlanResponse {
+  message: string;
+}
+
 export interface Subscription extends BaseExtend {
     getSubscriptions(
         page?: number,
@@ -131,6 +140,9 @@ export interface Subscription extends BaseExtend {
     createSubscription(
         data: CreateSubscriptionData
     ): Promise<AxiosResponse<CommonResponse>>;
+    changeSubscriptionPlan(
+        data: ChangeSubscriptionPlanRequestBody
+    ): Promise<AxiosResponse<ChangeSubscriptionPlanResponse>>;
     directDebitSubscribe: (
         data: DirectDebitData
       ) => Promise<AxiosResponse<CommonResponse>>;