fee.go

package stripe

import "encoding/json"

// FeeParams is the set of parameters that can be used when refunding an application fee.
// For more details see https://stripe.com/docs/api#refund_application_fee.
type FeeParams struct {
	Params
	Amount uint64
}

// FeeListParams is the set of parameters that can be used when listing application fees.
// For more details see https://stripe.com/docs/api#list_application_fees.
type FeeListParams struct {
	ListParams
	Created int64
	Charge  string
}

// Fee is the resource representing a Stripe application fee.
// For more details see https://stripe.com/docs/api#application_fees.
type Fee struct {
	ID                     string         `json:"id"`
	Live                   bool           `json:"livemode"`
	Account                *Account       `json:"account"`
	Amount                 uint64         `json:"amount"`
	App                    string         `json:"application"`
	Tx                     *Transaction   `json:"balance_transaction"`
	Charge                 *Charge        `json:"charge"`
	OriginatingTransaction *Charge        `json:"originating_transaction"`
	Created                int64          `json:"created"`
	Currency               Currency       `json:"currency"`
	Refunded               bool           `json:"refunded"`
	Refunds                *FeeRefundList `json:"refunds"`
	AmountRefunded         uint64         `json:"amount_refunded"`
}

// FeeList is a list of fees as retrieved from a list endpoint.
type FeeList struct {
	ListMeta
	Values []*Fee `json:"data"`
}

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

	return nil
}