Full documentation
install:
npm i @plasma-platform/service-memberships -S

Short documentation

Table of Contents

• MembershipsService
  • Parameters
  • messages
  • getListOfMembershipGroups
    • Parameters
    • Examples
  • getListOfAllMembershipPlans
    • Parameters
    • Examples
  • getMembershipPlanInfoById
    • Parameters
    • Examples
  • getListOfSubscriptions
    • Parameters
    • Examples
  • getSubscription
    • Parameters
    • Examples
  • reactivatePayments
    • Parameters
    • Examples
  • suspendPayments
    • Parameters
    • Examples
  • getDownloadsByProductId
    • Parameters
    • Examples

MembershipsService

• See: http://http://service-memberships.dev/doc/

Memberships Micro Service API

Parameters

• url string service url
• token (string | null) user access token if available (optional, default null)

messages

Object with class service messages

Type: object

getListOfMembershipGroups

Groups - Get list of membership groups

Parameters

• params Object
  • params.propertyId Number? Use for filtering by TM property value id.
  • params.all Number? Ignore membership group status on search, default value: 0, allowed values: 1, 0

Examples

Get list of membership groups

(async () => {
  const service = new MembershipsService('//api.templatemonsterdev.com/memberships/v1/');
  const response = await service.getListOfMembershipGroups(params);
})();

Returns Promise<Object> Promise object represents info

getListOfAllMembershipPlans

Memberships - Get list of all membership plans

Parameters

• params Object
  • params.groupId Number? Use for filtering by group ID
  • params.all Number? Ignore membership group status on search, default value: 0, allowed values: 1, 0

Examples

Get membership plan info by ID

(async () => {
  const service = new MembershipsService('//api.templatemonsterdev.com/memberships/v1/');
  const response = await service.getListOfAllMembershipPlans(params);
})();

Returns Promise<Object> Promise object represents info

getMembershipPlanInfoById

Memberships - Get membership plan info by ID

Parameters

• params Object
  • params.membershipId Number ID of the membership plan (required)

Examples

Get membership plan info by ID

(async () => {
  const service = new MembershipsService('//api.templatemonsterdev.com/memberships/v1/');
  const response = await service.getMembershipPlanInfoById(params);
})();

Returns Promise<Object> Promise object represents info

getListOfSubscriptions

Subscriptions - Get list of subscriptions

Parameters

• params Object
  • params.status String? Use for filtering by status. Allowed values: pending, active, inactive
  • params.membershipId Number? Use for filtering by membership ID
  • params.groupId Number? Use for filtering by membership group ID

Examples

Get list of subscriptions

(async () => {
  const service = new MembershipsService('//api.templatemonsterdev.com/memberships/v1/', token);
  const response = await service.getListOfSubscriptions(params);
})();

Returns Promise<Object> Promise object represents info

getSubscription

Subscriptions - Get subscription

Parameters

• params Object
  • params.subscriptionId Number ID of the subscription (required)

Examples

Get list of subscriptions

(async () => {
  const service = new MembershipsService('//api.templatemonsterdev.com/memberships/v1/', token);
  const response = await service.getSubscription(params);
})();

Returns Promise<Object> Promise object represents info

reactivatePayments

Subscriptions - Reactivate payments. Reactivate recurrent payments for subscription, payment status will be changed to active

Parameters

• params Object
  • params.subscriptionId Number ID of the subscription (required)

Examples

Get list of subscriptions

(async () => {
  const service = new MembershipsService('//api.templatemonsterdev.com/memberships/v1/', token);
  const response = await service.reactivatePayments(params);
})();

Returns Promise<Object> Promise object represents info

suspendPayments

Subscriptions - Suspend payments. Suspend recurrent payments for subscription, payment status will be changed to inactive

Parameters

• params Object
  • params.subscriptionId Number ID of the subscription (required)

Examples

Get list of subscriptions

(async () => {
  const service = new MembershipsService('//api.templatemonsterdev.com/memberships/v1/', token);
  const response = await service.suspendPayments(params);
})();

Returns Promise<Object> Promise object represents info

getDownloadsByProductId

Subscription Downloads - Get downloads by product ID. Gets download by product ID from entire user downloads list.

Parameters

• params Object
  • params.productId Number product id (required)

Examples

Get list of subscriptions

(async () => {
  const service = new MembershipsService('//api.templatemonsterdev.com/memberships/v1/', token);
  const response = await service.getDownloadsByProductId(params);
})();

Returns Promise<Object> Promise object represents info