Pricing_api.md

saasus-sdk / Pricing/api

Module: Pricing/api

Table of contents

Enumerations

• AggregateUsage
• Currency
• RecurringInterval
• UnitType
• UpdateMeteringUnitTimestampCountMethod

Classes

• ErrorApi
• MeteringApi
• PricingMenusApi
• PricingPlansApi
• PricingUnitsApi
• TaxRateApi

Interfaces

• MeteringUnit
• MeteringUnitAllOf
• MeteringUnitCount
• MeteringUnitDateCount
• MeteringUnitDateCounts
• MeteringUnitDatePeriodCounts
• MeteringUnitMonthCount
• MeteringUnitMonthCounts
• MeteringUnitProps
• MeteringUnitTimestampCount
• MeteringUnits
• ModelError
• PricingFixedUnit
• PricingFixedUnitAllOf
• PricingFixedUnitForSave
• PricingFixedUnitForSaveAllOf
• PricingMenu
• PricingMenuAllOf
• PricingMenuProps
• PricingMenuPropsAllOf
• PricingMenus
• PricingPlan
• PricingPlanProps
• PricingPlanPropsAllOf
• PricingPlans
• PricingTier
• PricingTieredUnit
• PricingTieredUnitForSave
• PricingTieredUsageUnit
• PricingTieredUsageUnitAllOf
• PricingTieredUsageUnitForSave
• PricingTieredUsageUnitForSaveAllOf
• PricingTiers
• PricingUnitBaseProps
• PricingUnits
• PricingUsageUnit
• PricingUsageUnitAllOf
• PricingUsageUnitForSave
• PricingUsageUnitForSaveAllOf
• SavePricingMenuParam
• SavePricingPlanParam
• TaxRate
• TaxRateProps
• TaxRates
• UpdateMeteringUnitTimestampCountNowParam
• UpdateMeteringUnitTimestampCountParam
• UpdatePricingPlansUsedParam
• UpdateTaxRateParam

Type Aliases

• PricingUnit
• PricingUnitForSave

Functions

• ErrorApiAxiosParamCreator
• ErrorApiFactory
• ErrorApiFp
• MeteringApiAxiosParamCreator
• MeteringApiFactory
• MeteringApiFp
• PricingMenusApiAxiosParamCreator
• PricingMenusApiFactory
• PricingMenusApiFp
• PricingPlansApiAxiosParamCreator
• PricingPlansApiFactory
• PricingPlansApiFp
• PricingUnitsApiAxiosParamCreator
• PricingUnitsApiFactory
• PricingUnitsApiFp
• TaxRateApiAxiosParamCreator
• TaxRateApiFactory
• TaxRateApiFp

Type Aliases

PricingUnit

Ƭ PricingUnit: { type: "fixed" } & PricingFixedUnit | { type: "tiered" } & PricingTieredUnit | { type: "tiered_usage" } & PricingTieredUsageUnit | { type: "usage" } & PricingUsageUnit

Export

Defined in

src/generated/Pricing/api.ts:1121

---

PricingUnitForSave

Ƭ PricingUnitForSave: { type: "fixed" } & PricingFixedUnitForSave | { type: "tiered" } & PricingTieredUnitForSave | { type: "tiered_usage" } & PricingTieredUsageUnitForSave | { type: "usage" } & PricingUsageUnitForSave

Export

Defined in

src/generated/Pricing/api.ts:1164

Functions

ErrorApiAxiosParamCreator

▸ ErrorApiAxiosParamCreator(configuration?): Object

ErrorApi - axios parameter creator

Parameters

Name	Type
configuration?	Configuration

Returns

Object

Name	Type	Description
returnInternalServerError	(options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-

Export

Defined in

src/generated/Pricing/api.ts:1674

---

ErrorApiFactory

▸ ErrorApiFactory(configuration?, basePath?, axios?): Object

ErrorApi - factory interface

Parameters

Name	Type
configuration?	Configuration
basePath?	string
axios?	AxiosInstance

Returns

Object

Name	Type
returnInternalServerError	(options?: any) => AxiosPromise<void>

Export

Defined in

src/generated/Pricing/api.ts:1737

---

ErrorApiFp

▸ ErrorApiFp(configuration?): Object

ErrorApi - functional programming interface

Parameters

Name	Type
configuration?	Configuration

Returns

Object

Name	Type
returnInternalServerError	(options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Export

Defined in

src/generated/Pricing/api.ts:1717

---

MeteringApiAxiosParamCreator

▸ MeteringApiAxiosParamCreator(configuration?): Object

MeteringApi - axios parameter creator

Parameters

Name	Type
configuration?	Configuration

Returns

Object

Name	Type	Description
createMeteringUnit	(body?: MeteringUnitProps, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
deleteMeteringUnitByID	(meteringUnitId: string, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
deleteMeteringUnitTimestampCount	(tenantId: string, meteringUnitName: string, timestamp: number, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
getMeteringUnitDateCountByTenantIdAndUnitNameAndDate	(tenantId: string, meteringUnitName: string, date: string, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
getMeteringUnitDateCountByTenantIdAndUnitNameAndDatePeriod	(tenantId: string, meteringUnitName: string, startTimestamp?: number, endTimestamp?: number, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
getMeteringUnitDateCountByTenantIdAndUnitNameToday	(tenantId: string, meteringUnitName: string, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
getMeteringUnitDateCountsByTenantIdAndDate	(tenantId: string, date: string, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
getMeteringUnitMonthCountByTenantIdAndUnitNameAndMonth	(tenantId: string, meteringUnitName: string, month: string, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
getMeteringUnitMonthCountByTenantIdAndUnitNameThisMonth	(tenantId: string, meteringUnitName: string, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
getMeteringUnitMonthCountsByTenantIdAndMonth	(tenantId: string, month: string, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
getMeteringUnits	(options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
updateMeteringUnitByID	(meteringUnitId: string, body?: MeteringUnitProps, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
updateMeteringUnitTimestampCount	(tenantId: string, meteringUnitName: string, timestamp: number, updateMeteringUnitTimestampCountParam?: UpdateMeteringUnitTimestampCountParam, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
updateMeteringUnitTimestampCountNow	(tenantId: string, meteringUnitName: string, updateMeteringUnitTimestampCountNowParam?: UpdateMeteringUnitTimestampCountNowParam, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-

Export

Defined in

src/generated/Pricing/api.ts:1776

---

MeteringApiFactory

▸ MeteringApiFactory(configuration?, basePath?, axios?): Object

MeteringApi - factory interface

Parameters

Name	Type
configuration?	Configuration
basePath?	string
axios?	AxiosInstance

Returns

Object

Name	Type
createMeteringUnit	(body?: MeteringUnitProps, options?: any) => AxiosPromise<MeteringUnit>
deleteMeteringUnitByID	(meteringUnitId: string, options?: any) => AxiosPromise<void>
deleteMeteringUnitTimestampCount	(tenantId: string, meteringUnitName: string, timestamp: number, options?: any) => AxiosPromise<void>
getMeteringUnitDateCountByTenantIdAndUnitNameAndDate	(tenantId: string, meteringUnitName: string, date: string, options?: any) => AxiosPromise<MeteringUnitDateCount>
getMeteringUnitDateCountByTenantIdAndUnitNameAndDatePeriod	(tenantId: string, meteringUnitName: string, startTimestamp?: number, endTimestamp?: number, options?: any) => AxiosPromise<MeteringUnitDatePeriodCounts>
getMeteringUnitDateCountByTenantIdAndUnitNameToday	(tenantId: string, meteringUnitName: string, options?: any) => AxiosPromise<MeteringUnitDateCount>
getMeteringUnitDateCountsByTenantIdAndDate	(tenantId: string, date: string, options?: any) => AxiosPromise<MeteringUnitDateCounts>
getMeteringUnitMonthCountByTenantIdAndUnitNameAndMonth	(tenantId: string, meteringUnitName: string, month: string, options?: any) => AxiosPromise<MeteringUnitMonthCount>
getMeteringUnitMonthCountByTenantIdAndUnitNameThisMonth	(tenantId: string, meteringUnitName: string, options?: any) => AxiosPromise<MeteringUnitMonthCount>
getMeteringUnitMonthCountsByTenantIdAndMonth	(tenantId: string, month: string, options?: any) => AxiosPromise<MeteringUnitMonthCounts>
getMeteringUnits	(options?: any) => AxiosPromise<MeteringUnits>
updateMeteringUnitByID	(meteringUnitId: string, body?: MeteringUnitProps, options?: any) => AxiosPromise<void>
updateMeteringUnitTimestampCount	(tenantId: string, meteringUnitName: string, timestamp: number, updateMeteringUnitTimestampCountParam?: UpdateMeteringUnitTimestampCountParam, options?: any) => AxiosPromise<MeteringUnitTimestampCount>
updateMeteringUnitTimestampCountNow	(tenantId: string, meteringUnitName: string, updateMeteringUnitTimestampCountNowParam?: UpdateMeteringUnitTimestampCountNowParam, options?: any) => AxiosPromise<MeteringUnitTimestampCount>

Export

Defined in

src/generated/Pricing/api.ts:2573

---

MeteringApiFp

▸ MeteringApiFp(configuration?): Object

MeteringApi - functional programming interface

Parameters

Name	Type
configuration?	Configuration

Returns

Object

Name	Type
createMeteringUnit	(body?: MeteringUnitProps, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MeteringUnit>>
deleteMeteringUnitByID	(meteringUnitId: string, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
deleteMeteringUnitTimestampCount	(tenantId: string, meteringUnitName: string, timestamp: number, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
getMeteringUnitDateCountByTenantIdAndUnitNameAndDate	(tenantId: string, meteringUnitName: string, date: string, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MeteringUnitDateCount>>
getMeteringUnitDateCountByTenantIdAndUnitNameAndDatePeriod	(tenantId: string, meteringUnitName: string, startTimestamp?: number, endTimestamp?: number, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MeteringUnitDatePeriodCounts>>
getMeteringUnitDateCountByTenantIdAndUnitNameToday	(tenantId: string, meteringUnitName: string, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MeteringUnitDateCount>>
getMeteringUnitDateCountsByTenantIdAndDate	(tenantId: string, date: string, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MeteringUnitDateCounts>>
getMeteringUnitMonthCountByTenantIdAndUnitNameAndMonth	(tenantId: string, meteringUnitName: string, month: string, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MeteringUnitMonthCount>>
getMeteringUnitMonthCountByTenantIdAndUnitNameThisMonth	(tenantId: string, meteringUnitName: string, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MeteringUnitMonthCount>>
getMeteringUnitMonthCountsByTenantIdAndMonth	(tenantId: string, month: string, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MeteringUnitMonthCounts>>
getMeteringUnits	(options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MeteringUnits>>
updateMeteringUnitByID	(meteringUnitId: string, body?: MeteringUnitProps, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
updateMeteringUnitTimestampCount	(tenantId: string, meteringUnitName: string, timestamp: number, updateMeteringUnitTimestampCountParam?: UpdateMeteringUnitTimestampCountParam, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MeteringUnitTimestampCount>>
updateMeteringUnitTimestampCountNow	(tenantId: string, meteringUnitName: string, updateMeteringUnitTimestampCountNowParam?: UpdateMeteringUnitTimestampCountNowParam, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MeteringUnitTimestampCount>>

Export

Defined in

src/generated/Pricing/api.ts:2391

---

PricingMenusApiAxiosParamCreator

▸ PricingMenusApiAxiosParamCreator(configuration?): Object

PricingMenusApi - axios parameter creator

Parameters

Name	Type
configuration?	Configuration

Returns

Object

Name	Type	Description
createPricingMenu	(body?: SavePricingMenuParam, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
deletePricingMenu	(menuId: string, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
getPricingMenu	(menuId: string, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
getPricingMenus	(options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
updatePricingMenu	(menuId: string, body?: SavePricingMenuParam, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-

Export

Defined in

src/generated/Pricing/api.ts:2936

---

PricingMenusApiFactory

▸ PricingMenusApiFactory(configuration?, basePath?, axios?): Object

PricingMenusApi - factory interface

Parameters

Name	Type
configuration?	Configuration
basePath?	string
axios?	AxiosInstance

Returns

Object

Name	Type
createPricingMenu	(body?: SavePricingMenuParam, options?: any) => AxiosPromise<PricingMenu>
deletePricingMenu	(menuId: string, options?: any) => AxiosPromise<void>
getPricingMenu	(menuId: string, options?: any) => AxiosPromise<PricingMenu>
getPricingMenus	(options?: any) => AxiosPromise<PricingMenus>
updatePricingMenu	(menuId: string, body?: SavePricingMenuParam, options?: any) => AxiosPromise<void>

Export

Defined in

src/generated/Pricing/api.ts:3200

---

PricingMenusApiFp

▸ PricingMenusApiFp(configuration?): Object

PricingMenusApi - functional programming interface

Parameters

Name	Type
configuration?	Configuration

Returns

Object

Name	Type
createPricingMenu	(body?: SavePricingMenuParam, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PricingMenu>>
deletePricingMenu	(menuId: string, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
getPricingMenu	(menuId: string, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PricingMenu>>
getPricingMenus	(options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PricingMenus>>
updatePricingMenu	(menuId: string, body?: SavePricingMenuParam, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Export

Defined in

src/generated/Pricing/api.ts:3135

---

PricingPlansApiAxiosParamCreator

▸ PricingPlansApiAxiosParamCreator(configuration?): Object

PricingPlansApi - axios parameter creator

Parameters

Name	Type
configuration?	Configuration

Returns

Object

Name	Type	Description
createPricingPlan	(body?: SavePricingPlanParam, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
deleteAllPlansAndMenusAndUnitsAndMetersAndTaxRates	(options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
deletePricingPlan	(planId: string, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
deleteStripePlan	(options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
getPricingPlan	(planId: string, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
getPricingPlans	(options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
linkPlanToStripe	(options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
updatePricingPlan	(planId: string, body?: SavePricingPlanParam, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
updatePricingPlansUsed	(updatePricingPlansUsedParam?: UpdatePricingPlansUsedParam, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-

Export

Defined in

src/generated/Pricing/api.ts:3329

---

PricingPlansApiFactory

▸ PricingPlansApiFactory(configuration?, basePath?, axios?): Object

PricingPlansApi - factory interface

Parameters

Name	Type
configuration?	Configuration
basePath?	string
axios?	AxiosInstance

Returns

Object

Name	Type
createPricingPlan	(body?: SavePricingPlanParam, options?: any) => AxiosPromise<PricingPlan>
deleteAllPlansAndMenusAndUnitsAndMetersAndTaxRates	(options?: any) => AxiosPromise<void>
deletePricingPlan	(planId: string, options?: any) => AxiosPromise<void>
deleteStripePlan	(options?: any) => AxiosPromise<void>
getPricingPlan	(planId: string, options?: any) => AxiosPromise<PricingPlan>
getPricingPlans	(options?: any) => AxiosPromise<PricingPlans>
linkPlanToStripe	(options?: any) => AxiosPromise<void>
updatePricingPlan	(planId: string, body?: SavePricingPlanParam, options?: any) => AxiosPromise<void>
updatePricingPlansUsed	(updatePricingPlansUsedParam?: UpdatePricingPlansUsedParam, options?: any) => AxiosPromise<void>

Export

Defined in

src/generated/Pricing/api.ts:3774

---

PricingPlansApiFp

▸ PricingPlansApiFp(configuration?): Object

PricingPlansApi - functional programming interface

Parameters

Name	Type
configuration?	Configuration

Returns

Object

Name	Type
createPricingPlan	(body?: SavePricingPlanParam, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PricingPlan>>
deleteAllPlansAndMenusAndUnitsAndMetersAndTaxRates	(options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
deletePricingPlan	(planId: string, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
deleteStripePlan	(options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
getPricingPlan	(planId: string, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PricingPlan>>
getPricingPlans	(options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PricingPlans>>
linkPlanToStripe	(options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
updatePricingPlan	(planId: string, body?: SavePricingPlanParam, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
updatePricingPlansUsed	(updatePricingPlansUsedParam?: UpdatePricingPlansUsedParam, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Export

Defined in

src/generated/Pricing/api.ts:3668

---

PricingUnitsApiAxiosParamCreator

▸ PricingUnitsApiAxiosParamCreator(configuration?): Object

PricingUnitsApi - axios parameter creator

Parameters

Name	Type
configuration?	Configuration

Returns

Object

Name	Type	Description
createPricingUnit	(body?: PricingUnitForSave, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
deletePricingUnit	(pricingUnitId: string, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
getPricingUnit	(pricingUnitId: string, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
getPricingUnits	(options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
updatePricingUnit	(pricingUnitId: string, body?: PricingUnitForSave, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-

Export

Defined in

src/generated/Pricing/api.ts:3985

---

PricingUnitsApiFactory

▸ PricingUnitsApiFactory(configuration?, basePath?, axios?): Object

PricingUnitsApi - factory interface

Parameters

Name	Type
configuration?	Configuration
basePath?	string
axios?	AxiosInstance

Returns

Object

Name	Type
createPricingUnit	(body?: PricingUnitForSave, options?: any) => AxiosPromise<PricingUnit>
deletePricingUnit	(pricingUnitId: string, options?: any) => AxiosPromise<void>
getPricingUnit	(pricingUnitId: string, options?: any) => AxiosPromise<PricingUnit>
getPricingUnits	(options?: any) => AxiosPromise<PricingUnits>
updatePricingUnit	(pricingUnitId: string, body?: PricingUnitForSave, options?: any) => AxiosPromise<void>

Export

Defined in

src/generated/Pricing/api.ts:4249

---

PricingUnitsApiFp

▸ PricingUnitsApiFp(configuration?): Object

PricingUnitsApi - functional programming interface

Parameters

Name	Type
configuration?	Configuration

Returns

Object

Name	Type
createPricingUnit	(body?: PricingUnitForSave, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PricingUnit>>
deletePricingUnit	(pricingUnitId: string, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
getPricingUnit	(pricingUnitId: string, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PricingUnit>>
getPricingUnits	(options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PricingUnits>>
updatePricingUnit	(pricingUnitId: string, body?: PricingUnitForSave, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Export

Defined in

src/generated/Pricing/api.ts:4184

---

TaxRateApiAxiosParamCreator

▸ TaxRateApiAxiosParamCreator(configuration?): Object

TaxRateApi - axios parameter creator

Parameters

Name	Type
configuration?	Configuration

Returns

Object

Name	Type	Description
createTaxRate	(body?: TaxRateProps, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
getTaxRates	(options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-
updateTaxRate	(taxRateId: string, updateTaxRateParam?: UpdateTaxRateParam, options?: AxiosRequestConfig<any>) => Promise<RequestArgs>	-

Export

Defined in

src/generated/Pricing/api.ts:4378

---

TaxRateApiFactory

▸ TaxRateApiFactory(configuration?, basePath?, axios?): Object

TaxRateApi - factory interface

Parameters

Name	Type
configuration?	Configuration
basePath?	string
axios?	AxiosInstance

Returns

Object

Name	Type
createTaxRate	(body?: TaxRateProps, options?: any) => AxiosPromise<TaxRate>
getTaxRates	(options?: any) => AxiosPromise<TaxRates>
updateTaxRate	(taxRateId: string, updateTaxRateParam?: UpdateTaxRateParam, options?: any) => AxiosPromise<void>

Export

Defined in

src/generated/Pricing/api.ts:4544

---

TaxRateApiFp

▸ TaxRateApiFp(configuration?): Object

TaxRateApi - functional programming interface

Parameters

Name	Type
configuration?	Configuration

Returns

Object

Name	Type
createTaxRate	(body?: TaxRateProps, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaxRate>>
getTaxRates	(options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaxRates>>
updateTaxRate	(taxRateId: string, updateTaxRateParam?: UpdateTaxRateParam, options?: AxiosRequestConfig<any>) => Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Export

Defined in

src/generated/Pricing/api.ts:4501