Class Plan

Hierarchy

TagoIOModule<GenericModuleParams>
- Plan

Index

Constructors

Methods

getActivePlan getCurrentPrices setPlanParameters

Constructors

constructor

new Plan(params: GenericModuleParams): Plan
Parameters
- params: GenericModuleParams
Returns Plan
Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in common/TagoIOModule.ts:75

Methods

getActivePlan

getActivePlan(): Promise<Pick<PlanInfo, "plan">>
Returns Promise<Pick<PlanInfo, "plan">>
Description
Retrieves information about the currently active plan and its associated services.

See
https://help.tago.io/portal/en/kb/articles/114-account-plans Account Plans
Example
```
const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.plan.getActivePlan();
console.log(result); // { plan: 'scale' }
```
- Defined in modules/Resources/Plan.ts:47

getCurrentPrices

getCurrentPrices(): Promise<CurrentPrices>
Returns Promise<CurrentPrices>
Description
Retrieves the current pricing information for all available services.

See
https://help.tago.io/portal/en/kb/articles/114-account-plans Account Plans
Example
```
const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const prices = await resources.plan.getCurrentPrices();
console.log(prices); // { analysis: [ { price: 0, amount: 3000 } ], data_records: [...], ... }
```
- Defined in modules/Resources/Plan.ts:70

setPlanParameters

setPlanParameters(data: PlanSetInfo): Promise<string>
Parameters
- data: PlanSetInfo
Returns Promise<string>
Description
Sets the active plan and configures service limits for the account, including SMS, email, data records, device requests and analysis quotas.

See
https://help.tago.io/portal/en/kb/articles/207-upgrading-plans-services Upgrading Plans & Services
Example
```
const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.plan.setPlanParameters({
  plan: "plan_id",
  sms: 100,
  email: 1000,
  data_records: 200000,
  device_request: 250,
  analysis: 1000
});
console.log(result);
```
- Defined in modules/Resources/Plan.ts:25