Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Subscription

Contains all Requests connected with subscriptions

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    Returns Subscription

Properties

config

config: ApiConfig

request

request: Request

setConfig

setConfig: (env: Env) => void

Type declaration

    • (env: Env): void

    • Parameters

      Returns void

Methods

cancelSubscription

  • Cancels a subscription

    method

    cancelSubscription

    async
    example
    InPlayer.Subscription
.cancelSubscription('abcdef')
.then(data => console.log(data));

    Parameters

    • unsubscribeUrl: string

      The url for the subscription which is getting unsubscribed

    Returns Promise<AxiosResponse<CancelSubscription>>

createSubscription

  • Subscribes to a given asset. Use this method ONLY if the accessFee.type === 'subscription'. Otherwise please use InPlayer.Payment.createPayment()

    method

    createSubscription

    async
    example
    InPlayer.Subscription
.createSubscription({
     number: 1,
     cardName: 'Payoneer',
     expMonth: 11,
     expYear: 12,
     cvv: 546,
     accessFee: 13.4,
     paymentMethod: 'card',
     referrer: 'http://localhost:3000',
     voucherCode: '123123125914i2erjfg',
     brandingId?: 1234,
     returnUrl?: 'https://event.inplayer.com/staging',
   }
)
.then(data => console.log(data));

    Parameters

    • data: CreateSubscriptionData

      { number: number, cardName: string, expMonth: number, expYear: number, cvv: number, accessFee: number, paymentMethod: string, referrer: string voucherCode?: string brandingId?: number returnUrl?: string }

    Returns Promise<AxiosResponse<CreateSubscription>>

getSubscription

  • Get subscription details for a given user by id

    method

    getSubscription

    async
    example
    InPlayer.Subscription
.getSubscription('abcdef')
.then(data => console.log(data));

    Parameters

    • id: number

      The subscription id

    Returns Promise<AxiosResponse<SubscriptionDetails>>

getSubscriptions

  • getSubscriptions(page?: undefined | number, limit?: undefined | number): Promise<AxiosResponse<GetSubscription>>

  • Gets all subscriptions for a given user

    method

    getSubscriptions

    async
    example
    InPlayer.Subscription
.getSubscriptions()
.then(data => console.log(data));

    Parameters

    • Optional page: undefined | number

      The current page

    • Optional limit: undefined | number

      The number of items per page

    Returns Promise<AxiosResponse<GetSubscription>>

Generated using TypeDoc