customer

Documentation

Index

• Variables
• func GetStripeTestClockFromContext(ctx context.Context) (string, bool)
• func GetStripeWebhookSignatureFromContext(ctx context.Context) (string, bool)
• func SetStripeTestClockInContext(ctx context.Context, s string) context.Context
• func SetStripeWebhookSignatureInContext(ctx context.Context, s string) context.Context
• type Address
• type CreditService
• type Customer
  • func (c Customer) IsActive() bool
  • func (c Customer) IsOffline() bool
• type Filter
• type PaymentMethod
• type Provider
• type Repository
• type Service
  • func NewService(stripeClient *client.API, repository Repository, cfg billing.Config, ...) *Service
  • func (s *Service) Close() error
  • func (s *Service) Create(ctx context.Context, customer Customer, offline bool) (Customer, error)
  • func (s *Service) Delete(ctx context.Context, id string) error
  • func (s *Service) Disable(ctx context.Context, id string) error
  • func (s *Service) Enable(ctx context.Context, id string) error
  • func (s *Service) GetByID(ctx context.Context, id string) (Customer, error)
  • func (s *Service) GetByOrgID(ctx context.Context, orgID string) (Customer, error)
  • func (s *Service) Init(ctx context.Context) error
  • func (s *Service) List(ctx context.Context, filter Filter) ([]Customer, error)
  • func (s *Service) ListPaymentMethods(ctx context.Context, id string) ([]PaymentMethod, error)
  • func (s *Service) RegisterToProvider(ctx context.Context, customer Customer) (*stripe.Customer, error)
  • func (s *Service) RegisterToProviderIfRequired(ctx context.Context, customerID string) (Customer, error)
  • func (s *Service) SyncWithProvider(ctx context.Context, customr Customer) error
  • func (s *Service) TriggerSyncByProviderID(ctx context.Context, id string) error
  • func (s *Service) Update(ctx context.Context, customer Customer) (Customer, error)
  • func (s *Service) UpdateCreditMinByID(ctx context.Context, customerID string, limit int64) (Customer, error)
• type State
  • func (s State) String() string
• type Tax

Variables

var (
	ErrNotFound                       = errors.New("customer not found")
	ErrInvalidUUID                    = errors.New("invalid syntax of uuid")
	ErrInvalidID                      = errors.New("billing customer id is invalid")
	ErrConflict                       = errors.New("customer already exist")
	ErrActiveConflict                 = errors.New("an active account already exists for the organization")
	ErrInvalidDetail                  = errors.New("invalid billing customer detail")
	ErrDisabled                       = errors.New("billing customer is disabled")
	ErrExistingAccountWithPendingDues = errors.New("existing account with pending dues found")
)

Functions

func GetStripeTestClockFromContext

func GetStripeTestClockFromContext(ctx context.Context) (string, bool)

GetStripeTestClockFromContext returns the stripe test clock id from the context

func GetStripeWebhookSignatureFromContext

func GetStripeWebhookSignatureFromContext(ctx context.Context) (string, bool)

func SetStripeTestClockInContext

func SetStripeTestClockInContext(ctx context.Context, s string) context.Context

SetStripeTestClockInContext sets the stripe test clock id in the context

func SetStripeWebhookSignatureInContext

func SetStripeWebhookSignatureInContext(ctx context.Context, s string) context.Context

Types

type Address

type Address struct {
	City       string `json:"city"`
	Country    string `json:"country"`
	Line1      string `json:"line1"`
	Line2      string `json:"line2"`
	PostalCode string `json:"postal_code"`
	State      string `json:"state"`
}

type CreditService

type CreditService interface {
	GetBalance(ctx context.Context, id string) (int64, error)
}

type Customer

type Customer struct {
	ID    string
	OrgID string
	// Provider id identifier set by the billing engine provider
	// could be empty if the customer is created as offline
	ProviderID string

	Name    string
	Email   string
	Phone   string
	Address Address
	TaxData []Tax
	// Currency Three-letter ISO 4217 currency code in lower case
	Currency  string `default:"usd"`
	Metadata  metadata.Metadata
	CreditMin int64

	// Stripe specific fields
	// StripeTestClockID is used for testing purposes only to simulate a subscription
	StripeTestClockID *string

	State     State
	CreatedAt time.Time
	UpdatedAt time.Time
	DeletedAt *time.Time
}

func (Customer) IsActive

func (c Customer) IsActive() bool

func (Customer) IsOffline

func (c Customer) IsOffline() bool

type Filter

type Filter struct {
	OrgID      string
	ProviderID string
	State      State
}

type PaymentMethod

type PaymentMethod struct {
	ID         string
	CustomerID string
	ProviderID string
	Type       string

	CardLast4       string
	CardBrand       string
	CardExpiryYear  int64
	CardExpiryMonth int64

	Metadata  metadata.Metadata
	CreatedAt time.Time
}

type Provider

type Provider string

const (
	ProviderStripe Provider = "stripe"
)

type Repository

type Repository interface {
	GetByID(ctx context.Context, id string) (Customer, error)
	List(ctx context.Context, filter Filter) ([]Customer, error)
	Create(ctx context.Context, customer Customer) (Customer, error)
	UpdateByID(ctx context.Context, customer Customer) (Customer, error)
	Delete(ctx context.Context, id string) error
	UpdateCreditMinByID(ctx context.Context, customerID string, limit int64) (Customer, error)
}

type Service

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

func NewService

func NewService(stripeClient *client.API, repository Repository, cfg billing.Config,
	creditService CreditService) *Service

func (*Service) Close

func (s *Service) Close() error

func (*Service) Create

func (s *Service) Create(ctx context.Context, customer Customer, offline bool) (Customer, error)

func (*Service) Delete

func (s *Service) Delete(ctx context.Context, id string) error

func (*Service) Disable

func (s *Service) Disable(ctx context.Context, id string) error

func (*Service) Enable

func (s *Service) Enable(ctx context.Context, id string) error

func (*Service) GetByID

func (s *Service) GetByID(ctx context.Context, id string) (Customer, error)

func (*Service) GetByOrgID

func (s *Service) GetByOrgID(ctx context.Context, orgID string) (Customer, error)

func (*Service) Init

func (s *Service) Init(ctx context.Context) error

func (*Service) List

func (s *Service) List(ctx context.Context, filter Filter) ([]Customer, error)

func (*Service) ListPaymentMethods

func (s *Service) ListPaymentMethods(ctx context.Context, id string) ([]PaymentMethod, error)

func (*Service) RegisterToProvider

func (s *Service) RegisterToProvider(ctx context.Context, customer Customer) (*stripe.Customer, error)

func (*Service) RegisterToProviderIfRequired

func (s *Service) RegisterToProviderIfRequired(ctx context.Context, customerID string) (Customer, error)

func (*Service) SyncWithProvider

func (s *Service) SyncWithProvider(ctx context.Context, customr Customer) error

SyncWithProvider syncs the customer state with the billing provider

func (*Service) TriggerSyncByProviderID

func (s *Service) TriggerSyncByProviderID(ctx context.Context, id string) error

func (*Service) Update

func (s *Service) Update(ctx context.Context, customer Customer) (Customer, error)

func (*Service) UpdateCreditMinByID

func (s *Service) UpdateCreditMinByID(ctx context.Context, customerID string, limit int64) (Customer, error)

type State

type State string

const (
	ActiveState   State = "active"
	DisabledState State = "disabled"
)

func (State) String

func (s State) String() string

type Tax

type Tax struct {
	// Type like "vat", "gst", "sales_tax" or if it's
	// provider specific us_ein, uk_vat, in_gst, etc
	Type string
	// ID is the tax identifier
	ID string
}