billing

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

type CheckoutOptions struct {
	Owner    string
	Plan     string
	Interval Interval
	// Email fills in the customer's email the first time.
	Email string
	// Seats is the quantity of a per-seat plan; at least 1.
	Seats int
	// SuccessURL and CancelURL are where Stripe sends the customer back:
	// absolute, or paths on the app's own address.
	SuccessURL, CancelURL string
}

type Interval string

type LimitError struct {
	Limit string // "projects"
	Max   int
	Plan  Plan
}

type Options struct {
	// SecretKey is Stripe's secret API key, sk_test_… or sk_live_….
	SecretKey string
	// WebhookSecret signs Stripe's webhooks to the app, whsec_…, from the
	// webhook endpoint's settings or `stripe listen`.
	WebhookSecret string
	// Plans are the plans, in the order the pricing page shows them.
	Plans []Plan
	// FreePlan is the plan of owners without an active subscription. The
	// default is the first plan without prices.
	FreePlan string
	// Jobs processes webhooks in the background, with retries. Without
	// it, they're processed in the webhook's request.
	Jobs *jobs.Queue
	// WebhookPath is where Stripe posts events. The default is
	// /_tern/billing/webhook.
	WebhookPath string
	// OnChange is called after an owner's subscription changes, from the
	// webhook's job: to email a receipt, or record it in the audit log.
	OnChange func(ctx context.Context, s Subscription)

	// APIBase is Stripe's API address, for tests. The default is
	// https://api.stripe.com.
	APIBase string
	// HTTPClient sends the API requests. The default has a 30s timeout.
	HTTPClient *http.Client
}

type Plan struct {
	ID          string `json:"id"`
	Name        string `json:"name"`
	Description string `json:"description"`
	// Prices are the plan's Stripe price IDs, by interval. A plan without
	// prices is free: everyone without a subscription is on it.
	Prices map[Interval]string `json:"-"`
	// Amounts are what the pricing page shows, in the currency's smallest
	// unit (cents), by interval. Stripe charges what its prices say: keep
	// them the same.
	Amounts  map[Interval]int64 `json:"amounts,omitempty"`
	Currency string             `json:"currency,omitempty"` // "usd", "eur"
	// Limits cap what the plan allows: {"projects": 10, "members": 5}. A
	// limit the plan doesn't list is unlimited.
	Limits map[string]int `json:"limits,omitempty"`
	// Features are what the plan includes, for the pricing page and Has.
	Features []string `json:"features,omitempty"`
	// TrialDays is a free trial before the first charge.
	TrialDays int `json:"trialDays,omitempty"`
	// PerSeat charges per member: the subscription's quantity is the seats.
	PerSeat bool `json:"perSeat,omitempty"`
	// Highlight marks the plan to recommend on the pricing page.
	Highlight bool `json:"highlight,omitempty"`

	// Paid and Intervals are for the pricing page, which doesn't see the
	// prices: whether the plan costs money, and the intervals it's paid
	// by. New sets them.
	Paid      bool       `json:"paid"`
	Intervals []Interval `json:"intervals"`
}

type Status string

type StripeError struct {
	Status  int
	Type    string `json:"type"`
	Code    string `json:"code"`
	Message string `json:"message"`
}

type Subscription struct {
	Owner    string   `json:"owner"`
	Plan     string   `json:"plan"`
	Status   Status   `json:"status"`
	Interval Interval `json:"interval"`
	Seats    int      `json:"seats"`
	// CurrentPeriodEnd is when it renews, or ends if CancelAtPeriodEnd.
	CurrentPeriodEnd  time.Time  `json:"currentPeriodEnd"`
	CancelAtPeriodEnd bool       `json:"cancelAtPeriodEnd"`
	TrialEnd          *time.Time `json:"trialEnd"`
	CustomerID        string     `json:"-"`
	SubscriptionID    string     `json:"-"`
	UpdatedAt         time.Time  `json:"updatedAt"`
}