swagger

package

v0.4.11 Latest Latest Go to latest Published: Dec 22, 2023 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/getoctane/octane-go

Links

Open Source Insights

Documentation ¶

Overview ¶

* Octane API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type AccountingCustomer
type AccruedRevenue
type AccruedRevenueLineItem
type ActiveSubscription
type AddAddOnsToPricePlanInput
type AddFeaturesToPricePlanInput
type AddMeteredComponentsToPricePlanInput
type AddOn
type AddOnInputArgs
type AdminApiService
- func (a *AdminApiService) AdminApiKeyRollPost(ctx context.Context, body RollApiKeyArgs) (RollApiKeys, *http.Response, error)
type AllOfActiveSubscriptionDiscountsItems
type AllOfActiveSubscriptionPricePlan
type AllOfActiveSubscriptionTrialOverride
type AllOfCreateSubscriptionArgsDiscountOverride
type AllOfCustomerContactInfo
type AllOfCustomerPortalActiveSubscriptionBillingCycle
type AllOfCustomerPortalActiveSubscriptionSubscription
type AllOfCustomerPortalInvoiceStatus
type AllOfCustomerPortalMeterLabelsWithDisplayNameKey
type AllOfCustomerPortalPaymentMethodBankAccountInfo
type AllOfCustomerPortalPaymentMethodCardInfo
type AllOfCustomerPortalUsageCurrentCycleUsage
type AllOfCustomerPortalUsagePreviousCycleUsage
type AllOfCustomerPortalVendorContactInfo
type AllOfCycleUsageUsageByTimeItems
type AllOfDiscountAddOn
type AllOfDiscountMeteredComponent
type AllOfSubscriptionDiscountsItems
type AllOfSubscriptionPricePlan
type AllOfSubscriptionTrialOverride
type AllOfUpdateSubscriptionArgsDiscountOverride
type AllOfUpdateSubscriptionArgsTrialOverride
type AllOfUpdateSubscriptionInPlaceArgsDiscountOverride
type ApplyCouponInputArgs
type AvalaraApiService
- func (a *AvalaraApiService) IntegrationTaxAvalaraCompanyGet(ctx context.Context) ([]Company, *http.Response, error)
- func (a *AvalaraApiService) IntegrationTaxAvalaraCredentialsValidPost(ctx context.Context, body ValidateCredentialsArgs) (ValidateCredentialsResp, *http.Response, error)
- func (a *AvalaraApiService) IntegrationTaxAvalaraEntityUseCodeGet(ctx context.Context) ([]EntityUseCode, *http.Response, error)
- func (a *AvalaraApiService) IntegrationTaxAvalaraSettingsGet(ctx context.Context) (VendorAvalaraSettings, *http.Response, error)
- func (a *AvalaraApiService) IntegrationTaxAvalaraSettingsPost(ctx context.Context, body CreateVendorAvalaraSettingsArgs) (VendorAvalaraSettings, *http.Response, error)
- func (a *AvalaraApiService) IntegrationTaxAvalaraSettingsPut(ctx context.Context, body UpdateVendorAvalaraSettingsArgs) (VendorAvalaraSettings, *http.Response, error)
- func (a *AvalaraApiService) IntegrationTaxAvalaraTaxCodeGet(ctx context.Context) ([]TaxCode, *http.Response, error)
type BankAccountInfo
type BasicAuth
type BillingCycleDate
type BillingSettings
type BillingSettingsApiService
- func (a *BillingSettingsApiService) BillingSettingsDelete(ctx context.Context) (*http.Response, error)
- func (a *BillingSettingsApiService) BillingSettingsGet(ctx context.Context) (BillingSettings, *http.Response, error)
- func (a *BillingSettingsApiService) BillingSettingsPost(ctx context.Context, body CreateBillingSettingsInputArgs) (BillingSettings, *http.Response, error)
- func (a *BillingSettingsApiService) BillingSettingsPut(ctx context.Context, body UpdateBillingSettingsInputArgs) (BillingSettings, *http.Response, error)
type CardInfo
type Company
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type ContactInfo
type ContactInfoInputArgs
type Coupon
type CouponInputArgs
type CouponsApiService
- func (a *CouponsApiService) CouponsApplyCouponPost(ctx context.Context, body ApplyCouponInputArgs) (*http.Response, error)
- func (a *CouponsApiService) CouponsCouponNameDelete(ctx context.Context, couponName string) (*http.Response, error)
- func (a *CouponsApiService) CouponsCouponNameGet(ctx context.Context, couponName string) (Coupon, *http.Response, error)
- func (a *CouponsApiService) CouponsGet(ctx context.Context) ([]Coupon, *http.Response, error)
- func (a *CouponsApiService) CouponsPost(ctx context.Context, body CouponInputArgs) (Coupon, *http.Response, error)
type CreateBillingSettingsInputArgs
type CreateCreditGrantArgs
type CreateCreditTopOffPlanInputArgs
type CreateCustomerArgs
type CreatePricePlanArgs
type CreateRefundArgs
type CreateRetryArgs
type CreateSubscriptionArgs
type CreateVendorAvalaraSettingsArgs
type CreateWebhookArgs
type CreditGrant
type CreditLedger
type CreditTopOffPlan
type CreditsApiService
- func (a *CreditsApiService) CreditsGrantGet(ctx context.Context, body ListCreditGrantsArgs) (ListCreditGrants, *http.Response, error)
- func (a *CreditsApiService) CreditsGrantGrantUuidVoidPost(ctx context.Context, grantUuid string) (*http.Response, error)
- func (a *CreditsApiService) CreditsGrantPost(ctx context.Context, body CreateCreditGrantArgs) (CreditGrant, *http.Response, error)
- func (a *CreditsApiService) CreditsLedgerCustomerNameAsOfStrGet(ctx context.Context, asOfStr string, customerName string) ([]CreditLedger, *http.Response, error)
- func (a *CreditsApiService) CreditsLedgerCustomerNameGet(ctx context.Context, customerName string) ([]CreditLedger, *http.Response, error)
type Customer
type Customer1
type CustomerAvalaraSettings
type CustomerBillingSettingsInputArgs
type CustomerFeature
type CustomerLabelLimit
type CustomerMeasurementMapping
type CustomerMeasurementMappingInputArgs
type CustomerMetadata
type CustomerMetadataInput
type CustomerPaymentGatewayCredentialInputArgs
type CustomerPaymentMethodStatus
type CustomerPortalAccruedRevenue
type CustomerPortalAccruedRevenueLineItem
type CustomerPortalActiveSubscription
type CustomerPortalActiveSubscriptionInputArgs
type CustomerPortalApiService
- func (a *CustomerPortalApiService) EcpActiveSubscriptionGet(ctx context.Context) (CustomerPortalActiveSubscription, *http.Response, error)
- func (a *CustomerPortalApiService) EcpActiveSubscriptionPost(ctx context.Context, body CustomerPortalActiveSubscriptionInputArgs) (CustomerPortalSubscription, *http.Response, error)
- func (a *CustomerPortalApiService) EcpContactInfoGet(ctx context.Context) (ContactInfo, *http.Response, error)
- func (a *CustomerPortalApiService) EcpContactInfoPut(ctx context.Context, body ContactInfoInputArgs) (ContactInfo, *http.Response, error)
- func (a *CustomerPortalApiService) EcpCreditLedgerGet(ctx context.Context) ([]CreditLedger, *http.Response, error)
- func (a *CustomerPortalApiService) EcpCreditPurchasePost(ctx context.Context, body CustomerPortalCreditPurchase) (CreditGrant, *http.Response, error)
- func (a *CustomerPortalApiService) EcpCustomerPortalUrlPost(ctx context.Context, body CustomerPortalTokenInputArgs) (CustomerPortalUrl, *http.Response, error)
- func (a *CustomerPortalApiService) EcpDailyAccruedRevenueGet(ctx context.Context) ([]CustomerPortalDailyAccruedRevenue, *http.Response, error)
- func (a *CustomerPortalApiService) EcpFilteredUsagePost(ctx context.Context, body CustomerPortalMeterLabelFilter) (CustomerPortalUsage, *http.Response, error)
- func (a *CustomerPortalApiService) EcpInvoicesGet(ctx context.Context) ([]CustomerPortalInvoice, *http.Response, error)
- func (a *CustomerPortalApiService) EcpMetersGet(ctx context.Context) ([]CustomerPortalMeter, *http.Response, error)
- func (a *CustomerPortalApiService) EcpPaymentMethodGet(ctx context.Context) (CustomerPortalPaymentMethod, *http.Response, error)
- func (a *CustomerPortalApiService) EcpPaymentMethodStatusGet(ctx context.Context) (CustomerPaymentMethodStatus, *http.Response, error)
- func (a *CustomerPortalApiService) EcpPortalUrlGet(ctx context.Context) (CustomerPortalUrl, *http.Response, error)
- func (a *CustomerPortalApiService) EcpPricePlansGet(ctx context.Context) ([]PricePlan, *http.Response, error)
- func (a *CustomerPortalApiService) EcpSelfServeCustomizationGet(ctx context.Context) (SelfServeCustomization, *http.Response, error)
- func (a *CustomerPortalApiService) EcpSelfServeSettingsGet(ctx context.Context) (SelfServeSettings, *http.Response, error)
- func (a *CustomerPortalApiService) EcpSetupIntentPost(ctx context.Context) (CustomerPortalStripeCredential, *http.Response, error)
- func (a *CustomerPortalApiService) EcpSubscriptionDelete(ctx context.Context) (*http.Response, error)
- func (a *CustomerPortalApiService) EcpSubscriptionGet(ctx context.Context) (CustomerPortalSubscription, *http.Response, error)
- func (a *CustomerPortalApiService) EcpSubscriptionPost(ctx context.Context, body CustomerPortalSubscriptionInputArgs) (CustomerPortalSubscription, *http.Response, error)
- func (a *CustomerPortalApiService) EcpTokenPost(ctx context.Context, body CustomerPortalTokenInputArgs) (CustomerPortalToken, *http.Response, error)
- func (a *CustomerPortalApiService) EcpTotalAccruedRevenueGet(ctx context.Context) (CustomerPortalAccruedRevenue, *http.Response, error)
- func (a *CustomerPortalApiService) EcpUsageGet(ctx context.Context) ([]CustomerPortalUsage, *http.Response, error)
- func (a *CustomerPortalApiService) EcpVendorGet(ctx context.Context) (CustomerPortalVendor, *http.Response, error)
type CustomerPortalCreditPurchase
type CustomerPortalDailyAccruedRevenue
type CustomerPortalInvoice
type CustomerPortalInvoiceStatus
type CustomerPortalLabelDisplayName
type CustomerPortalLabelFilter
type CustomerPortalMeter
type CustomerPortalMeterLabelFilter
type CustomerPortalMeterLabels
type CustomerPortalMeterLabelsWithDisplayName
type CustomerPortalPaymentMethod
type CustomerPortalSettings
type CustomerPortalSettingsApiService
- func (a *CustomerPortalSettingsApiService) CustomerPortalSettingsGet(ctx context.Context) (CustomerPortalSettings, *http.Response, error)
- func (a *CustomerPortalSettingsApiService) CustomerPortalSettingsPost(ctx context.Context, body UpdateCustomerPortalSettingsInputArgs) (CustomerPortalSettings, *http.Response, error)
type CustomerPortalStripeCredential
type CustomerPortalSubscription
type CustomerPortalSubscriptionInputArgs
type CustomerPortalToken
type CustomerPortalTokenInputArgs
type CustomerPortalUrl
type CustomerPortalUsage
type CustomerPortalVendor
type CustomerStatus
type CustomerTag
type CustomerUsage
type CustomersApiCustomersCustomerNameInvoicesGetOpts
type CustomersApiCustomersCustomerNameRevenueGetOpts
type CustomersApiCustomersCustomerNameUsageGetOpts
type CustomersApiService
- func (a *CustomersApiService) CustomersCustomerNameAccountingDelete(ctx context.Context, customerName string) (*http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameAccountingGenerationPost(ctx context.Context, customerName string) (*http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameAccountingGet(ctx context.Context, customerName string) (AccountingCustomer, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameAccountingPost(ctx context.Context, body AccountingCustomer, customerName string) (*http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameAccruedRevenueGet(ctx context.Context, customerName string) (RevenueBreakdown, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameActiveSubscriptionGet(ctx context.Context, customerName string) (ActiveSubscription, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameBillingSettingsDelete(ctx context.Context, customerName string) (*http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameBillingSettingsGet(ctx context.Context, customerName string) (BillingSettings, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameBillingSettingsPost(ctx context.Context, body CustomerBillingSettingsInputArgs, ...) (BillingSettings, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameBillingSettingsPut(ctx context.Context, body CustomerBillingSettingsInputArgs, ...) (BillingSettings, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameCreditTopOffPlanDelete(ctx context.Context, customerName string) (*http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameCreditTopOffPlanGet(ctx context.Context, customerName string) (CreditTopOffPlan, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameCreditTopOffPlanPost(ctx context.Context, body CreateCreditTopOffPlanInputArgs, customerName string) (CreditTopOffPlan, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameCreditTopOffPlanPut(ctx context.Context, body UpdateCreditTopOffPlanInputArgs, customerName string) (CreditTopOffPlan, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameDailyAccruedRevenueGet(ctx context.Context, customerName string) ([]DailyAccruedRevenue, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameDelete(ctx context.Context, customerName string) (*http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameDiscountsDelete(ctx context.Context, body DeleteDiscountInputArgs, customerName string) (*http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameDiscountsPost(ctx context.Context, body []DiscountInputArgs, customerName string) (*http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameFeaturesFeatureNameGet(ctx context.Context, customerName string, featureName string) (CustomerFeature, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameGet(ctx context.Context, customerName string) (Customer, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameIntegrationTaxAvalaraAddressValidGet(ctx context.Context, customerName string) (ValidateAddressResp, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameIntegrationTaxAvalaraSettingsGet(ctx context.Context, customerName string) (CustomerAvalaraSettings, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameIntegrationTaxAvalaraSettingsPut(ctx context.Context, body UpdateCustomerAvalaraSettingsArgs, ...) (CustomerAvalaraSettings, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameInvoiceInvoiceIdTokenGet(ctx context.Context, invoiceId int32, token string, customerName string) (ModelError, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameInvoicesGet(ctx context.Context, customerName string, ...) ([]Invoice, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameMappingsGet(ctx context.Context, customerName string) ([]CustomerMeasurementMapping, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameMappingsPost(ctx context.Context, body CustomerMeasurementMappingInputArgs, ...) (CustomerMeasurementMapping, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameMetadataGet(ctx context.Context, customerName string) ([]CustomerMetadata, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameMetadataPost(ctx context.Context, body []CustomerMetadataInput, customerName string) (*http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNamePaymentGatewayCredentialsGet(ctx context.Context, customerName string) (PaymentGatewayCredential, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNamePaymentGatewayCredentialsPost(ctx context.Context, body CustomerPaymentGatewayCredentialInputArgs, ...) (PaymentGatewayCredential, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNamePaymentMethodStatusGet(ctx context.Context, customerName string) (CustomerPaymentMethodStatus, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNamePut(ctx context.Context, body UpdateCustomerArgs, customerName string) (Customer, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameRevenueGet(ctx context.Context, customerName string, ...) (RevenueResponse, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameSampleInvoiceAsOfStrTokenGet(ctx context.Context, asOfStr string, token string, customerName string) (ModelError, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameSampleInvoiceTokenGet(ctx context.Context, customerName string, token string) (ModelError, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameScheduledSubscriptionsGet(ctx context.Context, customerName string) ([]Subscription, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameStatusGet(ctx context.Context, customerName string) (CustomerStatus, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameSubscriptionAddOnsPost(ctx context.Context, body []SubscriptionAddOnItem, customerName string) (*http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameSubscriptionDelete(ctx context.Context, body DeleteSubscriptionArgs, customerName string) (*http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameSubscriptionPut(ctx context.Context, body UpdateSubscriptionArgs, customerName string) (Subscription, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameSubscriptionUpdateInPlacePut(ctx context.Context, body UpdateSubscriptionInPlaceArgs, customerName string) (Subscription, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameSubscriptionsGet(ctx context.Context, customerName string) ([]Subscription, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameSubscriptionsPost(ctx context.Context, body CreateSubscriptionArgs, customerName string) (Subscription, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameTotalAccruedRevenueGet(ctx context.Context, customerName string) (AccruedRevenue, *http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameUsageAcrossMetersTokenGet(ctx context.Context, token string, customerName string, startTime time.Time, ...) (*http.Response, error)
- func (a *CustomersApiService) CustomersCustomerNameUsageGet(ctx context.Context, customerName string, ...) (CustomerUsage, *http.Response, error)
- func (a *CustomersApiService) CustomersGet(ctx context.Context) ([]Customer, *http.Response, error)
- func (a *CustomersApiService) CustomersPost(ctx context.Context, body CreateCustomerArgs) (Customer, *http.Response, error)
type CycleUsage
type DailyAccruedRevenue
type DailyUsage
type DeleteDiscountInputArgs
type DeleteSubscriptionArgs
type Discount
type DiscountInputArgs
type EntityUseCode
type Feature
type FeatureInputArgs
type FeaturesApiService
- func (a *FeaturesApiService) FeaturesGet(ctx context.Context) ([]Feature, *http.Response, error)
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type Invoice
type InvoicesApiInvoicesGetOpts
type InvoicesApiService
- func (a *InvoicesApiService) InvoicesGet(ctx context.Context, localVarOptionals *InvoicesApiInvoicesGetOpts) (PastInvoices, *http.Response, error)
- func (a *InvoicesApiService) InvoicesInvoiceUuidDelete(ctx context.Context, invoiceUuid string) (*http.Response, error)
- func (a *InvoicesApiService) InvoicesInvoiceUuidGet(ctx context.Context, invoiceUuid string) (Invoice, *http.Response, error)
- func (a *InvoicesApiService) InvoicesInvoiceUuidRetriesPost(ctx context.Context, body CreateRetryArgs, invoiceUuid string) (Retry, *http.Response, error)
- func (a *InvoicesApiService) InvoicesInvoiceUuidStatusPost(ctx context.Context, invoiceUuid string) (*http.Response, error)
- func (a *InvoicesApiService) InvoicesInvoiceUuidTokenPdfGet(ctx context.Context, invoiceUuidToken string) (ModelError, *http.Response, error)
type Limit
type LimitInputArgs
type LineItems
type ListCreditGrants
type ListCreditGrantsArgs
type ListPricePlans
type LiveMeasurementsApiService
- func (a *LiveMeasurementsApiService) LiveMeasurementsGet(ctx context.Context) (*http.Response, error)
type Measurement
type MeasurementsApiService
- func (a *MeasurementsApiService) MeasurementsMultiPost(ctx context.Context, body []Measurement) ([]Measurement, *http.Response, error)
- func (a *MeasurementsApiService) MeasurementsPost(ctx context.Context, body Measurement) (Measurement, *http.Response, error)
type Meter
type MeterInputArgs
type MeteredComponent
type MeteredComponentInputArgs
type MeteredComponentLabelLimit
type MeteredComponentLabelLimitInputArgs
type MetersApiService
- func (a *MetersApiService) MetersGet(ctx context.Context) ([]Meter, *http.Response, error)
- func (a *MetersApiService) MetersMeterNameArchivePost(ctx context.Context, meterName string) (*http.Response, error)
- func (a *MetersApiService) MetersMeterNameDelete(ctx context.Context, meterName string) (*http.Response, error)
- func (a *MetersApiService) MetersMeterNameGet(ctx context.Context, meterName string) (Meter, *http.Response, error)
- func (a *MetersApiService) MetersMeterNamePut(ctx context.Context, body UpdateMeterArgs, meterName string) (Meter, *http.Response, error)
- func (a *MetersApiService) MetersPost(ctx context.Context, body MeterInputArgs) (Meter, *http.Response, error)
type ModelError
type PastInvoice
type PastInvoices
type PaymentGatewayCredential
type PaymentGatewayCredentialApiService
- func (a *PaymentGatewayCredentialApiService) PaymentGatewayCredentialsGet(ctx context.Context) (PaymentGatewayCredential, *http.Response, error)
- func (a *PaymentGatewayCredentialApiService) PaymentGatewayCredentialsPost(ctx context.Context, body PaymentGatewayCredentialInputArgs) (PaymentGatewayCredential, *http.Response, error)
type PaymentGatewayCredentialInputArgs
type PriceInputArgs
type PricePlan
type PricePlan1
type PricePlanTag
type PricePlansApiPricePlansPaginateGetOpts
type PricePlansApiService
- func (a *PricePlansApiService) PricePlansGet(ctx context.Context) ([]PricePlan, *http.Response, error)
- func (a *PricePlansApiService) PricePlansMeteredComponentsUuidUpdateLimitsPost(ctx context.Context, body UpdateMeteredComponentLimitsInput, uuid string) (MeteredComponent, *http.Response, error)
- func (a *PricePlansApiService) PricePlansPaginateGet(ctx context.Context, localVarOptionals *PricePlansApiPricePlansPaginateGetOpts) (ListPricePlans, *http.Response, error)
- func (a *PricePlansApiService) PricePlansPost(ctx context.Context, body CreatePricePlanArgs) (PricePlan, *http.Response, error)
- func (a *PricePlansApiService) PricePlansPricePlanNameArchivePost(ctx context.Context, pricePlanName string) (*http.Response, error)
- func (a *PricePlansApiService) PricePlansPricePlanNameDelete(ctx context.Context, pricePlanName string) (*http.Response, error)
- func (a *PricePlansApiService) PricePlansPricePlanNameGet(ctx context.Context, pricePlanName string) (PricePlan, *http.Response, error)
- func (a *PricePlansApiService) PricePlansPricePlanNamePut(ctx context.Context, body UpdatePricePlanArgs, pricePlanName string) (PricePlan, *http.Response, error)
- func (a *PricePlansApiService) PricePlansPricePlanNameTagGet(ctx context.Context, pricePlanName string, tag string) (PricePlan, *http.Response, error)
- func (a *PricePlansApiService) PricePlansSelfServeGet(ctx context.Context) ([]PricePlan, *http.Response, error)
- func (a *PricePlansApiService) PricePlansSelfServePost(ctx context.Context, body SelfServePricePlansInputArgs) (*http.Response, error)
- func (a *PricePlansApiService) PricePlansUpdateInPlacePricePlanNamePost(ctx context.Context, body UpdatePricePlanInPlaceArgs, pricePlanName string) (PricePlan, *http.Response, error)
- func (a *PricePlansApiService) PricePlansUpdateInPlacePricePlanNameTagPost(ctx context.Context, body UpdatePricePlanInPlaceArgs, pricePlanName string, ...) (PricePlan, *http.Response, error)
- func (a *PricePlansApiService) PricePlansUuidAddAddOnsPost(ctx context.Context, body AddAddOnsToPricePlanInput, uuid string) (PricePlan, *http.Response, error)
- func (a *PricePlansApiService) PricePlansUuidAddFeaturesPost(ctx context.Context, body AddFeaturesToPricePlanInput, uuid string) (PricePlan, *http.Response, error)
- func (a *PricePlansApiService) PricePlansUuidAddMeteredComponentsPost(ctx context.Context, body AddMeteredComponentsToPricePlanInput, uuid string) (PricePlan, *http.Response, error)
- func (a *PricePlansApiService) PricePlansUuidRemoveFeaturesPost(ctx context.Context, body RemoveFeaturesFromPricePlanInput, uuid string) (PricePlan, *http.Response, error)
type PriceScheme
type PriceSchemeInputArgs
type PriceTier
type Refund
type RefundApiService
- func (a *RefundApiService) RefundPost(ctx context.Context, body CreateRefundArgs) (Refund, *http.Response, error)
type RemoveFeaturesFromPricePlanInput
type Retry
type RevenueBreakdown
type RevenueRecognitionApiService
- func (a *RevenueRecognitionApiService) RecognizedRevenuePost(ctx context.Context, body RevenueRecognitionInput) ([]RevenueRecognitionEntry, *http.Response, error)
type RevenueRecognitionEntry
type RevenueRecognitionInput
type RevenueResponse
type RollApiKeyArgs
type RollApiKeys
type SelfServeCustomization
type SelfServePricePlansInputArgs
type SelfServeSettings
type SelfServeSettingsApiService
- func (a *SelfServeSettingsApiService) SelfServeSettingsCustomizationGet(ctx context.Context) (SelfServeCustomization, *http.Response, error)
- func (a *SelfServeSettingsApiService) SelfServeSettingsCustomizationPost(ctx context.Context, body SelfServeCustomization) (SelfServeCustomization, *http.Response, error)
- func (a *SelfServeSettingsApiService) SelfServeSettingsCustomizationPut(ctx context.Context, body SelfServeCustomization) (SelfServeCustomization, *http.Response, error)
- func (a *SelfServeSettingsApiService) SelfServeSettingsGet(ctx context.Context) (SelfServeSettings, *http.Response, error)
- func (a *SelfServeSettingsApiService) SelfServeSettingsPost(ctx context.Context, body UpdateSelfServeSettingsArgs) (SelfServeSettings, *http.Response, error)
- func (a *SelfServeSettingsApiService) SelfServeSettingsPut(ctx context.Context, body UpdateSelfServeSettingsArgs) (SelfServeSettings, *http.Response, error)
type Subscription
type SubscriptionAddOnInput
type SubscriptionAddOnItem
type TaxCode
type Trial
type TrialInputArgs
type UpdateBillingSettingsInputArgs
type UpdateCreditTopOffPlanInputArgs
type UpdateCustomerArgs
type UpdateCustomerAvalaraSettingsArgs
type UpdateCustomerPortalSettingsInputArgs
type UpdateMeterArgs
type UpdateMeteredComponentLimitsInput
type UpdatePricePlanArgs
type UpdatePricePlanInPlaceArgs
type UpdateSelfServeSettingsArgs
type UpdateSubscriptionArgs
type UpdateSubscriptionInPlaceArgs
type UpdateVendorAvalaraSettingsArgs
type ValidateAddressResp
type ValidateCredentialsArgs
type ValidateCredentialsResp
type VendorAvalaraSettings
type Webhook
type WebhooksApiService
- func (a *WebhooksApiService) WebhooksGet(ctx context.Context) ([]Webhook, *http.Response, error)
- func (a *WebhooksApiService) WebhooksPost(ctx context.Context, body CreateWebhookArgs) (Webhook, *http.Response, error)
- func (a *WebhooksApiService) WebhooksUuidDelete(ctx context.Context, uuid string) (*http.Response, error)
- func (a *WebhooksApiService) WebhooksUuidGet(ctx context.Context, uuid string) (Webhook, *http.Response, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶

type APIClient struct {
	AdminApi *AdminApiService

	AvalaraApi *AvalaraApiService

	BillingSettingsApi *BillingSettingsApiService

	CouponsApi *CouponsApiService

	CreditsApi *CreditsApiService

	CustomerPortalApi *CustomerPortalApiService

	CustomerPortalSettingsApi *CustomerPortalSettingsApiService

	CustomersApi *CustomersApiService

	FeaturesApi *FeaturesApiService

	InvoicesApi *InvoicesApiService

	LiveMeasurementsApi *LiveMeasurementsApiService

	MeasurementsApi *MeasurementsApiService

	MetersApi *MetersApiService

	PaymentGatewayCredentialApi *PaymentGatewayCredentialApiService

	PricePlansApi *PricePlansApiService

	RefundApi *RefundApiService

	RevenueRecognitionApi *RevenueRecognitionApiService

	SelfServeSettingsApi *SelfServeSettingsApiService

	WebhooksApi *WebhooksApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Octane API API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AccountingCustomer ¶ added in v0.4.3

type AccountingCustomer struct {
	// ID of the customer in the target accounting platform
	AccountingCustomerId string `json:"accounting_customer_id,omitempty"`
}

type AccruedRevenue ¶ added in v0.4.9

type AccruedRevenue struct {
	// The cycle start of the billing cycle for which the accrued revenue is computed
	StartTime time.Time                `json:"start_time,omitempty"`
	LineItems []AccruedRevenueLineItem `json:"line_items,omitempty"`
	// The end time within the billing cycle for which this accrued revenue is computed
	EndTime time.Time `json:"end_time,omitempty"`
	// Total accrued revenue for the period in cents
	TotalAccruedRevenue int32 `json:"total_accrued_revenue,omitempty"`
}

type AccruedRevenueLineItem ¶ added in v0.4.9

type AccruedRevenueLineItem struct {
	// Any extra metadata associated with the item.          Will include the labels for metered components and metered component minimum charges when applicable
	Metadata map[string]string `json:"metadata,omitempty"`
	// Accrued revenue for this line item in cents
	Revenue int32 `json:"revenue,omitempty"`
	// Type of item. One of: METERED_COMPONENT, BASE_PRICE, DISCOUNT, ADD_ON, MINIMUM_CHARGE, METERED_COMPONENT_MINIMUM_CHARGE
	ItemType string `json:"item_type,omitempty"`
	//          The identifier of the item being returned.          For metered component will be meter name,          for add_ons will be feature name,          for base price will be price plan name,         for minimum charge will be price plan name,         for metered component minimum charge will be meter name
	ItemIdentifier string `json:"item_identifier,omitempty"`
}

type ActiveSubscription ¶ added in v0.2.0

type ActiveSubscription struct {
	Uuid string `json:"uuid"`
	// Unique name identifier of a customer
	CustomerName string `json:"customer_name"`
	// Unique name indentifier of a price plan
	PricePlanName string `json:"price_plan_name"`
	// Price plan associated with this subscription.
	PricePlan *AllOfActiveSubscriptionPricePlan       `json:"price_plan,omitempty"`
	Discounts []AllOfActiveSubscriptionDiscountsItems `json:"discounts,omitempty"`
	AddOns    []SubscriptionAddOnItem                 `json:"add_ons,omitempty"`
	// Optional trial override for the associated subscription.
	TrialOverride    *AllOfActiveSubscriptionTrialOverride `json:"trial_override,omitempty"`
	FeaturesOverride []Feature                             `json:"features_override,omitempty"`
	LimitsOverride   []Limit                               `json:"limits_override,omitempty"`
	// ISO-8601 formatted timestamp that defines when the subscription should take effect. If this field is omitted, the subscription is effective upon creation.
	EffectiveAt time.Time `json:"effective_at,omitempty"`
	// ISO-8601 formatted timestamp that defines when the subscription will expire.
	ExpiredAt time.Time `json:"expired_at,omitempty"`
	// Align billing cycles to a calendar unit if true. For example if the period is month, cycles will end on the first of every month.
	AlignToCalendar bool `json:"align_to_calendar,omitempty"`
	// Optional base price override for the associated subscription.
	BasePriceOverride    float64           `json:"base_price_override,omitempty"`
	CurrentBillingCycle  *BillingCycleDate `json:"current_billing_cycle,omitempty"`
	TotalFixedPrice      int32             `json:"total_fixed_price,omitempty"`
	DiscountedFixedPrice int32             `json:"discounted_fixed_price,omitempty"`
}

type AddAddOnsToPricePlanInput ¶ added in v0.4.9

type AddAddOnsToPricePlanInput struct {
	// List of add ons to add
	AddOns []AddOnInputArgs `json:"add_ons"`
}

type AddFeaturesToPricePlanInput ¶ added in v0.4.9

type AddFeaturesToPricePlanInput struct {
	// List of new features to add
	Features []FeatureInputArgs `json:"features,omitempty"`
	// List of new limits to add
	Limits []LimitInputArgs `json:"limits,omitempty"`
}

type AddMeteredComponentsToPricePlanInput ¶ added in v0.4.9

type AddMeteredComponentsToPricePlanInput struct {
	// List of metered components to add
	MeteredComponents []MeteredComponentInputArgs `json:"metered_components"`
}

type AddOn ¶ added in v0.4.0

type AddOn struct {
	Feature *Feature `json:"feature"`
	// Price of the add on
	Price float64 `json:"price"`
	// If true, customer is just charged once in the first billing cycle.
	SingleUse       bool `json:"single_use"`
	QuantityEnabled bool `json:"quantity_enabled"`
	// If true, immediately invoice the customer for this add on.
	ImmediatelyCharge bool `json:"immediately_charge,omitempty"`
	// The maximum number of add-ons that an end-customer can apply to their subscription.
	Limit int32 `json:"limit,omitempty"`
}

type AddOnInputArgs ¶

type AddOnInputArgs struct {
	// Whether this add on can only be used & charged once.
	SingleUse       bool              `json:"single_use,omitempty"`
	Limit           int32             `json:"limit,omitempty"`
	Feature         *FeatureInputArgs `json:"feature"`
	QuantityEnabled bool              `json:"quantity_enabled,omitempty"`
	// This field indicates whether or not we should cut an invoice immediately upon attaching this add on to a price plan.
	ImmediatelyCharge bool  `json:"immediately_charge,omitempty"`
	Price             int32 `json:"price,omitempty"`
}

type AdminApiService ¶ added in v0.4.9

type AdminApiService service

func (*AdminApiService) AdminApiKeyRollPost ¶ added in v0.4.9

func (a *AdminApiService) AdminApiKeyRollPost(ctx context.Context, body RollApiKeyArgs) (RollApiKeys, *http.Response, error)

AdminApiService Roll the API Key for a vendor Expires the specified API key and creates a new one.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return RollApiKeys

type AllOfActiveSubscriptionDiscountsItems ¶ added in v0.4.9

type AllOfActiveSubscriptionDiscountsItems struct {
	DiscountType string  `json:"discount_type,omitempty"`
	Amount       float64 `json:"amount,omitempty"`
	// The date when the discount is applied from.
	StartDate time.Time `json:"start_date,omitempty"`
	// The date when the discount ends.
	EndDate time.Time `json:"end_date,omitempty"`
	// Offset in number of billing cycles for when this discount will apply. For example, if set to 1, the discount will apply from the start of the next billing cycle.
	BillingCycleStartOffset int32 `json:"billing_cycle_start_offset,omitempty"`
	// Duration of this discount in number of billing cycles.
	BillingCycleDuration int32 `json:"billing_cycle_duration,omitempty"`
	// The id of coupon associated with this discount, none if discount does not originate from coupon
	CouponId int32 `json:"coupon_id,omitempty"`
	// External facing unique identifier of a price plan
	ExternalUuid string `json:"external_uuid,omitempty"`
	// The scope that this discount covers. One of 'INVOICE_TOTAL', 'ADD_ON', 'METERED_COMPONENT'.
	Scope string `json:"scope"`
	// Add-on this discount covers if scope is ADD_ON.
	AddOn AddOn `json:"add_on,omitempty"`
	// Metered Component this discount covers if scope is METERED_COMPONENT.
	MeteredComponent MeteredComponent `json:"metered_component,omitempty"`
	// Dictionary of labels (key: value) to which the discount applies if scope is METERED_COMPONENT.
	Labels map[string]string `json:"labels,omitempty"`
}

List of discounts associated with this subscription.

type AllOfActiveSubscriptionPricePlan ¶ added in v0.2.0

type AllOfActiveSubscriptionPricePlan struct {
	// External facing unique identifier of a price plan
	ExternalUuid string `json:"external_uuid,omitempty"`
	// Unique name indentifier of a price plan
	Name string `json:"name"`
	// UI-friendly name used for data display. Defaults to `name`.
	DisplayName string `json:"display_name,omitempty"`
	Description string `json:"description,omitempty"`
	// Lowest denomination of currency. e.g. USD is represented as cents.
	BasePrice          float64 `json:"base_price,omitempty"`
	BasePriceFrequency int32   `json:"base_price_frequency,omitempty"`
	// Custom invoice description for the base price line item.
	BasePriceDescription string `json:"base_price_description,omitempty"`
	// Time period that defines the length of a price plan cycle. One of `day`, `week`, `month`, `quarter`, or `year`.
	Period            string             `json:"period"`
	MeteredComponents []MeteredComponent `json:"metered_components"`
	// Minimum amount to charge every 'period'
	MinimumCharge int32 `json:"minimum_charge,omitempty"`
	// The frequency (as a an integer multiple of the period) at which to charge the minimum charge.
	MinimumChargeFrequency int32          `json:"minimum_charge_frequency,omitempty"`
	Features               []Feature      `json:"features,omitempty"`
	AddOns                 []AddOn        `json:"add_ons,omitempty"`
	Limits                 []Limit        `json:"limits,omitempty"`
	Tags                   []PricePlanTag `json:"tags,omitempty"`
	Trial                  *Trial         `json:"trial,omitempty"`
	// ISO-8601 formatted creation timestamp of price plan version
	CreatedAt time.Time `json:"created_at,omitempty"`
}

Price plan associated with this subscription.

type AllOfActiveSubscriptionTrialOverride ¶ added in v0.2.0

type AllOfActiveSubscriptionTrialOverride struct {
	TimeLength   float64 `json:"time_length,omitempty"`
	TimeUnitName string  `json:"time_unit_name,omitempty"`
	Credit       int32   `json:"credit,omitempty"`
}

Optional trial override for the associated subscription.

type AllOfCreateSubscriptionArgsDiscountOverride ¶ added in v0.4.9

type AllOfCreateSubscriptionArgsDiscountOverride struct {
	DiscountType string `json:"discount_type,omitempty"`
	// For ADD_ON scoped discounts: the name of the add on that the discount covers.
	AddOnName string `json:"add_on_name,omitempty"`
	// Length, in billing cycles, that this discount will be active.
	BillingCycleDuration int32 `json:"billing_cycle_duration,omitempty"`
	// For METERED_COMPONENT scoped discounts: Dictionary of labels (key: value) that the discount covers. The entire set of labels must be provided.
	Labels map[string]string `json:"labels,omitempty"`
	// The scope that this discount covers. One of 'INVOICE_TOTAL', 'ADD_ON', 'METERED_COMPONENT'.
	Scope  string  `json:"scope,omitempty"`
	Amount float64 `json:"amount,omitempty"`
	// Offset, in number of billing cycles, for when this discount will apply. If set to 0, the discount will start applying from the current billing cycle. If set to 1, the discount will start applying from the next billing cycle, etc. For scheduled subscriptions, the offset starts from the initial billing cycle.
	BillingCycleStartOffset int32 `json:"billing_cycle_start_offset,omitempty"`
	// For METERED_COMPONENT scoped discounts: the UUID of the metered component that the discount covers.
	MeteredComponentUuid string `json:"metered_component_uuid,omitempty"`
}

DEPRECATED - use discounts field

type AllOfCustomerContactInfo ¶

type AllOfCustomerContactInfo struct {
	AddressLine1    string `json:"address_line_1,omitempty"`
	AddressLine2    string `json:"address_line_2,omitempty"`
	City            string `json:"city,omitempty"`
	State           string `json:"state,omitempty"`
	Country         string `json:"country,omitempty"`
	Zipcode         string `json:"zipcode,omitempty"`
	Url             string `json:"url,omitempty"`
	LogoUrl         string `json:"logo_url,omitempty"`
	Email           string `json:"email,omitempty"`
	SecondaryEmails string `json:"secondary_emails,omitempty"`
	Phone           string `json:"phone,omitempty"`
	LegalName       string `json:"legal_name,omitempty"`
	VatId           string `json:"vat_id,omitempty"`
}

type AllOfCustomerPortalActiveSubscriptionBillingCycle ¶ added in v0.4.9

type AllOfCustomerPortalActiveSubscriptionBillingCycle struct {
	CycleStart time.Time `json:"cycle_start"`
	CycleEnd   time.Time `json:"cycle_end"`
}

Customer's current active biling cycle.

type AllOfCustomerPortalActiveSubscriptionSubscription ¶ added in v0.4.9

type AllOfCustomerPortalActiveSubscriptionSubscription struct {
	Uuid string `json:"uuid"`
	// Unique name identifier of a customer
	CustomerName string `json:"customer_name"`
	// Unique name indentifier of a price plan
	PricePlanName string `json:"price_plan_name"`
	// Price plan associated with this subscription.
	PricePlan PricePlan `json:"price_plan,omitempty"`
	// Align billing cycles to a calendar unit if true. For example if the period is month, cycles will end on the first of every month.
	AlignToCalendar bool       `json:"align_to_calendar,omitempty"`
	Discounts       []Discount `json:"discounts,omitempty"`
	AddOns          []AddOn    `json:"add_ons,omitempty"`
	// Optional trial override for the associated subscription.
	TrialOverride Trial `json:"trial_override,omitempty"`
	// Optional base price override for the associated subscription.
	BasePriceOverride float64   `json:"base_price_override,omitempty"`
	FeaturesOverride  []Feature `json:"features_override,omitempty"`
	LimitsOverride    []Limit   `json:"limits_override,omitempty"`
	// ISO-8601 formatted timestamp that defines when the subscription should take effect. If this field is omitted, the subscription is effective upon creation.
	EffectiveAt time.Time `json:"effective_at,omitempty"`
	// ISO-8601 formatted timestamp that defines when the subscription will expire.
	ExpiredAt time.Time `json:"expired_at,omitempty"`
}

Customer's current active subscription. Includes the price plan and overrides they are subscribed to.

type AllOfCustomerPortalInvoiceStatus ¶ added in v0.4.9

type AllOfCustomerPortalInvoiceStatus struct {
	// The current processing state for this invoice.
	Status       string `json:"status,omitempty"`
	UpdateSource string `json:"update_source,omitempty"`
	// The timestamp that the action will be performed at.
	PendingActionTime time.Time `json:"pending_action_time,omitempty"`
	// The current upcoming action associated with this invoice status, if any.
	Action string `json:"action,omitempty"`
	Error_ string `json:"error,omitempty"`
	// Creation time of this invoice status.
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Time the invoice status was last updated.
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

Information related to the current status of this invoice.

type AllOfCustomerPortalMeterLabelsWithDisplayNameKey ¶ added in v0.4.9

type AllOfCustomerPortalMeterLabelsWithDisplayNameKey struct {
	DisplayName string `json:"display_name,omitempty"`
	// The raw value of the label data
	Name string `json:"name,omitempty"`
}

Primary label key and prettified version of the key

type AllOfCustomerPortalPaymentMethodBankAccountInfo ¶ added in v0.4.9

type AllOfCustomerPortalPaymentMethodBankAccountInfo struct {
	// Name of the bank
	BankName string `json:"bank_name,omitempty"`
	// Country the bank account is in.
	Country string `json:"country,omitempty"`
	// Bank account type. E.g. Savings/Checking
	AccountType string `json:"account_type,omitempty"`
	// Last 4 digits of the bank account number.
	Last4      string `json:"last4,omitempty"`
	ExternalId string `json:"external_id,omitempty"`
	// Routing number for the bank accopunt
	RoutingNumber int32 `json:"routing_number,omitempty"`
}

Info about the customer's US bank account, if that is their payment method.

type AllOfCustomerPortalPaymentMethodCardInfo ¶ added in v0.4.9

type AllOfCustomerPortalPaymentMethodCardInfo struct {
	// Country of the card
	Country string `json:"country,omitempty"`
	// Brand of card. E.g. Amex, Visa, etc.
	Brand string `json:"brand,omitempty"`
	// Last 4 digits of the card.
	Last4      string `json:"last4,omitempty"`
	ExternalId string `json:"external_id,omitempty"`
	// Year the card expires
	ExpYear int32 `json:"exp_year,omitempty"`
	// Month the card expires
	ExpMonth int32 `json:"exp_month,omitempty"`
}

Info about the customer's card, if that is their payment method.

type AllOfCustomerPortalUsageCurrentCycleUsage ¶ added in v0.4.9

type AllOfCustomerPortalUsageCurrentCycleUsage struct {
	UsageByTime []CycleUsage `json:"usage_by_time,omitempty"`
	// Total usage in the cycle.
	TotalUsage int32 `json:"total_usage,omitempty"`
	// The start of the billing cycle in UTC.
	CycleStart time.Time `json:"cycle_start,omitempty"`
	// The end of the billing cycle in UTC.
	CycleEnd time.Time `json:"cycle_end,omitempty"`
}

Daily usage across the current billing cycle.

type AllOfCustomerPortalUsagePreviousCycleUsage ¶ added in v0.4.9

type AllOfCustomerPortalUsagePreviousCycleUsage struct {
	UsageByTime []CycleUsage `json:"usage_by_time,omitempty"`
	// Total usage in the cycle.
	TotalUsage int32 `json:"total_usage,omitempty"`
	// The start of the billing cycle in UTC.
	CycleStart time.Time `json:"cycle_start,omitempty"`
	// The end of the billing cycle in UTC.
	CycleEnd time.Time `json:"cycle_end,omitempty"`
}

Daily usage across the previous billing cycle.

type AllOfCustomerPortalVendorContactInfo ¶ added in v0.4.9

type AllOfCustomerPortalVendorContactInfo struct {
	AddressLine1    string `json:"address_line_1,omitempty"`
	AddressLine2    string `json:"address_line_2,omitempty"`
	City            string `json:"city,omitempty"`
	State           string `json:"state,omitempty"`
	Country         string `json:"country,omitempty"`
	Zipcode         string `json:"zipcode,omitempty"`
	Url             string `json:"url,omitempty"`
	LogoUrl         string `json:"logo_url,omitempty"`
	Email           string `json:"email,omitempty"`
	SecondaryEmails string `json:"secondary_emails,omitempty"`
	Phone           string `json:"phone,omitempty"`
	LegalName       string `json:"legal_name,omitempty"`
	VatId           string `json:"vat_id,omitempty"`
}

Full contact info for the Vendor

type AllOfCycleUsageUsageByTimeItems ¶ added in v0.4.9

type AllOfCycleUsageUsageByTimeItems struct {
	// Total usage during this window.
	Usage int32 `json:"usage,omitempty"`
	// Label value. Only present if label_group_by is provided.
	LabelValue string `json:"label_value,omitempty"`
	// Start of the 24 hour time window in UTC.
	Time time.Time `json:"time,omitempty"`
	// Label key. Only present if label_group_by is provided.
	LabelKey string `json:"label_key,omitempty"`
}

Usage by day.

type AllOfDiscountAddOn ¶ added in v0.4.9

type AllOfDiscountAddOn struct {
	Feature *Feature `json:"feature"`
	// Price of the add on
	Price float64 `json:"price"`
	// If true, customer is just charged once in the first billing cycle.
	SingleUse       bool `json:"single_use"`
	QuantityEnabled bool `json:"quantity_enabled"`
	// If true, immediately invoice the customer for this add on.
	ImmediatelyCharge bool `json:"immediately_charge,omitempty"`
	// The maximum number of add-ons that an end-customer can apply to their subscription.
	Limit int32 `json:"limit,omitempty"`
}

Add-on this discount covers if scope is ADD_ON.

type AllOfDiscountMeteredComponent ¶ added in v0.4.9

type AllOfDiscountMeteredComponent struct {
	MeterName        string       `json:"meter_name"`
	MeterDisplayName string       `json:"meter_display_name"`
	PriceScheme      *PriceScheme `json:"price_scheme"`
	// Limit on the usage for the meter.
	Limit       float64                      `json:"limit,omitempty"`
	LabelLimits []MeteredComponentLabelLimit `json:"label_limits"`
	// Name to be used on invoice.
	DisplayName string `json:"display_name,omitempty"`
	// External facing unique identifier of a metered component
	ExternalUuid string `json:"external_uuid,omitempty"`
	// Minimum charge for the metered component
	MinimumCharge int32 `json:"minimum_charge,omitempty"`
	// Minimum charge frequency (as a multiple of the price plan period) for the metered component
	MinimumChargeFrequency int32 `json:"minimum_charge_frequency,omitempty"`
}

Metered Component this discount covers if scope is METERED_COMPONENT.

type AllOfSubscriptionDiscountsItems ¶ added in v0.4.9

type AllOfSubscriptionDiscountsItems struct {
	DiscountType string  `json:"discount_type,omitempty"`
	Amount       float64 `json:"amount,omitempty"`
	// The date when the discount is applied from.
	StartDate time.Time `json:"start_date,omitempty"`
	// The date when the discount ends.
	EndDate time.Time `json:"end_date,omitempty"`
	// Offset in number of billing cycles for when this discount will apply. For example, if set to 1, the discount will apply from the start of the next billing cycle.
	BillingCycleStartOffset int32 `json:"billing_cycle_start_offset,omitempty"`
	// Duration of this discount in number of billing cycles.
	BillingCycleDuration int32 `json:"billing_cycle_duration,omitempty"`
	// The id of coupon associated with this discount, none if discount does not originate from coupon
	CouponId int32 `json:"coupon_id,omitempty"`
	// External facing unique identifier of a price plan
	ExternalUuid string `json:"external_uuid,omitempty"`
	// The scope that this discount covers. One of 'INVOICE_TOTAL', 'ADD_ON', 'METERED_COMPONENT'.
	Scope string `json:"scope"`
	// Add-on this discount covers if scope is ADD_ON.
	AddOn AddOn `json:"add_on,omitempty"`
	// Metered Component this discount covers if scope is METERED_COMPONENT.
	MeteredComponent MeteredComponent `json:"metered_component,omitempty"`
	// Dictionary of labels (key: value) to which the discount applies if scope is METERED_COMPONENT.
	Labels map[string]string `json:"labels,omitempty"`
}

List of discounts associated with this subscription.

type AllOfSubscriptionPricePlan ¶ added in v0.2.0

type AllOfSubscriptionPricePlan struct {
	// External facing unique identifier of a price plan
	ExternalUuid string `json:"external_uuid,omitempty"`
	// Unique name indentifier of a price plan
	Name string `json:"name"`
	// UI-friendly name used for data display. Defaults to `name`.
	DisplayName string `json:"display_name,omitempty"`
	Description string `json:"description,omitempty"`
	// Lowest denomination of currency. e.g. USD is represented as cents.
	BasePrice          float64 `json:"base_price,omitempty"`
	BasePriceFrequency int32   `json:"base_price_frequency,omitempty"`
	// Custom invoice description for the base price line item.
	BasePriceDescription string `json:"base_price_description,omitempty"`
	// Time period that defines the length of a price plan cycle. One of `day`, `week`, `month`, `quarter`, or `year`.
	Period            string             `json:"period"`
	MeteredComponents []MeteredComponent `json:"metered_components"`
	// Minimum amount to charge every 'period'
	MinimumCharge int32 `json:"minimum_charge,omitempty"`
	// The frequency (as a an integer multiple of the period) at which to charge the minimum charge.
	MinimumChargeFrequency int32          `json:"minimum_charge_frequency,omitempty"`
	Features               []Feature      `json:"features,omitempty"`
	AddOns                 []AddOn        `json:"add_ons,omitempty"`
	Limits                 []Limit        `json:"limits,omitempty"`
	Tags                   []PricePlanTag `json:"tags,omitempty"`
	Trial                  *Trial         `json:"trial,omitempty"`
	// ISO-8601 formatted creation timestamp of price plan version
	CreatedAt time.Time `json:"created_at,omitempty"`
}

Price plan associated with this subscription.

type AllOfSubscriptionTrialOverride ¶

type AllOfSubscriptionTrialOverride struct {
	TimeLength   float64 `json:"time_length,omitempty"`
	TimeUnitName string  `json:"time_unit_name,omitempty"`
	Credit       int32   `json:"credit,omitempty"`
}

Optional trial override for the associated subscription.

type AllOfUpdateSubscriptionArgsDiscountOverride ¶ added in v0.4.0

type AllOfUpdateSubscriptionArgsDiscountOverride struct {
	DiscountType string `json:"discount_type,omitempty"`
	// For ADD_ON scoped discounts: the name of the add on that the discount covers.
	AddOnName string `json:"add_on_name,omitempty"`
	// Length, in billing cycles, that this discount will be active.
	BillingCycleDuration int32 `json:"billing_cycle_duration,omitempty"`
	// For METERED_COMPONENT scoped discounts: Dictionary of labels (key: value) that the discount covers. The entire set of labels must be provided.
	Labels map[string]string `json:"labels,omitempty"`
	// The scope that this discount covers. One of 'INVOICE_TOTAL', 'ADD_ON', 'METERED_COMPONENT'.
	Scope  string  `json:"scope,omitempty"`
	Amount float64 `json:"amount,omitempty"`
	// Offset, in number of billing cycles, for when this discount will apply. If set to 0, the discount will start applying from the current billing cycle. If set to 1, the discount will start applying from the next billing cycle, etc. For scheduled subscriptions, the offset starts from the initial billing cycle.
	BillingCycleStartOffset int32 `json:"billing_cycle_start_offset,omitempty"`
	// For METERED_COMPONENT scoped discounts: the UUID of the metered component that the discount covers.
	MeteredComponentUuid string `json:"metered_component_uuid,omitempty"`
}

DEPRECATED - use discounts field

type AllOfUpdateSubscriptionArgsTrialOverride ¶ added in v0.4.0

type AllOfUpdateSubscriptionArgsTrialOverride struct {
	Credit       float64 `json:"credit,omitempty"`
	TimeLength   float64 `json:"time_length,omitempty"`
	TimeUnitName string  `json:"time_unit_name,omitempty"`
}

type AllOfUpdateSubscriptionInPlaceArgsDiscountOverride ¶ added in v0.4.0

type AllOfUpdateSubscriptionInPlaceArgsDiscountOverride struct {
	DiscountType string `json:"discount_type,omitempty"`
	// For ADD_ON scoped discounts: the name of the add on that the discount covers.
	AddOnName string `json:"add_on_name,omitempty"`
	// Length, in billing cycles, that this discount will be active.
	BillingCycleDuration int32 `json:"billing_cycle_duration,omitempty"`
	// For METERED_COMPONENT scoped discounts: Dictionary of labels (key: value) that the discount covers. The entire set of labels must be provided.
	Labels map[string]string `json:"labels,omitempty"`
	// The scope that this discount covers. One of 'INVOICE_TOTAL', 'ADD_ON', 'METERED_COMPONENT'.
	Scope  string  `json:"scope,omitempty"`
	Amount float64 `json:"amount,omitempty"`
	// Offset, in number of billing cycles, for when this discount will apply. If set to 0, the discount will start applying from the current billing cycle. If set to 1, the discount will start applying from the next billing cycle, etc. For scheduled subscriptions, the offset starts from the initial billing cycle.
	BillingCycleStartOffset int32 `json:"billing_cycle_start_offset,omitempty"`
	// For METERED_COMPONENT scoped discounts: the UUID of the metered component that the discount covers.
	MeteredComponentUuid string `json:"metered_component_uuid,omitempty"`
}

DEPRECATED - use discounts field

type ApplyCouponInputArgs ¶

type ApplyCouponInputArgs struct {
	CustomerName string `json:"customer_name,omitempty"`
	VendorId     int32  `json:"vendor_id,omitempty"`
	Name         string `json:"name,omitempty"`
	CustomerId   int32  `json:"customer_id,omitempty"`
	Code         string `json:"code,omitempty"`
}

type AvalaraApiService ¶ added in v0.4.9

type AvalaraApiService service

func (*AvalaraApiService) IntegrationTaxAvalaraCompanyGet ¶ added in v0.4.9

func (a *AvalaraApiService) IntegrationTaxAvalaraCompanyGet(ctx context.Context) ([]Company, *http.Response, error)

AvalaraApiService Get Avalara companies Lists the companies found in your Avalara account.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Company

func (*AvalaraApiService) IntegrationTaxAvalaraCredentialsValidPost ¶ added in v0.4.9

func (a *AvalaraApiService) IntegrationTaxAvalaraCredentialsValidPost(ctx context.Context, body ValidateCredentialsArgs) (ValidateCredentialsResp, *http.Response, error)

AvalaraApiService Validate Avalara credentials Validates the Avalara credentials for you vendor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return ValidateCredentialsResp

func (*AvalaraApiService) IntegrationTaxAvalaraEntityUseCodeGet ¶ added in v0.4.9

func (a *AvalaraApiService) IntegrationTaxAvalaraEntityUseCodeGet(ctx context.Context) ([]EntityUseCode, *http.Response, error)

AvalaraApiService Get Avalara entity codes Lists the entity codes available in avalara.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []EntityUseCode

func (*AvalaraApiService) IntegrationTaxAvalaraSettingsGet ¶ added in v0.4.9

func (a *AvalaraApiService) IntegrationTaxAvalaraSettingsGet(ctx context.Context) (VendorAvalaraSettings, *http.Response, error)

AvalaraApiService Get Vendor Avalara Settings Returns the vendor Avalara settings.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return VendorAvalaraSettings

func (*AvalaraApiService) IntegrationTaxAvalaraSettingsPost ¶ added in v0.4.9

func (a *AvalaraApiService) IntegrationTaxAvalaraSettingsPost(ctx context.Context, body CreateVendorAvalaraSettingsArgs) (VendorAvalaraSettings, *http.Response, error)

AvalaraApiService Create vendor Avalara settings Creates the Avalara settings for you vendor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return VendorAvalaraSettings

func (*AvalaraApiService) IntegrationTaxAvalaraSettingsPut ¶ added in v0.4.9

func (a *AvalaraApiService) IntegrationTaxAvalaraSettingsPut(ctx context.Context, body UpdateVendorAvalaraSettingsArgs) (VendorAvalaraSettings, *http.Response, error)

AvalaraApiService Update vendor Avalara settings Updates the Avalara settings for you vendor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return VendorAvalaraSettings

func (*AvalaraApiService) IntegrationTaxAvalaraTaxCodeGet ¶ added in v0.4.9

func (a *AvalaraApiService) IntegrationTaxAvalaraTaxCodeGet(ctx context.Context) ([]TaxCode, *http.Response, error)

AvalaraApiService Get Avalara Tax Codes Lists the Avalara Tax codes associated for a specific company.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []TaxCode

type BankAccountInfo ¶ added in v0.4.9

type BankAccountInfo struct {
	// Name of the bank
	BankName string `json:"bank_name,omitempty"`
	// Country the bank account is in.
	Country string `json:"country,omitempty"`
	// Bank account type. E.g. Savings/Checking
	AccountType string `json:"account_type,omitempty"`
	// Last 4 digits of the bank account number.
	Last4      string `json:"last4,omitempty"`
	ExternalId string `json:"external_id,omitempty"`
	// Routing number for the bank accopunt
	RoutingNumber int32 `json:"routing_number,omitempty"`
}

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BillingCycleDate ¶ added in v0.2.0

type BillingCycleDate struct {
	CycleStart time.Time `json:"cycle_start"`
	CycleEnd   time.Time `json:"cycle_end"`
}

type BillingSettings ¶

type BillingSettings struct {
	// Time length of the grace period between the end of a billing cycle and invoice generation in days.
	InvoiceGracePeriodLength int32 `json:"invoice_grace_period_length,omitempty"`
	// Time length unit of the grace period between the end of a billing cycle and invoice generation. Must be `day`.
	InvoiceGracePeriodUnit string `json:"invoice_grace_period_unit,omitempty"`
	// Time length of the grace period between the end of invoice generation and the actual charge. *NOTE*: The specified length is unitless. Unit is designated with the `payment_grace_period_unit` field.
	PaymentGracePeriodLength int32 `json:"payment_grace_period_length,omitempty"`
	// Time length unit of the grace period between the end of invoice generation and actual charge. One of `minute`, `hour`, `day`.
	PaymentGracePeriodUnit string `json:"payment_grace_period_unit,omitempty"`
	// Flag that controls whether or not invoices should be sent to customers.
	ShouldSendInvoiceToCustomers bool `json:"should_send_invoice_to_customers,omitempty"`
	// Flag that controls whether to invoice through Octane or through payment provider
	InvoiceViaOctane bool `json:"invoice_via_octane,omitempty"`
	// Flag that controls whether invoices are auto-approved or require manual approval
	AutoApproveInvoices        bool   `json:"auto_approve_invoices,omitempty"`
	CustomerInvoiceDetailLevel string `json:"customer_invoice_detail_level,omitempty"`
	// Flag that controls whether or not to auto-charge the customer based on the invoice.
	ChargesEnabled bool `json:"charges_enabled,omitempty"`
	// Flag that controls whether or not to invoice/charge the base rate, add ons and other fixed price plan components at the beginning of the billing cycle.
	InvoiceFixedComponentsAtStart bool `json:"invoice_fixed_components_at_start,omitempty"`
	// Flag that controls the number of retry attempts for invoicing/payments.
	RetryAttempts int32 `json:"retry_attempts,omitempty"`
	// Time length after which to attempt invoice/payment retry.
	RetryFrequencyLength int32 `json:"retry_frequency_length,omitempty"`
	// Time length unit after which to attempt invoice/payment retry.
	RetryFrequencyUnit string `json:"retry_frequency_unit,omitempty"`
	// The percentage tax rate to apply to invoices.
	TaxRate float64 `json:"tax_rate,omitempty"`
	// Flag that controls whether to do automated taxes via payment provider
	TaxViaPaymentProvider bool `json:"tax_via_payment_provider,omitempty"`
	// Flag that controls whether or not to invoice/charge gauge meters upfront according to their value at start of cycle. Only applies if invoice_fixed_components_at_start is enabled.
	InvoiceMeteredComponentsAtStart bool `json:"invoice_metered_components_at_start,omitempty"`
	// Flag that controls whether or not to invoice/charge a true up for a billing cycle on the following invoice. Only applies if invoice_fixed_components_at_start is enabled.
	InvoiceOverages bool `json:"invoice_overages,omitempty"`
	// Optional description attached to the invoice
	InvoiceMemo string `json:"invoice_memo,omitempty"`
	// Sets the due date on invoices to the number of days after the invoice is sent
	DaysUntilDue int32 `json:"days_until_due,omitempty"`
	// If using stripe, this field can be used to configure whether invoices should be auto advanced for collection
	StripeAutoAdvance bool `json:"stripe_auto_advance,omitempty"`
	// Default value for whether to align billing cycles to calendar on subscriptions
	AlignBillingCyclesToCalendar bool `json:"align_billing_cycles_to_calendar,omitempty"`
	// Optional url of a custom image to include on invoices.
	InvoiceLogoUrl string `json:"invoice_logo_url,omitempty"`
	// Flag determining whether ACH/Wire instructions should be included on invoices.
	IncludeAchInstructions bool `json:"include_ach_instructions,omitempty"`
	// Account name for ACH/Wire transfer instructions
	AchAccountName string `json:"ach_account_name,omitempty"`
	// ABA/Routing number for ACH/Wire transfer instructions
	AchRoutingNumber string `json:"ach_routing_number,omitempty"`
	// Account number for ACH/Wire transfer instructions
	AchAccountNumber string `json:"ach_account_number,omitempty"`
	// Swift code for ACH/Wire transfer instructions
	AchSwiftCode string `json:"ach_swift_code,omitempty"`
	// Bank name for ACH/Wire transfer instructions
	AchBankName string `json:"ach_bank_name,omitempty"`
	// First line of bank address for ACH/Wire transfer instructions
	AchBankAddress1 string `json:"ach_bank_address_1,omitempty"`
	// Second line of bank address for ACH/Wire transfer instructions
	AchBankAddress2 string `json:"ach_bank_address_2,omitempty"`
	// True if customer updates should be synced to Stripe.
	SyncCustomerDataToPaymentGateway bool `json:"sync_customer_data_to_payment_gateway,omitempty"`
	// If using Stripe, this field can be used to configure whether invoices should be finalized immediately when they are created.
	StripeImmediateFinalization bool `json:"stripe_immediate_finalization,omitempty"`
	// If set, we will use this template id for our emails instead of our default one
	AlternateSendgridTemplateId string `json:"alternate_sendgrid_template_id,omitempty"`
}

type BillingSettingsApiService ¶

type BillingSettingsApiService service

func (*BillingSettingsApiService) BillingSettingsDelete ¶

func (a *BillingSettingsApiService) BillingSettingsDelete(ctx context.Context) (*http.Response, error)

BillingSettingsApiService Delete Billing Settings Delete billing settings for a vendor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*BillingSettingsApiService) BillingSettingsGet ¶

func (a *BillingSettingsApiService) BillingSettingsGet(ctx context.Context) (BillingSettings, *http.Response, error)

BillingSettingsApiService Get Billing Settings Get billing settings for a vendor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return BillingSettings

func (*BillingSettingsApiService) BillingSettingsPost ¶

func (a *BillingSettingsApiService) BillingSettingsPost(ctx context.Context, body CreateBillingSettingsInputArgs) (BillingSettings, *http.Response, error)

BillingSettingsApiService Create Billing Settings Create billing settings for a vendor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return BillingSettings

func (*BillingSettingsApiService) BillingSettingsPut ¶

func (a *BillingSettingsApiService) BillingSettingsPut(ctx context.Context, body UpdateBillingSettingsInputArgs) (BillingSettings, *http.Response, error)

BillingSettingsApiService Update Billing Settings Update billing settings for a vendor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return BillingSettings

type CardInfo ¶ added in v0.4.9

type CardInfo struct {
	// Country of the card
	Country string `json:"country,omitempty"`
	// Brand of card. E.g. Amex, Visa, etc.
	Brand string `json:"brand,omitempty"`
	// Last 4 digits of the card.
	Last4      string `json:"last4,omitempty"`
	ExternalId string `json:"external_id,omitempty"`
	// Year the card expires
	ExpYear int32 `json:"exp_year,omitempty"`
	// Month the card expires
	ExpMonth int32 `json:"exp_month,omitempty"`
}

type Company ¶ added in v0.4.9

type Company struct {
	// This flag is true if this company is the default company for this account.
	IsDefault bool `json:"is_default,omitempty"`
	// The unique ID number of this company.
	Id string `json:"id,omitempty"`
	// A unique code that references this company within your account.
	CompanyCode string `json:"company_code,omitempty"`
	// This flag indicates whether tax activity can occur for this company.
	IsActive bool `json:"is_active,omitempty"`
	// The name of this company, as shown to customers.
	CompanyName string `json:"company_name,omitempty"`
}

type Configuration ¶

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

type ContactInfo ¶

type ContactInfo struct {
	AddressLine1    string `json:"address_line_1,omitempty"`
	AddressLine2    string `json:"address_line_2,omitempty"`
	City            string `json:"city,omitempty"`
	State           string `json:"state,omitempty"`
	Country         string `json:"country,omitempty"`
	Zipcode         string `json:"zipcode,omitempty"`
	Url             string `json:"url,omitempty"`
	LogoUrl         string `json:"logo_url,omitempty"`
	Email           string `json:"email,omitempty"`
	SecondaryEmails string `json:"secondary_emails,omitempty"`
	Phone           string `json:"phone,omitempty"`
	LegalName       string `json:"legal_name,omitempty"`
	VatId           string `json:"vat_id,omitempty"`
}

type ContactInfoInputArgs ¶

type ContactInfoInputArgs struct {
	VatId        string `json:"vat_id,omitempty"`
	Country      string `json:"country,omitempty"`
	Url          string `json:"url,omitempty"`
	City         string `json:"city,omitempty"`
	Zipcode      string `json:"zipcode,omitempty"`
	State        string `json:"state,omitempty"`
	Email        string `json:"email,omitempty"`
	Phone        string `json:"phone,omitempty"`
	AddressLine2 string `json:"address_line_2,omitempty"`
	AddressLine1 string `json:"address_line_1,omitempty"`
	LogoUrl      string `json:"logo_url,omitempty"`
	// List of secondary contact emails (all email communication will also be sent to these emails).
	SecondaryEmails []string `json:"secondary_emails,omitempty"`
	LegalName       string   `json:"legal_name,omitempty"`
}

type Coupon ¶

type Coupon struct {
	// Unique name identifier.
	Name string `json:"name"`
	// UI-friendly name used for data display. Defaults to `name`.
	DisplayName string `json:"display_name,omitempty"`
	// The time when the coupon will stop being effective one its applied.
	DurationLength int32 `json:"duration_length,omitempty"`
	// The unit time unit to apply to the specified duration length.
	DurationUnit string `json:"duration_unit,omitempty"`
	// ISO-8601 formatted timestamp that defines after what timestamp this coupon cannot be applied.
	ExpirationTime time.Time `json:"expiration_time,omitempty"`
	Frequency      string    `json:"frequency,omitempty"`
	// The maximum number of times this coupon can be used.
	MaxUses int32 `json:"max_uses,omitempty"`
	// Customer facing code that can be used to apply coupon.
	Code         string `json:"code,omitempty"`
	DiscountType string `json:"discount_type,omitempty"`
	// The amount of discount to give based on discount_type
	DiscountAmount     float64      `json:"discount_amount"`
	ExcludedCustomers  []Customer1  `json:"excluded_customers,omitempty"`
	ExcludedPricePlans []PricePlan1 `json:"excluded_price_plans,omitempty"`
}

type CouponInputArgs ¶

type CouponInputArgs struct {
	VendorId           int32     `json:"vendor_id,omitempty"`
	Name               string    `json:"name"`
	DisplayName        string    `json:"display_name,omitempty"`
	ExpirationTime     time.Time `json:"expiration_time,omitempty"`
	Frequency          string    `json:"frequency"`
	DurationLength     int32     `json:"duration_length,omitempty"`
	DurationUnit       string    `json:"duration_unit,omitempty"`
	MaxUses            int32     `json:"max_uses,omitempty"`
	Code               string    `json:"code,omitempty"`
	ExcludedCustomers  []string  `json:"excluded_customers,omitempty"`
	ExcludedPricePlans []string  `json:"excluded_price_plans,omitempty"`
	DiscountType       string    `json:"discount_type"`
	DiscountAmount     float64   `json:"discount_amount"`
}

type CouponsApiService ¶

type CouponsApiService service

func (*CouponsApiService) CouponsApplyCouponPost ¶

func (a *CouponsApiService) CouponsApplyCouponPost(ctx context.Context, body ApplyCouponInputArgs) (*http.Response, error)

CouponsApiService Apply Coupon Apply a coupon to the provided customer.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*CouponsApiService) CouponsCouponNameDelete ¶

func (a *CouponsApiService) CouponsCouponNameDelete(ctx context.Context, couponName string) (*http.Response, error)

CouponsApiService Delete Coupon Delete a specific coupon for a vendor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param couponName

func (*CouponsApiService) CouponsCouponNameGet ¶

func (a *CouponsApiService) CouponsCouponNameGet(ctx context.Context, couponName string) (Coupon, *http.Response, error)

CouponsApiService Get Coupon Get a specific coupon for a vendor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param couponName

@return Coupon

func (*CouponsApiService) CouponsGet ¶

func (a *CouponsApiService) CouponsGet(ctx context.Context) ([]Coupon, *http.Response, error)

CouponsApiService Get Coupons Gets all coupons for a specific vendor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Coupon

func (*CouponsApiService) CouponsPost ¶

func (a *CouponsApiService) CouponsPost(ctx context.Context, body CouponInputArgs) (Coupon, *http.Response, error)

CouponsApiService Create Coupons Create a coupon for a vendor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return Coupon

type CreateBillingSettingsInputArgs ¶

type CreateBillingSettingsInputArgs struct {
	// Optional description attached to the invoice
	InvoiceMemo string `json:"invoice_memo,omitempty"`
	// Account name for ACH/Wire transfer instructions
	AchAccountName string `json:"ach_account_name,omitempty"`
	// Time length after which to attempt invoice/payment retry.
	RetryFrequencyLength int32 `json:"retry_frequency_length,omitempty"`
	// Flag that controls whether to do automated taxes via payment provider
	TaxViaPaymentProvider bool `json:"tax_via_payment_provider,omitempty"`
	// Time length unit of the grace period between the end of a billing cycle and invoice generation. Must be `day`.
	InvoiceGracePeriodUnit string `json:"invoice_grace_period_unit,omitempty"`
	// Flag that controls whether or not to invoice/charge gauge meters upfront according to their value at start of cycle. Only applies if invoice_fixed_components_at_start is enabled.
	InvoiceMeteredComponentsAtStart bool `json:"invoice_metered_components_at_start,omitempty"`
	// Flag that controls whether or not to auto-charge the customer based on the invoice.
	ChargesEnabled bool `json:"charges_enabled,omitempty"`
	// Flag that controls the number of retry attempts for invoicing/payments.
	RetryAttempts int32 `json:"retry_attempts,omitempty"`
	// Sets the due date on invoices to the number of days after the invoice is sent
	DaysUntilDue int32 `json:"days_until_due,omitempty"`
	// Default value for whether to align billing cycles to calendar on subscriptions
	AlignBillingCyclesToCalendar bool `json:"align_billing_cycles_to_calendar,omitempty"`
	// Bank name for ACH/Wire transfer instructions
	AchBankName string `json:"ach_bank_name,omitempty"`
	// Time length unit after which to attempt invoice/payment retry.
	RetryFrequencyUnit string `json:"retry_frequency_unit,omitempty"`
	// If using Stripe, this field can be used to configure whether invoices should be finalized immediately when they are created.
	StripeImmediateFinalization bool `json:"stripe_immediate_finalization,omitempty"`
	// Time length of the grace period between the end of a billing cycle and invoice generation in days.
	InvoiceGracePeriodLength int32 `json:"invoice_grace_period_length,omitempty"`
	// Swift code for ACH/Wire transfer instructions
	AchSwiftCode string `json:"ach_swift_code,omitempty"`
	// Time length unit of the grace period between the end of invoice generation and actual charge. One of `minute`, `hour`, `day`.
	PaymentGracePeriodUnit string `json:"payment_grace_period_unit,omitempty"`
	// The percentage tax rate to apply to invoices.
	TaxRate float64 `json:"tax_rate,omitempty"`
	// Account number for ACH/Wire transfer instructions
	AchAccountNumber string `json:"ach_account_number,omitempty"`
	// Time length of the grace period between the end of invoice generation and the actual charge. *NOTE*: The specified length is unitless. Unit is designated with the `payment_grace_period_unit` field.
	PaymentGracePeriodLength int32 `json:"payment_grace_period_length,omitempty"`
	// Flag that controls whether invoices are auto-approved or require manual approval
	AutoApproveInvoices bool `json:"auto_approve_invoices,omitempty"`
	// First line of bank address for ACH/Wire transfer instructions
	AchBankAddress1 string `json:"ach_bank_address_1,omitempty"`
	// Flag that controls whether or not to invoice/charge the base rate, add ons and other fixed price plan components at the beginning of the billing cycle.
	InvoiceFixedComponentsAtStart bool `json:"invoice_fixed_components_at_start,omitempty"`
	// Second line of bank address for ACH/Wire transfer instructions
	AchBankAddress2 string `json:"ach_bank_address_2,omitempty"`
	// Flag that controls whether or not invoices should be sent to customers.
	ShouldSendInvoiceToCustomers bool `json:"should_send_invoice_to_customers,omitempty"`
	// Flag determining whether ACH/Wire instructions should be included on invoices.
	IncludeAchInstructions bool `json:"include_ach_instructions,omitempty"`
	// If using stripe, this field can be used to configure whether invoices should be auto advanced for collection
	StripeAutoAdvance bool `json:"stripe_auto_advance,omitempty"`
	// True if customer updates should be synced to Stripe.
	SyncCustomerDataToPaymentGateway bool `json:"sync_customer_data_to_payment_gateway,omitempty"`
	// Flag that controls whether to invoice through Octane or through payment provider
	InvoiceViaOctane           bool   `json:"invoice_via_octane,omitempty"`
	CustomerInvoiceDetailLevel string `json:"customer_invoice_detail_level,omitempty"`
	// Flag that controls whether or not to invoice/charge a true up for a billing cycle on the following invoice. Only applies if invoice_fixed_components_at_start is enabled.
	InvoiceOverages bool `json:"invoice_overages,omitempty"`
	// Optional url of a custom image to include on invoices.
	InvoiceLogoUrl string `json:"invoice_logo_url,omitempty"`
	// ABA/Routing number for ACH/Wire transfer instructions
	AchRoutingNumber string `json:"ach_routing_number,omitempty"`
}

type CreateCreditGrantArgs ¶ added in v0.4.3

type CreateCreditGrantArgs struct {
	// The date at which the grant is effective
	EffectiveAt *time.Time `json:"effective_at,omitempty"`
	// The date at which this grant expires
	ExpiresAt *time.Time `json:"expires_at,omitempty"`
	// Name of the customer receving the grant
	CustomerName string `json:"customer_name"`
	// Optional description. This is only viewable internally
	Description string `json:"description,omitempty"`
	// Number of credits to grant
	Amount float64 `json:"amount"`
	// Total price paid for the credits in cents. Defaults to $1 (100 cents) per credit if not specified
	Price int32 `json:"price"`
}

type CreateCreditTopOffPlanInputArgs ¶ added in v0.4.9

type CreateCreditTopOffPlanInputArgs struct {
	// Amount of credits that are granted in a single top off.
	GrantAmount float64 `json:"grant_amount"`
	// The threshold in amount of credits at which the balance will be topped off.
	TriggerAmount float64 `json:"trigger_amount"`
	// A description that will be used on the invoice line items.
	Description string `json:"description,omitempty"`
	// Time length unit for the default expiration for credits granted in a top off.
	ExpirationUnit string `json:"expiration_unit,omitempty"`
	// Time length of the default expiration for credits granted in a top off.
	ExpirationLength int32 `json:"expiration_length,omitempty"`
	// Price for the grant, in lowest denomination (i.e cents).
	Price int32 `json:"price"`
}

type CreateCustomerArgs ¶

type CreateCustomerArgs struct {
	PricePlanName                      string                                `json:"price_plan_name,omitempty"`
	Tags                               []string                              `json:"tags,omitempty"`
	ContactInfo                        *ContactInfoInputArgs                 `json:"contact_info,omitempty"`
	PricePlanTag                       string                                `json:"price_plan_tag,omitempty"`
	VendorId                           int32                                 `json:"vendor_id,omitempty"`
	AutogenerateAccountingCustomer     bool                                  `json:"autogenerate_accounting_customer,omitempty"`
	MeasurementMappings                []CustomerMeasurementMappingInputArgs `json:"measurement_mappings,omitempty"`
	Name                               string                                `json:"name,omitempty"`
	AutogeneratePaymentGatewayCustomer bool                                  `json:"autogenerate_payment_gateway_customer,omitempty"`
	DisplayName                        string                                `json:"display_name,omitempty"`
	CreatedAt                          time.Time                             `json:"created_at,omitempty"`
	CustomerMetadata                   []CustomerMetadataInput               `json:"customer_metadata,omitempty"`
}

type CreatePricePlanArgs ¶

type CreatePricePlanArgs struct {
	Trial *TrialInputArgs `json:"trial,omitempty"`
	// The frequency (as a an integer multiple of the period) at which to charge the minimum charge.
	MinimumChargeFrequency int32            `json:"minimum_charge_frequency,omitempty"`
	Tags                   []string         `json:"tags,omitempty"`
	Description            string           `json:"description,omitempty"`
	AddOns                 []AddOnInputArgs `json:"add_ons,omitempty"`
	VendorId               int32            `json:"vendor_id,omitempty"`
	// Custom invoice description for the base price line item.
	BasePriceDescription string             `json:"base_price_description,omitempty"`
	Features             []FeatureInputArgs `json:"features,omitempty"`
	// The frequency (as a an integer multiple of the period) at which to charge the base price.
	BasePriceFrequency int32                       `json:"base_price_frequency,omitempty"`
	Name               string                      `json:"name,omitempty"`
	BasePrice          int32                       `json:"base_price,omitempty"`
	Period             string                      `json:"period,omitempty"`
	DisplayName        string                      `json:"display_name,omitempty"`
	MeteredComponents  []MeteredComponentInputArgs `json:"metered_components,omitempty"`
	Limits             []LimitInputArgs            `json:"limits,omitempty"`
	// Minimum amount (in cents) to charge every price plan period.
	MinimumCharge int32 `json:"minimum_charge,omitempty"`
}

type CreateRefundArgs ¶ added in v0.4.3

type CreateRefundArgs struct {
	// Amount to be refunded
	Amount int32 `json:"amount,omitempty"`
	// Invoice that the refund should be against
	InvoiceId int32 `json:"invoice_id,omitempty"`
	// Invoice that the refund should be against
	InvoiceUuid string `json:"invoice_uuid,omitempty"`
}

type CreateRetryArgs ¶ added in v0.4.9

type CreateRetryArgs struct {
}

type CreateSubscriptionArgs ¶

type CreateSubscriptionArgs struct {
	PricePlanName string `json:"price_plan_name,omitempty"`
	// DEPRECATED - use discounts field
	DiscountOverride   *AllOfCreateSubscriptionArgsDiscountOverride `json:"discount_override,omitempty"`
	EffectiveAt        time.Time                                    `json:"effective_at,omitempty"`
	PricePlanTag       string                                       `json:"price_plan_tag,omitempty"`
	AddOns             []SubscriptionAddOnInput                     `json:"add_ons,omitempty"`
	Discounts          []DiscountInputArgs                          `json:"discounts,omitempty"`
	TrialOverride      *TrialInputArgs                              `json:"trial_override,omitempty"`
	CouponOverrideId   int32                                        `json:"coupon_override_id,omitempty"`
	VendorId           int32                                        `json:"vendor_id,omitempty"`
	PricePlanId        int32                                        `json:"price_plan_id,omitempty"`
	CustomerId         int32                                        `json:"customer_id,omitempty"`
	CouponOverrideName string                                       `json:"coupon_override_name,omitempty"`
	LimitsOverride     []LimitInputArgs                             `json:"limits_override,omitempty"`
	FeaturesOverride   []FeatureInputArgs                           `json:"features_override,omitempty"`
	AlignToCalendar    bool                                         `json:"align_to_calendar,omitempty"`
}

type CreateVendorAvalaraSettingsArgs ¶ added in v0.4.9

type CreateVendorAvalaraSettingsArgs struct {
	// True if the documents generated in Avalara should be committed, false otherwise. Defaults to False.
	CommitDocuments bool `json:"commit_documents,omitempty"`
	// The item description to use to represent all the lines on the Octane invoice.
	ItemDescription string `json:"item_description,omitempty"`
	// Enable/Disable the Avalara integration.
	EnableIntegration bool `json:"enable_integration"`
	// The Avalara item code to use to represent all the line items on the Octane invoice.
	ItemCode string `json:"item_code,omitempty"`
	// True if connecting to Avalara sandbox account, false otherwise.
	SandboxMode bool `json:"sandbox_mode"`
	// True if enabling logging for Avalara calls, false otherwise. Defaults to False.
	EnableLogging bool `json:"enable_logging,omitempty"`
	// Password of the Avalara account.
	Password string `json:"password"`
	// The Avalara company code string to associate the Octane vendor with.
	CompanyCode string `json:"company_code,omitempty"`
	// Username of the Avalara account.
	Username string `json:"username"`
	// The tax code to associate with the item that is representing the Octane invoice.
	TaxCode string `json:"tax_code,omitempty"`
}

type CreateWebhookArgs ¶ added in v0.4.0

type CreateWebhookArgs struct {
	EnableSignature bool   `json:"enable_signature,omitempty"`
	Url             string `json:"url,omitempty"`
}

type CreditGrant ¶ added in v0.4.3

type CreditGrant struct {
	// The date at which this grant is effective
	EffectiveAt string `json:"effective_at,omitempty"`
	// The date at which this grant expires
	ExpiresAt string `json:"expires_at,omitempty"`
	// A unique identifier for this grant
	Uuid string `json:"uuid,omitempty"`
	// Name of the customer who received the grant
	CustomerName string `json:"customer_name,omitempty"`
	// Optional description. This is only viewable internally
	Description string `json:"description,omitempty"`
	// The source of the grant.
	Source string `json:"source,omitempty"`
	// Number of credits granted
	Amount float64 `json:"amount,omitempty"`
	// Total price paid for the credits, in cents
	Price int32 `json:"price,omitempty"`
}

type CreditLedger ¶ added in v0.4.3

type CreditLedger struct {
	// The change in numer of credits
	Amount int32 `json:"amount,omitempty"`
	// The time at which this credit balance change occurred.
	Timestamp time.Time `json:"timestamp,omitempty"`
	Pending   bool      `json:"pending,omitempty"`
	// Credit balance as of this change
	Balance float64 `json:"balance,omitempty"`
}

type CreditTopOffPlan ¶ added in v0.4.9

type CreditTopOffPlan struct {
	// Unique identifier of this top off plan.
	Uuid string `json:"uuid,omitempty"`
	// The threshold in amount of credits at which the balance will be topped off.
	TriggerAmount float64 `json:"trigger_amount"`
	// Amount of credits that are granted in a single top off.
	GrantAmount float64 `json:"grant_amount"`
	// Price for the grant, in lowest denomination (i.e cents).
	Price int32 `json:"price"`
	// Time length of the default expiration for credits granted in a top off.
	ExpirationLength int32 `json:"expiration_length,omitempty"`
	// Time length unit for the default expiration for credits granted in a top off.
	ExpirationUnit string `json:"expiration_unit,omitempty"`
	// A description that will be used on the invoice line items.
	Description string `json:"description,omitempty"`
}

type CreditsApiService ¶ added in v0.4.3

type CreditsApiService service

func (*CreditsApiService) CreditsGrantGet ¶ added in v0.4.3

func (a *CreditsApiService) CreditsGrantGet(ctx context.Context, body ListCreditGrantsArgs) (ListCreditGrants, *http.Response, error)

CreditsApiService Get Credit Grants Returns all the credit grants under your account.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return ListCreditGrants

func (*CreditsApiService) CreditsGrantGrantUuidVoidPost ¶ added in v0.4.3

func (a *CreditsApiService) CreditsGrantGrantUuidVoidPost(ctx context.Context, grantUuid string) (*http.Response, error)

CreditsApiService Void a Credit Grant Deactivates a credit grant with the given grant UUID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param grantUuid

func (*CreditsApiService) CreditsGrantPost ¶ added in v0.4.3

func (a *CreditsApiService) CreditsGrantPost(ctx context.Context, body CreateCreditGrantArgs) (CreditGrant, *http.Response, error)

CreditsApiService Create a Credit Grant Creates a credit grant for one of your customers.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return CreditGrant

func (*CreditsApiService) CreditsLedgerCustomerNameAsOfStrGet ¶ added in v0.4.3

func (a *CreditsApiService) CreditsLedgerCustomerNameAsOfStrGet(ctx context.Context, asOfStr string, customerName string) ([]CreditLedger, *http.Response, error)

CreditsApiService Fetch a Credit Ledger Returns the credit ledger for one of your customers.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param asOfStr
@param customerName

@return []CreditLedger

func (*CreditsApiService) CreditsLedgerCustomerNameGet ¶ added in v0.4.3

func (a *CreditsApiService) CreditsLedgerCustomerNameGet(ctx context.Context, customerName string) ([]CreditLedger, *http.Response, error)

CreditsApiService Fetch a Credit Ledger Returns the credit ledger for one of your customers.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName

@return []CreditLedger

type Customer ¶

type Customer struct {
	// Unique name identifier of a customer
	Name                string                    `json:"name"`
	DisplayName         string                    `json:"display_name,omitempty"`
	ContactInfo         *AllOfCustomerContactInfo `json:"contact_info,omitempty"`
	CreatedAt           time.Time                 `json:"created_at,omitempty"`
	MeasurementMappings []map[string]string       `json:"measurement_mappings,omitempty"`
	Tags                []CustomerTag             `json:"tags,omitempty"`
}

type Customer1 ¶

type Customer1 struct {
	// Unique name identifier of a customer
	Name string `json:"name"`
}

type CustomerAvalaraSettings ¶ added in v0.4.9

type CustomerAvalaraSettings struct {
	// True if Avalara integration should be enabled for this customer, False otherwise.
	EnableIntegration bool `json:"enable_integration,omitempty"`
	// Entity code describing this customer.
	EntityUseCode string `json:"entity_use_code,omitempty"`
	// Tax exemption number specific to this customer
	ExemptionNumber string `json:"exemption_number,omitempty"`
}

type CustomerBillingSettingsInputArgs ¶ added in v0.4.9

type CustomerBillingSettingsInputArgs struct {
	// Optional description attached to the invoice
	InvoiceMemo string `json:"invoice_memo,omitempty"`
	// Account name for ACH/Wire transfer instructions
	AchAccountName string `json:"ach_account_name,omitempty"`
	// Time length after which to attempt invoice/payment retry.
	RetryFrequencyLength int32 `json:"retry_frequency_length,omitempty"`
	// Flag that controls whether to do automated taxes via payment provider
	TaxViaPaymentProvider bool `json:"tax_via_payment_provider,omitempty"`
	// Time length unit of the grace period between the end of a billing cycle and invoice generation. Must be `day`.
	InvoiceGracePeriodUnit string `json:"invoice_grace_period_unit,omitempty"`
	// Flag that controls whether or not to invoice/charge gauge meters upfront according to their value at start of cycle. Only applies if invoice_fixed_components_at_start is enabled.
	InvoiceMeteredComponentsAtStart bool `json:"invoice_metered_components_at_start,omitempty"`
	// Flag that controls whether or not to auto-charge the customer based on the invoice.
	ChargesEnabled bool `json:"charges_enabled,omitempty"`
	// Flag that controls the number of retry attempts for invoicing/payments.
	RetryAttempts int32 `json:"retry_attempts,omitempty"`
	// Sets the due date on invoices to the number of days after the invoice is sent
	DaysUntilDue int32 `json:"days_until_due,omitempty"`
	// Default value for whether to align billing cycles to calendar on subscriptions
	AlignBillingCyclesToCalendar bool `json:"align_billing_cycles_to_calendar,omitempty"`
	// Bank name for ACH/Wire transfer instructions
	AchBankName string `json:"ach_bank_name,omitempty"`
	// Time length unit after which to attempt invoice/payment retry.
	RetryFrequencyUnit string `json:"retry_frequency_unit,omitempty"`
	// If using Stripe, this field can be used to configure whether invoices should be finalized immediately when they are created.
	StripeImmediateFinalization bool `json:"stripe_immediate_finalization,omitempty"`
	// Time length of the grace period between the end of a billing cycle and invoice generation in days.
	InvoiceGracePeriodLength int32 `json:"invoice_grace_period_length,omitempty"`
	// Swift code for ACH/Wire transfer instructions
	AchSwiftCode string `json:"ach_swift_code,omitempty"`
	// Time length unit of the grace period between the end of invoice generation and actual charge. One of `minute`, `hour`, `day`.
	PaymentGracePeriodUnit string `json:"payment_grace_period_unit,omitempty"`
	// The percentage tax rate to apply to invoices.
	TaxRate float64 `json:"tax_rate,omitempty"`
	// Account number for ACH/Wire transfer instructions
	AchAccountNumber string `json:"ach_account_number,omitempty"`
	// Time length of the grace period between the end of invoice generation and the actual charge. *NOTE*: The specified length is unitless. Unit is designated with the `payment_grace_period_unit` field.
	PaymentGracePeriodLength int32 `json:"payment_grace_period_length,omitempty"`
	// Flag that controls whether invoices are auto-approved or require manual approval
	AutoApproveInvoices bool `json:"auto_approve_invoices,omitempty"`
	// First line of bank address for ACH/Wire transfer instructions
	AchBankAddress1 string `json:"ach_bank_address_1,omitempty"`
	// Flag that controls whether or not to invoice/charge the base rate, add ons and other fixed price plan components at the beginning of the billing cycle.
	InvoiceFixedComponentsAtStart bool `json:"invoice_fixed_components_at_start,omitempty"`
	// Second line of bank address for ACH/Wire transfer instructions
	AchBankAddress2 string `json:"ach_bank_address_2,omitempty"`
	// Flag that controls whether or not invoices should be sent to customers.
	ShouldSendInvoiceToCustomers bool `json:"should_send_invoice_to_customers,omitempty"`
	// Flag determining whether ACH/Wire instructions should be included on invoices.
	IncludeAchInstructions bool `json:"include_ach_instructions,omitempty"`
	// If using stripe, this field can be used to configure whether invoices should be auto advanced for collection
	StripeAutoAdvance bool `json:"stripe_auto_advance,omitempty"`
	// True if customer updates should be synced to Stripe.
	SyncCustomerDataToPaymentGateway bool `json:"sync_customer_data_to_payment_gateway,omitempty"`
	// Flag that controls whether to invoice through Octane or through payment provider
	InvoiceViaOctane           bool   `json:"invoice_via_octane,omitempty"`
	CustomerInvoiceDetailLevel string `json:"customer_invoice_detail_level,omitempty"`
	// Flag that controls whether or not to invoice/charge a true up for a billing cycle on the following invoice. Only applies if invoice_fixed_components_at_start is enabled.
	InvoiceOverages bool `json:"invoice_overages,omitempty"`
	// Optional url of a custom image to include on invoices.
	InvoiceLogoUrl string `json:"invoice_logo_url,omitempty"`
	// ABA/Routing number for ACH/Wire transfer instructions
	AchRoutingNumber string `json:"ach_routing_number,omitempty"`
}

type CustomerFeature ¶ added in v0.2.0

type CustomerFeature struct {
	LabelLimits []CustomerLabelLimit `json:"label_limits,omitempty"`
	Quantity    int32                `json:"quantity,omitempty"`
	Limit       float64              `json:"limit,omitempty"`
	Enabled     bool                 `json:"enabled,omitempty"`
	FeatureName string               `json:"feature_name,omitempty"`
}

type CustomerLabelLimit ¶ added in v0.4.3

type CustomerLabelLimit struct {
	Limit  float64           `json:"limit,omitempty"`
	Labels map[string]string `json:"labels,omitempty"`
}

type CustomerMeasurementMapping ¶

type CustomerMeasurementMapping struct {
	// The label key used to map measurements to customers.
	Label string `json:"label"`
	// A regex used to match the value of the associated label key.
	ValueRegex string `json:"value_regex,omitempty"`
}

type CustomerMeasurementMappingInputArgs ¶

type CustomerMeasurementMappingInputArgs struct {
	// A regex used to match the value of the associated label key.
	ValueRegex string `json:"value_regex"`
	// The label key used to map measurements to customers.
	Label string `json:"label"`
}

type CustomerMetadata ¶ added in v0.4.9

type CustomerMetadata struct {
	// Value of property for customer
	Value string `json:"value,omitempty"`
	// Property name
	Property string `json:"property,omitempty"`
}

type CustomerMetadataInput ¶ added in v0.4.9

type CustomerMetadataInput struct {
	Value    string `json:"value,omitempty"`
	Property string `json:"property,omitempty"`
}

type CustomerPaymentGatewayCredentialInputArgs ¶

type CustomerPaymentGatewayCredentialInputArgs struct {
	AccountId string `json:"account_id,omitempty"`
}

type CustomerPaymentMethodStatus ¶ added in v0.2.0

type CustomerPaymentMethodStatus struct {
	// The status of the customer's current payment method. Can be one of: NO_PAYMENT_GATEWAY_CREDENTIAL, NO_PAYMENT_METHOD, EXPIRED_PAYMENT_METHOD, VALID_PAYMENT_METHOD
	Status string `json:"status,omitempty"`
}

type CustomerPortalAccruedRevenue ¶ added in v0.4.9

type CustomerPortalAccruedRevenue struct {
	// The cycle start of the billing cycle for which the accrued revenue is computed
	StartTime time.Time                              `json:"start_time,omitempty"`
	LineItems []CustomerPortalAccruedRevenueLineItem `json:"line_items,omitempty"`
	// The end time within the billing cycle for which this accrued revenue is computed
	EndTime time.Time `json:"end_time,omitempty"`
	// Total accrued revenue for the period in cents
	TotalAccruedRevenue int32 `json:"total_accrued_revenue,omitempty"`
}

type CustomerPortalAccruedRevenueLineItem ¶ added in v0.4.9

type CustomerPortalAccruedRevenueLineItem struct {
	// Any extra metadata associated with the item.          Will include the labels for metered components and metered component minimum charges when applicable
	Metadata map[string]string `json:"metadata,omitempty"`
	// Accrued revenue for this line item in cents
	Revenue int32 `json:"revenue,omitempty"`
	// Type of item. One of: METERED_COMPONENT, BASE_PRICE, DISCOUNT, ADD_ON, MINIMUM_CHARGE, METERED_COMPONENT_MINIMUM_CHARGE
	ItemType string `json:"item_type,omitempty"`
	//          The identifier of the item being returned.          For metered component will be meter name,          for add_ons will be feature name,          for base price will be price plan name,         for minimum charge will be price plan name,         for metered component minimum charge will be meter name
	ItemIdentifier string `json:"item_identifier,omitempty"`
}

type CustomerPortalActiveSubscription ¶ added in v0.4.9

type CustomerPortalActiveSubscription struct {
	// The total fixed price the customer will be charged for this billing cycle. Includes the base price and any add ons.
	TotalFixedPrice int32 `json:"total_fixed_price,omitempty"`
	// Customer's current active biling cycle.
	BillingCycle *AllOfCustomerPortalActiveSubscriptionBillingCycle `json:"billing_cycle"`
	// The date that the customer will be invoiced for their current billing cycle.
	InvoicingDate time.Time `json:"invoicing_date,omitempty"`
	// The total fixed price with all discounts applied.
	DiscountedFixedPrice int32 `json:"discounted_fixed_price,omitempty"`
	// Customer's current active subscription. Includes the price plan and overrides they are subscribed to.
	Subscription *AllOfCustomerPortalActiveSubscriptionSubscription `json:"subscription,omitempty"`
}

type CustomerPortalActiveSubscriptionInputArgs ¶ added in v0.4.9

type CustomerPortalActiveSubscriptionInputArgs struct {
	PricePlanUuid string                   `json:"price_plan_uuid,omitempty"`
	AddOns        []SubscriptionAddOnInput `json:"add_ons,omitempty"`
}

type CustomerPortalApiService ¶ added in v0.4.0

type CustomerPortalApiService service

func (*CustomerPortalApiService) EcpActiveSubscriptionGet ¶ added in v0.4.9

func (a *CustomerPortalApiService) EcpActiveSubscriptionGet(ctx context.Context) (CustomerPortalActiveSubscription, *http.Response, error)

CustomerPortalApiService Get Active Subscription Fetch the customer's active subscription and related information if they exists. This endpoint expects the customer-scoped token for authentication.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return CustomerPortalActiveSubscription

func (*CustomerPortalApiService) EcpActiveSubscriptionPost ¶ added in v0.4.9

func (a *CustomerPortalApiService) EcpActiveSubscriptionPost(ctx context.Context, body CustomerPortalActiveSubscriptionInputArgs) (CustomerPortalSubscription, *http.Response, error)

CustomerPortalApiService Create/Update Active Subscription Create/update the customer's subscription. This endpoint expects the customer-scoped token for authentication.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return CustomerPortalSubscription

func (*CustomerPortalApiService) EcpContactInfoGet ¶ added in v0.4.9

func (a *CustomerPortalApiService) EcpContactInfoGet(ctx context.Context) (ContactInfo, *http.Response, error)

CustomerPortalApiService Get Contact Info Gets the customer's contact info. This endpoint expects the customer-scoped token for authentication.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ContactInfo

func (*CustomerPortalApiService) EcpContactInfoPut ¶ added in v0.4.9

func (a *CustomerPortalApiService) EcpContactInfoPut(ctx context.Context, body ContactInfoInputArgs) (ContactInfo, *http.Response, error)

CustomerPortalApiService Create/Update Contact Info Create/update the customer's contact info. This endpoint expects the customer-scoped token for authentication.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return ContactInfo

func (*CustomerPortalApiService) EcpCreditLedgerGet ¶ added in v0.4.9

func (a *CustomerPortalApiService) EcpCreditLedgerGet(ctx context.Context) ([]CreditLedger, *http.Response, error)

CustomerPortalApiService Fetch the Credit Ledger Returns the customer entire credit ledger. This can be used to compute the current and available credit balance. This endpoint expects the customer-scoped token for authentication.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []CreditLedger

func (*CustomerPortalApiService) EcpCreditPurchasePost ¶ added in v0.4.9

func (a *CustomerPortalApiService) EcpCreditPurchasePost(ctx context.Context, body CustomerPortalCreditPurchase) (CreditGrant, *http.Response, error)

CustomerPortalApiService Purchase Credits Purchase the provided amount of credits at the default expiration and price set by the vendor. This endpoint expects the customer-scoped token for authentication.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return CreditGrant

func (*CustomerPortalApiService) EcpCustomerPortalUrlPost ¶ added in v0.4.9

func (a *CustomerPortalApiService) EcpCustomerPortalUrlPost(ctx context.Context, body CustomerPortalTokenInputArgs) (CustomerPortalUrl, *http.Response, error)

CustomerPortalApiService Generate Customer Portal Url Generate the url to the customer portal. This endpoint expects the vendor API key for authentication.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return CustomerPortalUrl

func (*CustomerPortalApiService) EcpDailyAccruedRevenueGet ¶ added in v0.4.9

func (a *CustomerPortalApiService) EcpDailyAccruedRevenueGet(ctx context.Context) ([]CustomerPortalDailyAccruedRevenue, *http.Response, error)

CustomerPortalApiService Get Daily Accrued Revenue Gets the daily accrued revenue for a customer broken down by line item until the beginning of the current hour.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []CustomerPortalDailyAccruedRevenue

func (*CustomerPortalApiService) EcpFilteredUsagePost ¶ added in v0.4.9

func (a *CustomerPortalApiService) EcpFilteredUsagePost(ctx context.Context, body CustomerPortalMeterLabelFilter) (CustomerPortalUsage, *http.Response, error)

CustomerPortalApiService Compute Filtered Daily Usage Get the customer's daily usage filtered by the inputted meter and labels. This endpoint expects the customer-scoped token for authentication.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return CustomerPortalUsage

func (*CustomerPortalApiService) EcpInvoicesGet ¶ added in v0.4.9

func (a *CustomerPortalApiService) EcpInvoicesGet(ctx context.Context) ([]CustomerPortalInvoice, *http.Response, error)

CustomerPortalApiService Get Invoices Get all invoices visible to the given customer. This endpoint expects the customer-scoped token for authentication.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []CustomerPortalInvoice

func (*CustomerPortalApiService) EcpMetersGet ¶ added in v0.4.9

func (a *CustomerPortalApiService) EcpMetersGet(ctx context.Context) ([]CustomerPortalMeter, *http.Response, error)

CustomerPortalApiService Get Meters and Primary Labels Get the meters and corresponding primary label keys and values from the customer's active subscription.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []CustomerPortalMeter

func (*CustomerPortalApiService) EcpPaymentMethodGet ¶ added in v0.4.9

func (a *CustomerPortalApiService) EcpPaymentMethodGet(ctx context.Context) (CustomerPortalPaymentMethod, *http.Response, error)

CustomerPortalApiService Get Payment Method Get the customer's current payment method if it exists in their payment gateway. This endpoint expects the customer-scoped token for authentication.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return CustomerPortalPaymentMethod

func (*CustomerPortalApiService) EcpPaymentMethodStatusGet ¶ added in v0.4.0

func (a *CustomerPortalApiService) EcpPaymentMethodStatusGet(ctx context.Context) (CustomerPaymentMethodStatus, *http.Response, error)

CustomerPortalApiService Get Payment Method Status Gets the customer's current payment method status. Returns a 400 if the customer has no configuration or if the current payment provider doesn't have customer-level payment status. This endpoint expects the customer-scoped token for authentication.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return CustomerPaymentMethodStatus

func (*CustomerPortalApiService) EcpPortalUrlGet ¶ added in v0.4.9

func (a *CustomerPortalApiService) EcpPortalUrlGet(ctx context.Context) (CustomerPortalUrl, *http.Response, error)

CustomerPortalApiService Get the Customer Portal Url Get the url to the customer portal. This endpoint expects the customer-scoped token for authentication.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return CustomerPortalUrl

func (*CustomerPortalApiService) EcpPricePlansGet ¶ added in v0.4.0

func (a *CustomerPortalApiService) EcpPricePlansGet(ctx context.Context) ([]PricePlan, *http.Response, error)

CustomerPortalApiService Get Self Serve Price Plans Get all price plans visible to the given customer for self serve. By default, no price plans are visible. Price plan visibility can be configured by the vendor using the /price_plans/self_serve endpoint.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []PricePlan

func (*CustomerPortalApiService) EcpSelfServeCustomizationGet ¶ added in v0.4.9

func (a *CustomerPortalApiService) EcpSelfServeCustomizationGet(ctx context.Context) (SelfServeCustomization, *http.Response, error)

CustomerPortalApiService Get Self Serve Customization. Get the customer's self serve customization. This endpoint expects the customer-scoped token for authentication.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return SelfServeCustomization

func (*CustomerPortalApiService) EcpSelfServeSettingsGet ¶ added in v0.4.9

func (a *CustomerPortalApiService) EcpSelfServeSettingsGet(ctx context.Context) (SelfServeSettings, *http.Response, error)

CustomerPortalApiService Get Self Serve Settings. Get the customer's self serve settings. This endpoint expects the customer-scoped token for authentication.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return SelfServeSettings

func (*CustomerPortalApiService) EcpSetupIntentPost ¶ added in v0.4.0

func (a *CustomerPortalApiService) EcpSetupIntentPost(ctx context.Context) (CustomerPortalStripeCredential, *http.Response, error)

CustomerPortalApiService Create SetupIntent Attempt to create a Stripe SetupIntent object. This endpoint expects the customer-scoped token for authentication.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return CustomerPortalStripeCredential

func (*CustomerPortalApiService) EcpSubscriptionDelete ¶ added in v0.4.0

func (a *CustomerPortalApiService) EcpSubscriptionDelete(ctx context.Context) (*http.Response, error)

CustomerPortalApiService Cancel Subscription Cancel the customer's subscription. This endpoint expects the customer-scoped token for authentication.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*CustomerPortalApiService) EcpSubscriptionGet ¶ added in v0.4.0

func (a *CustomerPortalApiService) EcpSubscriptionGet(ctx context.Context) (CustomerPortalSubscription, *http.Response, error)

CustomerPortalApiService Get Price Plan Fetch the customer's active price plan if it exists. This endpoint expects the customer-scoped token for authentication.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return CustomerPortalSubscription

func (*CustomerPortalApiService) EcpSubscriptionPost ¶ added in v0.4.0

func (a *CustomerPortalApiService) EcpSubscriptionPost(ctx context.Context, body CustomerPortalSubscriptionInputArgs) (CustomerPortalSubscription, *http.Response, error)

CustomerPortalApiService Create/Update Subscription Create/update the customer's subscription. This endpoint expects the customer-scoped token for authentication.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return CustomerPortalSubscription

func (*CustomerPortalApiService) EcpTokenPost ¶ added in v0.4.0

func (a *CustomerPortalApiService) EcpTokenPost(ctx context.Context, body CustomerPortalTokenInputArgs) (CustomerPortalToken, *http.Response, error)

CustomerPortalApiService Exchange Access Token Generate a customer-scoped JWT to authorize access to ECP endpoints. This endpoint expects the vendor API key for authentication.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return CustomerPortalToken

func (*CustomerPortalApiService) EcpTotalAccruedRevenueGet ¶ added in v0.4.9

func (a *CustomerPortalApiService) EcpTotalAccruedRevenueGet(ctx context.Context) (CustomerPortalAccruedRevenue, *http.Response, error)

CustomerPortalApiService Get Total Accrued Revenue Gets the total accrued revenue for a customer broken down by line item until the beginning of the current hour.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return CustomerPortalAccruedRevenue

func (*CustomerPortalApiService) EcpUsageGet ¶ added in v0.4.9

func (a *CustomerPortalApiService) EcpUsageGet(ctx context.Context) ([]CustomerPortalUsage, *http.Response, error)

CustomerPortalApiService Get Daily Usage [DEPRECATED] Get the customer's daily usage by meter for current and previous billing cycles. This endpoint expects the customer-scoped token for authentication. Please use /ecp/filtered_usage instead.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []CustomerPortalUsage

func (*CustomerPortalApiService) EcpVendorGet ¶ added in v0.4.9

func (a *CustomerPortalApiService) EcpVendorGet(ctx context.Context) (CustomerPortalVendor, *http.Response, error)

CustomerPortalApiService Get Vendor Information Get relevant information about the customer's vendor. This endpoint expects the customer-scoped token for authentication.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return CustomerPortalVendor

type CustomerPortalCreditPurchase ¶ added in v0.4.9

type CustomerPortalCreditPurchase struct {
	// Number of credits to purchase.
	Amount int32 `json:"amount"`
}

type CustomerPortalDailyAccruedRevenue ¶ added in v0.4.9

type CustomerPortalDailyAccruedRevenue struct {
	// The start time of the billing cycle for which the accrued revenue is computed
	StartTime time.Time                              `json:"start_time,omitempty"`
	LineItems []CustomerPortalAccruedRevenueLineItem `json:"line_items,omitempty"`
	// The end time till when the accured revenue is computed
	EndTime time.Time `json:"end_time,omitempty"`
	// The date for which this accrued revenue is computed
	Date time.Time `json:"date,omitempty"`
	// Total accrued revenue for the day in cents
	TotalAccruedRevenue int32 `json:"total_accrued_revenue,omitempty"`
}

type CustomerPortalInvoice ¶ added in v0.4.9

type CustomerPortalInvoice struct {
	// Information related to the current status of this invoice.
	Status *AllOfCustomerPortalInvoiceStatus `json:"status,omitempty"`
	// Any discount credits applied to the invoice
	DiscountCredit int32 `json:"discount_credit,omitempty"`
	// Earliest start time of line items covered by the invoice
	MinItemStartTime time.Time `json:"min_item_start_time,omitempty"`
	// Url pointing to the pdf of this invoice.
	PdfUrl string `json:"pdf_url,omitempty"`
	// Latest end time of line items covered by the invoice
	MaxItemEndTime time.Time `json:"max_item_end_time,omitempty"`
	// Amount due before any credits are applied
	SubTotal int32 `json:"sub_total,omitempty"`
	// The date the invoice will be issued to the end customer or forwarded to the payment processor.
	IssueDate time.Time `json:"issue_date,omitempty"`
	// False if not paid yet
	IsPaid  bool      `json:"is_paid,omitempty"`
	DueDate time.Time `json:"due_date,omitempty"`
	Id      string    `json:"id,omitempty"`
	// [DEPRECATED] Start time of the cycle in which the invoice was generated
	StartTime time.Time   `json:"start_time,omitempty"`
	LineItems []LineItems `json:"line_items,omitempty"`
	// Total amount due
	AmountDue int32 `json:"amount_due,omitempty"`
	// [DEPRECATED] End time of the cycle in which the invoice was generated
	EndTime time.Time `json:"end_time,omitempty"`
	// Tax amount applied to subtotal
	TaxAmount int32 `json:"tax_amount,omitempty"`
}

type CustomerPortalInvoiceStatus ¶ added in v0.4.9

type CustomerPortalInvoiceStatus struct {
	// The current processing state for this invoice.
	Status       string `json:"status,omitempty"`
	UpdateSource string `json:"update_source,omitempty"`
	// The timestamp that the action will be performed at.
	PendingActionTime time.Time `json:"pending_action_time,omitempty"`
	// The current upcoming action associated with this invoice status, if any.
	Action string `json:"action,omitempty"`
	Error_ string `json:"error,omitempty"`
	// Creation time of this invoice status.
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Time the invoice status was last updated.
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type CustomerPortalLabelDisplayName ¶ added in v0.4.9

type CustomerPortalLabelDisplayName struct {
	DisplayName string `json:"display_name,omitempty"`
	// The raw value of the label data
	Name string `json:"name,omitempty"`
}

type CustomerPortalLabelFilter ¶ added in v0.4.9

type CustomerPortalLabelFilter struct {
	Key string `json:"key,omitempty"`
	// Primary label value associated with the key
	Value string `json:"value,omitempty"`
}

type CustomerPortalMeter ¶ added in v0.4.9

type CustomerPortalMeter struct {
	// Name of the meter.
	MeterName string `json:"meter_name,omitempty"`
	// Type of the meter. E.g. COUNTER or GAUGE.
	MeterType string `json:"meter_type,omitempty"`
	// The raw and prettified label keys and values
	LabelsWithDisplayNames []CustomerPortalMeterLabelsWithDisplayName `json:"labels_with_display_names,omitempty"`
	// Name of the unit the meter uses.
	UnitName string `json:"unit_name,omitempty"`
	// Primary labels with keys and values
	Labels []CustomerPortalMeterLabels `json:"labels,omitempty"`
	// Display name of the meter.
	MeterDisplayName string `json:"meter_display_name,omitempty"`
}

type CustomerPortalMeterLabelFilter ¶ added in v0.4.9

type CustomerPortalMeterLabelFilter struct {
	// The aggregate function to use for the meter.
	Aggregate string `json:"aggregate,omitempty"`
	// Name of the meter.
	MeterName string `json:"meter_name"`
	// Primary labels with keys and values
	LabelFilters []CustomerPortalLabelFilter `json:"label_filters,omitempty"`
	// The label key to group results by.
	LabelGroupBy string `json:"label_group_by,omitempty"`
}

type CustomerPortalMeterLabels ¶ added in v0.4.9

type CustomerPortalMeterLabels struct {
	Key string `json:"key,omitempty"`
	// Primary label values associated with the key
	Values []string `json:"values,omitempty"`
}

type CustomerPortalMeterLabelsWithDisplayName ¶ added in v0.4.9

type CustomerPortalMeterLabelsWithDisplayName struct {
	// Primary label key and prettified version of the key
	Key *AllOfCustomerPortalMeterLabelsWithDisplayNameKey `json:"key,omitempty"`
	// Primary label values associated with the key
	Values []CustomerPortalLabelDisplayName `json:"values,omitempty"`
}

type CustomerPortalPaymentMethod ¶ added in v0.4.9

type CustomerPortalPaymentMethod struct {
	// Info about the customer's card, if that is their payment method.
	CardInfo *AllOfCustomerPortalPaymentMethodCardInfo `json:"card_info,omitempty"`
	// Type of payment method for the customer.
	PaymentMethodType string `json:"payment_method_type,omitempty"`
	// Info about the customer's US bank account, if that is their payment method.
	BankAccountInfo *AllOfCustomerPortalPaymentMethodBankAccountInfo `json:"bank_account_info,omitempty"`
}

type CustomerPortalSettings ¶ added in v0.4.0

type CustomerPortalSettings struct {
	// Comma-separated list of names to filter visible price plans by.
	PricePlanNamesFilter string `json:"price_plan_names_filter,omitempty"`
	// Comma-separated list of tags to filter visible price plans by.
	PricePlanTagsFilter string `json:"price_plan_tags_filter,omitempty"`
}

type CustomerPortalSettingsApiService ¶ added in v0.4.0

type CustomerPortalSettingsApiService service

func (*CustomerPortalSettingsApiService) CustomerPortalSettingsGet ¶ added in v0.4.0

func (a *CustomerPortalSettingsApiService) CustomerPortalSettingsGet(ctx context.Context) (CustomerPortalSettings, *http.Response, error)

CustomerPortalSettingsApiService Get Customer Portal Settings Fetch the Customer Portal settings for your account.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return CustomerPortalSettings

func (*CustomerPortalSettingsApiService) CustomerPortalSettingsPost ¶ added in v0.4.0

func (a *CustomerPortalSettingsApiService) CustomerPortalSettingsPost(ctx context.Context, body UpdateCustomerPortalSettingsInputArgs) (CustomerPortalSettings, *http.Response, error)

CustomerPortalSettingsApiService Update Customer Portal Settings Update Customer Portal settings for your account.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return CustomerPortalSettings

type CustomerPortalStripeCredential ¶ added in v0.4.0

type CustomerPortalStripeCredential struct {
	PublishableKey string `json:"publishable_key,omitempty"`
	AccountId      string `json:"account_id,omitempty"`
	ClientSecret   string `json:"client_secret,omitempty"`
}

type CustomerPortalSubscription ¶ added in v0.4.0

type CustomerPortalSubscription struct {
	PricePlan *PricePlan `json:"price_plan,omitempty"`
}

type CustomerPortalSubscriptionInputArgs ¶ added in v0.4.0

type CustomerPortalSubscriptionInputArgs struct {
	PricePlanName string `json:"price_plan_name,omitempty"`
}

type CustomerPortalToken ¶ added in v0.4.0

type CustomerPortalToken struct {
	Token string `json:"token,omitempty"`
}

type CustomerPortalTokenInputArgs ¶ added in v0.4.0

type CustomerPortalTokenInputArgs struct {
	CustomerName string `json:"customer_name,omitempty"`
}

type CustomerPortalUrl ¶ added in v0.4.9

type CustomerPortalUrl struct {
	Url string `json:"url,omitempty"`
}

type CustomerPortalUsage ¶ added in v0.4.9

type CustomerPortalUsage struct {
	// Name of the meter.
	MeterName string `json:"meter_name,omitempty"`
	// Type of the meter. E.g. COUNTER or GAUGE.
	MeterType string `json:"meter_type,omitempty"`
	// Name of the unit the meter uses.
	UnitName string `json:"unit_name,omitempty"`
	// Daily usage across the previous billing cycle.
	PreviousCycleUsage *AllOfCustomerPortalUsagePreviousCycleUsage `json:"previous_cycle_usage,omitempty"`
	// Daily usage across the current billing cycle.
	CurrentCycleUsage *AllOfCustomerPortalUsageCurrentCycleUsage `json:"current_cycle_usage,omitempty"`
	// Display name of the meter.
	MeterDisplayName string `json:"meter_display_name,omitempty"`
}

type CustomerPortalVendor ¶ added in v0.4.9

type CustomerPortalVendor struct {
	// Currency preference of the Vendor.
	Currency string `json:"currency,omitempty"`
	// Full contact info for the Vendor
	ContactInfo *AllOfCustomerPortalVendorContactInfo `json:"contact_info,omitempty"`
	// Vendor's current payment gateway.
	PaymentGateway string `json:"payment_gateway,omitempty"`
	// Unique name identifier of a Vendor
	Name string `json:"name,omitempty"`
	// Display name for the Vendor
	DisplayName string `json:"display_name,omitempty"`
}

type CustomerStatus ¶

type CustomerStatus struct {
	Status string `json:"status,omitempty"`
}

type CustomerTag ¶ added in v0.4.0

type CustomerTag struct {
	// Supplementary tag that is associated with a customer
	Tag string `json:"tag"`
}

type CustomerUsage ¶ added in v0.2.0

type CustomerUsage struct {
	Usage float64 `json:"usage,omitempty"`
}

type CustomersApiCustomersCustomerNameInvoicesGetOpts ¶ added in v0.2.0

type CustomersApiCustomersCustomerNameInvoicesGetOpts struct {
	ForwardSecondarySortOffset optional.String
	SortDirection              optional.String
	Status                     optional.String
	ForwardSortOffset          optional.String
	Limit                      optional.Int32
	CustomerName               optional.String
	StartTime                  optional.Time
	SortColumn                 optional.String
}

type CustomersApiCustomersCustomerNameRevenueGetOpts ¶

type CustomersApiCustomersCustomerNameRevenueGetOpts struct {
	StartTime optional.Time
	EndTime   optional.Time
}

type CustomersApiCustomersCustomerNameUsageGetOpts ¶ added in v0.2.0

type CustomersApiCustomersCustomerNameUsageGetOpts struct {
	StartTime optional.Time
	MeterName optional.String
	EndTime   optional.Time
}

type CustomersApiService ¶

type CustomersApiService service

func (*CustomersApiService) CustomersCustomerNameAccountingDelete ¶ added in v0.4.9

func (a *CustomersApiService) CustomersCustomerNameAccountingDelete(ctx context.Context, customerName string) (*http.Response, error)

CustomersApiService Delete Accounting Customer Deletes the customer entity tied to your accounting software.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName

func (*CustomersApiService) CustomersCustomerNameAccountingGenerationPost ¶ added in v0.4.9

func (a *CustomersApiService) CustomersCustomerNameAccountingGenerationPost(ctx context.Context, customerName string) (*http.Response, error)

CustomersApiService Create Accounting Customer Create the customer entity tied to your accounting software.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName

func (*CustomersApiService) CustomersCustomerNameAccountingGet ¶ added in v0.4.3

func (a *CustomersApiService) CustomersCustomerNameAccountingGet(ctx context.Context, customerName string) (AccountingCustomer, *http.Response, error)

CustomersApiService Get Accounting Customer ID Get the accounting customer ID of a customer that has been connected via an accounting integration.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName

@return AccountingCustomer

func (*CustomersApiService) CustomersCustomerNameAccountingPost ¶ added in v0.4.3

func (a *CustomersApiService) CustomersCustomerNameAccountingPost(ctx context.Context, body AccountingCustomer, customerName string) (*http.Response, error)

CustomersApiService Connect Accounting Customer Connect an Octane customer to an Accounting customer through the configured Accounting integration. The vendor must have an integration configured.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param customerName

func (*CustomersApiService) CustomersCustomerNameAccruedRevenueGet ¶ added in v0.2.0

func (a *CustomersApiService) CustomersCustomerNameAccruedRevenueGet(ctx context.Context, customerName string) (RevenueBreakdown, *http.Response, error)

CustomersApiService Get Accrued Revenue Get the accrued revenue and invoice line items for the given customer.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName

@return RevenueBreakdown

func (*CustomersApiService) CustomersCustomerNameActiveSubscriptionGet ¶ added in v0.2.0

func (a *CustomersApiService) CustomersCustomerNameActiveSubscriptionGet(ctx context.Context, customerName string) (ActiveSubscription, *http.Response, error)

CustomersApiService Get Active Subscription Get the customer's current active subscription.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName

@return ActiveSubscription

func (*CustomersApiService) CustomersCustomerNameBillingSettingsDelete ¶

func (a *CustomersApiService) CustomersCustomerNameBillingSettingsDelete(ctx context.Context, customerName string) (*http.Response, error)

CustomersApiService Delete Billing Settings Delete billing settings for a customer.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName

func (*CustomersApiService) CustomersCustomerNameBillingSettingsGet ¶

func (a *CustomersApiService) CustomersCustomerNameBillingSettingsGet(ctx context.Context, customerName string) (BillingSettings, *http.Response, error)

CustomersApiService Get Billing Settings Fetch the billing settings for a customer.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName

@return BillingSettings

func (*CustomersApiService) CustomersCustomerNameBillingSettingsPost ¶

func (a *CustomersApiService) CustomersCustomerNameBillingSettingsPost(ctx context.Context, body CustomerBillingSettingsInputArgs, customerName string) (BillingSettings, *http.Response, error)

CustomersApiService Create Billing Settings Create billing settings for a customer.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param customerName

@return BillingSettings

func (*CustomersApiService) CustomersCustomerNameBillingSettingsPut ¶

func (a *CustomersApiService) CustomersCustomerNameBillingSettingsPut(ctx context.Context, body CustomerBillingSettingsInputArgs, customerName string) (BillingSettings, *http.Response, error)

CustomersApiService Update Billing Settings Update billing settings for a customer.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param customerName

@return BillingSettings

func (*CustomersApiService) CustomersCustomerNameCreditTopOffPlanDelete ¶ added in v0.4.9

func (a *CustomersApiService) CustomersCustomerNameCreditTopOffPlanDelete(ctx context.Context, customerName string) (*http.Response, error)

CustomersApiService Delete Customer's Credit Top Off Plan Delete a customer's credit top off plan.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName

func (*CustomersApiService) CustomersCustomerNameCreditTopOffPlanGet ¶ added in v0.4.9

func (a *CustomersApiService) CustomersCustomerNameCreditTopOffPlanGet(ctx context.Context, customerName string) (CreditTopOffPlan, *http.Response, error)

CustomersApiService Get Customer's Credit Top Off Plan Get a customer's credit top off plan.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName

@return CreditTopOffPlan

func (*CustomersApiService) CustomersCustomerNameCreditTopOffPlanPost ¶ added in v0.4.9

func (a *CustomersApiService) CustomersCustomerNameCreditTopOffPlanPost(ctx context.Context, body CreateCreditTopOffPlanInputArgs, customerName string) (CreditTopOffPlan, *http.Response, error)

CustomersApiService Create Customer's Credit Top Off Plan Create a credit top off plan for a customer.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param customerName

@return CreditTopOffPlan

func (*CustomersApiService) CustomersCustomerNameCreditTopOffPlanPut ¶ added in v0.4.9

func (a *CustomersApiService) CustomersCustomerNameCreditTopOffPlanPut(ctx context.Context, body UpdateCreditTopOffPlanInputArgs, customerName string) (CreditTopOffPlan, *http.Response, error)

CustomersApiService Update Customer's Credit Top Off Plan Update a customer's current credit top off plan.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param customerName

@return CreditTopOffPlan

func (*CustomersApiService) CustomersCustomerNameDailyAccruedRevenueGet ¶ added in v0.4.9

func (a *CustomersApiService) CustomersCustomerNameDailyAccruedRevenueGet(ctx context.Context, customerName string) ([]DailyAccruedRevenue, *http.Response, error)

CustomersApiService Get Daily Accrued Revenue Gets the daily accrued revenue for a customer broken down by line item until the beginning of the current hour.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName

@return []DailyAccruedRevenue

func (*CustomersApiService) CustomersCustomerNameDelete ¶

func (a *CustomersApiService) CustomersCustomerNameDelete(ctx context.Context, customerName string) (*http.Response, error)

CustomersApiService Delete Customer Delete a customer by their unique name.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName

func (*CustomersApiService) CustomersCustomerNameDiscountsDelete ¶ added in v0.4.9

func (a *CustomersApiService) CustomersCustomerNameDiscountsDelete(ctx context.Context, body DeleteDiscountInputArgs, customerName string) (*http.Response, error)

CustomersApiService Delete Discount Delete a discount from the customer's current subscription. If the discount started before the start of the current billing cycle, we will expire it by setting it's end date to the start of the current billing cycle. Otherwise, we will delete the discount.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param customerName

func (*CustomersApiService) CustomersCustomerNameDiscountsPost ¶ added in v0.4.9

func (a *CustomersApiService) CustomersCustomerNameDiscountsPost(ctx context.Context, body []DiscountInputArgs, customerName string) (*http.Response, error)

CustomersApiService Add Discounts to a Subscription Add discounts to the list of discounts on the customer's current subscription. The new discounts will be effective_at of the start of the current billing cycle.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param customerName

func (*CustomersApiService) CustomersCustomerNameFeaturesFeatureNameGet ¶ added in v0.2.0

func (a *CustomersApiService) CustomersCustomerNameFeaturesFeatureNameGet(ctx context.Context, customerName string, featureName string) (CustomerFeature, *http.Response, error)

CustomersApiService Get Feature Status Get the details of a feature for a given customer. The feature's status is determined by their subscription first, and by their price plan if no feature overrides are found on the subscription.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName
@param featureName

@return CustomerFeature

func (*CustomersApiService) CustomersCustomerNameGet ¶

func (a *CustomersApiService) CustomersCustomerNameGet(ctx context.Context, customerName string) (Customer, *http.Response, error)

CustomersApiService Get Customer Fetch a customer by their unique name.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName

@return Customer

func (*CustomersApiService) CustomersCustomerNameIntegrationTaxAvalaraAddressValidGet ¶ added in v0.4.9

func (a *CustomersApiService) CustomersCustomerNameIntegrationTaxAvalaraAddressValidGet(ctx context.Context, customerName string) (ValidateAddressResp, *http.Response, error)

CustomersApiService Validate customer address. Validates to ensure that customer address is taxable via Avalara.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName

@return ValidateAddressResp

func (*CustomersApiService) CustomersCustomerNameIntegrationTaxAvalaraSettingsGet ¶ added in v0.4.9

func (a *CustomersApiService) CustomersCustomerNameIntegrationTaxAvalaraSettingsGet(ctx context.Context, customerName string) (CustomerAvalaraSettings, *http.Response, error)

CustomersApiService Get Customer Avalara Settings Returns the customer Avalara settings.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName

@return CustomerAvalaraSettings

func (*CustomersApiService) CustomersCustomerNameIntegrationTaxAvalaraSettingsPut ¶ added in v0.4.9

func (a *CustomersApiService) CustomersCustomerNameIntegrationTaxAvalaraSettingsPut(ctx context.Context, body UpdateCustomerAvalaraSettingsArgs, customerName string) (CustomerAvalaraSettings, *http.Response, error)

CustomersApiService Update customer Avalara settings Updates the Avalara settings for a specific customer.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param customerName

@return CustomerAvalaraSettings

func (*CustomersApiService) CustomersCustomerNameInvoiceInvoiceIdTokenGet ¶

func (a *CustomersApiService) CustomersCustomerNameInvoiceInvoiceIdTokenGet(ctx context.Context, invoiceId int32, token string, customerName string) (ModelError, *http.Response, error)

CustomersApiService Generate Current Invoice Fetch current cycle revenue for a customer and generate an invoice.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param invoiceId
@param token
@param customerName

@return ModelError

func (*CustomersApiService) CustomersCustomerNameInvoicesGet ¶ added in v0.2.0

func (a *CustomersApiService) CustomersCustomerNameInvoicesGet(ctx context.Context, customerName string, localVarOptionals *CustomersApiCustomersCustomerNameInvoicesGetOpts) ([]Invoice, *http.Response, error)

func (*CustomersApiService) CustomersCustomerNameMappingsGet ¶

func (a *CustomersApiService) CustomersCustomerNameMappingsGet(ctx context.Context, customerName string) ([]CustomerMeasurementMapping, *http.Response, error)

CustomersApiService Get Measurement Mappings Fetch all measurement mappings for a specific customer (by unique customer name).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName

@return []CustomerMeasurementMapping

func (*CustomersApiService) CustomersCustomerNameMappingsPost ¶

func (a *CustomersApiService) CustomersCustomerNameMappingsPost(ctx context.Context, body CustomerMeasurementMappingInputArgs, customerName string) (CustomerMeasurementMapping, *http.Response, error)

CustomersApiService Append Measurement Mapping Create a new measurement mapping for a customer. If no value_regex is passed, label existence is checked instead.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param customerName

@return CustomerMeasurementMapping

func (*CustomersApiService) CustomersCustomerNameMetadataGet ¶ added in v0.4.9

func (a *CustomersApiService) CustomersCustomerNameMetadataGet(ctx context.Context, customerName string) ([]CustomerMetadata, *http.Response, error)

CustomersApiService Get All Customer Metadata Get the metadata for a given customer

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName

@return []CustomerMetadata

func (*CustomersApiService) CustomersCustomerNameMetadataPost ¶ added in v0.4.9

func (a *CustomersApiService) CustomersCustomerNameMetadataPost(ctx context.Context, body []CustomerMetadataInput, customerName string) (*http.Response, error)

CustomersApiService Add metadata to a customer Add metadata to a customer (e.g., a tuple of Region: US for a US based customer)

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param customerName

func (*CustomersApiService) CustomersCustomerNamePaymentGatewayCredentialsGet ¶ added in v0.2.0

func (a *CustomersApiService) CustomersCustomerNamePaymentGatewayCredentialsGet(ctx context.Context, customerName string) (PaymentGatewayCredential, *http.Response, error)

CustomersApiService Get PaymentGatewayCredential Get the payment gateway credentials from the vendor's configured payment gateway for the given customer. For example, this endpoint will return a customer's Stripe customer ID, assuming the vendor has integrated with stripe and has configured the given customer with a Stripe customer ID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName

@return PaymentGatewayCredential

func (*CustomersApiService) CustomersCustomerNamePaymentGatewayCredentialsPost ¶

func (a *CustomersApiService) CustomersCustomerNamePaymentGatewayCredentialsPost(ctx context.Context, body CustomerPaymentGatewayCredentialInputArgs, customerName string) (PaymentGatewayCredential, *http.Response, error)

CustomersApiService Add PaymentGatewayCredential Add credentials for a customer's account in the vendor's currently configured payment gateway. For example, this endpoint can be used to associate a customer with a Stripe customer ID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param customerName

@return PaymentGatewayCredential

func (*CustomersApiService) CustomersCustomerNamePaymentMethodStatusGet ¶ added in v0.2.0

func (a *CustomersApiService) CustomersCustomerNamePaymentMethodStatusGet(ctx context.Context, customerName string) (CustomerPaymentMethodStatus, *http.Response, error)

CustomersApiService Get Customer Payment Method Status Fetch payment method status for a specific customer (by unique customer name).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName

@return CustomerPaymentMethodStatus

func (*CustomersApiService) CustomersCustomerNamePut ¶

func (a *CustomersApiService) CustomersCustomerNamePut(ctx context.Context, body UpdateCustomerArgs, customerName string) (Customer, *http.Response, error)

CustomersApiService Update Customer Update a single customer. To update Customer measurement mappings, use the `customers/{customer_name}/mappings` endpoint.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param customerName

@return Customer

func (*CustomersApiService) CustomersCustomerNameRevenueGet ¶

func (a *CustomersApiService) CustomersCustomerNameRevenueGet(ctx context.Context, customerName string, localVarOptionals *CustomersApiCustomersCustomerNameRevenueGetOpts) (RevenueResponse, *http.Response, error)

func (*CustomersApiService) CustomersCustomerNameSampleInvoiceAsOfStrTokenGet ¶ added in v0.4.0

func (a *CustomersApiService) CustomersCustomerNameSampleInvoiceAsOfStrTokenGet(ctx context.Context, asOfStr string, token string, customerName string) (ModelError, *http.Response, error)

CustomersApiService Generate Current Invoice Fetch current cycle revenue for a customer and generate an invoice.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param asOfStr
@param token
@param customerName

@return ModelError

func (*CustomersApiService) CustomersCustomerNameSampleInvoiceTokenGet ¶

func (a *CustomersApiService) CustomersCustomerNameSampleInvoiceTokenGet(ctx context.Context, customerName string, token string) (ModelError, *http.Response, error)

CustomersApiService Generate Current Invoice Fetch current cycle revenue for a customer and generate an invoice.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName
@param token

@return ModelError

func (*CustomersApiService) CustomersCustomerNameScheduledSubscriptionsGet ¶ added in v0.2.0

func (a *CustomersApiService) CustomersCustomerNameScheduledSubscriptionsGet(ctx context.Context, customerName string) ([]Subscription, *http.Response, error)

CustomersApiService Get Scheduled Subscriptions Get a list of any subscriptions scheduled to start in the future for the given customer.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName

@return []Subscription

func (*CustomersApiService) CustomersCustomerNameStatusGet ¶

func (a *CustomersApiService) CustomersCustomerNameStatusGet(ctx context.Context, customerName string) (CustomerStatus, *http.Response, error)

CustomersApiService Get Customer Status Get the current status for a customer.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName

@return CustomerStatus

func (*CustomersApiService) CustomersCustomerNameSubscriptionAddOnsPost ¶ added in v0.4.9

func (a *CustomersApiService) CustomersCustomerNameSubscriptionAddOnsPost(ctx context.Context, body []SubscriptionAddOnItem, customerName string) (*http.Response, error)

CustomersApiService Modify Add Ons on Subscription Add or remove add ons from the current customer's subscription.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param customerName

func (*CustomersApiService) CustomersCustomerNameSubscriptionDelete ¶

func (a *CustomersApiService) CustomersCustomerNameSubscriptionDelete(ctx context.Context, body DeleteSubscriptionArgs, customerName string) (*http.Response, error)

CustomersApiService Delete Subscription Delete a subscription for a specific customer (by customer name).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param customerName

func (*CustomersApiService) CustomersCustomerNameSubscriptionPut ¶

func (a *CustomersApiService) CustomersCustomerNameSubscriptionPut(ctx context.Context, body UpdateSubscriptionArgs, customerName string) (Subscription, *http.Response, error)

CustomersApiService Update Subscription Update a subscription for a specific customer (by customer name).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param customerName

@return Subscription

func (*CustomersApiService) CustomersCustomerNameSubscriptionUpdateInPlacePut ¶ added in v0.4.0

func (a *CustomersApiService) CustomersCustomerNameSubscriptionUpdateInPlacePut(ctx context.Context, body UpdateSubscriptionInPlaceArgs, customerName string) (Subscription, *http.Response, error)

CustomersApiService Update Subscription In-Place Update a subscription in-place for a specific customer (by customer name).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param customerName

@return Subscription

func (*CustomersApiService) CustomersCustomerNameSubscriptionsGet ¶

func (a *CustomersApiService) CustomersCustomerNameSubscriptionsGet(ctx context.Context, customerName string) ([]Subscription, *http.Response, error)

CustomersApiService Get Subscriptions Get all subscriptions for the customer.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName

@return []Subscription

func (*CustomersApiService) CustomersCustomerNameSubscriptionsPost ¶

func (a *CustomersApiService) CustomersCustomerNameSubscriptionsPost(ctx context.Context, body CreateSubscriptionArgs, customerName string) (Subscription, *http.Response, error)

CustomersApiService Create Subscription Create a new subscription for a customer / price plan combination (by unique name).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param customerName

@return Subscription

func (*CustomersApiService) CustomersCustomerNameTotalAccruedRevenueGet ¶ added in v0.4.9

func (a *CustomersApiService) CustomersCustomerNameTotalAccruedRevenueGet(ctx context.Context, customerName string) (AccruedRevenue, *http.Response, error)

CustomersApiService Get Total Accrued Revenue Gets the total accrued revenue for a customer broken down by line item until the beginning of the current hour.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerName

@return AccruedRevenue

func (*CustomersApiService) CustomersCustomerNameUsageAcrossMetersTokenGet ¶ added in v0.4.9

func (a *CustomersApiService) CustomersCustomerNameUsageAcrossMetersTokenGet(ctx context.Context, token string, customerName string, startTime time.Time, endTime time.Time) (*http.Response, error)

CustomersApiService Get Customer's Usage Across Meters Get the usage for a customer across all meters in XLS format for a given time period.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param token
@param customerName
@param startTime
@param endTime

func (*CustomersApiService) CustomersCustomerNameUsageGet ¶ added in v0.2.0

func (a *CustomersApiService) CustomersCustomerNameUsageGet(ctx context.Context, customerName string, localVarOptionals *CustomersApiCustomersCustomerNameUsageGetOpts) (CustomerUsage, *http.Response, error)

func (*CustomersApiService) CustomersGet ¶

func (a *CustomersApiService) CustomersGet(ctx context.Context) ([]Customer, *http.Response, error)

CustomersApiService Get All Customers Retrieve all customers for a given vendor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Customer

func (*CustomersApiService) CustomersPost ¶

func (a *CustomersApiService) CustomersPost(ctx context.Context, body CreateCustomerArgs) (Customer, *http.Response, error)

CustomersApiService Create Customer Create a new customer.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return Customer

type CycleUsage ¶ added in v0.4.9

type CycleUsage struct {
	UsageByTime []AllOfCycleUsageUsageByTimeItems `json:"usage_by_time,omitempty"`
	// Total usage in the cycle.
	TotalUsage int32 `json:"total_usage,omitempty"`
	// The start of the billing cycle in UTC.
	CycleStart time.Time `json:"cycle_start,omitempty"`
	// The end of the billing cycle in UTC.
	CycleEnd time.Time `json:"cycle_end,omitempty"`
}

type DailyAccruedRevenue ¶ added in v0.4.9

type DailyAccruedRevenue struct {
	// The start time of the billing cycle for which the accrued revenue is computed
	StartTime time.Time                `json:"start_time,omitempty"`
	LineItems []AccruedRevenueLineItem `json:"line_items,omitempty"`
	// The end time till when the accured revenue is computed
	EndTime time.Time `json:"end_time,omitempty"`
	// The date for which this accrued revenue is computed
	Date time.Time `json:"date,omitempty"`
	// Total accrued revenue for the day in cents
	TotalAccruedRevenue int32 `json:"total_accrued_revenue,omitempty"`
}

type DailyUsage ¶ added in v0.4.9

type DailyUsage struct {
	// Total usage during this window.
	Usage int32 `json:"usage,omitempty"`
	// Label value. Only present if label_group_by is provided.
	LabelValue string `json:"label_value,omitempty"`
	// Start of the 24 hour time window in UTC.
	Time time.Time `json:"time,omitempty"`
	// Label key. Only present if label_group_by is provided.
	LabelKey string `json:"label_key,omitempty"`
}

type DeleteDiscountInputArgs ¶ added in v0.4.9

type DeleteDiscountInputArgs struct {
	// Number of billing cycles that the discount should expire in. Defaults to 0 (start of current billing cycle). If the inputted discount is scheduled, it is the number of billing cycles relative to the scheduled start. You can only shorten a discount, it is not possible to extend it.
	BillingCycleDuration int32 `json:"billing_cycle_duration,omitempty"`
	// External UUID representing the discount to be deleted.
	DiscountUuid string `json:"discount_uuid"`
}

type DeleteSubscriptionArgs ¶

type DeleteSubscriptionArgs struct {
	VendorId   int32     `json:"vendor_id,omitempty"`
	ExpireAt   time.Time `json:"expire_at,omitempty"`
	CustomerId int32     `json:"customer_id,omitempty"`
	// Boolean that indicates whether to expire the subscription at the end of thebilling cycle. If 'true' and `expire_at` is set, will return an error.
	AtCycleEnd bool `json:"at_cycle_end,omitempty"`
}

type Discount ¶

type Discount struct {
	DiscountType string  `json:"discount_type,omitempty"`
	Amount       float64 `json:"amount,omitempty"`
	// The date when the discount is applied from.
	StartDate time.Time `json:"start_date,omitempty"`
	// The date when the discount ends.
	EndDate time.Time `json:"end_date,omitempty"`
	// Offset in number of billing cycles for when this discount will apply. For example, if set to 1, the discount will apply from the start of the next billing cycle.
	BillingCycleStartOffset int32 `json:"billing_cycle_start_offset,omitempty"`
	// Duration of this discount in number of billing cycles.
	BillingCycleDuration int32 `json:"billing_cycle_duration,omitempty"`
	// The id of coupon associated with this discount, none if discount does not originate from coupon
	CouponId int32 `json:"coupon_id,omitempty"`
	// External facing unique identifier of a price plan
	ExternalUuid string `json:"external_uuid,omitempty"`
	// The scope that this discount covers. One of 'INVOICE_TOTAL', 'ADD_ON', 'METERED_COMPONENT'.
	Scope string `json:"scope"`
	// Add-on this discount covers if scope is ADD_ON.
	AddOn *AllOfDiscountAddOn `json:"add_on,omitempty"`
	// Metered Component this discount covers if scope is METERED_COMPONENT.
	MeteredComponent *AllOfDiscountMeteredComponent `json:"metered_component,omitempty"`
	// Dictionary of labels (key: value) to which the discount applies if scope is METERED_COMPONENT.
	Labels map[string]string `json:"labels,omitempty"`
}

type DiscountInputArgs ¶

type DiscountInputArgs struct {
	DiscountType string `json:"discount_type,omitempty"`
	// For ADD_ON scoped discounts: the name of the add on that the discount covers.
	AddOnName string `json:"add_on_name,omitempty"`
	// Length, in billing cycles, that this discount will be active.
	BillingCycleDuration int32 `json:"billing_cycle_duration,omitempty"`
	// For METERED_COMPONENT scoped discounts: Dictionary of labels (key: value) that the discount covers. The entire set of labels must be provided.
	Labels map[string]string `json:"labels,omitempty"`
	// The scope that this discount covers. One of 'INVOICE_TOTAL', 'ADD_ON', 'METERED_COMPONENT'.
	Scope  string  `json:"scope,omitempty"`
	Amount float64 `json:"amount,omitempty"`
	// Offset, in number of billing cycles, for when this discount will apply. If set to 0, the discount will start applying from the current billing cycle. If set to 1, the discount will start applying from the next billing cycle, etc. For scheduled subscriptions, the offset starts from the initial billing cycle.
	BillingCycleStartOffset int32 `json:"billing_cycle_start_offset,omitempty"`
	// For METERED_COMPONENT scoped discounts: the UUID of the metered component that the discount covers.
	MeteredComponentUuid string `json:"metered_component_uuid,omitempty"`
}

type EntityUseCode ¶ added in v0.4.9

type EntityUseCode struct {
	// Text describing the meaning of this use code.
	Description string `json:"description,omitempty"`
	// The Avalara-recognized entity use code for this definition.
	Code string `json:"code,omitempty"`
	// The name of this entity use code.
	Name string `json:"name,omitempty"`
	// A list of countries where this use code is valid.
	ValidCountries []string `json:"valid_countries,omitempty"`
}

type Feature ¶

type Feature struct {
	Description string `json:"description,omitempty"`
	// Unique name of a feature
	Name        string `json:"name"`
	DisplayName string `json:"display_name,omitempty"`
}

type FeatureInputArgs ¶

type FeatureInputArgs struct {
	DisplayName string `json:"display_name,omitempty"`
	Description string `json:"description,omitempty"`
	Name        string `json:"name"`
}

type FeaturesApiService ¶ added in v0.4.9

type FeaturesApiService service

func (*FeaturesApiService) FeaturesGet ¶ added in v0.4.9

func (a *FeaturesApiService) FeaturesGet(ctx context.Context) ([]Feature, *http.Response, error)

FeaturesApiService Get Features Gets all existing features for a specific vendor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Feature

type GenericSwaggerError ¶

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type Invoice ¶ added in v0.2.0

type Invoice struct {
	// Amount due before any credits are applied
	SubTotal int32 `json:"sub_total,omitempty"`
	// The number of retries done to send the invoice
	InvoiceRetryAttempt int32 `json:"invoice_retry_attempt,omitempty"`
	// False if not approved
	IsApproved bool `json:"is_approved,omitempty"`
	// The potentially permanent state this invoice can live in (e.g., ISSUED if the invoice has been issued to the customer)
	Status                 string    `json:"status,omitempty"`
	LatestInvoiceAttemptAt time.Time `json:"latest_invoice_attempt_at,omitempty"`
	// Earliest start time of line items covered by the invoice
	MinItemStartTime time.Time `json:"min_item_start_time,omitempty"`
	PdfUrl           string    `json:"pdf_url,omitempty"`
	// The number of retries done to process the payment
	PaymentRetryAttempt int32 `json:"payment_retry_attempt,omitempty"`
	// Total amount due
	AmountDue int32 `json:"amount_due,omitempty"`
	// [DEPRECATED] End time of the cycle in which the invoice was generated
	EndTime time.Time `json:"end_time,omitempty"`
	// Latest end time of line items covered by the invoice
	MaxItemEndTime time.Time `json:"max_item_end_time,omitempty"`
	// False if not paid yet
	IsPaid bool `json:"is_paid,omitempty"`
	// External unique 'uuid' identifier for this Invoice.
	Id string `json:"id,omitempty"`
	// Tax amount applied to subtotal
	TaxAmount int32 `json:"tax_amount,omitempty"`
	// Any discount credits applied to the invoice
	DiscountCredit int32 `json:"discount_credit,omitempty"`
	// If there is an error processing this invoice, this field contains the error message.
	StatusError string `json:"status_error,omitempty"`
	// Non-empty string if there was an error while processing payment
	PaymentError string `json:"payment_error,omitempty"`
	// The date the invoice will be issued to the end customer or forwarded to the payment processor.
	IssueDate time.Time `json:"issue_date,omitempty"`
	// Name of the customer this invoice is for.
	CustomerName string    `json:"customer_name,omitempty"`
	DueDate      time.Time `json:"due_date,omitempty"`
	// [DEPRECATED] Start time of the cycle in which the invoice was generated
	StartTime time.Time   `json:"start_time,omitempty"`
	LineItems []LineItems `json:"line_items,omitempty"`
	// False if invoice has not been sent to the customer
	IsInvoiced bool `json:"is_invoiced,omitempty"`
	// Non-empty string if there was an error while sending out invoice
	InvoicingError         string    `json:"invoicing_error,omitempty"`
	LatestPaymentAttemptAt time.Time `json:"latest_payment_attempt_at,omitempty"`
}

type InvoicesApiInvoicesGetOpts ¶ added in v0.4.0

type InvoicesApiInvoicesGetOpts struct {
	ForwardSecondarySortOffset optional.String
	SortDirection              optional.String
	Status                     optional.String
	ForwardSortOffset          optional.String
	Limit                      optional.Int32
	CustomerName               optional.String
	StartTime                  optional.Time
	SortColumn                 optional.String
}

type InvoicesApiService ¶ added in v0.4.0

type InvoicesApiService service

func (*InvoicesApiService) InvoicesGet ¶ added in v0.4.0

func (a *InvoicesApiService) InvoicesGet(ctx context.Context, localVarOptionals *InvoicesApiInvoicesGetOpts) (PastInvoices, *http.Response, error)

func (*InvoicesApiService) InvoicesInvoiceUuidDelete ¶ added in v0.4.9

func (a *InvoicesApiService) InvoicesInvoiceUuidDelete(ctx context.Context, invoiceUuid string) (*http.Response, error)

InvoicesApiService Delete Invoice Delete a specific invoice via it's UUID. Invoices can only be deleted if they have not been issued.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param invoiceUuid

func (*InvoicesApiService) InvoicesInvoiceUuidGet ¶ added in v0.4.9

func (a *InvoicesApiService) InvoicesInvoiceUuidGet(ctx context.Context, invoiceUuid string) (Invoice, *http.Response, error)

InvoicesApiService Get Invoice Get a specific invoice via it's UUID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param invoiceUuid

@return Invoice

func (*InvoicesApiService) InvoicesInvoiceUuidRetriesPost ¶ added in v0.4.9

func (a *InvoicesApiService) InvoicesInvoiceUuidRetriesPost(ctx context.Context, body CreateRetryArgs, invoiceUuid string) (Retry, *http.Response, error)

InvoicesApiService Create Retry Moves the invoice into the next logical action. For example, an invoice that is generated gets moved to issued, and an invoice that is in payment error tries payment again. For more information see our docs https://docs.getoctane.io/docs/manual-invoicing-triggers.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param invoiceUuid

@return Retry

func (*InvoicesApiService) InvoicesInvoiceUuidStatusPost ¶ added in v0.4.9

func (a *InvoicesApiService) InvoicesInvoiceUuidStatusPost(ctx context.Context, invoiceUuid string) (*http.Response, error)

InvoicesApiService Update Invoice Status Manually change the status of an invoice in Octane. For example, if an invoice was paid outside of Octane's payment providers, you can reflect that in Octane by setting the status to paid.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param invoiceUuid

func (*InvoicesApiService) InvoicesInvoiceUuidTokenPdfGet ¶ added in v0.4.3

func (a *InvoicesApiService) InvoicesInvoiceUuidTokenPdfGet(ctx context.Context, invoiceUuidToken string) (ModelError, *http.Response, error)

InvoicesApiService Return Invoice PDF Return the invoice pdf for the given invoice_uuid, first validating token.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param invoiceUuidToken

@return ModelError

type Limit ¶ added in v0.2.0

type Limit struct {
	Feature *Feature `json:"feature"`
	// Limit on feature
	Limit float64 `json:"limit"`
}

type LimitInputArgs ¶

type LimitInputArgs struct {
	Feature *FeatureInputArgs `json:"feature"`
	Limit   float64           `json:"limit,omitempty"`
}

type LineItems ¶ added in v0.2.0

type LineItems struct {
	QuantityUnit string            `json:"quantity_unit,omitempty"`
	Quantity     float64           `json:"quantity,omitempty"`
	Description  string            `json:"description,omitempty"`
	Id           string            `json:"id,omitempty"`
	PriceInt     int32             `json:"price_int,omitempty"`
	StartTime    time.Time         `json:"start_time,omitempty"`
	Metadata     map[string]string `json:"metadata,omitempty"`
	EndTime      time.Time         `json:"end_time,omitempty"`
	Name         string            `json:"name,omitempty"`
	Price        string            `json:"price,omitempty"`
}

type ListCreditGrants ¶ added in v0.4.3

type ListCreditGrants struct {
	// The unique offset to start at when paging forwards
	ForwardSecondarySortOffset string        `json:"forward_secondary_sort_offset,omitempty"`
	SortDirection              string        `json:"sort_direction,omitempty"`
	CreditGrants               []CreditGrant `json:"credit_grants,omitempty"`
	// The sort column offset to start at when paging forwards
	ForwardSortOffset string `json:"forward_sort_offset,omitempty"`
	// The number of items to fetch. Defaults to 10.
	Limit      int32  `json:"limit,omitempty"`
	SortColumn string `json:"sort_column,omitempty"`
}

type ListCreditGrantsArgs ¶ added in v0.4.3

type ListCreditGrantsArgs struct {
	// The unique offset to start at when paging forwards
	ForwardSecondarySortOffset string `json:"forward_secondary_sort_offset,omitempty"`
	SortDirection              string `json:"sort_direction,omitempty"`
	// The sort column offset to start at when paging forwards
	ForwardSortOffset string `json:"forward_sort_offset,omitempty"`
	// The number of items to fetch. Defaults to 10.
	Limit int32 `json:"limit,omitempty"`
	// Customer to filter the results to
	CustomerName string `json:"customer_name,omitempty"`
	SortColumn   string `json:"sort_column,omitempty"`
}

type ListPricePlans ¶ added in v0.4.3

type ListPricePlans struct {
	// The unique offset to start at when paging forwards
	ForwardSecondarySortOffset string `json:"forward_secondary_sort_offset,omitempty"`
	SortDirection              string `json:"sort_direction,omitempty"`
	// The sort column offset to start at when paging forwards
	ForwardSortOffset string `json:"forward_sort_offset,omitempty"`
	// The number of items to fetch. Defaults to 10.
	Limit      int32       `json:"limit,omitempty"`
	PricePlans []PricePlan `json:"price_plans,omitempty"`
	SortColumn string      `json:"sort_column,omitempty"`
}

type LiveMeasurementsApiService ¶ added in v0.4.9

type LiveMeasurementsApiService service

func (*LiveMeasurementsApiService) LiveMeasurementsGet ¶ added in v0.4.9

func (a *LiveMeasurementsApiService) LiveMeasurementsGet(ctx context.Context) (*http.Response, error)

LiveMeasurementsApiService Get Live Measurements Get a list of most recent measurements (maximum of 5000) for a vendor. Optionally filter by customer name.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

type Measurement ¶

type Measurement struct {
	// The unique name of the meter associated with this measurement
	MeterName string `json:"meter_name,omitempty"`
	// The raw value of the measurement
	Value float64 `json:"value"`
	// The name of the customer to associate the measurement with.
	CustomerName string `json:"customer_name,omitempty"`
	// The name of the event associated with this measurement. Events allow for a 1 to many relationship between measurement and meters.
	EventName string `json:"event_name,omitempty"`
	// An ID that is unique for the set of labels and meter_name
	Id string `json:"id,omitempty"`
	// All times are parsed as `ISO-8601` formatted, UTC-based timestamps
	Time time.Time `json:"time,omitempty"`
	// A set of key:value label pairs to supplement a measurement. Each meter defines its own set of primary and/or expected labels.
	Labels map[string]string `json:"labels,omitempty"`
	// Applies to incremental meters and resets the total current value to this new value.
	ResetTotal bool `json:"reset_total,omitempty"`
}

type MeasurementsApiService ¶

type MeasurementsApiService service

func (*MeasurementsApiService) MeasurementsMultiPost ¶

func (a *MeasurementsApiService) MeasurementsMultiPost(ctx context.Context, body []Measurement) ([]Measurement, *http.Response, error)

MeasurementsApiService Send Batched Measurements

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return []Measurement

func (*MeasurementsApiService) MeasurementsPost ¶

func (a *MeasurementsApiService) MeasurementsPost(ctx context.Context, body Measurement) (Measurement, *http.Response, error)

MeasurementsApiService Send Measurement

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return Measurement

type Meter ¶

type Meter struct {
	// Unique name identifier
	Name string `json:"name"`
	// Name of the event associated with this meter
	EventName string `json:"event_name"`
	// Name used for display in UI
	DisplayName string `json:"display_name,omitempty"`
	Description string `json:"description,omitempty"`
	// Whether measurement values are to be considered incremental (versus a running total)
	IsIncremental bool   `json:"is_incremental"`
	MeterType     string `json:"meter_type,omitempty"`
	// The expected unit for the measurement values associated with this meter.
	UnitName       string   `json:"unit_name,omitempty"`
	ExpectedLabels []string `json:"expected_labels,omitempty"`
	PrimaryLabels  []string `json:"primary_labels,omitempty"`
}

type MeterInputArgs ¶

type MeterInputArgs struct {
	MeterType      string   `json:"meter_type,omitempty"`
	UnitName       string   `json:"unit_name,omitempty"`
	Description    string   `json:"description,omitempty"`
	VendorId       int32    `json:"vendor_id,omitempty"`
	EventName      string   `json:"event_name,omitempty"`
	Name           string   `json:"name,omitempty"`
	DisplayName    string   `json:"display_name,omitempty"`
	IsIncremental  bool     `json:"is_incremental,omitempty"`
	ExpectedLabels []string `json:"expected_labels,omitempty"`
	PrimaryLabels  []string `json:"primary_labels,omitempty"`
}

type MeteredComponent ¶

type MeteredComponent struct {
	MeterName        string       `json:"meter_name"`
	MeterDisplayName string       `json:"meter_display_name"`
	PriceScheme      *PriceScheme `json:"price_scheme"`
	// Limit on the usage for the meter.
	Limit       float64                      `json:"limit,omitempty"`
	LabelLimits []MeteredComponentLabelLimit `json:"label_limits"`
	// Name to be used on invoice.
	DisplayName string `json:"display_name,omitempty"`
	// External facing unique identifier of a metered component
	ExternalUuid string `json:"external_uuid,omitempty"`
	// Minimum charge for the metered component
	MinimumCharge int32 `json:"minimum_charge,omitempty"`
	// Minimum charge frequency (as a multiple of the price plan period) for the metered component
	MinimumChargeFrequency int32 `json:"minimum_charge_frequency,omitempty"`
}

type MeteredComponentInputArgs ¶

type MeteredComponentInputArgs struct {
	LabelLimits []MeteredComponentLabelLimitInputArgs `json:"label_limits,omitempty"`
	// Codename of the meter.
	MeterName string `json:"meter_name,omitempty"`
	// Minimum charge frequency (as a multiple of the price plan period) for the metered component
	MinimumChargeFrequency int32 `json:"minimum_charge_frequency,omitempty"`
	// Numeric limit to set on customer usage for the meter.
	Limit       int32                 `json:"limit,omitempty"`
	PriceScheme *PriceSchemeInputArgs `json:"price_scheme,omitempty"`
	Id          int32                 `json:"id,omitempty"`
	MeterId     int32                 `json:"meter_id,omitempty"`
	// Name to be used on invoice.
	DisplayName string `json:"display_name,omitempty"`
	// Minimum charge for the metered component
	MinimumCharge int32 `json:"minimum_charge,omitempty"`
}

type MeteredComponentLabelLimit ¶ added in v0.4.3

type MeteredComponentLabelLimit struct {
	// Dictionary of labels (key: value) to which the limit applies. A value of 'any' will apply the limit to any single value of the field.
	Labels map[string]string `json:"labels"`
	// Numeric limit set on the labels.
	Limit float64 `json:"limit"`
}

type MeteredComponentLabelLimitInputArgs ¶ added in v0.4.3

type MeteredComponentLabelLimitInputArgs struct {
	// Numeric limit to set on customer usage for the meter with the given labels.
	Limit float64 `json:"limit"`
	// Dictionary of labels (key: value) to which the limit applies. A value of 'any' will apply the limit to any single value of the field.
	Labels map[string]string `json:"labels"`
}

type MetersApiService ¶

type MetersApiService service

func (*MetersApiService) MetersGet ¶

func (a *MetersApiService) MetersGet(ctx context.Context) ([]Meter, *http.Response, error)

MetersApiService Get Meters Get all meters for a given vendor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Meter

func (*MetersApiService) MetersMeterNameArchivePost ¶ added in v0.4.0

func (a *MetersApiService) MetersMeterNameArchivePost(ctx context.Context, meterName string) (*http.Response, error)

MetersApiService Archive Meter Update a meter by its unique name.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param meterName

func (*MetersApiService) MetersMeterNameDelete ¶

func (a *MetersApiService) MetersMeterNameDelete(ctx context.Context, meterName string) (*http.Response, error)

MetersApiService Delete Meter Delete a meter by its unique name. Meters can only be deleted if not in-use by a price plan.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param meterName

func (*MetersApiService) MetersMeterNameGet ¶

func (a *MetersApiService) MetersMeterNameGet(ctx context.Context, meterName string) (Meter, *http.Response, error)

MetersApiService Get Meter Get a meter by its unique name.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param meterName

@return Meter

func (*MetersApiService) MetersMeterNamePut ¶

func (a *MetersApiService) MetersMeterNamePut(ctx context.Context, body UpdateMeterArgs, meterName string) (Meter, *http.Response, error)

MetersApiService Update Meter Update a meter by its unique name.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param meterName

@return Meter

func (*MetersApiService) MetersPost ¶

func (a *MetersApiService) MetersPost(ctx context.Context, body MeterInputArgs) (Meter, *http.Response, error)

MetersApiService Create Meter Create a new meter for a given vendor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return Meter

type ModelError ¶

type ModelError struct {
	// Error name
	Status string `json:"status,omitempty"`
	// Errors
	Errors *interface{} `json:"errors,omitempty"`
	// Error code
	Code int32 `json:"code,omitempty"`
	// Error message
	Message string `json:"message,omitempty"`
}

type PastInvoice ¶ added in v0.4.0

type PastInvoice struct {
	Status       string    `json:"status,omitempty"`
	IssueDate    time.Time `json:"issue_date,omitempty"`
	CustomerName string    `json:"customer_name,omitempty"`
	DueDate      time.Time `json:"due_date,omitempty"`
	AmountDue    float64   `json:"amount_due,omitempty"`
	// External unique 'uuid' identifier for this Invoice.
	Id                string `json:"id,omitempty"`
	StatusDescription string `json:"status_description,omitempty"`
	ExportUrl         string `json:"export_url,omitempty"`
}

type PastInvoices ¶ added in v0.4.0

type PastInvoices struct {
	// The unique offset to start at when paging forwards
	ForwardSecondarySortOffset string `json:"forward_secondary_sort_offset,omitempty"`
	SortDirection              string `json:"sort_direction,omitempty"`
	// The sort column offset to start at when paging forwards
	ForwardSortOffset string        `json:"forward_sort_offset,omitempty"`
	Invoices          []PastInvoice `json:"invoices,omitempty"`
	// The number of items to fetch. Defaults to 10.
	Limit      int32  `json:"limit,omitempty"`
	SortColumn string `json:"sort_column,omitempty"`
}

type PaymentGatewayCredential ¶

type PaymentGatewayCredential struct {
	PaymentGateway string `json:"payment_gateway,omitempty"`
	// Payment gateway account id associated with customer
	AccountId string `json:"account_id"`
	// Unique name identifier of a customer
	AuthToken string `json:"auth_token,omitempty"`
}

type PaymentGatewayCredentialApiService ¶

type PaymentGatewayCredentialApiService service

func (*PaymentGatewayCredentialApiService) PaymentGatewayCredentialsGet ¶ added in v0.2.0

func (a *PaymentGatewayCredentialApiService) PaymentGatewayCredentialsGet(ctx context.Context) (PaymentGatewayCredential, *http.Response, error)

PaymentGatewayCredentialApiService Get PaymentGatewayCredential Returns the payment gateway information for your account (the Paddle or Stripe credentials used to issue and pay invoices)

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return PaymentGatewayCredential

func (*PaymentGatewayCredentialApiService) PaymentGatewayCredentialsPost ¶

func (a *PaymentGatewayCredentialApiService) PaymentGatewayCredentialsPost(ctx context.Context, body PaymentGatewayCredentialInputArgs) (PaymentGatewayCredential, *http.Response, error)

PaymentGatewayCredentialApiService Add PaymentGatewayCredential Adds the credentials for a payment gateway, to be used to issue and pay invoices to your account.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return PaymentGatewayCredential

type PaymentGatewayCredentialInputArgs ¶

type PaymentGatewayCredentialInputArgs struct {
	PaymentGateway string `json:"payment_gateway,omitempty"`
	AuthToken      string `json:"auth_token,omitempty"`
	AccountId      string `json:"account_id,omitempty"`
}

type PriceInputArgs ¶

type PriceInputArgs struct {
	Cap         float64 `json:"cap,omitempty"`
	Description string  `json:"description,omitempty"`
	Price       float64 `json:"price,omitempty"`
}

type PricePlan ¶

type PricePlan struct {
	// External facing unique identifier of a price plan
	ExternalUuid string `json:"external_uuid,omitempty"`
	// Unique name indentifier of a price plan
	Name string `json:"name"`
	// UI-friendly name used for data display. Defaults to `name`.
	DisplayName string `json:"display_name,omitempty"`
	Description string `json:"description,omitempty"`
	// Lowest denomination of currency. e.g. USD is represented as cents.
	BasePrice          float64 `json:"base_price,omitempty"`
	BasePriceFrequency int32   `json:"base_price_frequency,omitempty"`
	// Custom invoice description for the base price line item.
	BasePriceDescription string `json:"base_price_description,omitempty"`
	// Time period that defines the length of a price plan cycle. One of `day`, `week`, `month`, `quarter`, or `year`.
	Period            string             `json:"period"`
	MeteredComponents []MeteredComponent `json:"metered_components"`
	// Minimum amount to charge every 'period'
	MinimumCharge int32 `json:"minimum_charge,omitempty"`
	// The frequency (as a an integer multiple of the period) at which to charge the minimum charge.
	MinimumChargeFrequency int32          `json:"minimum_charge_frequency,omitempty"`
	Features               []Feature      `json:"features,omitempty"`
	AddOns                 []AddOn        `json:"add_ons,omitempty"`
	Limits                 []Limit        `json:"limits,omitempty"`
	Tags                   []PricePlanTag `json:"tags,omitempty"`
	Trial                  *Trial         `json:"trial,omitempty"`
	// ISO-8601 formatted creation timestamp of price plan version
	CreatedAt time.Time `json:"created_at,omitempty"`
}

type PricePlan1 ¶

type PricePlan1 struct {
	// Unique name indentifier of a price plan
	Name string `json:"name"`
}

type PricePlanTag ¶

type PricePlanTag struct {
	// Supplementary tag label that is associated with a specific version of a price plan
	Tag string `json:"tag"`
}

type PricePlansApiPricePlansPaginateGetOpts ¶ added in v0.4.3

type PricePlansApiPricePlansPaginateGetOpts struct {
	ForwardSecondarySortOffset optional.String
	SortDirection              optional.String
	ForwardSortOffset          optional.String
	Tags                       optional.Interface
	Limit                      optional.Int32
	Names                      optional.Interface
	SortColumn                 optional.String
}

type PricePlansApiService ¶

type PricePlansApiService service

func (*PricePlansApiService) PricePlansGet ¶

func (a *PricePlansApiService) PricePlansGet(ctx context.Context) ([]PricePlan, *http.Response, error)

PricePlansApiService Get All Price Plans Get all price plans associated with a vendor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []PricePlan

func (*PricePlansApiService) PricePlansMeteredComponentsUuidUpdateLimitsPost ¶ added in v0.4.9

func (a *PricePlansApiService) PricePlansMeteredComponentsUuidUpdateLimitsPost(ctx context.Context, body UpdateMeteredComponentLimitsInput, uuid string) (MeteredComponent, *http.Response, error)

PricePlansApiService Update Metered Component Limits Update metered component usage limits in place

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param uuid

@return MeteredComponent

func (*PricePlansApiService) PricePlansPaginateGet ¶ added in v0.4.3

func (a *PricePlansApiService) PricePlansPaginateGet(ctx context.Context, localVarOptionals *PricePlansApiPricePlansPaginateGetOpts) (ListPricePlans, *http.Response, error)

func (*PricePlansApiService) PricePlansPost ¶

func (a *PricePlansApiService) PricePlansPost(ctx context.Context, body CreatePricePlanArgs) (PricePlan, *http.Response, error)

PricePlansApiService Create Price Plan Create a price plan for a vendor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return PricePlan

func (*PricePlansApiService) PricePlansPricePlanNameArchivePost ¶ added in v0.4.0

func (a *PricePlansApiService) PricePlansPricePlanNameArchivePost(ctx context.Context, pricePlanName string) (*http.Response, error)

PricePlansApiService Archive Price Plan Archive a price plan that has no active/scheduled subscription.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param pricePlanName

func (*PricePlansApiService) PricePlansPricePlanNameDelete ¶

func (a *PricePlansApiService) PricePlansPricePlanNameDelete(ctx context.Context, pricePlanName string) (*http.Response, error)

PricePlansApiService Delete Price Plan Delete an existing Price Plan. Price Plans which map to active Subscriptions must be replaced or removed before deletion can occur.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param pricePlanName

func (*PricePlansApiService) PricePlansPricePlanNameGet ¶

func (a *PricePlansApiService) PricePlansPricePlanNameGet(ctx context.Context, pricePlanName string) (PricePlan, *http.Response, error)

PricePlansApiService Get a Price Plan Fetch an existing price plan.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param pricePlanName

@return PricePlan

func (*PricePlansApiService) PricePlansPricePlanNamePut ¶

func (a *PricePlansApiService) PricePlansPricePlanNamePut(ctx context.Context, body UpdatePricePlanArgs, pricePlanName string) (PricePlan, *http.Response, error)

PricePlansApiService Update a Price Plan Update an existing price plan.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param pricePlanName

@return PricePlan

func (*PricePlansApiService) PricePlansPricePlanNameTagGet ¶ added in v0.4.3

func (a *PricePlansApiService) PricePlansPricePlanNameTagGet(ctx context.Context, pricePlanName string, tag string) (PricePlan, *http.Response, error)

PricePlansApiService Get a Price Plan Get an existing price plan.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param pricePlanName
@param tag

@return PricePlan

func (*PricePlansApiService) PricePlansSelfServeGet ¶ added in v0.4.9

func (a *PricePlansApiService) PricePlansSelfServeGet(ctx context.Context) ([]PricePlan, *http.Response, error)

PricePlansApiService Get All Self Serve Price Plans Get all price plans marked for self serve for this vendor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []PricePlan

func (*PricePlansApiService) PricePlansSelfServePost ¶ added in v0.4.9

func (a *PricePlansApiService) PricePlansSelfServePost(ctx context.Context, body SelfServePricePlansInputArgs) (*http.Response, error)

PricePlansApiService Set Self Serve Price Plans Set the exhaustive list of price plans that the customer can see and select via self serve.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*PricePlansApiService) PricePlansUpdateInPlacePricePlanNamePost ¶ added in v0.4.0

func (a *PricePlansApiService) PricePlansUpdateInPlacePricePlanNamePost(ctx context.Context, body UpdatePricePlanInPlaceArgs, pricePlanName string) (PricePlan, *http.Response, error)

PricePlansApiService Update Price Plan In Place Edit a price plan without creating a new version.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param pricePlanName

@return PricePlan

func (*PricePlansApiService) PricePlansUpdateInPlacePricePlanNameTagPost ¶ added in v0.4.0

func (a *PricePlansApiService) PricePlansUpdateInPlacePricePlanNameTagPost(ctx context.Context, body UpdatePricePlanInPlaceArgs, pricePlanName string, tag string) (PricePlan, *http.Response, error)

PricePlansApiService Update Price Plan In Place Edit a price plan without creating a new version.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param pricePlanName
@param tag

@return PricePlan

func (*PricePlansApiService) PricePlansUuidAddAddOnsPost ¶ added in v0.4.9

func (a *PricePlansApiService) PricePlansUuidAddAddOnsPost(ctx context.Context, body AddAddOnsToPricePlanInput, uuid string) (PricePlan, *http.Response, error)

PricePlansApiService Add AddOns Add add ons to price plan in place

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param uuid

@return PricePlan

func (*PricePlansApiService) PricePlansUuidAddFeaturesPost ¶ added in v0.4.9

func (a *PricePlansApiService) PricePlansUuidAddFeaturesPost(ctx context.Context, body AddFeaturesToPricePlanInput, uuid string) (PricePlan, *http.Response, error)

PricePlansApiService Add features and limits Add features and(or) limits to a price plan in place

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param uuid

@return PricePlan

func (*PricePlansApiService) PricePlansUuidAddMeteredComponentsPost ¶ added in v0.4.9

func (a *PricePlansApiService) PricePlansUuidAddMeteredComponentsPost(ctx context.Context, body AddMeteredComponentsToPricePlanInput, uuid string) (PricePlan, *http.Response, error)

PricePlansApiService Add Metered Components Add metered components to price plan in place

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param uuid

@return PricePlan

func (*PricePlansApiService) PricePlansUuidRemoveFeaturesPost ¶ added in v0.4.9

func (a *PricePlansApiService) PricePlansUuidRemoveFeaturesPost(ctx context.Context, body RemoveFeaturesFromPricePlanInput, uuid string) (PricePlan, *http.Response, error)

PricePlansApiService Remove features and limits Remove features and(or) limits from a price plan in place

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param uuid

@return PricePlan

type PriceScheme ¶

type PriceScheme struct {
	DisplayName string `json:"display_name,omitempty"`
	Name        string `json:"name,omitempty"`
	SchemeType  string `json:"scheme_type,omitempty"`
	// Size of the unit batch to use for the prices. Can only be set if scheme_type='FLAT' or 'TIERED'. E.g. To charge $10 per 100 API Requests, set batch_size to 100.
	BatchSize int32 `json:"batch_size,omitempty"`
	// Array of price tiers, each of which consists of `price` and `cap` key:value pairs
	Prices []PriceTier `json:"prices,omitempty"`
	// Array of (key, value) meter labels to price on & the price tiers that should be used against those labels
	PriceList    []interface{} `json:"price_list,omitempty"`
	TimeUnitName string        `json:"time_unit_name,omitempty"`
	UnitName     string        `json:"unit_name,omitempty"`
	// The % increase/decrease in price after the minimum charge is reached.
	PostMinimumChargePercentageChange float64 `json:"post_minimum_charge_percentage_change,omitempty"`
}

type PriceSchemeInputArgs ¶

type PriceSchemeInputArgs struct {
	// The name of the unit used for this metered component (e.g., gigabyte)
	UnitName string `json:"unit_name,omitempty"`
	// The % increase/decrease in price after the minimum charge is reached (e.g., 25.5 -> 25.5% increase).
	PostMinimumChargePercentageChange float64 `json:"post_minimum_charge_percentage_change,omitempty"`
	// Array of (key, value) meter labels to price on & the price tiers that should be used against those labels
	PriceList []interface{} `json:"price_list,omitempty"`
	// The time unit for the metered component (e.g., month or hour)
	TimeUnitName string `json:"time_unit_name,omitempty"`
	// One of 'FLAT', 'TIERED', or 'STAIRSTEP'
	SchemeType string `json:"scheme_type"`
	// Array of price tiers, each of which consists of `price` and `cap` key:value pairs
	Prices []PriceInputArgs `json:"prices,omitempty"`
	// Size of the unit batch to use for the prices. Can only be set if scheme_type='FLAT' or 'TIERED'. E.g. To charge $10 per 100 API Requests, set batch_size to 100.
	BatchSize int32 `json:"batch_size,omitempty"`
}

type PriceTier ¶

type PriceTier struct {
	// Cap of the tier, meaning that any subsequent usage will be bucketed into the following tier. If cap is undefined, it is effectively treated as Infinity.
	Cap float64 `json:"cap,omitempty"`
	// The line item description to use if usage falls in this tier.
	Description string `json:"description,omitempty"`
	// The price (in lowest currency denomination by which to charge, given that the usage is within the cap range.
	Price float64 `json:"price"`
}

type Refund ¶ added in v0.4.3

type Refund struct {
	Success bool `json:"success,omitempty"`
}

type RefundApiService ¶ added in v0.4.3

type RefundApiService service

func (*RefundApiService) RefundPost ¶ added in v0.4.3

func (a *RefundApiService) RefundPost(ctx context.Context, body CreateRefundArgs) (Refund, *http.Response, error)

RefundApiService Create Refund Create a refund for a paid invoice.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return Refund

type RemoveFeaturesFromPricePlanInput ¶ added in v0.4.9

type RemoveFeaturesFromPricePlanInput struct {
	// List of feature names to remove
	FeatureNames []string `json:"feature_names"`
}

type Retry ¶ added in v0.4.9

type Retry struct {
	Success bool `json:"success,omitempty"`
}

type RevenueBreakdown ¶ added in v0.2.0

type RevenueBreakdown struct {
	TotalRevenue float64     `json:"total_revenue,omitempty"`
	LineItems    []LineItems `json:"line_items,omitempty"`
}

type RevenueRecognitionApiService ¶ added in v0.4.9

type RevenueRecognitionApiService service

func (*RevenueRecognitionApiService) RecognizedRevenuePost ¶ added in v0.4.9

func (a *RevenueRecognitionApiService) RecognizedRevenuePost(ctx context.Context, body RevenueRecognitionInput) ([]RevenueRecognitionEntry, *http.Response, error)

RevenueRecognitionApiService Compute monthly recognized revenue Compute monthly recognized revenue

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return []RevenueRecognitionEntry

type RevenueRecognitionEntry ¶ added in v0.4.9

type RevenueRecognitionEntry struct {
	// The newly booked amount in this month (in cents).
	Booked int32 `json:"booked,omitempty"`
	// The month in which the revenue is booked and(or) recognized.
	Month time.Time `json:"month,omitempty"`
	// The change in deferred revenue this month (in cents).
	Deferred int32 `json:"deferred,omitempty"`
	// The change in recognized revenue this month (in cents).
	Recognized int32 `json:"recognized,omitempty"`
}

type RevenueRecognitionInput ¶ added in v0.4.9

type RevenueRecognitionInput struct {
	// List of customer names for which to compute booked/recognized revenue.
	CustomerNames []string `json:"customer_names,omitempty"`
}

type RevenueResponse ¶

type RevenueResponse struct {
	Revenue float64 `json:"revenue,omitempty"`
}

type RollApiKeyArgs ¶ added in v0.4.9

type RollApiKeyArgs struct {
	// The date at which this API key will expire. Will default to 7 days.
	ExpiresAt time.Time `json:"expires_at,omitempty"`
	// The API key you want to roll.
	ApiKey string `json:"api_key"`
}

type RollApiKeys ¶ added in v0.4.9

type RollApiKeys struct {
	Success bool `json:"success,omitempty"`
	// The newly generated API Key.
	ApiKey string `json:"api_key,omitempty"`
}

type SelfServeCustomization ¶ added in v0.4.9

type SelfServeCustomization struct {
	// Dictionary of customization settings as key value pairs.
	Settings map[string]string `json:"settings"`
}

type SelfServePricePlansInputArgs ¶ added in v0.4.9

type SelfServePricePlansInputArgs struct {
	PricePlanUuids []string `json:"price_plan_uuids,omitempty"`
}

type SelfServeSettings ¶ added in v0.4.9

type SelfServeSettings struct {
	// True if the customer can purchase credits via self serve. Defaults to False.
	PurchaseCredits bool `json:"purchase_credits"`
	// Time length of the default expiration for credits bought in the customer portal.
	CreditsExpirationLength int32 `json:"credits_expiration_length,omitempty"`
	// Time length unit for the default expiration for credits bought in the customer portal.
	CreditsExpirationUnit string `json:"credits_expiration_unit,omitempty"`
	// Price per credit, in cents, that the customer is charged for buying credits through the customer portal
	PricePerCreditCents int32 `json:"price_per_credit_cents,omitempty"`
	// True if the customer can switch their current price plan via self serve. Defaults to False.
	SwitchPricePlans bool `json:"switch_price_plans"`
	// True if the vendor has enabled customization for their customer portal.
	Customization bool `json:"customization,omitempty"`
}

type SelfServeSettingsApiService ¶ added in v0.4.9

type SelfServeSettingsApiService service

func (*SelfServeSettingsApiService) SelfServeSettingsCustomizationGet ¶ added in v0.4.9

func (a *SelfServeSettingsApiService) SelfServeSettingsCustomizationGet(ctx context.Context) (SelfServeCustomization, *http.Response, error)

SelfServeSettingsApiService Get Vendor Customization for Self Serve Get the customization settings for the vendor's customer portal.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return SelfServeCustomization

func (*SelfServeSettingsApiService) SelfServeSettingsCustomizationPost ¶ added in v0.4.9

func (a *SelfServeSettingsApiService) SelfServeSettingsCustomizationPost(ctx context.Context, body SelfServeCustomization) (SelfServeCustomization, *http.Response, error)

SelfServeSettingsApiService Create Vendor Customization for Self Serve Create the customization settings for the vendor's customer portal.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return SelfServeCustomization

func (*SelfServeSettingsApiService) SelfServeSettingsCustomizationPut ¶ added in v0.4.9

func (a *SelfServeSettingsApiService) SelfServeSettingsCustomizationPut(ctx context.Context, body SelfServeCustomization) (SelfServeCustomization, *http.Response, error)

SelfServeSettingsApiService Update Vendor Customization for Self Serve Update the customization settings for the vendor's customer portal.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return SelfServeCustomization

func (*SelfServeSettingsApiService) SelfServeSettingsGet ¶ added in v0.4.9

func (a *SelfServeSettingsApiService) SelfServeSettingsGet(ctx context.Context) (SelfServeSettings, *http.Response, error)

SelfServeSettingsApiService Get Vendor Self Serve Settings Get self serve settings for a vendor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return SelfServeSettings

func (*SelfServeSettingsApiService) SelfServeSettingsPost ¶ added in v0.4.9

func (a *SelfServeSettingsApiService) SelfServeSettingsPost(ctx context.Context, body UpdateSelfServeSettingsArgs) (SelfServeSettings, *http.Response, error)

SelfServeSettingsApiService Create Vendor Self Serve Settings Create the self serve settings for a vendor. If partial fields are given, we will fallback on default values.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return SelfServeSettings

func (*SelfServeSettingsApiService) SelfServeSettingsPut ¶ added in v0.4.9

func (a *SelfServeSettingsApiService) SelfServeSettingsPut(ctx context.Context, body UpdateSelfServeSettingsArgs) (SelfServeSettings, *http.Response, error)

SelfServeSettingsApiService Update Vendor Self Serve Settings. Update the self serve settings for a vendor. If partial fields are given, we will only update the provided fields.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return SelfServeSettings

type Subscription ¶

type Subscription struct {
	Uuid string `json:"uuid"`
	// Unique name identifier of a customer
	CustomerName string `json:"customer_name"`
	// Unique name indentifier of a price plan
	PricePlanName string `json:"price_plan_name"`
	// Price plan associated with this subscription.
	PricePlan *AllOfSubscriptionPricePlan `json:"price_plan,omitempty"`
	// Align billing cycles to a calendar unit if true. For example if the period is month, cycles will end on the first of every month.
	AlignToCalendar bool                              `json:"align_to_calendar,omitempty"`
	Discounts       []AllOfSubscriptionDiscountsItems `json:"discounts,omitempty"`
	AddOns          AddOn                             `json:"add_ons,omitempty"`
	// Optional trial override for the associated subscription.
	TrialOverride *AllOfSubscriptionTrialOverride `json:"trial_override,omitempty"`
	// Optional base price override for the associated subscription.
	BasePriceOverride float64   `json:"base_price_override,omitempty"`
	FeaturesOverride  []Feature `json:"features_override,omitempty"`
	LimitsOverride    []Limit   `json:"limits_override,omitempty"`
	// ISO-8601 formatted timestamp that defines when the subscription should take effect. If this field is omitted, the subscription is effective upon creation.
	EffectiveAt time.Time `json:"effective_at,omitempty"`
	// ISO-8601 formatted timestamp that defines when the subscription will expire.
	ExpiredAt time.Time `json:"expired_at,omitempty"`
}

type SubscriptionAddOnInput ¶ added in v0.4.0

type SubscriptionAddOnInput struct {
	// Override for the add-on price on this subscription.
	Price    float64 `json:"price,omitempty"`
	Name     string  `json:"name"`
	Quantity int32   `json:"quantity,omitempty"`
}

type SubscriptionAddOnItem ¶ added in v0.4.9

type SubscriptionAddOnItem struct {
	// Boolean that indicates whether to update the subscription add on at the start of the billing cycle. If 'true' and either of `effective_at` or `at_cycle_end` are set, will return an error.
	AtCycleStart bool `json:"at_cycle_start,omitempty"`
	// Boolean that indicates whether to update the subscription add on at the end of the billing cycle. If 'true' and either of `effective_at` or `at_cycle_start` are set, will return an error.
	AtCycleEnd bool `json:"at_cycle_end,omitempty"`
	// Quantity represents how many of this add on you want to attach to the subscription. Can be positive forincreasing the number of this add on or negative for decreasing.
	Quantity    int32     `json:"quantity,omitempty"`
	EffectiveAt time.Time `json:"effective_at,omitempty"`
	FeatureName string    `json:"feature_name,omitempty"`
}

type TaxCode ¶ added in v0.4.9

type TaxCode struct {
	// A friendly description of this tax code.
	Description string `json:"description,omitempty"`
	// The unique ID number of this tax code.
	Id string `json:"id,omitempty"`
	// The type of this tax code.
	TaxCodeTypeId string `json:"tax_code_type_id,omitempty"`
	// The Avalara Entity Use Code represented by this tax code.
	EntityUseCode string `json:"entity_use_code,omitempty"`
	// A code string that identifies this tax code.
	TaxCode string `json:"tax_code,omitempty"`
}

type Trial ¶

type Trial struct {
	TimeLength   float64 `json:"time_length,omitempty"`
	TimeUnitName string  `json:"time_unit_name,omitempty"`
	Credit       int32   `json:"credit,omitempty"`
}

type TrialInputArgs ¶

type TrialInputArgs struct {
	Credit       float64 `json:"credit,omitempty"`
	TimeLength   float64 `json:"time_length,omitempty"`
	TimeUnitName string  `json:"time_unit_name,omitempty"`
}

type UpdateBillingSettingsInputArgs ¶

type UpdateBillingSettingsInputArgs struct {
	// Optional description attached to the invoice
	InvoiceMemo string `json:"invoice_memo,omitempty"`
	// Account name for ACH/Wire transfer instructions
	AchAccountName string `json:"ach_account_name,omitempty"`
	// Time length after which to attempt invoice/payment retry.
	RetryFrequencyLength int32 `json:"retry_frequency_length,omitempty"`
	// Flag that controls whether to do automated taxes via payment provider
	TaxViaPaymentProvider bool `json:"tax_via_payment_provider,omitempty"`
	// Time length unit of the grace period between the end of a billing cycle and invoice generation. Must be `day`.
	InvoiceGracePeriodUnit string `json:"invoice_grace_period_unit,omitempty"`
	// Flag that controls whether or not to invoice/charge gauge meters upfront according to their value at start of cycle. Only applies if invoice_fixed_components_at_start is enabled.
	InvoiceMeteredComponentsAtStart bool `json:"invoice_metered_components_at_start,omitempty"`
	// Flag that controls whether or not to auto-charge the customer based on the invoice.
	ChargesEnabled bool `json:"charges_enabled,omitempty"`
	// Flag that controls the number of retry attempts for invoicing/payments.
	RetryAttempts int32 `json:"retry_attempts,omitempty"`
	// Sets the due date on invoices to the number of days after the invoice is sent
	DaysUntilDue int32 `json:"days_until_due,omitempty"`
	// Default value for whether to align billing cycles to calendar on subscriptions
	AlignBillingCyclesToCalendar bool `json:"align_billing_cycles_to_calendar,omitempty"`
	// Bank name for ACH/Wire transfer instructions
	AchBankName string `json:"ach_bank_name,omitempty"`
	// Time length unit after which to attempt invoice/payment retry.
	RetryFrequencyUnit string `json:"retry_frequency_unit,omitempty"`
	// If using Stripe, this field can be used to configure whether invoices should be finalized immediately when they are created.
	StripeImmediateFinalization bool `json:"stripe_immediate_finalization,omitempty"`
	// Time length of the grace period between the end of a billing cycle and invoice generation in days.
	InvoiceGracePeriodLength int32 `json:"invoice_grace_period_length,omitempty"`
	// Swift code for ACH/Wire transfer instructions
	AchSwiftCode string `json:"ach_swift_code,omitempty"`
	// Time length unit of the grace period between the end of invoice generation and actual charge. One of `minute`, `hour`, `day`.
	PaymentGracePeriodUnit string `json:"payment_grace_period_unit,omitempty"`
	// The percentage tax rate to apply to invoices.
	TaxRate float64 `json:"tax_rate,omitempty"`
	// Account number for ACH/Wire transfer instructions
	AchAccountNumber string `json:"ach_account_number,omitempty"`
	// Time length of the grace period between the end of invoice generation and the actual charge. *NOTE*: The specified length is unitless. Unit is designated with the `payment_grace_period_unit` field.
	PaymentGracePeriodLength int32 `json:"payment_grace_period_length,omitempty"`
	// Flag that controls whether invoices are auto-approved or require manual approval
	AutoApproveInvoices bool `json:"auto_approve_invoices,omitempty"`
	// First line of bank address for ACH/Wire transfer instructions
	AchBankAddress1 string `json:"ach_bank_address_1,omitempty"`
	// Flag that controls whether or not to invoice/charge the base rate, add ons and other fixed price plan components at the beginning of the billing cycle.
	InvoiceFixedComponentsAtStart bool `json:"invoice_fixed_components_at_start,omitempty"`
	// Second line of bank address for ACH/Wire transfer instructions
	AchBankAddress2 string `json:"ach_bank_address_2,omitempty"`
	// Flag that controls whether or not invoices should be sent to customers.
	ShouldSendInvoiceToCustomers bool `json:"should_send_invoice_to_customers,omitempty"`
	// Flag determining whether ACH/Wire instructions should be included on invoices.
	IncludeAchInstructions bool `json:"include_ach_instructions,omitempty"`
	// If using stripe, this field can be used to configure whether invoices should be auto advanced for collection
	StripeAutoAdvance bool `json:"stripe_auto_advance,omitempty"`
	// True if customer updates should be synced to Stripe.
	SyncCustomerDataToPaymentGateway bool `json:"sync_customer_data_to_payment_gateway,omitempty"`
	// Flag that controls whether to invoice through Octane or through payment provider
	InvoiceViaOctane           bool   `json:"invoice_via_octane,omitempty"`
	CustomerInvoiceDetailLevel string `json:"customer_invoice_detail_level,omitempty"`
	// Flag that controls whether or not to invoice/charge a true up for a billing cycle on the following invoice. Only applies if invoice_fixed_components_at_start is enabled.
	InvoiceOverages bool `json:"invoice_overages,omitempty"`
	// Optional url of a custom image to include on invoices.
	InvoiceLogoUrl string `json:"invoice_logo_url,omitempty"`
	// ABA/Routing number for ACH/Wire transfer instructions
	AchRoutingNumber string `json:"ach_routing_number,omitempty"`
}

type UpdateCreditTopOffPlanInputArgs ¶ added in v0.4.9

type UpdateCreditTopOffPlanInputArgs struct {
	// Amount of credits that are granted in a single top off.
	GrantAmount int32 `json:"grant_amount,omitempty"`
	// The threshold in amount of credits at which the balance will be topped off.
	TriggerAmount int32 `json:"trigger_amount,omitempty"`
	// A description that will be used on the invoice line items.
	Description string `json:"description,omitempty"`
	// Time length unit for the default expiration for credits granted in a top off.
	ExpirationUnit string `json:"expiration_unit,omitempty"`
	// Time length of the default expiration for credits granted in a top off.
	ExpirationLength int32 `json:"expiration_length,omitempty"`
	// Price for the grant, in lowest denomination (i.e cents).
	Price int32 `json:"price,omitempty"`
}

type UpdateCustomerArgs ¶

type UpdateCustomerArgs struct {
	Tags                []string                              `json:"tags,omitempty"`
	ContactInfo         *ContactInfoInputArgs                 `json:"contact_info,omitempty"`
	VendorId            int32                                 `json:"vendor_id,omitempty"`
	MeasurementMappings []CustomerMeasurementMappingInputArgs `json:"measurement_mappings,omitempty"`
	Name                string                                `json:"name,omitempty"`
	DisplayName         string                                `json:"display_name,omitempty"`
	CreatedAt           time.Time                             `json:"created_at,omitempty"`
}

type UpdateCustomerAvalaraSettingsArgs ¶ added in v0.4.9

type UpdateCustomerAvalaraSettingsArgs struct {
	// True if Avalara integration should be enabled for this customer, False otherwise.
	EnableIntegration bool `json:"enable_integration,omitempty"`
	// Entity code describing this customer.
	EntityUseCode string `json:"entity_use_code,omitempty"`
	// Tax exemption number specific to this customer
	ExemptionNumber string `json:"exemption_number,omitempty"`
}

type UpdateCustomerPortalSettingsInputArgs ¶ added in v0.4.0

type UpdateCustomerPortalSettingsInputArgs struct {
	VendorId             int32  `json:"vendor_id,omitempty"`
	PricePlanTagsFilter  string `json:"price_plan_tags_filter,omitempty"`
	PricePlanNamesFilter string `json:"price_plan_names_filter,omitempty"`
}

type UpdateMeterArgs ¶

type UpdateMeterArgs struct {
	DisplayName string `json:"display_name,omitempty"`
	Description string `json:"description,omitempty"`
}

type UpdateMeteredComponentLimitsInput ¶ added in v0.4.9

type UpdateMeteredComponentLimitsInput struct {
	LabelLimits []MeteredComponentLabelLimitInputArgs `json:"label_limits,omitempty"`
	// Numeric limit to set on customer usage for the meter.
	Limit int32 `json:"limit,omitempty"`
}

type UpdatePricePlanArgs ¶

type UpdatePricePlanArgs struct {
	Trial *TrialInputArgs `json:"trial,omitempty"`
	// The frequency (as a an integer multiple of the period) at which to charge the minimum charge.
	MinimumChargeFrequency int32            `json:"minimum_charge_frequency,omitempty"`
	Tags                   []string         `json:"tags,omitempty"`
	Description            string           `json:"description,omitempty"`
	AddOns                 []AddOnInputArgs `json:"add_ons,omitempty"`
	VendorId               int32            `json:"vendor_id,omitempty"`
	// Custom invoice description for the base price line item.
	BasePriceDescription string             `json:"base_price_description,omitempty"`
	Features             []FeatureInputArgs `json:"features,omitempty"`
	// The frequency (as a an integer multiple of the period) at which to charge the base price.
	BasePriceFrequency int32                       `json:"base_price_frequency,omitempty"`
	Name               string                      `json:"name,omitempty"`
	BasePrice          int32                       `json:"base_price,omitempty"`
	Period             string                      `json:"period,omitempty"`
	DisplayName        string                      `json:"display_name,omitempty"`
	MeteredComponents  []MeteredComponentInputArgs `json:"metered_components,omitempty"`
	Limits             []LimitInputArgs            `json:"limits,omitempty"`
	// Minimum amount (in cents) to charge every price plan period.
	MinimumCharge int32 `json:"minimum_charge,omitempty"`
}

type UpdatePricePlanInPlaceArgs ¶ added in v0.4.0

type UpdatePricePlanInPlaceArgs struct {
	AddOns      []AddOnInputArgs   `json:"add_ons,omitempty"`
	Description string             `json:"description,omitempty"`
	Features    []FeatureInputArgs `json:"features,omitempty"`
	// Custom invoice description for the base price line item.
	BasePriceDescription string                      `json:"base_price_description,omitempty"`
	MeteredComponents    []MeteredComponentInputArgs `json:"metered_components,omitempty"`
	DisplayName          string                      `json:"display_name,omitempty"`
	Limits               []LimitInputArgs            `json:"limits,omitempty"`
}

type UpdateSelfServeSettingsArgs ¶ added in v0.4.9

type UpdateSelfServeSettingsArgs struct {
	// Price per credit, in cents, that the customer is charged for buying credits through the customer portal
	PricePerCreditCents int32 `json:"price_per_credit_cents,omitempty"`
	// Time length unit for the default expiration for credits bought in the customer portal.
	CreditsExpirationUnit string `json:"credits_expiration_unit,omitempty"`
	// True if the customer can purchase credits via self serve. Defaults to False.
	PurchaseCredits bool `json:"purchase_credits,omitempty"`
	// True if the vendor has enabled customization for their customer portal.
	Customization bool `json:"customization,omitempty"`
	// Time length of the default expiration for credits bought in the customer portal.
	CreditsExpirationLength int32 `json:"credits_expiration_length,omitempty"`
	// True if the customer can switch their current price plan via self serve. Defaults to False.
	SwitchPricePlans bool `json:"switch_price_plans,omitempty"`
	// True if the vendor has enabled customization for their customer portal.
	Enabled bool `json:"enabled,omitempty"`
}

type UpdateSubscriptionArgs ¶

type UpdateSubscriptionArgs struct {
	PricePlanName string `json:"price_plan_name,omitempty"`
	// Boolean that indicates whether to update the subscription at the start of the billing cycle. If 'true' and either of `effective_at` or `at_cycle_end` are set, will return an error.
	AtCycleStart bool `json:"at_cycle_start,omitempty"`
	// Boolean that indicates whether to update the subscription at the end of the billing cycle. If 'true' and either of `effective_at` or `at_cycle_start` are set, will return an error.
	AtCycleEnd bool `json:"at_cycle_end,omitempty"`
	// DEPRECATED - use discounts field
	DiscountOverride   *AllOfUpdateSubscriptionArgsDiscountOverride `json:"discount_override,omitempty"`
	EffectiveAt        time.Time                                    `json:"effective_at,omitempty"`
	PricePlanTag       string                                       `json:"price_plan_tag,omitempty"`
	AddOns             []SubscriptionAddOnInput                     `json:"add_ons,omitempty"`
	Discounts          []DiscountInputArgs                          `json:"discounts,omitempty"`
	TrialOverride      *AllOfUpdateSubscriptionArgsTrialOverride    `json:"trial_override,omitempty"`
	CouponOverrideId   int32                                        `json:"coupon_override_id,omitempty"`
	VendorId           int32                                        `json:"vendor_id,omitempty"`
	PricePlanId        int32                                        `json:"price_plan_id,omitempty"`
	CustomerId         int32                                        `json:"customer_id,omitempty"`
	CouponOverrideName string                                       `json:"coupon_override_name,omitempty"`
	LimitsOverride     []LimitInputArgs                             `json:"limits_override,omitempty"`
	FeaturesOverride   []FeatureInputArgs                           `json:"features_override,omitempty"`
	AlignToCalendar    bool                                         `json:"align_to_calendar,omitempty"`
}

type UpdateSubscriptionInPlaceArgs ¶ added in v0.4.0

type UpdateSubscriptionInPlaceArgs struct {
	AddOns []SubscriptionAddOnInput `json:"add_ons,omitempty"`
	// DEPRECATED - use discounts field
	DiscountOverride   *AllOfUpdateSubscriptionInPlaceArgsDiscountOverride `json:"discount_override,omitempty"`
	Discounts          []DiscountInputArgs                                 `json:"discounts,omitempty"`
	CouponOverrideName string                                              `json:"coupon_override_name,omitempty"`
}

type UpdateVendorAvalaraSettingsArgs ¶ added in v0.4.9

type UpdateVendorAvalaraSettingsArgs struct {
	// True if the documents generated in Avalara should be committed, false otherwise.
	CommitDocuments bool `json:"commit_documents,omitempty"`
	// The item description to use to represent all the lines on the Octane invoice.
	ItemDescription string `json:"item_description,omitempty"`
	// Enable/Disable the Avalara integration.
	EnableIntegration bool `json:"enable_integration,omitempty"`
	// The Avalara item code to use to represent all the line items on the Octane invoice.
	ItemCode string `json:"item_code,omitempty"`
	// True if enabling logging for Avalara calls, false otherwise.
	EnableLogging bool `json:"enable_logging,omitempty"`
	// The Avalara company code string to associate the Octane vendor with.
	CompanyCode string `json:"company_code,omitempty"`
	// he tax code to associate with the item that is representing the Octane invoice.
	TaxCode string `json:"tax_code,omitempty"`
}

type ValidateAddressResp ¶ added in v0.4.9

type ValidateAddressResp struct {
	// Set if 'success' is True. The resolution quality of the geospatial coordinates.
	ResolutionQuality string `json:"resolution_quality,omitempty"`
	// True if validation was successful, False address is invalid.
	Success bool `json:"success,omitempty"`
	// Set if 'sucess' is True. Geospatial latitude measurement, in Decimal Degrees (string).
	Longitude string `json:"longitude,omitempty"`
	// Set if 'success' is True. Geospatial latitude measurement, in Decimal Degrees (string).
	Latitude string `json:"latitude,omitempty"`
	// Set if 'success' is False. Contains the details of why the address is invalid.
	InvalidAddressError string `json:"invalid_address_error,omitempty"`
}

type ValidateCredentialsArgs ¶ added in v0.4.9

type ValidateCredentialsArgs struct {
	// Username of the Avalara account
	Username string `json:"username"`
	// True if using a Avalara sandbox account, False otherwise
	SandboxMode bool `json:"sandbox_mode"`
	// Password of the Avalara account
	Password string `json:"password"`
}

type ValidateCredentialsResp ¶ added in v0.4.9

type ValidateCredentialsResp struct {
	// Indicates whether the ping to Avalara was successful and the credentials were validated.
	Success bool `json:"success,omitempty"`
}

type VendorAvalaraSettings ¶ added in v0.4.9

type VendorAvalaraSettings struct {
	// True if the documents generated in Avalara should be committed, false otherwise.
	CommitDocuments bool `json:"commit_documents,omitempty"`
	// The item description to use to represent all the lines on the Octane invoice.
	ItemDescription string `json:"item_description,omitempty"`
	// Enable/Disable the Avalara integration.
	EnableIntegration bool `json:"enable_integration,omitempty"`
	// The Avalara item code to use to represent all the line items on the Octane invoice.
	ItemCode string `json:"item_code,omitempty"`
	// True if connecting to Avalara sandbox account, false otherwise.
	SandboxMode bool `json:"sandbox_mode,omitempty"`
	// True if enabling logging for Avalara calls, false otherwise.
	EnableLogging bool `json:"enable_logging,omitempty"`
	// Password of the Avalara account.
	Password string `json:"password,omitempty"`
	// The Avalara company code string to associate the Octane vendor with.
	CompanyCode string `json:"company_code,omitempty"`
	// Username of the Avalara account.
	Username string `json:"username,omitempty"`
	// he tax code to associate with the item that is representing the Octane invoice.
	TaxCode string `json:"tax_code,omitempty"`
}

type Webhook ¶ added in v0.4.0

type Webhook struct {
	// The url to send the webhooks to.
	Url string `json:"url"`
	// Unique string identifier representing this webhook configuration.
	Uuid string `json:"uuid,omitempty"`
	// Determines whether Octane will sign the outgoing webhook
	EnableSignature bool `json:"enable_signature"`
}

type WebhooksApiService ¶ added in v0.4.0

type WebhooksApiService service

func (*WebhooksApiService) WebhooksGet ¶ added in v0.4.0

func (a *WebhooksApiService) WebhooksGet(ctx context.Context) ([]Webhook, *http.Response, error)

WebhooksApiService Get Webhooks Get all Webhooks for a given Vendor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Webhook

func (*WebhooksApiService) WebhooksPost ¶ added in v0.4.0

func (a *WebhooksApiService) WebhooksPost(ctx context.Context, body CreateWebhookArgs) (Webhook, *http.Response, error)

WebhooksApiService Add Webhook Add an endpoint to use with Octane's Webhook API.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return Webhook

func (*WebhooksApiService) WebhooksUuidDelete ¶ added in v0.4.0

func (a *WebhooksApiService) WebhooksUuidDelete(ctx context.Context, uuid string) (*http.Response, error)

WebhooksApiService Delete Webhook Delete and unregister a webhook URL given its UUID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param uuid

func (*WebhooksApiService) WebhooksUuidGet ¶ added in v0.4.0

func (a *WebhooksApiService) WebhooksUuidGet(ctx context.Context, uuid string) (Webhook, *http.Response, error)

WebhooksApiService Get Webhook Retrieve a webhook given its UUID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param uuid

@return Webhook

Source Files ¶

View all Source files

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