Pricing_api.PricingPlansApi.md

saasus-sdk / Pricing/api / PricingPlansApi

Class: PricingPlansApi

Pricing/api.PricingPlansApi

PricingPlansApi - object-oriented interface

Export

PricingPlansApi

Hierarchy

• BaseAPI

  ↳ PricingPlansApi

Table of contents

Constructors

• constructor

Properties

• axios
• basePath
• configuration

Methods

• createPricingPlan
• deleteAllPlansAndMenusAndUnitsAndMetersAndTaxRates
• deletePricingPlan
• deleteStripePlan
• getPricingPlan
• getPricingPlans
• linkPlanToStripe
• updatePricingPlan
• updatePricingPlansUsed

Constructors

constructor

• new PricingPlansApi(configuration?, basePath?, axios?): PricingPlansApi

Parameters

Name	Type	Default value
configuration?	Configuration	undefined
basePath	string	BASE_PATH
axios	AxiosInstance	globalAxios

Returns

PricingPlansApi

Inherited from

BaseAPI.constructor

Defined in

src/generated/Pricing/base.ts:52

Properties

axios

• Protected axios: AxiosInstance = globalAxios

Inherited from

BaseAPI.axios

Defined in

src/generated/Pricing/base.ts:52

---

basePath

• Protected basePath: string = BASE_PATH

Inherited from

BaseAPI.basePath

Defined in

src/generated/Pricing/base.ts:52

---

configuration

• Protected configuration: undefined | Configuration

Inherited from

BaseAPI.configuration

Defined in

src/generated/Pricing/base.ts:50

Methods

createPricingPlan

▸ createPricingPlan(body?, options?): Promise<AxiosResponse<PricingPlan, any>>

Create a pricing plan.

Parameters

Name	Type	Description
body?	SavePricingPlanParam
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<PricingPlan, any>>

Summary

Create Pricing Plan

Throws

Memberof

PricingPlansApi

Defined in

src/generated/Pricing/api.ts:3882

---

deleteAllPlansAndMenusAndUnitsAndMetersAndTaxRates

▸ deleteAllPlansAndMenusAndUnitsAndMetersAndTaxRates(options?): Promise<AxiosResponse<void, any>>

Unconditionally remove all rate plans, menus, units, meters and tax rates.

Parameters

Name	Type	Description
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<void, any>>

Summary

Delete all Plans, Menus, Units, Meters and Tax Rates

Throws

Memberof

PricingPlansApi

Defined in

src/generated/Pricing/api.ts:3893

---

deletePricingPlan

▸ deletePricingPlan(planId, options?): Promise<AxiosResponse<void, any>>

Delete a pricing plan.

Parameters

Name	Type	Description
planId	string	Pricing Plan ID
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<void, any>>

Summary

Delete Pricing Plan

Throws

Memberof

PricingPlansApi

Defined in

src/generated/Pricing/api.ts:3905

---

deleteStripePlan

▸ deleteStripePlan(options?): Promise<AxiosResponse<void, any>>

Delete product data from Stripe.

Parameters

Name	Type	Description
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<void, any>>

Summary

Delete Product Data from Stripe

Throws

Memberof

PricingPlansApi

Defined in

src/generated/Pricing/api.ts:3916

---

getPricingPlan

▸ getPricingPlan(planId, options?): Promise<AxiosResponse<PricingPlan, any>>

Get a pricing plan.

Parameters

Name	Type	Description
planId	string	Pricing Plan ID
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<PricingPlan, any>>

Summary

Get Pricing Plan

Throws

Memberof

PricingPlansApi

Defined in

src/generated/Pricing/api.ts:3928

---

getPricingPlans

▸ getPricingPlans(options?): Promise<AxiosResponse<PricingPlans, any>>

Get pricing plans. Multiple feature menus are grouped together and defined as one pricing plan. Each tenant can choose a pricing plan defined here. If you have a specific tenant-specific rate (private pricing), create and connect the pricing plan specifically for that tenant.

Parameters

Name	Type	Description
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<PricingPlans, any>>

Summary

Get Pricing Plans

Throws

Memberof

PricingPlansApi

Defined in

src/generated/Pricing/api.ts:3939

---

linkPlanToStripe

▸ linkPlanToStripe(options?): Promise<AxiosResponse<void, any>>

Connect information to Stripe.

Parameters

Name	Type	Description
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<void, any>>

Summary

Connect to Stripe

Throws

Memberof

PricingPlansApi

Defined in

src/generated/Pricing/api.ts:3950

---

updatePricingPlan

▸ updatePricingPlan(planId, body?, options?): Promise<AxiosResponse<void, any>>

Update a pricing plan.

Parameters

Name	Type	Description
planId	string	Pricing Plan ID
body?	SavePricingPlanParam
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<void, any>>

Summary

Update Pricing Plan

Throws

Memberof

PricingPlansApi

Defined in

src/generated/Pricing/api.ts:3963

---

updatePricingPlansUsed

▸ updatePricingPlansUsed(updatePricingPlansUsedParam?, options?): Promise<AxiosResponse<void, any>>

Update price plan and feature menu/pricing unit to used.

Parameters

Name	Type	Description
updatePricingPlansUsedParam?	UpdatePricingPlansUsedParam
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<void, any>>

Summary

Update Used Flag

Throws

Memberof

PricingPlansApi

Defined in

src/generated/Pricing/api.ts:3975