chargebee

package
v0.1.0 Latest Latest
Warning

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

 Go to latest Published: Nov 21, 2024 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AdvancedInvoiceSchedule 

type AdvancedInvoiceSchedule struct {
	Id                    string                       `json:"id" validate:"required"`
	ScheduleType          enums.ScheduleTypeEnum       `json:"schedule_type"`
	FixedIntervalSchedule models.FixedIntervalSchedule `json:"fixed_interval_schedule"`
	SpecificDatesSchedule models.SpecificDatesSchedule `json:"specific_dates_schedule"`
}

func ListAdvancedInvoiceSchedules 

func ListAdvancedInvoiceSchedules(site, id string) ([]AdvancedInvoiceSchedule, error)

func ListAdvancedInvoiceSchedulesCreatedSince 

func ListAdvancedInvoiceSchedulesCreatedSince(site, id string, createdSince *time.Time) ([]AdvancedInvoiceSchedule, error)

func ListAdvancedInvoiceSchedulesPage 

func ListAdvancedInvoiceSchedulesPage(site string, id string, offset string) ([]AdvancedInvoiceSchedule, string, error)

func ListAdvancedInvoiceSchedulesPageSortBy 

func ListAdvancedInvoiceSchedulesPageSortBy(site string, id string, offset string, sortBy *SortBy) ([]AdvancedInvoiceSchedule, string, error)

func ListAdvancedInvoiceSchedulesUpdatedSince 

func ListAdvancedInvoiceSchedulesUpdatedSince(site, id string, updatedSince *time.Time) ([]AdvancedInvoiceSchedule, error)

type BusinessEntity 

type BusinessEntity struct {
	Id              string           `json:"id" validate:"required"`
	Name            string           `json:"name" validate:"required"`
	Status          enums.StatusEnum `json:"status" validate:"required"`
	Deleted         bool             `json:"deleted" validate:"required"`
	CreatedAt       uint64           `json:"created_at" validate:"required"`
	ResourceVersion int64            `json:"resource_version"`
	UpdatedAt       uint64           `json:"updated_at"`
}

type BusinessEntityTransfer 

type BusinessEntityTransfer struct {
	Id                          string                 `json:"id" validate:"required"`
	ResourceType                enums.ResourceTypeEnum `json:"resource_type" validate:"required"`
	ResourceId                  string                 `json:"resource_id" validate:"required"`
	ActiveResourceId            string                 `json:"active_resource_id" validate:"required"`
	DestinationBusinessEntityId string                 `json:"destination_business_entity_id" validate:"required"`
	SourceBusinessEntityId      string                 `json:"source_business_entity_id" validate:"required"`
	ReasonCode                  enums.ReasonCodeEnum   `json:"reason_code" validate:"required"`
	CreatedAt                   uint64                 `json:"created_at" validate:"required"`
}

func ListBusinessEntityTransfers 

func ListBusinessEntityTransfers(site string) ([]BusinessEntityTransfer, error)

func ListBusinessEntityTransfersCreatedSince 

func ListBusinessEntityTransfersCreatedSince(site string, createdSince *time.Time) ([]BusinessEntityTransfer, error)

func ListBusinessEntityTransfersPage 

func ListBusinessEntityTransfersPage(site string, offset string) ([]BusinessEntityTransfer, string, error)

func ListBusinessEntityTransfersPageSortBy 

func ListBusinessEntityTransfersPageSortBy(site string, offset string, sortBy *SortBy) ([]BusinessEntityTransfer, string, error)

func ListBusinessEntityTransfersUpdatedSince 

func ListBusinessEntityTransfersUpdatedSince(site string, updatedSince *time.Time) ([]BusinessEntityTransfer, error)

type Contact 

type Contact struct {
	Id               string `json:"id" validate:"required"`
	FirstName        string `json:"first_name"`
	LastName         string `json:"last_name"`
	Email            string `json:"email" validate:"required"`
	Phone            string `json:"phone"`
	Label            string `json:"label"`
	Enabled          bool   `json:"enabled" validate:"required"`
	SendAccountEmail bool   `json:"send_account_email" validate:"required"`
	SendBillingEmail bool   `json:"send_billing_email" validate:"required"`
}

func ListCustomerContacts 

func ListCustomerContacts(site, id string) ([]Contact, error)

func ListCustomerContactsCreatedSince 

func ListCustomerContactsCreatedSince(site, id string, createdSince *time.Time) ([]Contact, error)

func ListCustomerContactsPage 

func ListCustomerContactsPage(site string, id string, offset string) ([]Contact, string, error)

func ListCustomerContactsPageSortBy 

func ListCustomerContactsPageSortBy(site string, id string, offset string, sortBy *SortBy) ([]Contact, string, error)

func ListCustomerContactsUpdatedSince 

func ListCustomerContactsUpdatedSince(site, id string, updatedSince *time.Time) ([]Contact, error)

type ContractTerm 

type ContractTerm struct {
}

func ListContractTerms 

func ListContractTerms(site, id string) ([]ContractTerm, error)

func ListContractTermsCreatedSince 

func ListContractTermsCreatedSince(site, id string, createdSince *time.Time) ([]ContractTerm, error)

func ListContractTermsPage 

func ListContractTermsPage(site string, id string, offset string) ([]ContractTerm, string, error)

func ListContractTermsPageSortBy 

func ListContractTermsPageSortBy(site string, id string, offset string, sortBy *SortBy) ([]ContractTerm, string, error)

func ListContractTermsUpdatedSince 

func ListContractTermsUpdatedSince(site, id string, updatedSince *time.Time) ([]ContractTerm, error)

type Coupon 

type Coupon struct {
	Id                     string                          `json:"id" validate:"required"`
	Name                   string                          `json:"name" validate:"required"`
	InvoiceName            string                          `json:"invoice_name"`
	DiscountType           enums.DiscountTypeEnum          `json:"discount_type" validate:"required"`
	DiscountPercentage     float64                         `json:"discount_percentage"`
	DiscountAmount         uint64                          `json:"discount_amount"`
	CurrencyCode           string                          `json:"currency_code"`
	DurationType           enums.DurationTypeEnum          `json:"duration_type" validate:"required"`
	ValidFrom              uint64                          `json:"valid_from"`
	ValidTill              uint64                          `json:"valid_till"`
	MaxRedemptions         int                             `json:"max_redemptions"`
	Status                 enums.StatusEnum                `json:"status"`
	ApplyOn                enums.ApplyOnEnum               `json:"apply_on" validate:"required"`
	CreatedAt              uint64                          `json:"created_at" validate:"required"`
	ArchivedAt             uint64                          `json:"archived_at"`
	ResourceVersion        int64                           `json:"resource_version"`
	UpdatedAt              uint64                          `json:"updated_at"`
	Period                 int                             `json:"period"`
	PeriodUnit             enums.PeriodUnitEnum            `json:"period_unit"`
	Redemptions            int                             `json:"redemptions"`
	InvoiceNotes           string                          `json:"invoice_notes"`
	ItemConstraints        []models.ItemConstraint         `json:"item_constraints"`
	ItemConstraintCriteria []models.ItemConstraintCriteria `json:"item_constraint_criteria"`
	CouponConstraints      []models.CouponConstraint       `json:"coupon_constraints"`
}

func ListCoupons 

func ListCoupons(site string) ([]Coupon, error)

func ListCouponsCreatedSince 

func ListCouponsCreatedSince(site string, createdSince *time.Time) ([]Coupon, error)

func ListCouponsPage 

func ListCouponsPage(site string, offset string) ([]Coupon, string, error)

func ListCouponsPageSortBy 

func ListCouponsPageSortBy(site string, offset string, sortBy *SortBy) ([]Coupon, string, error)

func ListCouponsUpdatedSince 

func ListCouponsUpdatedSince(site string, updatedSince *time.Time) ([]Coupon, error)

func RetrieveCouponById 

func RetrieveCouponById(site string, id string) (*Coupon, error)

type CouponCode 

type CouponCode struct {
	Code          string           `json:"code" validate:"required"`
	Status        enums.StatusEnum `json:"status" validate:"required"`
	CouponId      string           `json:"coupon_id" validate:"required"`
	CouponSetId   string           `json:"coupon_set_id" validate:"required"`
	CouponSetName string           `json:"coupon_set_name" validate:"required"`
}

func ListCouponCodes 

func ListCouponCodes(site string) ([]CouponCode, error)

func ListCouponCodesCreatedSince 

func ListCouponCodesCreatedSince(site string, createdSince *time.Time) ([]CouponCode, error)

func ListCouponCodesPage 

func ListCouponCodesPage(site string, offset string) ([]CouponCode, string, error)

func ListCouponCodesPageSortBy 

func ListCouponCodesPageSortBy(site string, offset string, sortBy *SortBy) ([]CouponCode, string, error)

func ListCouponCodesUpdatedSince 

func ListCouponCodesUpdatedSince(site string, updatedSince *time.Time) ([]CouponCode, error)

func RetrieveCouponCodeById 

func RetrieveCouponCodeById(site string, id string) (*CouponCode, error)

type CouponSet 

type CouponSet struct {
	Id            string `json:"id" validate:"required"`
	CouponId      string `json:"coupon_id" validate:"required"`
	Name          string `json:"name" validate:"required"`
	TotalCount    int    `json:"total_count"`
	RedeemedCount int    `json:"redeemed_count"`
	ArchivedCount int    `json:"archived_count"`
}

func ListCouponSets 

func ListCouponSets(site string) ([]CouponSet, error)

func ListCouponSetsCreatedSince 

func ListCouponSetsCreatedSince(site string, createdSince *time.Time) ([]CouponSet, error)

func ListCouponSetsPage 

func ListCouponSetsPage(site string, offset string) ([]CouponSet, string, error)

func ListCouponSetsPageSortBy 

func ListCouponSetsPageSortBy(site string, offset string, sortBy *SortBy) ([]CouponSet, string, error)

func ListCouponSetsUpdatedSince 

func ListCouponSetsUpdatedSince(site string, updatedSince *time.Time) ([]CouponSet, error)

func RetrieveCouponSetById 

func RetrieveCouponSetById(site string, id string) (*CouponSet, error)

type CreditNote 

type CreditNote struct {
	Id                        string                           `json:"id" validate:"required"`
	CustomerId                string                           `json:"customer_id" validate:"required"`
	SubscriptionId            string                           `json:"subscription_id"`
	ReferenceInvoiceId        string                           `json:"reference_invoice_id"`
	Type                      enums.TypeEnum                   `json:"type" validate:"required"`
	ReasonCode                enums.ReasonCodeEnum             `json:"reason_code"`
	Status                    enums.StatusEnum                 `json:"status" validate:"required"`
	VatNumber                 string                           `json:"vat_number"`
	Date                      uint64                           `json:"date"`
	PriceType                 enums.PriceTypeEnum              `json:"price_type" validate:"required"`
	CurrencyCode              string                           `json:"currency_code" validate:"required"`
	Total                     uint64                           `json:"total"`
	AmountAllocated           uint64                           `json:"amount_allocated"`
	AmountRefunded            uint64                           `json:"amount_refunded"`
	AmountAvailable           uint64                           `json:"amount_available"`
	RefundedAt                uint64                           `json:"refunded_at"`
	VoidedAt                  uint64                           `json:"voided_at"`
	GeneratedAt               uint64                           `json:"generated_at"`
	ResourceVersion           int64                            `json:"resource_version"`
	UpdatedAt                 uint64                           `json:"updated_at"`
	Channel                   enums.ChannelEnum                `json:"channel"`
	SubTotal                  uint64                           `json:"sub_total" validate:"required"`
	SubTotalInLocalCurrency   uint64                           `json:"sub_total_in_local_currency"`
	TotalInLocalCurrency      uint64                           `json:"total_in_local_currency"`
	LocalCurrencyCode         string                           `json:"local_currency_code"`
	RoundOffAmount            uint64                           `json:"round_off_amount"`
	FractionalCorrection      uint64                           `json:"fractional_correction"`
	Deleted                   bool                             `json:"deleted" validate:"required"`
	TaxCategory               string                           `json:"tax_category"`
	LocalCurrencyExchangeRate *decimal.Decimal                 `json:"local_currency_exchange_rate"`
	CreateReasonCode          string                           `json:"create_reason_code"`
	VatNumberPrefix           string                           `json:"vat_number_prefix"`
	BusinessEntityId          string                           `json:"business_entity_id"`
	Einvoice                  models.Einvoice                  `json:"einvoice"`
	LineItems                 []models.LineItem                `json:"line_items"`
	Discounts                 []models.Discount                `json:"discounts"`
	LineItemDiscounts         []models.LineItemDiscount        `json:"line_item_discounts"`
	LineItemTiers             []models.LineItemTier            `json:"line_item_tiers"`
	Taxes                     []models.Tax                     `json:"taxes"`
	LineItemTaxes             []models.LineItemTax             `json:"line_item_taxes"`
	LinkedRefunds             []models.CreditNoteTransaction   `json:"linked_refunds"`
	LinkedTaxWithheldRefunds  []models.LinkedTaxWithheldRefund `json:"linked_tax_withheld_refunds"`
	Allocations               []models.AppliedCredit           `json:"allocations"`
	ShippingAddress           models.ShippingAddress           `json:"shipping_address"`
	BillingAddress            models.BillingAddress            `json:"billing_address"`
	SiteDetailsAtCreation     models.SiteDetailsAtCreation     `json:"site_details_at_creation"`
	TaxOrigin                 models.TaxOrigin                 `json:"tax_origin"`
}

func ListCreditNotes 

func ListCreditNotes(site string) ([]CreditNote, error)

func ListCreditNotesCreatedSince 

func ListCreditNotesCreatedSince(site string, createdSince *time.Time) ([]CreditNote, error)

func ListCreditNotesPage 

func ListCreditNotesPage(site string, offset string) ([]CreditNote, string, error)

func ListCreditNotesPageSortBy 

func ListCreditNotesPageSortBy(site string, offset string, sortBy *SortBy) ([]CreditNote, string, error)

func ListCreditNotesUpdatedSince 

func ListCreditNotesUpdatedSince(site string, updatedSince *time.Time) ([]CreditNote, error)

func RetrieveCreditNoteById 

func RetrieveCreditNoteById(site string, id string) (*CreditNote, error)

type Currency 

type Currency struct {
	Id                 string              `json:"id"`
	Enabled            bool                `json:"enabled" validate:"required"`
	ForexType          enums.ForexTypeEnum `json:"forex_type"`
	CurrencyCode       string              `json:"currency_code"`
	IsBaseCurrency     bool                `json:"is_base_currency"`
	ManualExchangeRate string              `json:"manual_exchange_rate"`
}

func ListCurrencies 

func ListCurrencies(site string) ([]Currency, error)

func ListCurrenciesCreatedSince 

func ListCurrenciesCreatedSince(site string, createdSince *time.Time) ([]Currency, error)

func ListCurrenciesPage 

func ListCurrenciesPage(site string, offset string) ([]Currency, string, error)

func ListCurrenciesPageSortBy 

func ListCurrenciesPageSortBy(site string, offset string, sortBy *SortBy) ([]Currency, string, error)

func ListCurrenciesUpdatedSince 

func ListCurrenciesUpdatedSince(site string, updatedSince *time.Time) ([]Currency, error)

func RetrieveCurrencyById 

func RetrieveCurrencyById(site string, id string) (*Currency, error)

type Customer 

type Customer struct {
	Id                               string                         `json:"id" validate:"required"`
	FirstName                        string                         `json:"first_name"`
	LastName                         string                         `json:"last_name"`
	Email                            string                         `json:"email"`
	Phone                            string                         `json:"phone"`
	Company                          string                         `json:"company"`
	VatNumber                        string                         `json:"vat_number"`
	AutoCollection                   enums.AutoCollectionEnum       `json:"auto_collection" validate:"required"`
	OfflinePaymentMethod             enums.OfflinePaymentMethodEnum `json:"offline_payment_method"`
	NetTermDays                      int                            `json:"net_term_days" validate:"required"`
	VatNumberValidatedTime           uint64                         `json:"vat_number_validated_time"`
	VatNumberStatus                  enums.VatNumberStatusEnum      `json:"vat_number_status"`
	AllowDirectDebit                 bool                           `json:"allow_direct_debit" validate:"required"`
	IsLocationValid                  bool                           `json:"is_location_valid"`
	CreatedAt                        uint64                         `json:"created_at" validate:"required"`
	CreatedFromIp                    string                         `json:"created_from_ip"`
	ExemptionDetails                 []string                       `json:"exemption_details"`
	Taxability                       enums.TaxabilityEnum           `json:"taxability"`
	EntityCode                       enums.EntityCodeEnum           `json:"entity_code"`
	ExemptNumber                     string                         `json:"exempt_number"`
	ResourceVersion                  int64                          `json:"resource_version"`
	UpdatedAt                        uint64                         `json:"updated_at"`
	Locale                           string                         `json:"locale"`
	BillingDate                      int                            `json:"billing_date"`
	BillingMonth                     int                            `json:"billing_month"`
	BillingDateMode                  enums.BillingDateModeEnum      `json:"billing_date_mode"`
	BillingDayOfWeek                 enums.BillingDayOfWeekEnum     `json:"billing_day_of_week"`
	BillingDayOfWeekMode             enums.BillingDayOfWeekModeEnum `json:"billing_day_of_week_mode"`
	PiiCleared                       enums.PiiClearedEnum           `json:"pii_cleared"`
	AutoCloseInvoices                bool                           `json:"auto_close_invoices"`
	Channel                          enums.ChannelEnum              `json:"channel"`
	ActiveId                         string                         `json:"active_id"`
	FraudFlag                        enums.FraudFlagEnum            `json:"fraud_flag"`
	PrimaryPaymentSourceId           string                         `json:"primary_payment_source_id"`
	BackupPaymentSourceId            string                         `json:"backup_payment_source_id"`
	InvoiceNotes                     string                         `json:"invoice_notes"`
	BusinessEntityId                 string                         `json:"business_entity_id"`
	PreferredCurrencyCode            string                         `json:"preferred_currency_code"`
	PromotionalCredits               uint64                         `json:"promotional_credits" validate:"required"`
	UnbilledCharges                  uint64                         `json:"unbilled_charges" validate:"required"`
	RefundableCredits                uint64                         `json:"refundable_credits" validate:"required"`
	ExcessPayments                   uint64                         `json:"excess_payments" validate:"required"`
	IsEinvoiceEnabled                bool                           `json:"is_einvoice_enabled"`
	EinvoicingMethod                 enums.EinvoicingMethodEnum     `json:"einvoicing_method"`
	Deleted                          bool                           `json:"deleted" validate:"required"`
	RegisteredForGst                 bool                           `json:"registered_for_gst"`
	ConsolidatedInvoicing            bool                           `json:"consolidated_invoicing"`
	CustomerType                     enums.CustomerTypeEnum         `json:"customer_type"`
	BusinessCustomerWithoutVatNumber bool                           `json:"business_customer_without_vat_number"`
	ClientProfileId                  string                         `json:"client_profile_id"`
	UseDefaultHierarchySettings      bool                           `json:"use_default_hierarchy_settings"`
	VatNumberPrefix                  string                         `json:"vat_number_prefix"`
	EntityIdentifierScheme           string                         `json:"entity_identifier_scheme"`
	EntityIdentifierStandard         string                         `json:"entity_identifier_standard"`
	BillingAddress                   models.BillingAddress          `json:"billing_address"`
	ReferralUrls                     []models.ReferralUrl           `json:"referral_urls"`
	Contacts                         []models.Contact               `json:"contacts"`
	PaymentMethod                    models.PaymentMethod           `json:"payment_method"`
	Balances                         []models.CustomerBalance       `json:"balances"`
	EntityIdentifiers                []models.EntityIdentifier      `json:"entity_identifiers"`
	TaxProvidersFields               []models.TaxProvidersField     `json:"tax_providers_fields"`
	Relationship                     models.Relationship            `json:"relationship"`
	ParentAccountAccess              models.ParentAccountAccess     `json:"parent_account_access"`
	ChildAccountAccess               models.ChildAccountAccess      `json:"child_account_access"`
}

func ListCustomers 

func ListCustomers(site string) ([]Customer, error)

func ListCustomersCreatedSince 

func ListCustomersCreatedSince(site string, createdSince *time.Time) ([]Customer, error)

func ListCustomersPage 

func ListCustomersPage(site string, offset string) ([]Customer, string, error)

func ListCustomersPageSortBy 

func ListCustomersPageSortBy(site string, offset string, sortBy *SortBy) ([]Customer, string, error)

func ListCustomersUpdatedSince 

func ListCustomersUpdatedSince(site string, updatedSince *time.Time) ([]Customer, error)

func RetrieveCustomerById 

func RetrieveCustomerById(site string, id string) (*Customer, error)

type DifferentialPrice 

type DifferentialPrice struct {
	Id               string                `json:"id" validate:"required"`
	ItemPriceId      string                `json:"item_price_id" validate:"required"`
	ParentItemId     string                `json:"parent_item_id" validate:"required"`
	Price            uint64                `json:"price"`
	PriceInDecimal   string                `json:"price_in_decimal"`
	Status           enums.StatusEnum      `json:"status"`
	ResourceVersion  int64                 `json:"resource_version"`
	UpdatedAt        uint64                `json:"updated_at"`
	CreatedAt        uint64                `json:"created_at" validate:"required"`
	ModifiedAt       uint64                `json:"modified_at" validate:"required"`
	CurrencyCode     string                `json:"currency_code" validate:"required"`
	BusinessEntityId string                `json:"business_entity_id"`
	Tiers            []models.Tier         `json:"tiers"`
	ParentPeriods    []models.ParentPeriod `json:"parent_periods"`
}

func ListDifferentialPrices 

func ListDifferentialPrices(site string) ([]DifferentialPrice, error)

func ListDifferentialPricesCreatedSince 

func ListDifferentialPricesCreatedSince(site string, createdSince *time.Time) ([]DifferentialPrice, error)

func ListDifferentialPricesPage 

func ListDifferentialPricesPage(site string, offset string) ([]DifferentialPrice, string, error)

func ListDifferentialPricesPageSortBy 

func ListDifferentialPricesPageSortBy(site string, offset string, sortBy *SortBy) ([]DifferentialPrice, string, error)

func ListDifferentialPricesUpdatedSince 

func ListDifferentialPricesUpdatedSince(site string, updatedSince *time.Time) ([]DifferentialPrice, error)

func RetrieveDifferentialPriceById 

func RetrieveDifferentialPriceById(site string, id string) (*DifferentialPrice, error)

type Discount 

type Discount struct {
	Id            string                 `json:"id" validate:"required"`
	InvoiceName   string                 `json:"invoice_name"`
	Type          enums.TypeEnum         `json:"type" validate:"required"`
	Percentage    float64                `json:"percentage"`
	Amount        uint64                 `json:"amount"`
	CurrencyCode  string                 `json:"currency_code"`
	DurationType  enums.DurationTypeEnum `json:"duration_type" validate:"required"`
	Period        int                    `json:"period"`
	PeriodUnit    enums.PeriodUnitEnum   `json:"period_unit"`
	IncludedInMrr bool                   `json:"included_in_mrr" validate:"required"`
	ApplyOn       enums.ApplyOnEnum      `json:"apply_on" validate:"required"`
	ItemPriceId   string                 `json:"item_price_id"`
	CreatedAt     uint64                 `json:"created_at" validate:"required"`
	ApplyTill     uint64                 `json:"apply_till"`
	AppliedCount  int                    `json:"applied_count"`
	CouponId      string                 `json:"coupon_id" validate:"required"`
	Index         int                    `json:"index" validate:"required"`
}

func ListDiscounts 

func ListDiscounts(site, id string) ([]Discount, error)

func ListDiscountsCreatedSince 

func ListDiscountsCreatedSince(site, id string, createdSince *time.Time) ([]Discount, error)

func ListDiscountsPage 

func ListDiscountsPage(site string, id string, offset string) ([]Discount, string, error)

func ListDiscountsPageSortBy 

func ListDiscountsPageSortBy(site string, id string, offset string, sortBy *SortBy) ([]Discount, string, error)

func ListDiscountsUpdatedSince 

func ListDiscountsUpdatedSince(site, id string, updatedSince *time.Time) ([]Discount, error)

type Entitlement 

type Entitlement struct {
	Id          string               `json:"id" validate:"required"`
	EntityId    string               `json:"entity_id"`
	EntityType  enums.EntityTypeEnum `json:"entity_type"`
	FeatureId   string               `json:"feature_id"`
	FeatureName string               `json:"feature_name"`
	Value       string               `json:"value"`
	Name        string               `json:"name"`
}

func ListEntitlements 

func ListEntitlements(site string) ([]Entitlement, error)

func ListEntitlementsCreatedSince 

func ListEntitlementsCreatedSince(site string, createdSince *time.Time) ([]Entitlement, error)

func ListEntitlementsPage 

func ListEntitlementsPage(site string, offset string) ([]Entitlement, string, error)

func ListEntitlementsPageSortBy 

func ListEntitlementsPageSortBy(site string, offset string, sortBy *SortBy) ([]Entitlement, string, error)

func ListEntitlementsUpdatedSince 

func ListEntitlementsUpdatedSince(site string, updatedSince *time.Time) ([]Entitlement, error)

type Event 

type Event struct {
	Id         string                 `json:"id" validate:"required"`
	OccurredAt uint64                 `json:"occurred_at" validate:"required"`
	Source     enums.SourceEnum       `json:"source" validate:"required"`
	User       string                 `json:"user"`
	EventType  enums.EventTypeEnum    `json:"event_type"`
	ApiVersion enums.ApiVersionEnum   `json:"api_version"`
	Content    map[string]interface{} `json:"content" validate:"required"`
	OriginUser string                 `json:"origin_user"`
	Webhooks   []models.Webhook       `json:"webhooks"`
}

func ListEvents 

func ListEvents(site string) ([]Event, error)

func ListEventsCreatedSince 

func ListEventsCreatedSince(site string, createdSince *time.Time) ([]Event, error)

func ListEventsPage 

func ListEventsPage(site string, offset string) ([]Event, string, error)

func ListEventsPageSortBy 

func ListEventsPageSortBy(site string, offset string, sortBy *SortBy) ([]Event, string, error)

func ListEventsUpdatedSince 

func ListEventsUpdatedSince(site string, updatedSince *time.Time) ([]Event, error)

func RetrieveEventById 

func RetrieveEventById(site string, id string) (*Event, error)

type Feature 

type Feature struct {
	Id              string           `json:"id" validate:"required"`
	Name            string           `json:"name" validate:"required"`
	Description     string           `json:"description"`
	Status          enums.StatusEnum `json:"status"`
	Type            enums.TypeEnum   `json:"type"`
	Unit            string           `json:"unit"`
	ResourceVersion int64            `json:"resource_version"`
	UpdatedAt       uint64           `json:"updated_at"`
	CreatedAt       uint64           `json:"created_at" validate:"required"`
	Levels          []models.Level   `json:"levels"`
}

func ListFeatures 

func ListFeatures(site string) ([]Feature, error)

func ListFeaturesCreatedSince 

func ListFeaturesCreatedSince(site string, createdSince *time.Time) ([]Feature, error)

func ListFeaturesPage 

func ListFeaturesPage(site string, offset string) ([]Feature, string, error)

func ListFeaturesPageSortBy 

func ListFeaturesPageSortBy(site string, offset string, sortBy *SortBy) ([]Feature, string, error)

func ListFeaturesUpdatedSince 

func ListFeaturesUpdatedSince(site string, updatedSince *time.Time) ([]Feature, error)

func RetrieveFeatureById 

func RetrieveFeatureById(site string, id string) (*Feature, error)

type Gift 

type Gift struct {
	Id              string                `json:"id" validate:"required"`
	Status          enums.StatusEnum      `json:"status" validate:"required"`
	ScheduledAt     uint64                `json:"scheduled_at"`
	AutoClaim       bool                  `json:"auto_claim" validate:"required"`
	NoExpiry        bool                  `json:"no_expiry" validate:"required"`
	ClaimExpiryDate uint64                `json:"claim_expiry_date"`
	ResourceVersion int64                 `json:"resource_version"`
	UpdatedAt       uint64                `json:"updated_at"`
	Gifter          models.Gifter         `json:"gifter" validate:"required"`
	GiftReceiver    models.GiftReceiver   `json:"gift_receiver" validate:"required"`
	GiftTimelines   []models.GiftTimeline `json:"gift_timelines"`
}

func ListGifts 

func ListGifts(site string) ([]Gift, error)

func ListGiftsCreatedSince 

func ListGiftsCreatedSince(site string, createdSince *time.Time) ([]Gift, error)

func ListGiftsPage 

func ListGiftsPage(site string, offset string) ([]Gift, string, error)

func ListGiftsPageSortBy 

func ListGiftsPageSortBy(site string, offset string, sortBy *SortBy) ([]Gift, string, error)

func ListGiftsUpdatedSince 

func ListGiftsUpdatedSince(site string, updatedSince *time.Time) ([]Gift, error)

func RetrieveGiftById 

func RetrieveGiftById(site string, id string) (*Gift, error)

type Hierarchy 

type Hierarchy struct {
	CustomerId     string   `json:"customer_id" validate:"required"`
	ParentId       string   `json:"parent_id"`
	PaymentOwnerId string   `json:"payment_owner_id" validate:"required"`
	InvoiceOwnerId string   `json:"invoice_owner_id" validate:"required"`
	ChildrenIds    []string `json:"children_ids"`
}

func ListCustomerHierarchies 

func ListCustomerHierarchies(site, id string) ([]Hierarchy, error)

func ListCustomerHierarchiesCreatedSince 

func ListCustomerHierarchiesCreatedSince(site, id string, createdSince *time.Time) ([]Hierarchy, error)

func ListCustomerHierarchiesPage 

func ListCustomerHierarchiesPage(site string, id string, offset string) ([]Hierarchy, string, error)

func ListCustomerHierarchiesPageSortBy 

func ListCustomerHierarchiesPageSortBy(site string, id string, offset string, sortBy *SortBy) ([]Hierarchy, string, error)

func ListCustomerHierarchiesUpdatedSince 

func ListCustomerHierarchiesUpdatedSince(site, id string, updatedSince *time.Time) ([]Hierarchy, error)

type ImpactedItem 

type ImpactedItem struct {
	Count    int             `json:"count"`
	Items    []string        `json:"items"`
	Download models.Download `json:"download"`
}

type ImpactedSubscription 

type ImpactedSubscription struct {
	Count           int             `json:"count"`
	SubscriptionIds []string        `json:"subscription_ids"`
	Download        models.Download `json:"download"`
}

type Invoice 

type Invoice struct {
	Id                        string                       `json:"id" validate:"required"`
	PoNumber                  string                       `json:"po_number"`
	CustomerId                string                       `json:"customer_id" validate:"required"`
	SubscriptionId            string                       `json:"subscription_id"`
	Recurring                 bool                         `json:"recurring" validate:"required"`
	Status                    enums.StatusEnum             `json:"status" validate:"required"`
	VatNumber                 string                       `json:"vat_number"`
	PriceType                 enums.PriceTypeEnum          `json:"price_type" validate:"required"`
	Date                      uint64                       `json:"date"`
	DueDate                   uint64                       `json:"due_date"`
	NetTermDays               int                          `json:"net_term_days"`
	ExchangeRate              *decimal.Decimal             `json:"exchange_rate"`
	CurrencyCode              string                       `json:"currency_code" validate:"required"`
	Total                     uint64                       `json:"total"`
	AmountPaid                uint64                       `json:"amount_paid"`
	AmountAdjusted            uint64                       `json:"amount_adjusted"`
	WriteOffAmount            uint64                       `json:"write_off_amount"`
	CreditsApplied            uint64                       `json:"credits_applied"`
	AmountDue                 uint64                       `json:"amount_due"`
	PaidAt                    uint64                       `json:"paid_at"`
	DunningStatus             enums.DunningStatusEnum      `json:"dunning_status"`
	NextRetryAt               uint64                       `json:"next_retry_at"`
	VoidedAt                  uint64                       `json:"voided_at"`
	ResourceVersion           int64                        `json:"resource_version"`
	UpdatedAt                 uint64                       `json:"updated_at"`
	SubTotal                  uint64                       `json:"sub_total" validate:"required"`
	SubTotalInLocalCurrency   uint64                       `json:"sub_total_in_local_currency"`
	TotalInLocalCurrency      uint64                       `json:"total_in_local_currency"`
	LocalCurrencyCode         string                       `json:"local_currency_code"`
	Tax                       uint64                       `json:"tax" validate:"required"`
	LocalCurrencyExchangeRate *decimal.Decimal             `json:"local_currency_exchange_rate"`
	FirstInvoice              bool                         `json:"first_invoice"`
	NewSalesAmount            uint64                       `json:"new_sales_amount"`
	HasAdvanceCharges         bool                         `json:"has_advance_charges"`
	TermFinalized             bool                         `json:"term_finalized" validate:"required"`
	IsGifted                  bool                         `json:"is_gifted" validate:"required"`
	GeneratedAt               uint64                       `json:"generated_at"`
	ExpectedPaymentDate       uint64                       `json:"expected_payment_date"`
	AmountToCollect           uint64                       `json:"amount_to_collect"`
	RoundOffAmount            uint64                       `json:"round_off_amount"`
	PaymentOwner              string                       `json:"payment_owner"`
	VoidReasonCode            string                       `json:"void_reason_code"`
	Deleted                   bool                         `json:"deleted" validate:"required"`
	TaxCategory               string                       `json:"tax_category"`
	VatNumberPrefix           string                       `json:"vat_number_prefix"`
	Channel                   enums.ChannelEnum            `json:"channel"`
	BusinessEntityId          string                       `json:"business_entity_id"`
	LineItems                 []models.LineItem            `json:"line_items"`
	Discounts                 []models.Discount            `json:"discounts"`
	LineItemDiscounts         []models.LineItemDiscount    `json:"line_item_discounts"`
	Taxes                     []models.Tax                 `json:"taxes"`
	LineItemTaxes             []models.LineItemTax         `json:"line_item_taxes"`
	LineItemTiers             []models.LineItemTier        `json:"line_item_tiers"`
	LinkedPayments            []models.InvoiceTransaction  `json:"linked_payments"`
	DunningAttempts           []models.DunningAttempt      `json:"dunning_attempts"`
	AppliedCredits            []models.AppliedCredit       `json:"applied_credits"`
	AdjustmentCreditNotes     []models.CreatedCreditNote   `json:"adjustment_credit_notes"`
	IssuedCreditNotes         []models.CreatedCreditNote   `json:"issued_credit_notes"`
	LinkedOrders              []models.LinkedOrder         `json:"linked_orders"`
	Notes                     []models.Note                `json:"notes"`
	ShippingAddress           models.ShippingAddress       `json:"shipping_address"`
	StatementDescriptor       models.StatementDescriptor   `json:"statement_descriptor"`
	BillingAddress            models.BillingAddress        `json:"billing_address"`
	Einvoice                  models.Einvoice              `json:"einvoice"`
	LinkedTaxesWithheld       []models.LinkedTaxWithheld   `json:"linked_taxes_withheld"`
	SiteDetailsAtCreation     models.SiteDetailsAtCreation `json:"site_details_at_creation"`
	TaxOrigin                 models.TaxOrigin             `json:"tax_origin"`
}

func ListInvoices 

func ListInvoices(site string) ([]Invoice, error)

func ListInvoicesCreatedSince 

func ListInvoicesCreatedSince(site string, createdSince *time.Time) ([]Invoice, error)

func ListInvoicesPage 

func ListInvoicesPage(site string, offset string) ([]Invoice, string, error)

func ListInvoicesPageSortBy 

func ListInvoicesPageSortBy(site string, offset string, sortBy *SortBy) ([]Invoice, string, error)

func ListInvoicesUpdatedSince 

func ListInvoicesUpdatedSince(site string, updatedSince *time.Time) ([]Invoice, error)

func RetrieveInvoiceById 

func RetrieveInvoiceById(site string, id string) (*Invoice, error)

type InvoiceUnbilledCharge 

type InvoiceUnbilledCharge struct {
	Id                  string                 `json:"id"`
	CustomerId          string                 `json:"customer_id"`
	SubscriptionId      string                 `json:"subscription_id"`
	DateFrom            uint64                 `json:"date_from"`
	DateTo              uint64                 `json:"date_to"`
	UnitAmount          uint64                 `json:"unit_amount"`
	PricingModel        enums.PricingModelEnum `json:"pricing_model"`
	Quantity            int                    `json:"quantity"`
	Amount              uint64                 `json:"amount"`
	CurrencyCode        string                 `json:"currency_code" validate:"required"`
	DiscountAmount      uint64                 `json:"discount_amount"`
	Description         string                 `json:"description"`
	EntityType          enums.EntityTypeEnum   `json:"entity_type" validate:"required"`
	EntityId            string                 `json:"entity_id"`
	IsVoided            bool                   `json:"is_voided" validate:"required"`
	VoidedAt            uint64                 `json:"voided_at"`
	UnitAmountInDecimal string                 `json:"unit_amount_in_decimal"`
	QuantityInDecimal   string                 `json:"quantity_in_decimal"`
	AmountInDecimal     string                 `json:"amount_in_decimal"`
	UpdatedAt           uint64                 `json:"updated_at" validate:"required"`
	IsAdvanceCharge     bool                   `json:"is_advance_charge"`
	BusinessEntityId    string                 `json:"business_entity_id"`
	Deleted             bool                   `json:"deleted" validate:"required"`
	Tiers               []models.LineItemTier  `json:"tiers"`
}

func ListInvoiceUnbilledCharges 

func ListInvoiceUnbilledCharges(site string) ([]InvoiceUnbilledCharge, error)

func ListInvoiceUnbilledChargesCreatedSince 

func ListInvoiceUnbilledChargesCreatedSince(site string, createdSince *time.Time) ([]InvoiceUnbilledCharge, error)

func ListInvoiceUnbilledChargesPage 

func ListInvoiceUnbilledChargesPage(site string, offset string) ([]InvoiceUnbilledCharge, string, error)

func ListInvoiceUnbilledChargesPageSortBy 

func ListInvoiceUnbilledChargesPageSortBy(site string, offset string, sortBy *SortBy) ([]InvoiceUnbilledCharge, string, error)

func ListInvoiceUnbilledChargesUpdatedSince 

func ListInvoiceUnbilledChargesUpdatedSince(site string, updatedSince *time.Time) ([]InvoiceUnbilledCharge, error)

type Item 

type Item struct {
	Id                   string                      `json:"id" validate:"required"`
	Name                 string                      `json:"name" validate:"required"`
	ExternalName         string                      `json:"external_name"`
	Description          string                      `json:"description"`
	Status               enums.StatusEnum            `json:"status"`
	ResourceVersion      int64                       `json:"resource_version"`
	UpdatedAt            uint64                      `json:"updated_at"`
	ItemFamilyId         string                      `json:"item_family_id"`
	Type                 enums.TypeEnum              `json:"type" validate:"required"`
	IsShippable          bool                        `json:"is_shippable"`
	IsGiftable           bool                        `json:"is_giftable" validate:"required"`
	RedirectUrl          string                      `json:"redirect_url"`
	EnabledForCheckout   bool                        `json:"enabled_for_checkout" validate:"required"`
	EnabledInPortal      bool                        `json:"enabled_in_portal" validate:"required"`
	IncludedInMrr        bool                        `json:"included_in_mrr"`
	ItemApplicability    enums.ItemApplicabilityEnum `json:"item_applicability" validate:"required"`
	GiftClaimRedirectUrl string                      `json:"gift_claim_redirect_url"`
	Unit                 string                      `json:"unit"`
	Metered              bool                        `json:"metered" validate:"required"`
	UsageCalculation     enums.UsageCalculationEnum  `json:"usage_calculation"`
	ArchivedAt           uint64                      `json:"archived_at"`
	Channel              enums.ChannelEnum           `json:"channel"`
	Metadata             map[string]interface{}      `json:"metadata"`
	BusinessEntityId     string                      `json:"business_entity_id"`
	ApplicableItems      []models.ApplicableItem     `json:"applicable_items"`
	BundleItems          []models.BundleItem         `json:"bundle_items"`
}

func ListItems 

func ListItems(site string) ([]Item, error)

func ListItemsCreatedSince 

func ListItemsCreatedSince(site string, createdSince *time.Time) ([]Item, error)

func ListItemsPage 

func ListItemsPage(site string, offset string) ([]Item, string, error)

func ListItemsPageSortBy 

func ListItemsPageSortBy(site string, offset string, sortBy *SortBy) ([]Item, string, error)

func ListItemsUpdatedSince 

func ListItemsUpdatedSince(site string, updatedSince *time.Time) ([]Item, error)

func RetrieveItemById 

func RetrieveItemById(site string, id string) (*Item, error)

type ItemAttached 

type ItemAttached struct {
	Id                string                  `json:"id" validate:"required"`
	ParentItemId      string                  `json:"parent_item_id" validate:"required"`
	ItemId            string                  `json:"item_id" validate:"required"`
	Type              enums.TypeEnum          `json:"type" validate:"required"`
	Status            enums.StatusEnum        `json:"status"`
	Quantity          int                     `json:"quantity"`
	QuantityInDecimal string                  `json:"quantity_in_decimal"`
	BillingCycles     int                     `json:"billing_cycles"`
	ChargeOnEvent     enums.ChargeOnEventEnum `json:"charge_on_event" validate:"required"`
	ChargeOnce        bool                    `json:"charge_once" validate:"required"`
	CreatedAt         uint64                  `json:"created_at" validate:"required"`
	ResourceVersion   int64                   `json:"resource_version"`
	UpdatedAt         uint64                  `json:"updated_at"`
	Channel           enums.ChannelEnum       `json:"channel"`
	BusinessEntityId  string                  `json:"business_entity_id"`
}

func ListItemsAttached 

func ListItemsAttached(site, id string) ([]ItemAttached, error)

func ListItemsAttachedCreatedSince 

func ListItemsAttachedCreatedSince(site, id string, createdSince *time.Time) ([]ItemAttached, error)

func ListItemsAttachedPage 

func ListItemsAttachedPage(site string, id string, offset string) ([]ItemAttached, string, error)

func ListItemsAttachedPageSortBy 

func ListItemsAttachedPageSortBy(site string, id string, offset string, sortBy *SortBy) ([]ItemAttached, string, error)

func ListItemsAttachedUpdatedSince 

func ListItemsAttachedUpdatedSince(site, id string, updatedSince *time.Time) ([]ItemAttached, error)

func RetrieveItemAttachedById 

func RetrieveItemAttachedById(site string, id string) (*ItemAttached, error)

type ItemFamily 

type ItemFamily struct {
	Id               string            `json:"id" validate:"required"`
	Name             string            `json:"name" validate:"required"`
	Description      string            `json:"description"`
	Status           enums.StatusEnum  `json:"status"`
	ResourceVersion  int64             `json:"resource_version"`
	UpdatedAt        uint64            `json:"updated_at"`
	Channel          enums.ChannelEnum `json:"channel"`
	BusinessEntityId string            `json:"business_entity_id"`
}

func ListItemFamilies 

func ListItemFamilies(site string) ([]ItemFamily, error)

func ListItemFamiliesCreatedSince 

func ListItemFamiliesCreatedSince(site string, createdSince *time.Time) ([]ItemFamily, error)

func ListItemFamiliesPage 

func ListItemFamiliesPage(site string, offset string) ([]ItemFamily, string, error)

func ListItemFamiliesPageSortBy 

func ListItemFamiliesPageSortBy(site string, offset string, sortBy *SortBy) ([]ItemFamily, string, error)

func ListItemFamiliesUpdatedSince 

func ListItemFamiliesUpdatedSince(site string, updatedSince *time.Time) ([]ItemFamily, error)

func RetrieveItemFamilyById 

func RetrieveItemFamilyById(site string, id string) (*ItemFamily, error)

type ItemPrice 

type ItemPrice struct {
	Id                              string                                    `json:"id" validate:"required"`
	Name                            string                                    `json:"name" validate:"required"`
	ItemFamilyId                    string                                    `json:"item_family_id"`
	ItemId                          string                                    `json:"item_id"`
	Description                     string                                    `json:"description"`
	Status                          enums.StatusEnum                          `json:"status"`
	ExternalName                    string                                    `json:"external_name"`
	PriceVariantId                  string                                    `json:"price_variant_id"`
	ProrationType                   enums.ProrationTypeEnum                   `json:"proration_type"`
	PricingModel                    enums.PricingModelEnum                    `json:"pricing_model" validate:"required"`
	Price                           uint64                                    `json:"price"`
	PriceInDecimal                  string                                    `json:"price_in_decimal"`
	Period                          int                                       `json:"period"`
	CurrencyCode                    string                                    `json:"currency_code" validate:"required"`
	PeriodUnit                      enums.PeriodUnitEnum                      `json:"period_unit"`
	TrialPeriod                     int                                       `json:"trial_period"`
	TrialPeriodUnit                 enums.TrialPeriodUnitEnum                 `json:"trial_period_unit"`
	TrialEndAction                  enums.TrialEndActionEnum                  `json:"trial_end_action"`
	ShippingPeriod                  int                                       `json:"shipping_period"`
	ShippingPeriodUnit              enums.ShippingPeriodUnitEnum              `json:"shipping_period_unit"`
	BillingCycles                   int                                       `json:"billing_cycles"`
	FreeQuantity                    int                                       `json:"free_quantity" validate:"required"`
	FreeQuantityInDecimal           string                                    `json:"free_quantity_in_decimal"`
	Channel                         enums.ChannelEnum                         `json:"channel"`
	ResourceVersion                 int64                                     `json:"resource_version"`
	UpdatedAt                       uint64                                    `json:"updated_at"`
	CreatedAt                       uint64                                    `json:"created_at" validate:"required"`
	UsageAccumulationResetFrequency enums.UsageAccumulationResetFrequencyEnum `json:"usage_accumulation_reset_frequency"`
	ArchivedAt                      uint64                                    `json:"archived_at"`
	InvoiceNotes                    string                                    `json:"invoice_notes"`
	IsTaxable                       bool                                      `json:"is_taxable"`
	Metadata                        map[string]interface{}                    `json:"metadata"`
	ItemType                        enums.ItemTypeEnum                        `json:"item_type"`
	ShowDescriptionInInvoices       bool                                      `json:"show_description_in_invoices"`
	ShowDescriptionInQuotes         bool                                      `json:"show_description_in_quotes"`
	BusinessEntityId                string                                    `json:"business_entity_id"`
	Tiers                           []models.Tier                             `json:"tiers"`
	TaxDetail                       models.TaxDetail                          `json:"tax_detail"`
	TaxProvidersFields              []models.TaxProvidersField                `json:"tax_providers_fields"`
	AccountingDetail                models.AccountingDetail                   `json:"accounting_detail"`
}

func ListItemPrices 

func ListItemPrices(site string) ([]ItemPrice, error)

func ListItemPricesCreatedSince 

func ListItemPricesCreatedSince(site string, createdSince *time.Time) ([]ItemPrice, error)

func ListItemPricesPage 

func ListItemPricesPage(site string, offset string) ([]ItemPrice, string, error)

func ListItemPricesPageSortBy 

func ListItemPricesPageSortBy(site string, offset string, sortBy *SortBy) ([]ItemPrice, string, error)

func ListItemPricesUpdatedSince 

func ListItemPricesUpdatedSince(site string, updatedSince *time.Time) ([]ItemPrice, error)

func RetrieveItemPriceById 

func RetrieveItemPriceById(site string, id string) (*ItemPrice, error)

type Order 

type Order struct {
	Id                      string                             `json:"id" validate:"required"`
	DocumentNumber          string                             `json:"document_number"`
	InvoiceId               string                             `json:"invoice_id"`
	SubscriptionId          string                             `json:"subscription_id"`
	CustomerId              string                             `json:"customer_id"`
	Status                  enums.StatusEnum                   `json:"status"`
	CancellationReason      enums.CancellationReasonEnum       `json:"cancellation_reason"`
	PaymentStatus           enums.PaymentStatusEnum            `json:"payment_status"`
	OrderType               enums.OrderTypeEnum                `json:"order_type"`
	PriceType               enums.PriceTypeEnum                `json:"price_type" validate:"required"`
	ReferenceId             string                             `json:"reference_id"`
	FulfillmentStatus       string                             `json:"fulfillment_status"`
	OrderDate               uint64                             `json:"order_date"`
	ShippingDate            uint64                             `json:"shipping_date"`
	Note                    string                             `json:"note"`
	TrackingId              string                             `json:"tracking_id"`
	TrackingUrl             string                             `json:"tracking_url"`
	BatchId                 string                             `json:"batch_id"`
	CreatedBy               string                             `json:"created_by"`
	ShipmentCarrier         string                             `json:"shipment_carrier"`
	InvoiceRoundOffAmount   uint64                             `json:"invoice_round_off_amount"`
	Tax                     uint64                             `json:"tax"`
	AmountPaid              uint64                             `json:"amount_paid"`
	AmountAdjusted          uint64                             `json:"amount_adjusted"`
	RefundableCreditsIssued uint64                             `json:"refundable_credits_issued"`
	RefundableCredits       uint64                             `json:"refundable_credits"`
	RoundingAdjustement     uint64                             `json:"rounding_adjustement"`
	PaidOn                  uint64                             `json:"paid_on"`
	ShippingCutOffDate      uint64                             `json:"shipping_cut_off_date"`
	CreatedAt               uint64                             `json:"created_at" validate:"required"`
	StatusUpdateAt          uint64                             `json:"status_update_at"`
	DeliveredAt             uint64                             `json:"delivered_at"`
	ShippedAt               uint64                             `json:"shipped_at"`
	ResourceVersion         int64                              `json:"resource_version"`
	UpdatedAt               uint64                             `json:"updated_at"`
	CancelledAt             uint64                             `json:"cancelled_at"`
	ResentStatus            enums.ResentStatusEnum             `json:"resent_status"`
	IsResent                bool                               `json:"is_resent" validate:"required"`
	OriginalOrderId         string                             `json:"original_order_id"`
	Discount                uint64                             `json:"discount"`
	SubTotal                uint64                             `json:"sub_total"`
	Total                   uint64                             `json:"total"`
	Deleted                 bool                               `json:"deleted" validate:"required"`
	CurrencyCode            string                             `json:"currency_code"`
	IsGifted                bool                               `json:"is_gifted"`
	GiftNote                string                             `json:"gift_note"`
	GiftId                  string                             `json:"gift_id"`
	ResendReason            string                             `json:"resend_reason"`
	BusinessEntityId        string                             `json:"business_entity_id"`
	OrderLineItems          []models.OrderLineItem             `json:"order_line_items"`
	ShippingAddress         models.ShippingAddress             `json:"shipping_address"`
	BillingAddress          models.BillingAddress              `json:"billing_address"`
	LineItemTaxes           []models.LineItemTax               `json:"line_item_taxes"`
	LineItemDiscounts       []models.LineItemDiscount          `json:"line_item_discounts"`
	LinkedCreditNotes       []models.OrderLineItemLinkedCredit `json:"linked_credit_notes"`
	ResentOrders            []models.ResentOrder               `json:"resent_orders"`
}

func ListOrders 

func ListOrders(site string) ([]Order, error)

func ListOrdersCreatedSince 

func ListOrdersCreatedSince(site string, createdSince *time.Time) ([]Order, error)

func ListOrdersPage 

func ListOrdersPage(site string, offset string) ([]Order, string, error)

func ListOrdersPageSortBy 

func ListOrdersPageSortBy(site string, offset string, sortBy *SortBy) ([]Order, string, error)

func ListOrdersUpdatedSince 

func ListOrdersUpdatedSince(site string, updatedSince *time.Time) ([]Order, error)

func RetrieveOrderById 

func RetrieveOrderById(site string, id string) (*Order, error)

type PaymentReferenceNumber 

type PaymentReferenceNumber struct {
	Id        string         `json:"id" validate:"required"`
	Type      enums.TypeEnum `json:"type" validate:"required"`
	Number    string         `json:"number" validate:"required"`
	InvoiceId string         `json:"invoice_id"`
}

func ListPaymentReferenceNumbers 

func ListPaymentReferenceNumbers(site, id string) ([]PaymentReferenceNumber, error)

func ListPaymentReferenceNumbersCreatedSince 

func ListPaymentReferenceNumbersCreatedSince(site, id string, createdSince *time.Time) ([]PaymentReferenceNumber, error)

func ListPaymentReferenceNumbersPage 

func ListPaymentReferenceNumbersPage(site string, id string, offset string) ([]PaymentReferenceNumber, string, error)

func ListPaymentReferenceNumbersPageSortBy 

func ListPaymentReferenceNumbersPageSortBy(site string, id string, offset string, sortBy *SortBy) ([]PaymentReferenceNumber, string, error)

func ListPaymentReferenceNumbersUpdatedSince 

func ListPaymentReferenceNumbersUpdatedSince(site, id string, updatedSince *time.Time) ([]PaymentReferenceNumber, error)

type PaymentSource 

type PaymentSource struct {
	Id               string                   `json:"id" validate:"required"`
	ResourceVersion  int64                    `json:"resource_version"`
	UpdatedAt        uint64                   `json:"updated_at"`
	CreatedAt        uint64                   `json:"created_at" validate:"required"`
	CustomerId       string                   `json:"customer_id" validate:"required"`
	Type             enums.TypeEnum           `json:"type" validate:"required"`
	ReferenceId      string                   `json:"reference_id" validate:"required"`
	Status           enums.StatusEnum         `json:"status" validate:"required"`
	Gateway          enums.GatewayEnum        `json:"gateway" validate:"required"`
	GatewayAccountId string                   `json:"gateway_account_id"`
	IpAddress        string                   `json:"ip_address"`
	IssuingCountry   string                   `json:"issuing_country"`
	Deleted          bool                     `json:"deleted" validate:"required"`
	BusinessEntityId string                   `json:"business_entity_id"`
	Card             models.Card              `json:"card"`
	BankAccount      models.BankAccount       `json:"bank_account"`
	Boleto           models.CustVoucherSource `json:"boleto"`
	BillingAddress   models.BillingAddress    `json:"billing_address"`
	AmazonPayment    models.AmazonPayment     `json:"amazon_payment"`
	Upi              models.Upi               `json:"upi"`
	Paypal           models.Paypal            `json:"paypal"`
	Venmo            models.Venmo             `json:"venmo"`
	KlarnaPayNow     models.KlarnaPayNow      `json:"klarna_pay_now"`
	Mandates         []models.Mandate         `json:"mandates"`
}

func ListPaymentSources 

func ListPaymentSources(site string) ([]PaymentSource, error)

func ListPaymentSourcesCreatedSince 

func ListPaymentSourcesCreatedSince(site string, createdSince *time.Time) ([]PaymentSource, error)

func ListPaymentSourcesPage 

func ListPaymentSourcesPage(site string, offset string) ([]PaymentSource, string, error)

func ListPaymentSourcesPageSortBy 

func ListPaymentSourcesPageSortBy(site string, offset string, sortBy *SortBy) ([]PaymentSource, string, error)

func ListPaymentSourcesUpdatedSince 

func ListPaymentSourcesUpdatedSince(site string, updatedSince *time.Time) ([]PaymentSource, error)

func RetrievePaymentSourceById 

func RetrievePaymentSourceById(site string, id string) (*PaymentSource, error)

type PaymentVoucher 

type PaymentVoucher struct {
	Id                 string                         `json:"id" validate:"required"`
	IdAtGateway        string                         `json:"id_at_gateway"`
	PaymentVoucherType enums.PaymentVoucherTypeEnum   `json:"payment_voucher_type" validate:"required"`
	ExpiresAt          uint64                         `json:"expires_at"`
	Status             enums.StatusEnum               `json:"status"`
	SubscriptionId     string                         `json:"subscription_id"`
	CurrencyCode       string                         `json:"currency_code" validate:"required"`
	Amount             uint64                         `json:"amount"`
	GatewayAccountId   string                         `json:"gateway_account_id"`
	PaymentSourceId    string                         `json:"payment_source_id"`
	Gateway            enums.GatewayEnum              `json:"gateway" validate:"required"`
	Payload            string                         `json:"payload"`
	ErrorCode          string                         `json:"error_code"`
	ErrorText          string                         `json:"error_text"`
	Url                string                         `json:"url"`
	Date               uint64                         `json:"date"`
	ResourceVersion    int64                          `json:"resource_version"`
	UpdatedAt          uint64                         `json:"updated_at"`
	CustomerId         string                         `json:"customer_id" validate:"required"`
	LinkedInvoices     []models.InvoicePaymentVoucher `json:"linked_invoices"`
}

func ListCustomerPaymentVouchers 

func ListCustomerPaymentVouchers(site, id string) ([]PaymentVoucher, error)

func ListCustomerPaymentVouchersCreatedSince 

func ListCustomerPaymentVouchersCreatedSince(site, id string, createdSince *time.Time) ([]PaymentVoucher, error)

func ListCustomerPaymentVouchersPage 

func ListCustomerPaymentVouchersPage(site string, id string, offset string) ([]PaymentVoucher, string, error)

func ListCustomerPaymentVouchersPageSortBy 

func ListCustomerPaymentVouchersPageSortBy(site string, id string, offset string, sortBy *SortBy) ([]PaymentVoucher, string, error)

func ListCustomerPaymentVouchersUpdatedSince 

func ListCustomerPaymentVouchersUpdatedSince(site, id string, updatedSince *time.Time) ([]PaymentVoucher, error)

func ListInvoicePaymentVouchers 

func ListInvoicePaymentVouchers(site, id string) ([]PaymentVoucher, error)

func ListInvoicePaymentVouchersCreatedSince 

func ListInvoicePaymentVouchersCreatedSince(site, id string, createdSince *time.Time) ([]PaymentVoucher, error)

func ListInvoicePaymentVouchersPage 

func ListInvoicePaymentVouchersPage(site string, id string, offset string) ([]PaymentVoucher, string, error)

func ListInvoicePaymentVouchersPageSortBy 

func ListInvoicePaymentVouchersPageSortBy(site string, id string, offset string, sortBy *SortBy) ([]PaymentVoucher, string, error)

func ListInvoicePaymentVouchersUpdatedSince 

func ListInvoicePaymentVouchersUpdatedSince(site, id string, updatedSince *time.Time) ([]PaymentVoucher, error)

type PromotionalCredit 

type PromotionalCredit struct {
	Id              string               `json:"id" validate:"required"`
	CustomerId      string               `json:"customer_id" validate:"required"`
	Type            enums.TypeEnum       `json:"type" validate:"required"`
	AmountInDecimal string               `json:"amount_in_decimal"`
	Amount          uint64               `json:"amount" validate:"required"`
	CurrencyCode    string               `json:"currency_code" validate:"required"`
	Description     string               `json:"description" validate:"required"`
	CreditType      enums.CreditTypeEnum `json:"credit_type" validate:"required"`
	Reference       string               `json:"reference"`
	ClosingBalance  uint64               `json:"closing_balance" validate:"required"`
	DoneBy          string               `json:"done_by"`
	CreatedAt       uint64               `json:"created_at" validate:"required"`
}

func ListPromotionalCredits 

func ListPromotionalCredits(site string) ([]PromotionalCredit, error)

func ListPromotionalCreditsCreatedSince 

func ListPromotionalCreditsCreatedSince(site string, createdSince *time.Time) ([]PromotionalCredit, error)

func ListPromotionalCreditsPage 

func ListPromotionalCreditsPage(site string, offset string) ([]PromotionalCredit, string, error)

func ListPromotionalCreditsPageSortBy 

func ListPromotionalCreditsPageSortBy(site string, offset string, sortBy *SortBy) ([]PromotionalCredit, string, error)

func ListPromotionalCreditsUpdatedSince 

func ListPromotionalCreditsUpdatedSince(site string, updatedSince *time.Time) ([]PromotionalCredit, error)

func RetrievePromotionalCreditById 

func RetrievePromotionalCreditById(site string, id string) (*PromotionalCredit, error)

type Quote 

type Quote struct {
	Id                         string                    `json:"id" validate:"required"`
	Name                       string                    `json:"name"`
	PoNumber                   string                    `json:"po_number"`
	CustomerId                 string                    `json:"customer_id" validate:"required"`
	SubscriptionId             string                    `json:"subscription_id"`
	InvoiceId                  string                    `json:"invoice_id"`
	Status                     enums.StatusEnum          `json:"status" validate:"required"`
	OperationType              enums.OperationTypeEnum   `json:"operation_type" validate:"required"`
	VatNumber                  string                    `json:"vat_number"`
	PriceType                  enums.PriceTypeEnum       `json:"price_type" validate:"required"`
	ValidTill                  uint64                    `json:"valid_till" validate:"required"`
	Date                       uint64                    `json:"date" validate:"required"`
	TotalPayable               uint64                    `json:"total_payable"`
	ChargeOnAcceptance         uint64                    `json:"charge_on_acceptance"`
	SubTotal                   uint64                    `json:"sub_total" validate:"required"`
	Total                      uint64                    `json:"total"`
	CreditsApplied             uint64                    `json:"credits_applied"`
	AmountPaid                 uint64                    `json:"amount_paid"`
	AmountDue                  uint64                    `json:"amount_due"`
	Version                    int                       `json:"version"`
	ResourceVersion            int64                     `json:"resource_version"`
	UpdatedAt                  uint64                    `json:"updated_at"`
	VatNumberPrefix            string                    `json:"vat_number_prefix"`
	TaxCategory                string                    `json:"tax_category"`
	CurrencyCode               string                    `json:"currency_code" validate:"required"`
	Notes                      []string                  `json:"notes"`
	ContractTermStart          uint64                    `json:"contract_term_start"`
	ContractTermEnd            uint64                    `json:"contract_term_end"`
	ContractTermTerminationFee uint64                    `json:"contract_term_termination_fee"`
	BusinessEntityId           string                    `json:"business_entity_id"`
	LineItems                  []models.LineItem         `json:"line_items"`
	Discounts                  []models.Discount         `json:"discounts"`
	LineItemDiscounts          []models.LineItemDiscount `json:"line_item_discounts"`
	Taxes                      []models.Tax              `json:"taxes"`
	LineItemTaxes              []models.LineItemTax      `json:"line_item_taxes"`
	LineItemTiers              []models.LineItemTier     `json:"line_item_tiers"`
	ShippingAddress            models.ShippingAddress    `json:"shipping_address"`
	BillingAddress             models.BillingAddress     `json:"billing_address"`
}

func ListQuotes 

func ListQuotes(site string) ([]Quote, error)

func ListQuotesCreatedSince 

func ListQuotesCreatedSince(site string, createdSince *time.Time) ([]Quote, error)

func ListQuotesPage 

func ListQuotesPage(site string, offset string) ([]Quote, string, error)

func ListQuotesPageSortBy 

func ListQuotesPageSortBy(site string, offset string, sortBy *SortBy) ([]Quote, string, error)

func ListQuotesUpdatedSince 

func ListQuotesUpdatedSince(site string, updatedSince *time.Time) ([]Quote, error)

func RetrieveQuoteById 

func RetrieveQuoteById(site string, id string) (*Quote, error)

type QuoteLineGroup 

type QuoteLineGroup struct {
	Version            int                       `json:"version"`
	Id                 string                    `json:"id"`
	SubTotal           uint64                    `json:"sub_total" validate:"required"`
	Total              uint64                    `json:"total"`
	CreditsApplied     uint64                    `json:"credits_applied"`
	AmountPaid         uint64                    `json:"amount_paid"`
	AmountDue          uint64                    `json:"amount_due"`
	ChargeEvent        enums.ChargeEventEnum     `json:"charge_event"`
	BillingCycleNumber int                       `json:"billing_cycle_number"`
	LineItems          []models.LineItem         `json:"line_items"`
	Discounts          []models.Discount         `json:"discounts"`
	LineItemDiscounts  []models.LineItemDiscount `json:"line_item_discounts"`
	Taxes              []models.Tax              `json:"taxes"`
	LineItemTaxes      []models.LineItemTax      `json:"line_item_taxes"`
}

func ListAllQuoteLineGroupsPage 

func ListAllQuoteLineGroupsPage(site string, offset string) ([]QuoteLineGroup, string, error)

func ListAllQuoteLineGroupsPageSortBy 

func ListAllQuoteLineGroupsPageSortBy(site string, offset string, sortBy *SortBy) ([]QuoteLineGroup, string, error)

func ListQuoteLineGroups 

func ListQuoteLineGroups(site, id string) ([]QuoteLineGroup, error)

func ListQuoteLineGroupsCreatedSince 

func ListQuoteLineGroupsCreatedSince(site, id string, createdSince *time.Time) ([]QuoteLineGroup, error)

func ListQuoteLineGroupsPage 

func ListQuoteLineGroupsPage(site string, id string, offset string) ([]QuoteLineGroup, string, error)

func ListQuoteLineGroupsPageSortBy 

func ListQuoteLineGroupsPageSortBy(site string, id string, offset string, sortBy *SortBy) ([]QuoteLineGroup, string, error)

func ListQuoteLineGroupsUpdatedSince 

func ListQuoteLineGroupsUpdatedSince(site, id string, updatedSince *time.Time) ([]QuoteLineGroup, error)

type QuotedCharge 

type QuotedCharge struct {
	Charges      []models.Charge    `json:"charges"`
	InvoiceItems []models.ItemPrice `json:"invoice_items"`
	ItemTiers    []models.ItemTier  `json:"item_tiers"`
	Coupons      []models.Coupon    `json:"coupons"`
	Discounts    []models.Discount  `json:"discounts"`
}

type QuotedSubscription 

type QuotedSubscription struct {
	Id                                string                    `json:"id" validate:"required"`
	StartDate                         uint64                    `json:"start_date"`
	TrialEnd                          uint64                    `json:"trial_end"`
	RemainingBillingCycles            int                       `json:"remaining_billing_cycles"`
	PoNumber                          string                    `json:"po_number"`
	PlanQuantityInDecimal             string                    `json:"plan_quantity_in_decimal"`
	PlanUnitPriceInDecimal            string                    `json:"plan_unit_price_in_decimal"`
	ChangesScheduledAt                uint64                    `json:"changes_scheduled_at"`
	ChangeOption                      enums.ChangeOptionEnum    `json:"change_option"`
	ContractTermBillingCycleOnRenewal int                       `json:"contract_term_billing_cycle_on_renewal"`
	Coupons                           []models.Coupon           `json:"coupons"`
	Discounts                         []models.Discount         `json:"discounts"`
	SubscriptionItems                 []models.SubscriptionItem `json:"subscription_items"`
	ItemTiers                         []models.ItemTier         `json:"item_tiers"`
	QuotedContractTerm                models.QuotedContractTerm `json:"quoted_contract_term"`
}

type Ramp 

type Ramp struct {
	Id                     string                        `json:"id" validate:"required"`
	Description            string                        `json:"description"`
	SubscriptionId         string                        `json:"subscription_id" validate:"required"`
	EffectiveFrom          uint64                        `json:"effective_from" validate:"required"`
	Status                 enums.StatusEnum              `json:"status" validate:"required"`
	CreatedAt              uint64                        `json:"created_at" validate:"required"`
	ResourceVersion        int64                         `json:"resource_version"`
	UpdatedAt              uint64                        `json:"updated_at"`
	ItemsToRemove          []string                      `json:"items_to_remove"`
	CouponsToRemove        []string                      `json:"coupons_to_remove"`
	DiscountsToRemove      []string                      `json:"discounts_to_remove"`
	Deleted                bool                          `json:"deleted" validate:"required"`
	ItemsToAdd             []models.ItemsToAdd           `json:"items_to_add"`
	ItemsToUpdate          []models.ItemsToUpdate        `json:"items_to_update"`
	CouponsToAdd           []models.CouponsToAdd         `json:"coupons_to_add"`
	DiscountsToAdd         []models.DiscountsToAdd       `json:"discounts_to_add"`
	ItemTiers              []models.ItemTier             `json:"item_tiers"`
	StatusTransitionReason models.StatusTransitionReason `json:"status_transition_reason"`
}

func ListRamps 

func ListRamps(site string) ([]Ramp, error)

func ListRampsCreatedSince 

func ListRampsCreatedSince(site string, createdSince *time.Time) ([]Ramp, error)

func ListRampsPage 

func ListRampsPage(site string, offset string) ([]Ramp, string, error)

func ListRampsPageSortBy 

func ListRampsPageSortBy(site string, offset string, sortBy *SortBy) ([]Ramp, string, error)

func ListRampsUpdatedSince 

func ListRampsUpdatedSince(site string, updatedSince *time.Time) ([]Ramp, error)

type Subscription 

type Subscription struct {
	Id                                string                    `json:"id" validate:"required"`
	CurrencyCode                      string                    `json:"currency_code" validate:"required"`
	StartDate                         uint64                    `json:"start_date"`
	TrialEnd                          uint64                    `json:"trial_end"`
	RemainingBillingCycles            int                       `json:"remaining_billing_cycles"`
	PoNumber                          string                    `json:"po_number"`
	PlanQuantityInDecimal             string                    `json:"plan_quantity_in_decimal"`
	PlanUnitPriceInDecimal            string                    `json:"plan_unit_price_in_decimal"`
	CustomerId                        string                    `json:"customer_id" validate:"required"`
	Status                            enums.StatusEnum          `json:"status" validate:"required"`
	TrialStart                        uint64                    `json:"trial_start"`
	TrialEndAction                    enums.TrialEndActionEnum  `json:"trial_end_action"`
	CurrentTermStart                  uint64                    `json:"current_term_start"`
	CurrentTermEnd                    uint64                    `json:"current_term_end"`
	NextBillingAt                     uint64                    `json:"next_billing_at"`
	CreatedAt                         uint64                    `json:"created_at"`
	StartedAt                         uint64                    `json:"started_at"`
	ActivatedAt                       uint64                    `json:"activated_at"`
	ContractTermBillingCycleOnRenewal int                       `json:"contract_term_billing_cycle_on_renewal"`
	OverrideRelationship              bool                      `json:"override_relationship"`
	PauseDate                         uint64                    `json:"pause_date"`
	ResumeDate                        uint64                    `json:"resume_date"`
	CancelledAt                       uint64                    `json:"cancelled_at"`
	CancelReason                      enums.CancelReasonEnum    `json:"cancel_reason"`
	CreatedFromIp                     string                    `json:"created_from_ip"`
	ResourceVersion                   int64                     `json:"resource_version"`
	UpdatedAt                         uint64                    `json:"updated_at"`
	HasScheduledAdvanceInvoices       bool                      `json:"has_scheduled_advance_invoices" validate:"required"`
	HasScheduledChanges               bool                      `json:"has_scheduled_changes" validate:"required"`
	PaymentSourceId                   string                    `json:"payment_source_id"`
	PlanFreeQuantityInDecimal         string                    `json:"plan_free_quantity_in_decimal"`
	PlanAmountInDecimal               string                    `json:"plan_amount_in_decimal"`
	CancelScheduleCreatedAt           uint64                    `json:"cancel_schedule_created_at"`
	Channel                           enums.ChannelEnum         `json:"channel"`
	NetTermDays                       int                       `json:"net_term_days"`
	ActiveId                          string                    `json:"active_id"`
	DueInvoicesCount                  int                       `json:"due_invoices_count"`
	DueSince                          uint64                    `json:"due_since"`
	TotalDues                         uint64                    `json:"total_dues"`
	Mrr                               uint64                    `json:"mrr"`
	ExchangeRate                      *decimal.Decimal          `json:"exchange_rate"`
	BaseCurrencyCode                  string                    `json:"base_currency_code"`
	InvoiceNotes                      string                    `json:"invoice_notes"`
	Metadata                          map[string]interface{}    `json:"metadata"`
	Deleted                           bool                      `json:"deleted" validate:"required"`
	ChangesScheduledAt                uint64                    `json:"changes_scheduled_at"`
	CancelReasonCode                  string                    `json:"cancel_reason_code"`
	FreePeriod                        int                       `json:"free_period"`
	FreePeriodUnit                    enums.FreePeriodUnitEnum  `json:"free_period_unit"`
	CreatePendingInvoices             bool                      `json:"create_pending_invoices"`
	AutoCloseInvoices                 bool                      `json:"auto_close_invoices"`
	BusinessEntityId                  string                    `json:"business_entity_id"`
	SubscriptionItems                 []models.SubscriptionItem `json:"subscription_items"`
	ItemTiers                         []models.ItemTier         `json:"item_tiers"`
	ChargedItems                      []models.ChargedItem      `json:"charged_items"`
	Coupons                           []models.Coupon           `json:"coupons"`
	ShippingAddress                   models.ShippingAddress    `json:"shipping_address"`
	ReferralInfo                      models.ReferralInfo       `json:"referral_info"`
	ContractTerm                      models.ContractTerm       `json:"contract_term"`
	Discounts                         []models.Discount         `json:"discounts"`
}

func ListSubscriptionWithScheduledChangesPage 

func ListSubscriptionWithScheduledChangesPage(site string, id string, offset string) ([]Subscription, string, error)

func ListSubscriptionWithScheduledChangesPageSortBy 

func ListSubscriptionWithScheduledChangesPageSortBy(site string, id string, offset string, sortBy *SortBy) ([]Subscription, string, error)

func ListSubscriptions 

func ListSubscriptions(site string) ([]Subscription, error)

func ListSubscriptionsCreatedSince 

func ListSubscriptionsCreatedSince(site string, createdSince *time.Time) ([]Subscription, error)

func ListSubscriptionsPage 

func ListSubscriptionsPage(site string, offset string) ([]Subscription, string, error)

func ListSubscriptionsPageSortBy 

func ListSubscriptionsPageSortBy(site string, offset string, sortBy *SortBy) ([]Subscription, string, error)

func ListSubscriptionsUpdatedSince 

func ListSubscriptionsUpdatedSince(site string, updatedSince *time.Time) ([]Subscription, error)

type SubscriptionEntitlement 

type SubscriptionEntitlement struct {
	SubscriptionId string           `json:"subscription_id" validate:"required"`
	FeatureId      string           `json:"feature_id"`
	FeatureName    string           `json:"feature_name"`
	FeatureUnit    string           `json:"feature_unit"`
	FeatureType    string           `json:"feature_type"`
	Value          string           `json:"value"`
	Name           string           `json:"name"`
	IsOverridden   bool             `json:"is_overridden" validate:"required"`
	IsEnabled      bool             `json:"is_enabled" validate:"required"`
	ExpiresAt      uint64           `json:"expires_at"`
	Components     models.Component `json:"components"`
}

func ListSubscriptionEntitlements 

func ListSubscriptionEntitlements(site, id string) ([]SubscriptionEntitlement, error)

func ListSubscriptionEntitlementsCreatedSince 

func ListSubscriptionEntitlementsCreatedSince(site, id string, createdSince *time.Time) ([]SubscriptionEntitlement, error)

func ListSubscriptionEntitlementsPage 

func ListSubscriptionEntitlementsPage(site string, id string, offset string) ([]SubscriptionEntitlement, string, error)

func ListSubscriptionEntitlementsPageSortBy 

func ListSubscriptionEntitlementsPageSortBy(site string, id string, offset string, sortBy *SortBy) ([]SubscriptionEntitlement, string, error)

func ListSubscriptionEntitlementsUpdatedSince 

func ListSubscriptionEntitlementsUpdatedSince(site, id string, updatedSince *time.Time) ([]SubscriptionEntitlement, error)

type Transaction 

type Transaction struct {
	Id                       string                         `json:"id" validate:"required"`
	CustomerId               string                         `json:"customer_id"`
	SubscriptionId           string                         `json:"subscription_id"`
	GatewayAccountId         string                         `json:"gateway_account_id"`
	PaymentSourceId          string                         `json:"payment_source_id"`
	PaymentMethod            enums.PaymentMethodEnum        `json:"payment_method" validate:"required"`
	ReferenceNumber          string                         `json:"reference_number"`
	Gateway                  enums.GatewayEnum              `json:"gateway" validate:"required"`
	Type                     enums.TypeEnum                 `json:"type" validate:"required"`
	Date                     uint64                         `json:"date"`
	SettledAt                uint64                         `json:"settled_at"`
	ExchangeRate             *decimal.Decimal               `json:"exchange_rate"`
	CurrencyCode             string                         `json:"currency_code" validate:"required"`
	Amount                   uint64                         `json:"amount"`
	IdAtGateway              string                         `json:"id_at_gateway"`
	Status                   enums.StatusEnum               `json:"status"`
	FraudFlag                enums.FraudFlagEnum            `json:"fraud_flag"`
	InitiatorType            enums.InitiatorTypeEnum        `json:"initiator_type"`
	ThreeDSecure             bool                           `json:"three_d_secure"`
	AuthorizationReason      enums.AuthorizationReasonEnum  `json:"authorization_reason"`
	ErrorCode                string                         `json:"error_code"`
	ErrorText                string                         `json:"error_text"`
	VoidedAt                 uint64                         `json:"voided_at"`
	ResourceVersion          int64                          `json:"resource_version"`
	UpdatedAt                uint64                         `json:"updated_at"`
	FraudReason              string                         `json:"fraud_reason"`
	CustomPaymentMethodId    string                         `json:"custom_payment_method_id"`
	AmountUnused             uint64                         `json:"amount_unused"`
	MaskedCardNumber         string                         `json:"masked_card_number"`
	ReferenceTransactionId   string                         `json:"reference_transaction_id"`
	RefundedTxnId            string                         `json:"refunded_txn_id"`
	ReferenceAuthorizationId string                         `json:"reference_authorization_id"`
	AmountCapturable         uint64                         `json:"amount_capturable"`
	ReversalTransactionId    string                         `json:"reversal_transaction_id"`
	Deleted                  bool                           `json:"deleted" validate:"required"`
	Iin                      string                         `json:"iin"`
	Last4                    string                         `json:"last4"`
	MerchantReferenceId      string                         `json:"merchant_reference_id"`
	BusinessEntityId         string                         `json:"business_entity_id"`
	PaymentMethodDetails     string                         `json:"payment_method_details"`
	CustomPaymentMethodName  string                         `json:"custom_payment_method_name"`
	LinkedInvoices           []models.InvoiceTransaction    `json:"linked_invoices"`
	LinkedCreditNotes        []models.CreditNoteTransaction `json:"linked_credit_notes"`
	LinkedRefunds            []models.TxnRefundsAndReversal `json:"linked_refunds"`
	LinkedPayments           []models.LinkedPayment         `json:"linked_payments"`
	ErrorDetail              models.GatewayErrorDetail      `json:"error_detail"`
}

func ListInvoicePayments 

func ListInvoicePayments(site, id string) ([]Transaction, error)

func ListInvoicePaymentsCreatedSince 

func ListInvoicePaymentsCreatedSince(site, id string, createdSince *time.Time) ([]Transaction, error)

func ListInvoicePaymentsPage 

func ListInvoicePaymentsPage(site string, id string, offset string) ([]Transaction, string, error)

func ListInvoicePaymentsPageSortBy 

func ListInvoicePaymentsPageSortBy(site string, id string, offset string, sortBy *SortBy) ([]Transaction, string, error)

func ListInvoicePaymentsUpdatedSince 

func ListInvoicePaymentsUpdatedSince(site, id string, updatedSince *time.Time) ([]Transaction, error)

func ListTransactions 

func ListTransactions(site string) ([]Transaction, error)

func ListTransactionsCreatedSince 

func ListTransactionsCreatedSince(site string, createdSince *time.Time) ([]Transaction, error)

func ListTransactionsPage 

func ListTransactionsPage(site string, offset string) ([]Transaction, string, error)

func ListTransactionsPageSortBy 

func ListTransactionsPageSortBy(site string, offset string, sortBy *SortBy) ([]Transaction, string, error)

func ListTransactionsUpdatedSince 

func ListTransactionsUpdatedSince(site string, updatedSince *time.Time) ([]Transaction, error)

func RetrieveTransactionById 

func RetrieveTransactionById(site string, id string) (*Transaction, error)

type Usage 

type Usage struct {
	Id              string           `json:"id"`
	UsageDate       uint64           `json:"usage_date" validate:"required"`
	SubscriptionId  string           `json:"subscription_id" validate:"required"`
	ItemPriceId     string           `json:"item_price_id" validate:"required"`
	InvoiceId       string           `json:"invoice_id"`
	LineItemId      string           `json:"line_item_id"`
	Quantity        string           `json:"quantity" validate:"required"`
	Source          enums.SourceEnum `json:"source"`
	Note            string           `json:"note"`
	ResourceVersion int64            `json:"resource_version"`
	UpdatedAt       uint64           `json:"updated_at"`
	CreatedAt       uint64           `json:"created_at" validate:"required"`
}

func ListSubscriptionUsagesPage 

func ListSubscriptionUsagesPage(site string, id string, offset string) ([]Usage, string, error)

func ListSubscriptionUsagesPageSortBy 

func ListSubscriptionUsagesPageSortBy(site string, id string, offset string, sortBy *SortBy) ([]Usage, string, error)

func ListUsages 

func ListUsages(site string) ([]Usage, error)

func ListUsagesCreatedSince 

func ListUsagesCreatedSince(site string, createdSince *time.Time) ([]Usage, error)

func ListUsagesPage 

func ListUsagesPage(site string, offset string) ([]Usage, string, error)

func ListUsagesPageSortBy 

func ListUsagesPageSortBy(site string, offset string, sortBy *SortBy) ([]Usage, string, error)

func ListUsagesUpdatedSince 

func ListUsagesUpdatedSince(site string, updatedSince *time.Time) ([]Usage, error)

type VirtualBankAccount 

type VirtualBankAccount struct {
	Id               string            `json:"id" validate:"required"`
	CustomerId       string            `json:"customer_id" validate:"required"`
	Email            string            `json:"email" validate:"required"`
	Scheme           enums.SchemeEnum  `json:"scheme"`
	BankName         string            `json:"bank_name"`
	AccountNumber    string            `json:"account_number" validate:"required"`
	RoutingNumber    string            `json:"routing_number"`
	SwiftCode        string            `json:"swift_code" validate:"required"`
	Gateway          enums.GatewayEnum `json:"gateway" validate:"required"`
	GatewayAccountId string            `json:"gateway_account_id" validate:"required"`
	ResourceVersion  int64             `json:"resource_version"`
	UpdatedAt        uint64            `json:"updated_at"`
	CreatedAt        uint64            `json:"created_at" validate:"required"`
	ReferenceId      string            `json:"reference_id" validate:"required"`
	Deleted          bool              `json:"deleted" validate:"required"`
}

func ListVirtualBankAccounts 

func ListVirtualBankAccounts(site string) ([]VirtualBankAccount, error)

func ListVirtualBankAccountsCreatedSince 

func ListVirtualBankAccountsCreatedSince(site string, createdSince *time.Time) ([]VirtualBankAccount, error)

func ListVirtualBankAccountsPage 

func ListVirtualBankAccountsPage(site string, offset string) ([]VirtualBankAccount, string, error)

func ListVirtualBankAccountsPageSortBy 

func ListVirtualBankAccountsPageSortBy(site string, offset string, sortBy *SortBy) ([]VirtualBankAccount, string, error)

func ListVirtualBankAccountsUpdatedSince 

func ListVirtualBankAccountsUpdatedSince(site string, updatedSince *time.Time) ([]VirtualBankAccount, error)

func RetrieveVirtualBankAccountById 

func RetrieveVirtualBankAccountById(site string, id string) (*VirtualBankAccount, error)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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