item

package
v3.41.0 Latest Latest
Warning

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

Go to latest
Published: Dec 1, 2025 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 ApplicableItem

type ApplicableItem struct {
	Id     string `json:"id"`
	Object string `json:"object"`
}

type BundleConfiguration added in v3.24.0

type BundleConfiguration struct {
	Type   itemEnum.BundleConfigurationType `json:"type"`
	Object string                           `json:"object"`
}

type BundleItem added in v3.24.0

type BundleItem struct {
	ItemId          string        `json:"item_id"`
	ItemType        enum.ItemType `json:"item_type"`
	Quantity        int32         `json:"quantity"`
	PriceAllocation float64       `json:"price_allocation"`
	Object          string        `json:"object"`
}

type CreateBundleConfigurationParams added in v3.24.0

type CreateBundleConfigurationParams struct {
	Type itemEnum.BundleConfigurationType `json:"type,omitempty"`
}

type CreateBundleItemsToAddParams added in v3.24.0

type CreateBundleItemsToAddParams struct {
	ItemId          string        `json:"item_id,omitempty"`
	ItemType        enum.ItemType `json:"item_type,omitempty"`
	Quantity        *int32        `json:"quantity,omitempty"`
	PriceAllocation *float64      `json:"price_allocation,omitempty"`
}

type CreateRequestParams

type CreateRequestParams struct {
	Id                   string                           `json:"id"`
	Name                 string                           `json:"name"`
	Type                 itemEnum.Type                    `json:"type"`
	Description          string                           `json:"description,omitempty"`
	ItemFamilyId         string                           `json:"item_family_id"`
	IsGiftable           *bool                            `json:"is_giftable,omitempty"`
	IsShippable          *bool                            `json:"is_shippable,omitempty"`
	ExternalName         string                           `json:"external_name,omitempty"`
	EnabledInPortal      *bool                            `json:"enabled_in_portal,omitempty"`
	RedirectUrl          string                           `json:"redirect_url,omitempty"`
	EnabledForCheckout   *bool                            `json:"enabled_for_checkout,omitempty"`
	ItemApplicability    itemEnum.ItemApplicability       `json:"item_applicability,omitempty"`
	ApplicableItems      []string                         `json:"applicable_items,omitempty"`
	BundleConfiguration  *CreateBundleConfigurationParams `json:"bundle_configuration,omitempty"`
	Unit                 string                           `json:"unit,omitempty"`
	GiftClaimRedirectUrl string                           `json:"gift_claim_redirect_url,omitempty"`
	IncludedInMrr        *bool                            `json:"included_in_mrr,omitempty"`
	Metered              *bool                            `json:"metered,omitempty"`
	UsageCalculation     itemEnum.UsageCalculation        `json:"usage_calculation,omitempty"`
	IsPercentagePricing  *bool                            `json:"is_percentage_pricing,omitempty"`
	Metadata             map[string]interface{}           `json:"metadata,omitempty"`
	BusinessEntityId     string                           `json:"business_entity_id,omitempty"`
	BundleItemsToAdd     []*CreateBundleItemsToAddParams  `json:"bundle_items_to_add,omitempty"`
}

type Item

type Item struct {
	Id                   string                     `json:"id"`
	Name                 string                     `json:"name"`
	ExternalName         string                     `json:"external_name"`
	Description          string                     `json:"description"`
	Status               itemEnum.Status            `json:"status"`
	ResourceVersion      int64                      `json:"resource_version"`
	UpdatedAt            int64                      `json:"updated_at"`
	ItemFamilyId         string                     `json:"item_family_id"`
	Type                 itemEnum.Type              `json:"type"`
	IsShippable          bool                       `json:"is_shippable"`
	IsGiftable           bool                       `json:"is_giftable"`
	RedirectUrl          string                     `json:"redirect_url"`
	EnabledForCheckout   bool                       `json:"enabled_for_checkout"`
	EnabledInPortal      bool                       `json:"enabled_in_portal"`
	IncludedInMrr        bool                       `json:"included_in_mrr"`
	ItemApplicability    itemEnum.ItemApplicability `json:"item_applicability"`
	GiftClaimRedirectUrl string                     `json:"gift_claim_redirect_url"`
	Unit                 string                     `json:"unit"`
	Metered              bool                       `json:"metered"`
	UsageCalculation     itemEnum.UsageCalculation  `json:"usage_calculation"`
	IsPercentagePricing  bool                       `json:"is_percentage_pricing"`
	ArchivedAt           int64                      `json:"archived_at"`
	Channel              enum.Channel               `json:"channel"`
	ApplicableItems      []*ApplicableItem          `json:"applicable_items"`
	BundleItems          []*BundleItem              `json:"bundle_items"`
	BundleConfiguration  *BundleConfiguration       `json:"bundle_configuration"`
	Metadata             json.RawMessage            `json:"metadata"`
	Deleted              bool                       `json:"deleted"`
	BusinessEntityId     string                     `json:"business_entity_id"`
	CustomField          map[string]interface{}     `json:"custom_field"`
	Object               string                     `json:"object"`
}

type ListBundleConfigurationParams added in v3.24.0

type ListBundleConfigurationParams struct {
	Type *filter.EnumFilter `json:"type,omitempty"`
}

type ListRequestParams

type ListRequestParams struct {
	Limit                     *int32                         `json:"limit,omitempty"`
	Offset                    string                         `json:"offset,omitempty"`
	BundleConfiguration       *ListBundleConfigurationParams `json:"bundle_configuration,omitempty"`
	Id                        *filter.StringFilter           `json:"id,omitempty"`
	ItemFamilyId              *filter.StringFilter           `json:"item_family_id,omitempty"`
	Type                      *filter.EnumFilter             `json:"type,omitempty"`
	Name                      *filter.StringFilter           `json:"name,omitempty"`
	ItemApplicability         *filter.EnumFilter             `json:"item_applicability,omitempty"`
	Status                    *filter.EnumFilter             `json:"status,omitempty"`
	IsGiftable                *filter.BooleanFilter          `json:"is_giftable,omitempty"`
	UpdatedAt                 *filter.TimestampFilter        `json:"updated_at,omitempty"`
	EnabledForCheckout        *filter.BooleanFilter          `json:"enabled_for_checkout,omitempty"`
	EnabledInPortal           *filter.BooleanFilter          `json:"enabled_in_portal,omitempty"`
	Metered                   *filter.BooleanFilter          `json:"metered,omitempty"`
	UsageCalculation          *filter.EnumFilter             `json:"usage_calculation,omitempty"`
	Channel                   *filter.EnumFilter             `json:"channel,omitempty"`
	BusinessEntityId          *filter.StringFilter           `json:"business_entity_id,omitempty"`
	IncludeSiteLevelResources *filter.BooleanFilter          `json:"include_site_level_resources,omitempty"`
	SortBy                    *filter.SortFilter             `json:"sort_by,omitempty"`
}

type UpdateBundleConfigurationParams added in v3.24.0

type UpdateBundleConfigurationParams struct {
	Type itemEnum.BundleConfigurationType `json:"type,omitempty"`
}

type UpdateBundleItemsToAddParams added in v3.24.0

type UpdateBundleItemsToAddParams struct {
	ItemId          string        `json:"item_id,omitempty"`
	ItemType        enum.ItemType `json:"item_type,omitempty"`
	Quantity        *int32        `json:"quantity,omitempty"`
	PriceAllocation *float64      `json:"price_allocation,omitempty"`
}

type UpdateBundleItemsToRemoveParams added in v3.24.0

type UpdateBundleItemsToRemoveParams struct {
	ItemId   string        `json:"item_id,omitempty"`
	ItemType enum.ItemType `json:"item_type,omitempty"`
}

type UpdateBundleItemsToUpdateParams added in v3.24.0

type UpdateBundleItemsToUpdateParams struct {
	ItemId          string        `json:"item_id,omitempty"`
	ItemType        enum.ItemType `json:"item_type,omitempty"`
	Quantity        *int32        `json:"quantity,omitempty"`
	PriceAllocation *float64      `json:"price_allocation,omitempty"`
}

type UpdateRequestParams

type UpdateRequestParams struct {
	Name                 string                             `json:"name,omitempty"`
	Description          string                             `json:"description,omitempty"`
	IsShippable          *bool                              `json:"is_shippable,omitempty"`
	ExternalName         string                             `json:"external_name,omitempty"`
	ItemFamilyId         string                             `json:"item_family_id,omitempty"`
	EnabledInPortal      *bool                              `json:"enabled_in_portal,omitempty"`
	RedirectUrl          string                             `json:"redirect_url,omitempty"`
	EnabledForCheckout   *bool                              `json:"enabled_for_checkout,omitempty"`
	ItemApplicability    itemEnum.ItemApplicability         `json:"item_applicability,omitempty"`
	ClearApplicableItems *bool                              `json:"clear_applicable_items,omitempty"`
	ApplicableItems      []string                           `json:"applicable_items,omitempty"`
	BundleConfiguration  *UpdateBundleConfigurationParams   `json:"bundle_configuration,omitempty"`
	Unit                 string                             `json:"unit,omitempty"`
	GiftClaimRedirectUrl string                             `json:"gift_claim_redirect_url,omitempty"`
	Metadata             map[string]interface{}             `json:"metadata,omitempty"`
	IncludedInMrr        *bool                              `json:"included_in_mrr,omitempty"`
	Status               itemEnum.Status                    `json:"status,omitempty"`
	IsPercentagePricing  *bool                              `json:"is_percentage_pricing,omitempty"`
	BundleItemsToAdd     []*UpdateBundleItemsToAddParams    `json:"bundle_items_to_add,omitempty"`
	BundleItemsToUpdate  []*UpdateBundleItemsToUpdateParams `json:"bundle_items_to_update,omitempty"`
	BundleItemsToRemove  []*UpdateBundleItemsToRemoveParams `json:"bundle_items_to_remove,omitempty"`
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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