sub.go

package stripe

import "encoding/json"

// SubStatus is the list of allowed values for the subscription's status.
// Allowed values are "trialing", "active", "past_due", "canceled", "unpaid", "all".
type SubStatus string

// SubBilling is the type of billing method for this subscription's invoices.
// Currently supported values are "send_invoice" and "charge_automatically".
type SubBilling string

// SubParams is the set of parameters that can be used when creating or updating a subscription.
// For more details see https://stripe.com/docs/api#create_subscription and https://stripe.com/docs/api#update_subscription.
type SubParams struct {
	Params
	Customer, Plan                                  string
	Coupon, Token                                   string
	CouponEmpty                                     bool
	TrialEnd, TrialPeriod                           int64
	Card                                            *CardParams
	Quantity                                        uint64
	ProrationDate                                   int64
	FeePercent, TaxPercent                          float64
	TaxPercentZero                                  bool
	NoProrate, EndCancel, QuantityZero, TrialEndNow bool
	BillingCycleAnchor                              int64
	BillingCycleAnchorNow                           bool
	Items                                           []*SubItemsParams
	Billing                                         SubBilling
	DaysUntilDue                                    uint64
}

// SubItemsParams is the set of parameters that can be used when creating or updating a subscription item on a subscription
// For more details see https://stripe.com/docs/api#create_subscription and https://stripe.com/docs/api#update_subscription.
type SubItemsParams struct {
	Params
	ID                    string
	Quantity              uint64
	Plan                  string
	Deleted, QuantityZero bool
}

// SubListParams is the set of parameters that can be used when listing active subscriptions.
// For more details see https://stripe.com/docs/api#list_subscriptions.
type SubListParams struct {
	ListParams
	Customer string
	Plan     string
	Status   SubStatus
}

// Sub is the resource representing a Stripe subscription.
// For more details see https://stripe.com/docs/api#subscriptions.
type Sub struct {
	ID           string            `json:"id"`
	EndCancel    bool              `json:"cancel_at_period_end"`
	Customer     *Customer         `json:"customer"`
	Plan         *Plan             `json:"plan"`
	Quantity     uint64            `json:"quantity"`
	Status       SubStatus         `json:"status"`
	FeePercent   float64           `json:"application_fee_percent"`
	Canceled     int64             `json:"canceled_at"`
	Created      int64             `json:"created"`
	Start        int64             `json:"start"`
	PeriodEnd    int64             `json:"current_period_end"`
	PeriodStart  int64             `json:"current_period_start"`
	Discount     *Discount         `json:"discount"`
	Ended        int64             `json:"ended_at"`
	Meta         map[string]string `json:"metadata"`
	TaxPercent   float64           `json:"tax_percent"`
	TrialEnd     int64             `json:"trial_end"`
	TrialStart   int64             `json:"trial_start"`
	Items        *SubItemList      `json:"items"`
	Billing      SubBilling        `json:"billing"`
	DaysUntilDue uint64            `json:"days_until_due"`
}

// SubList is a list object for subscriptions.
type SubList struct {
	ListMeta
	Values []*Sub `json:"data"`
}

// UnmarshalJSON handles deserialization of a Sub.
// This custom unmarshaling is needed because the resulting
// property may be an id or the full struct if it was expanded.
func (s *Sub) UnmarshalJSON(data []byte) error {
	type sub Sub
	var ss sub
	err := json.Unmarshal(data, &ss)
	if err == nil {
		*s = Sub(ss)
	} else {
		// the id is surrounded by "\" characters, so strip them
		s.ID = string(data[1 : len(data)-1])
	}

	return nil
}