addon

package
v3.45.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 6, 2026 License: MIT Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Addon

type Addon struct {
	Id           string            `json:"id"`
	Name         string            `json:"name"`
	InvoiceName  string            `json:"invoice_name"`
	Description  string            `json:"description"`
	PricingModel enum.PricingModel `json:"pricing_model"`
	//Deprecated: this field is deprecated
	Type                        addonEnum.Type                        `json:"type"`
	ChargeType                  addonEnum.ChargeType                  `json:"charge_type"`
	Price                       int64                                 `json:"price"`
	CurrencyCode                string                                `json:"currency_code"`
	Period                      int32                                 `json:"period"`
	PeriodUnit                  addonEnum.PeriodUnit                  `json:"period_unit"`
	Unit                        string                                `json:"unit"`
	Status                      addonEnum.Status                      `json:"status"`
	ArchivedAt                  int64                                 `json:"archived_at"`
	EnabledInPortal             bool                                  `json:"enabled_in_portal"`
	TaxCode                     string                                `json:"tax_code"`
	HsnCode                     string                                `json:"hsn_code"`
	TaxjarProductCode           string                                `json:"taxjar_product_code"`
	AvalaraSaleType             enum.AvalaraSaleType                  `json:"avalara_sale_type"`
	AvalaraTransactionType      int32                                 `json:"avalara_transaction_type"`
	AvalaraServiceType          int32                                 `json:"avalara_service_type"`
	Sku                         string                                `json:"sku"`
	AccountingCode              string                                `json:"accounting_code"`
	AccountingCategory1         string                                `json:"accounting_category1"`
	AccountingCategory2         string                                `json:"accounting_category2"`
	AccountingCategory3         string                                `json:"accounting_category3"`
	AccountingCategory4         string                                `json:"accounting_category4"`
	IsShippable                 bool                                  `json:"is_shippable"`
	ShippingFrequencyPeriod     int32                                 `json:"shipping_frequency_period"`
	ShippingFrequencyPeriodUnit addonEnum.ShippingFrequencyPeriodUnit `json:"shipping_frequency_period_unit"`
	ResourceVersion             int64                                 `json:"resource_version"`
	UpdatedAt                   int64                                 `json:"updated_at"`
	PriceInDecimal              string                                `json:"price_in_decimal"`
	IncludedInMrr               bool                                  `json:"included_in_mrr"`
	Channel                     enum.Channel                          `json:"channel"`
	ProrationType               addonEnum.ProrationType               `json:"proration_type"`
	InvoiceNotes                string                                `json:"invoice_notes"`
	Taxable                     bool                                  `json:"taxable"`
	TaxProfileId                string                                `json:"tax_profile_id"`
	MetaData                    json.RawMessage                       `json:"meta_data"`
	Tiers                       []*Tier                               `json:"tiers"`
	TaxProvidersFields          []*TaxProvidersField                  `json:"tax_providers_fields"`
	ShowDescriptionInInvoices   bool                                  `json:"show_description_in_invoices"`
	ShowDescriptionInQuotes     bool                                  `json:"show_description_in_quotes"`
	CustomField                 map[string]interface{}                `json:"custom_field"`
	Object                      string                                `json:"object"`
}

type CopyRequestParams

type CopyRequestParams struct {
	FromSite       string `json:"from_site"`
	IdAtFromSite   string `json:"id_at_from_site"`
	Id             string `json:"id,omitempty"`
	ForSiteMerging *bool  `json:"for_site_merging,omitempty"`
}

type CreateRequestParams

type CreateRequestParams struct {
	Id                          string                                `json:"id"`
	Name                        string                                `json:"name"`
	InvoiceName                 string                                `json:"invoice_name,omitempty"`
	Description                 string                                `json:"description,omitempty"`
	ChargeType                  addonEnum.ChargeType                  `json:"charge_type"`
	Price                       *int64                                `json:"price,omitempty"`
	Tiers                       []*CreateTierParams                   `json:"tiers,omitempty"`
	CurrencyCode                string                                `json:"currency_code,omitempty"`
	Period                      *int32                                `json:"period,omitempty"`
	PeriodUnit                  addonEnum.PeriodUnit                  `json:"period_unit,omitempty"`
	PricingModel                enum.PricingModel                     `json:"pricing_model,omitempty"`
	Type                        addonEnum.Type                        `json:"type,omitempty"`
	Unit                        string                                `json:"unit,omitempty"`
	EnabledInPortal             *bool                                 `json:"enabled_in_portal,omitempty"`
	Taxable                     *bool                                 `json:"taxable,omitempty"`
	TaxProfileId                string                                `json:"tax_profile_id,omitempty"`
	AvalaraSaleType             enum.AvalaraSaleType                  `json:"avalara_sale_type,omitempty"`
	AvalaraTransactionType      *int32                                `json:"avalara_transaction_type,omitempty"`
	AvalaraServiceType          *int32                                `json:"avalara_service_type,omitempty"`
	TaxCode                     string                                `json:"tax_code,omitempty"`
	HsnCode                     string                                `json:"hsn_code,omitempty"`
	TaxjarProductCode           string                                `json:"taxjar_product_code,omitempty"`
	InvoiceNotes                string                                `json:"invoice_notes,omitempty"`
	MetaData                    map[string]interface{}                `json:"meta_data,omitempty"`
	Sku                         string                                `json:"sku,omitempty"`
	AccountingCode              string                                `json:"accounting_code,omitempty"`
	AccountingCategory1         string                                `json:"accounting_category1,omitempty"`
	AccountingCategory2         string                                `json:"accounting_category2,omitempty"`
	AccountingCategory3         string                                `json:"accounting_category3,omitempty"`
	AccountingCategory4         string                                `json:"accounting_category4,omitempty"`
	IsShippable                 *bool                                 `json:"is_shippable,omitempty"`
	ShippingFrequencyPeriod     *int32                                `json:"shipping_frequency_period,omitempty"`
	ShippingFrequencyPeriodUnit addonEnum.ShippingFrequencyPeriodUnit `json:"shipping_frequency_period_unit,omitempty"`
	IncludedInMrr               *bool                                 `json:"included_in_mrr,omitempty"`
	ShowDescriptionInInvoices   *bool                                 `json:"show_description_in_invoices,omitempty"`
	ShowDescriptionInQuotes     *bool                                 `json:"show_description_in_quotes,omitempty"`
	PriceInDecimal              string                                `json:"price_in_decimal,omitempty"`
	TaxProvidersFields          []*CreateTaxProvidersFieldParams      `json:"tax_providers_fields,omitempty"`
	ProrationType               addonEnum.ProrationType               `json:"proration_type,omitempty"`
	Status                      addonEnum.Status                      `json:"status,omitempty"`
}

type CreateTaxProvidersFieldParams added in v3.18.0

type CreateTaxProvidersFieldParams struct {
	ProviderName string `json:"provider_name"`
	FieldId      string `json:"field_id"`
	FieldValue   string `json:"field_value"`
}

type CreateTierParams

type CreateTierParams struct {
	StartingUnit          *int32 `json:"starting_unit,omitempty"`
	EndingUnit            *int32 `json:"ending_unit,omitempty"`
	Price                 *int64 `json:"price,omitempty"`
	StartingUnitInDecimal string `json:"starting_unit_in_decimal,omitempty"`
	EndingUnitInDecimal   string `json:"ending_unit_in_decimal,omitempty"`
	PriceInDecimal        string `json:"price_in_decimal,omitempty"`
}

type ListRequestParams

type ListRequestParams struct {
	Limit          *int32                  `json:"limit,omitempty"`
	Offset         string                  `json:"offset,omitempty"`
	Id             *filter.StringFilter    `json:"id,omitempty"`
	Name           *filter.StringFilter    `json:"name,omitempty"`
	PricingModel   *filter.EnumFilter      `json:"pricing_model,omitempty"`
	Type           *filter.EnumFilter      `json:"type,omitempty"`
	ChargeType     *filter.EnumFilter      `json:"charge_type,omitempty"`
	Price          *filter.NumberFilter    `json:"price,omitempty"`
	Period         *filter.NumberFilter    `json:"period,omitempty"`
	PeriodUnit     *filter.EnumFilter      `json:"period_unit,omitempty"`
	Status         *filter.EnumFilter      `json:"status,omitempty"`
	UpdatedAt      *filter.TimestampFilter `json:"updated_at,omitempty"`
	CurrencyCode   *filter.StringFilter    `json:"currency_code,omitempty"`
	Channel        *filter.EnumFilter      `json:"channel,omitempty"`
	IncludeDeleted *bool                   `json:"include_deleted,omitempty"`
}

type TaxProvidersField added in v3.17.0

type TaxProvidersField struct {
	ProviderName string `json:"provider_name"`
	FieldId      string `json:"field_id"`
	FieldValue   string `json:"field_value"`
	Object       string `json:"object"`
}

type Tier

type Tier struct {
	StartingUnit          int32            `json:"starting_unit"`
	EndingUnit            int32            `json:"ending_unit"`
	Price                 int64            `json:"price"`
	StartingUnitInDecimal string           `json:"starting_unit_in_decimal"`
	EndingUnitInDecimal   string           `json:"ending_unit_in_decimal"`
	PriceInDecimal        string           `json:"price_in_decimal"`
	PricingType           enum.PricingType `json:"pricing_type"`
	PackageSize           int32            `json:"package_size"`
	Object                string           `json:"object"`
}

type UpdateRequestParams

type UpdateRequestParams struct {
	Name                        string                                `json:"name,omitempty"`
	InvoiceName                 string                                `json:"invoice_name,omitempty"`
	Description                 string                                `json:"description,omitempty"`
	ChargeType                  addonEnum.ChargeType                  `json:"charge_type,omitempty"`
	Price                       *int64                                `json:"price,omitempty"`
	Tiers                       []*UpdateTierParams                   `json:"tiers,omitempty"`
	CurrencyCode                string                                `json:"currency_code,omitempty"`
	Period                      *int32                                `json:"period,omitempty"`
	PeriodUnit                  addonEnum.PeriodUnit                  `json:"period_unit,omitempty"`
	PricingModel                enum.PricingModel                     `json:"pricing_model,omitempty"`
	Type                        addonEnum.Type                        `json:"type,omitempty"`
	Unit                        string                                `json:"unit,omitempty"`
	EnabledInPortal             *bool                                 `json:"enabled_in_portal,omitempty"`
	Taxable                     *bool                                 `json:"taxable,omitempty"`
	TaxProfileId                string                                `json:"tax_profile_id,omitempty"`
	AvalaraSaleType             enum.AvalaraSaleType                  `json:"avalara_sale_type,omitempty"`
	AvalaraTransactionType      *int32                                `json:"avalara_transaction_type,omitempty"`
	AvalaraServiceType          *int32                                `json:"avalara_service_type,omitempty"`
	TaxCode                     string                                `json:"tax_code,omitempty"`
	HsnCode                     string                                `json:"hsn_code,omitempty"`
	TaxjarProductCode           string                                `json:"taxjar_product_code,omitempty"`
	InvoiceNotes                string                                `json:"invoice_notes,omitempty"`
	MetaData                    map[string]interface{}                `json:"meta_data,omitempty"`
	Sku                         string                                `json:"sku,omitempty"`
	AccountingCode              string                                `json:"accounting_code,omitempty"`
	AccountingCategory1         string                                `json:"accounting_category1,omitempty"`
	AccountingCategory2         string                                `json:"accounting_category2,omitempty"`
	AccountingCategory3         string                                `json:"accounting_category3,omitempty"`
	AccountingCategory4         string                                `json:"accounting_category4,omitempty"`
	IsShippable                 *bool                                 `json:"is_shippable,omitempty"`
	ShippingFrequencyPeriod     *int32                                `json:"shipping_frequency_period,omitempty"`
	ShippingFrequencyPeriodUnit addonEnum.ShippingFrequencyPeriodUnit `json:"shipping_frequency_period_unit,omitempty"`
	IncludedInMrr               *bool                                 `json:"included_in_mrr,omitempty"`
	ShowDescriptionInInvoices   *bool                                 `json:"show_description_in_invoices,omitempty"`
	ShowDescriptionInQuotes     *bool                                 `json:"show_description_in_quotes,omitempty"`
	PriceInDecimal              string                                `json:"price_in_decimal,omitempty"`
	TaxProvidersFields          []*UpdateTaxProvidersFieldParams      `json:"tax_providers_fields,omitempty"`
	ProrationType               addonEnum.ProrationType               `json:"proration_type,omitempty"`
}

type UpdateTaxProvidersFieldParams added in v3.18.0

type UpdateTaxProvidersFieldParams struct {
	ProviderName string `json:"provider_name"`
	FieldId      string `json:"field_id"`
	FieldValue   string `json:"field_value"`
}

type UpdateTierParams

type UpdateTierParams struct {
	StartingUnit          *int32 `json:"starting_unit,omitempty"`
	EndingUnit            *int32 `json:"ending_unit,omitempty"`
	Price                 *int64 `json:"price,omitempty"`
	StartingUnitInDecimal string `json:"starting_unit_in_decimal,omitempty"`
	EndingUnitInDecimal   string `json:"ending_unit_in_decimal,omitempty"`
	PriceInDecimal        string `json:"price_in_decimal,omitempty"`
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL