enterprisebillingunitsv1

package
v0.17.6 Latest Latest
Warning

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

 Go to latest Published: Jan 19, 2021 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package enterprisebillingunitsv1 : Operations and models for the EnterpriseBillingUnitsV1 service

Index

Constants

View Source 
const (
	BillingOptionStateActiveConst    = "ACTIVE"
	BillingOptionStateCanceledConst  = "CANCELED"
	BillingOptionStateSuspendedConst = "SUSPENDED"
)

Constants associated with the BillingOption.State property. The state of the billing option. The valid values include `ACTIVE, `SUSPENDED`, and `CANCELED`.

View Source 
const (
	BillingOptionTypeOfferConst        = "OFFER"
	BillingOptionTypeSubscriptionConst = "SUBSCRIPTION"
)

Constants associated with the BillingOption.Type property. The type of billing option. The valid values are `SUBSCRIPTION` and `OFFER`.

View Source 
const (
	BillingOptionCategoryPlatformConst = "PLATFORM"
	BillingOptionCategoryServiceConst  = "SERVICE"
	BillingOptionCategorySupportConst  = "SUPPORT"
)

Constants associated with the BillingOption.Category property. The category of the billing option. The valid values are `PLATFORM`, `SERVICE`, and `SUPPORT`.

View Source 
const (
	CreditPoolTypePlatformConst = "PLATFORM"
	CreditPoolTypeSupportConst  = "SUPPORT"
)

Constants associated with the CreditPool.Type property. The type of credit, either `PLATFORM` or `SUPPORT`.

View Source 
const (
	TermCreditsCategoryOfferConst    = "OFFER"
	TermCreditsCategoryPlatformConst = "PLATFORM"
	TermCreditsCategoryServiceConst  = "SERVICE"
	TermCreditsCategorySupportConst  = "SUPPORT"
)

Constants associated with the TermCredits.Category property. The category of the credit pool. The valid values are `PLATFORM`, `OFFER`, or `SERVICE` for platform credit and `SUPPORT` for support credit.

View Source 
const DefaultServiceName = "enterprise_billing_units"

DefaultServiceName is the default key used to find external configuration information.

View Source 
const DefaultServiceURL = "https://billing.cloud.ibm.com"

DefaultServiceURL is the default URL to make service requests to.

Variables

This section is empty.

Functions

func GetServiceURLForRegion added in v0.17.1 

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalBillingOption 

func UnmarshalBillingOption(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBillingOption unmarshals an instance of BillingOption from the specified map of raw messages.

func UnmarshalBillingOptionsList 

func UnmarshalBillingOptionsList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBillingOptionsList unmarshals an instance of BillingOptionsList from the specified map of raw messages.

func UnmarshalBillingUnit 

func UnmarshalBillingUnit(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBillingUnit unmarshals an instance of BillingUnit from the specified map of raw messages.

func UnmarshalBillingUnitsList 

func UnmarshalBillingUnitsList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBillingUnitsList unmarshals an instance of BillingUnitsList from the specified map of raw messages.

func UnmarshalCreditPool 

func UnmarshalCreditPool(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCreditPool unmarshals an instance of CreditPool from the specified map of raw messages.

func UnmarshalCreditPoolOverage 

func UnmarshalCreditPoolOverage(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCreditPoolOverage unmarshals an instance of CreditPoolOverage from the specified map of raw messages.

func UnmarshalCreditPoolsList 

func UnmarshalCreditPoolsList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCreditPoolsList unmarshals an instance of CreditPoolsList from the specified map of raw messages.

func UnmarshalTermCredits 

func UnmarshalTermCredits(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTermCredits unmarshals an instance of TermCredits from the specified map of raw messages.

Types

type BillingOption 

type BillingOption struct {
	// The ID of the billing option.
	ID *string `json:"id,omitempty"`

	// The ID of the billing unit that's associated with the billing option.
	BillingUnitID *string `json:"billing_unit_id,omitempty"`

	// The start date of billing option.
	StartDate *strfmt.DateTime `json:"start_date,omitempty"`

	// The end date of billing option.
	EndDate *strfmt.DateTime `json:"end_date,omitempty"`

	// The state of the billing option. The valid values include `ACTIVE, `SUSPENDED`, and `CANCELED`.
	State *string `json:"state,omitempty"`

	// The type of billing option. The valid values are `SUBSCRIPTION` and `OFFER`.
	Type *string `json:"type,omitempty"`

	// The category of the billing option. The valid values are `PLATFORM`, `SERVICE`, and `SUPPORT`.
	Category *string `json:"category,omitempty"`

	// The payment method for support.
	PaymentInstrument map[string]interface{} `json:"payment_instrument,omitempty"`

	// The duration of the billing options in months.
	DurationInMonths *int64 `json:"duration_in_months,omitempty"`

	// The line item ID for support.
	LineItemID *int64 `json:"line_item_id,omitempty"`

	// The support billing system.
	BillingSystem map[string]interface{} `json:"billing_system,omitempty"`

	// The renewal code for support. This code denotes whether the subscription automatically renews, is assessed monthly,
	// and so on.
	RenewalModeCode *string `json:"renewal_mode_code,omitempty"`

	// The date when the billing option was updated.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
}

BillingOption : Information about a billing option.

type BillingOptionsList 

type BillingOptionsList struct {
	// A count of the billing units that were found by the query.
	RowsCount *int64 `json:"rows_count,omitempty"`

	// Bookmark URL to query for next batch of billing units. This returns `null` if no additional pages are required.
	NextURL *string `json:"next_url,omitempty"`

	// A list of billing units found.
	Resources []BillingOption `json:"resources,omitempty"`
}

BillingOptionsList : A search result containing zero or more billing options.

type BillingUnit 

type BillingUnit struct {
	// The ID of the billing unit, which is a globally unique identifier (GUID).
	ID *string `json:"id,omitempty"`

	// The Cloud Resource Name (CRN) of the billing unit, scoped to the enterprise account ID.
	CRN *string `json:"crn,omitempty"`

	// The name of the billing unit.
	Name *string `json:"name,omitempty"`

	// The ID of the enterprise to which the billing unit is associated.
	EnterpriseID *string `json:"enterprise_id,omitempty"`

	// The currency code for the billing unit.
	CurrencyCode *string `json:"currency_code,omitempty"`

	// The country code for the billing unit.
	CountryCode *string `json:"country_code,omitempty"`

	// A flag that indicates whether this billing unit is the primary billing mechanism for the enterprise.
	Master *bool `json:"master,omitempty"`

	// The creation date of the billing unit.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`
}

BillingUnit : Information about a billing unit.

type BillingUnitsList 

type BillingUnitsList struct {
	// A count of the billing units that were found by the query.
	RowsCount *int64 `json:"rows_count,omitempty"`

	// Bookmark URL to query for next batch of billing units. This returns `null` if no additional pages are required.
	NextURL *string `json:"next_url,omitempty"`

	// A list of billing units found.
	Resources []BillingUnit `json:"resources,omitempty"`
}

BillingUnitsList : A search result contining zero or more billing units.

type CreditPool 

type CreditPool struct {
	// The type of credit, either `PLATFORM` or `SUPPORT`.
	Type *string `json:"type,omitempty"`

	// The currency code of the associated billing unit.
	CurrencyCode *string `json:"currency_code,omitempty"`

	// The ID of the billing unit that's associated with the credit pool. This value is a globally unique identifier
	// (GUID).
	BillingUnitID *string `json:"billing_unit_id,omitempty"`

	// A list of active subscription terms available within a credit pool.
	TermCredits []TermCredits `json:"term_credits,omitempty"`

	// Overage that was generated on the credit pool.
	Overage *CreditPoolOverage `json:"overage,omitempty"`
}

CreditPool : The credit pool for a billing unit.

type CreditPoolOverage 

type CreditPoolOverage struct {
	// The number of credits used as overage.
	Cost *float64 `json:"cost,omitempty"`

	// A list of resources that generated overage.
	Resources []map[string]interface{} `json:"resources,omitempty"`
}

CreditPoolOverage : Overage that was generated on the credit pool.

type CreditPoolsList 

type CreditPoolsList struct {
	// The number of credit pools that were found by the query.
	RowsCount *int64 `json:"rows_count,omitempty"`

	// A bookmark URL to the query for the next batch of billing units. Use a value of `null` if no additional pages are
	// required.
	NextURL *string `json:"next_url,omitempty"`

	// A list of credit pools found by the query.
	Resources []CreditPool `json:"resources,omitempty"`
}

CreditPoolsList : A search result containing zero or more credit pools.

type EnterpriseBillingUnitsV1 

type EnterpriseBillingUnitsV1 struct {
	Service *core.BaseService
}

EnterpriseBillingUnitsV1 : Billing units for IBM Cloud enterprises

Version: 1.0.0

func NewEnterpriseBillingUnitsV1 

func NewEnterpriseBillingUnitsV1(options *EnterpriseBillingUnitsV1Options) (service *EnterpriseBillingUnitsV1, err error)

NewEnterpriseBillingUnitsV1 : constructs an instance of EnterpriseBillingUnitsV1 with passed in options.

func NewEnterpriseBillingUnitsV1UsingExternalConfig 

func NewEnterpriseBillingUnitsV1UsingExternalConfig(options *EnterpriseBillingUnitsV1Options) (enterpriseBillingUnits *EnterpriseBillingUnitsV1, err error)

NewEnterpriseBillingUnitsV1UsingExternalConfig : constructs an instance of EnterpriseBillingUnitsV1 with passed in options and external configuration.

func (*EnterpriseBillingUnitsV1) Clone added in v0.17.1 

func (enterpriseBillingUnits *EnterpriseBillingUnitsV1) Clone() *EnterpriseBillingUnitsV1

Clone makes a copy of "enterpriseBillingUnits" suitable for processing requests.

func (*EnterpriseBillingUnitsV1) DisableRetries 

func (enterpriseBillingUnits *EnterpriseBillingUnitsV1) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*EnterpriseBillingUnitsV1) EnableRetries 

func (enterpriseBillingUnits *EnterpriseBillingUnitsV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*EnterpriseBillingUnitsV1) GetBillingUnit 

func (enterpriseBillingUnits *EnterpriseBillingUnitsV1) GetBillingUnit(getBillingUnitOptions *GetBillingUnitOptions) (result *BillingUnit, response *core.DetailedResponse, err error)

GetBillingUnit : Get billing unit by ID Return the billing unit information if it exists.

func (*EnterpriseBillingUnitsV1) GetBillingUnitWithContext 

func (enterpriseBillingUnits *EnterpriseBillingUnitsV1) GetBillingUnitWithContext(ctx context.Context, getBillingUnitOptions *GetBillingUnitOptions) (result *BillingUnit, response *core.DetailedResponse, err error)

GetBillingUnitWithContext is an alternate form of the GetBillingUnit method which supports a Context parameter

func (*EnterpriseBillingUnitsV1) GetCreditPools 

func (enterpriseBillingUnits *EnterpriseBillingUnitsV1) GetCreditPools(getCreditPoolsOptions *GetCreditPoolsOptions) (result *CreditPoolsList, response *core.DetailedResponse, err error)

GetCreditPools : Get credit pools Get credit pools for a billing unit. Credit pools can be either platform or support credit pools. The platform credit pool contains credit from platform subscriptions and promotional offers. The support credit pool contains credit from support subscriptions.

func (*EnterpriseBillingUnitsV1) GetCreditPoolsWithContext 

func (enterpriseBillingUnits *EnterpriseBillingUnitsV1) GetCreditPoolsWithContext(ctx context.Context, getCreditPoolsOptions *GetCreditPoolsOptions) (result *CreditPoolsList, response *core.DetailedResponse, err error)

GetCreditPoolsWithContext is an alternate form of the GetCreditPools method which supports a Context parameter

func (*EnterpriseBillingUnitsV1) GetEnableGzipCompression 

func (enterpriseBillingUnits *EnterpriseBillingUnitsV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*EnterpriseBillingUnitsV1) GetServiceURL 

func (enterpriseBillingUnits *EnterpriseBillingUnitsV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*EnterpriseBillingUnitsV1) ListBillingOptions 

func (enterpriseBillingUnits *EnterpriseBillingUnitsV1) ListBillingOptions(listBillingOptionsOptions *ListBillingOptionsOptions) (result *BillingOptionsList, response *core.DetailedResponse, err error)

ListBillingOptions : List billing options Return matching billing options if any exist. Show subscriptions and promotional offers that are available to a billing unit.

func (*EnterpriseBillingUnitsV1) ListBillingOptionsWithContext 

func (enterpriseBillingUnits *EnterpriseBillingUnitsV1) ListBillingOptionsWithContext(ctx context.Context, listBillingOptionsOptions *ListBillingOptionsOptions) (result *BillingOptionsList, response *core.DetailedResponse, err error)

ListBillingOptionsWithContext is an alternate form of the ListBillingOptions method which supports a Context parameter

func (*EnterpriseBillingUnitsV1) ListBillingUnits 

func (enterpriseBillingUnits *EnterpriseBillingUnitsV1) ListBillingUnits(listBillingUnitsOptions *ListBillingUnitsOptions) (result *BillingUnitsList, response *core.DetailedResponse, err error)

ListBillingUnits : List billing units Return matching billing unit information if any exists. Omits internal properties and enterprise account ID from the billing unit.

func (*EnterpriseBillingUnitsV1) ListBillingUnitsWithContext 

func (enterpriseBillingUnits *EnterpriseBillingUnitsV1) ListBillingUnitsWithContext(ctx context.Context, listBillingUnitsOptions *ListBillingUnitsOptions) (result *BillingUnitsList, response *core.DetailedResponse, err error)

ListBillingUnitsWithContext is an alternate form of the ListBillingUnits method which supports a Context parameter

func (*EnterpriseBillingUnitsV1) NewGetBillingUnitOptions 

func (*EnterpriseBillingUnitsV1) NewGetBillingUnitOptions(billingUnitID string) *GetBillingUnitOptions

NewGetBillingUnitOptions : Instantiate GetBillingUnitOptions

func (*EnterpriseBillingUnitsV1) NewGetCreditPoolsOptions 

func (*EnterpriseBillingUnitsV1) NewGetCreditPoolsOptions(billingUnitID string) *GetCreditPoolsOptions

NewGetCreditPoolsOptions : Instantiate GetCreditPoolsOptions

func (*EnterpriseBillingUnitsV1) NewListBillingOptionsOptions 

func (*EnterpriseBillingUnitsV1) NewListBillingOptionsOptions(billingUnitID string) *ListBillingOptionsOptions

NewListBillingOptionsOptions : Instantiate ListBillingOptionsOptions

func (*EnterpriseBillingUnitsV1) NewListBillingUnitsOptions 

func (*EnterpriseBillingUnitsV1) NewListBillingUnitsOptions() *ListBillingUnitsOptions

NewListBillingUnitsOptions : Instantiate ListBillingUnitsOptions

func (*EnterpriseBillingUnitsV1) SetDefaultHeaders 

func (enterpriseBillingUnits *EnterpriseBillingUnitsV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*EnterpriseBillingUnitsV1) SetEnableGzipCompression 

func (enterpriseBillingUnits *EnterpriseBillingUnitsV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*EnterpriseBillingUnitsV1) SetServiceURL 

func (enterpriseBillingUnits *EnterpriseBillingUnitsV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

type EnterpriseBillingUnitsV1Options 

type EnterpriseBillingUnitsV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

EnterpriseBillingUnitsV1Options : Service options

type GetBillingUnitOptions 

type GetBillingUnitOptions struct {
	// The ID of the requested billing unit.
	BillingUnitID *string `json:"billing_unit_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetBillingUnitOptions : The GetBillingUnit options.

func (*GetBillingUnitOptions) SetBillingUnitID 

func (options *GetBillingUnitOptions) SetBillingUnitID(billingUnitID string) *GetBillingUnitOptions

SetBillingUnitID : Allow user to set BillingUnitID

func (*GetBillingUnitOptions) SetHeaders 

func (options *GetBillingUnitOptions) SetHeaders(param map[string]string) *GetBillingUnitOptions

SetHeaders : Allow user to set Headers

type GetCreditPoolsOptions 

type GetCreditPoolsOptions struct {
	// The ID of the billing unit.
	BillingUnitID *string `json:"billing_unit_id" validate:"required"`

	// The date in the format of YYYY-MM.
	Date *string `json:"date,omitempty"`

	// Filters the credit pool by type, either `PLATFORM` or `SUPPORT`.
	Type *string `json:"type,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetCreditPoolsOptions : The GetCreditPools options.

func (*GetCreditPoolsOptions) SetBillingUnitID 

func (options *GetCreditPoolsOptions) SetBillingUnitID(billingUnitID string) *GetCreditPoolsOptions

SetBillingUnitID : Allow user to set BillingUnitID

func (*GetCreditPoolsOptions) SetDate 

func (options *GetCreditPoolsOptions) SetDate(date string) *GetCreditPoolsOptions

SetDate : Allow user to set Date

func (*GetCreditPoolsOptions) SetHeaders 

func (options *GetCreditPoolsOptions) SetHeaders(param map[string]string) *GetCreditPoolsOptions

SetHeaders : Allow user to set Headers

func (*GetCreditPoolsOptions) SetType 

func (options *GetCreditPoolsOptions) SetType(typeVar string) *GetCreditPoolsOptions

SetType : Allow user to set Type

type ListBillingOptionsOptions 

type ListBillingOptionsOptions struct {
	// The billing unit ID.
	BillingUnitID *string `json:"billing_unit_id" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListBillingOptionsOptions : The ListBillingOptions options.

func (*ListBillingOptionsOptions) SetBillingUnitID 

func (options *ListBillingOptionsOptions) SetBillingUnitID(billingUnitID string) *ListBillingOptionsOptions

SetBillingUnitID : Allow user to set BillingUnitID

func (*ListBillingOptionsOptions) SetHeaders 

func (options *ListBillingOptionsOptions) SetHeaders(param map[string]string) *ListBillingOptionsOptions

SetHeaders : Allow user to set Headers

type ListBillingUnitsOptions 

type ListBillingUnitsOptions struct {
	// The enterprise account ID.
	AccountID *string `json:"account_id,omitempty"`

	// The enterprise ID.
	EnterpriseID *string `json:"enterprise_id,omitempty"`

	// The account group ID.
	AccountGroupID *string `json:"account_group_id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListBillingUnitsOptions : The ListBillingUnits options.

func (*ListBillingUnitsOptions) SetAccountGroupID 

func (options *ListBillingUnitsOptions) SetAccountGroupID(accountGroupID string) *ListBillingUnitsOptions

SetAccountGroupID : Allow user to set AccountGroupID

func (*ListBillingUnitsOptions) SetAccountID 

func (options *ListBillingUnitsOptions) SetAccountID(accountID string) *ListBillingUnitsOptions

SetAccountID : Allow user to set AccountID

func (*ListBillingUnitsOptions) SetEnterpriseID 

func (options *ListBillingUnitsOptions) SetEnterpriseID(enterpriseID string) *ListBillingUnitsOptions

SetEnterpriseID : Allow user to set EnterpriseID

func (*ListBillingUnitsOptions) SetHeaders 

func (options *ListBillingUnitsOptions) SetHeaders(param map[string]string) *ListBillingUnitsOptions

SetHeaders : Allow user to set Headers

type TermCredits 

type TermCredits struct {
	// The ID of the billing option from which the subscription term is derived.
	BillingOptionID *string `json:"billing_option_id,omitempty"`

	// The category of the credit pool. The valid values are `PLATFORM`, `OFFER`, or `SERVICE` for platform credit and
	// `SUPPORT` for support credit.
	Category *string `json:"category,omitempty"`

	// The start date of the term in ISO format.
	StartDate *strfmt.DateTime `json:"start_date,omitempty"`

	// The end date of the term in ISO format.
	EndDate *strfmt.DateTime `json:"end_date,omitempty"`

	// The total credit available in this term.
	TotalCredits *float64 `json:"total_credits,omitempty"`

	// The balance of available credit at the start of the current month.
	StartingBalance *float64 `json:"starting_balance,omitempty"`

	// The amount of credit used during the current month.
	UsedCredits *float64 `json:"used_credits,omitempty"`

	// The balance of remaining credit in the subscription term.
	CurrentBalance *float64 `json:"current_balance,omitempty"`

	// A list of resources that used credit during the month.
	Resources []map[string]interface{} `json:"resources,omitempty"`
}

TermCredits : The subscription term that is active in the current month.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.