5d656e66bf
This change allows for overriding project usage prices for a specific partner so that users who sign up with that partner do not need their invoices to be manually adjusted. Relates to storj/storj-private#90 Change-Id: Ia54a9cc7c2f8064922bbb15861f974e5dea82d5a
59 lines
2.2 KiB
Go
59 lines
2.2 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)
|
|
|
|
// Balance returns an object that represents current free credits and coins balance in cents.
|
|
Balance(ctx context.Context, userID uuid.UUID) (Balance, error)
|
|
|
|
// 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 user agent.
|
|
// If the user agent is malformed or does not contain a valid partner ID, the default
|
|
// price model is returned.
|
|
GetProjectUsagePriceModel(userAgent []byte) 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
|
|
}
|