a2e3247471
Add and implement interface to manage customer balances. Adds ability to add credit to a user's balance, list balance transactions, and get the balance. Change-Id: I7fd65d07868bb2b7489d1141a5e9049514d6984e
63 lines
2.4 KiB
Go
63 lines
2.4 KiB
Go
// Copyright (C) 2019 Storj Labs, Inc.
|
|
// See LICENSE for copying information.
|
|
|
|
package payments
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"github.com/zeebo/errs"
|
|
|
|
"storj.io/common/uuid"
|
|
)
|
|
|
|
// ErrAccountNotSetup is an error type which indicates that payment account is not created.
|
|
var ErrAccountNotSetup = errs.Class("payment account is not set up")
|
|
|
|
// Accounts exposes all needed functionality to manage payment accounts.
|
|
//
|
|
// architecture: Service
|
|
type Accounts interface {
|
|
// Setup creates a payment account for the user.
|
|
// If account is already set up it will return nil.
|
|
Setup(ctx context.Context, userID uuid.UUID, email string, signupPromoCode string) (CouponType, error)
|
|
|
|
// UpdatePackage updates a customer's package plan information.
|
|
UpdatePackage(ctx context.Context, userID uuid.UUID, packagePlan *string, timestamp *time.Time) error
|
|
|
|
// GetPackageInfo returns the package plan and time of purchase for a user.
|
|
GetPackageInfo(ctx context.Context, userID uuid.UUID) (packagePlan *string, purchaseTime *time.Time, err error)
|
|
|
|
// Balances exposes functionality to manage account balances.
|
|
Balances() Balances
|
|
|
|
// ProjectCharges returns how much money current user will be charged for each project.
|
|
ProjectCharges(ctx context.Context, userID uuid.UUID, since, before time.Time) ([]ProjectCharge, error)
|
|
|
|
// GetProjectUsagePriceModel returns the project usage price model for a partner name.
|
|
GetProjectUsagePriceModel(partner string) ProjectUsagePriceModel
|
|
|
|
// CheckProjectInvoicingStatus returns error if for the given project there are outstanding project records and/or usage
|
|
// which have not been applied/invoiced yet (meaning sent over to stripe).
|
|
CheckProjectInvoicingStatus(ctx context.Context, projectID uuid.UUID) error
|
|
|
|
// CheckProjectUsageStatus returns error if for the given project there is some usage for current or previous month.
|
|
CheckProjectUsageStatus(ctx context.Context, projectID uuid.UUID) error
|
|
|
|
// Charges returns list of all credit card charges related to account.
|
|
Charges(ctx context.Context, userID uuid.UUID) ([]Charge, error)
|
|
|
|
// CreditCards exposes all needed functionality to manage account credit cards.
|
|
CreditCards() CreditCards
|
|
|
|
// StorjTokens exposes all storj token related functionality.
|
|
StorjTokens() StorjTokens
|
|
|
|
// Invoices exposes all needed functionality to manage account invoices.
|
|
Invoices() Invoices
|
|
|
|
// Coupons exposes all needed functionality to manage coupons.
|
|
Coupons() Coupons
|
|
}
|