feerefund

Documentation

Overview

Package feerefund provides the /application_fees/{id}/refunds APIs

Index

• func Get(id string, params *stripe.FeeRefundParams) (*stripe.FeeRefund, error)
• func New(params *stripe.FeeRefundParams) (*stripe.FeeRefund, error)
• func Update(id string, params *stripe.FeeRefundParams) (*stripe.FeeRefund, error)
• type Client
  • func (c Client) Get(id string, params *stripe.FeeRefundParams) (*stripe.FeeRefund, error)
  • func (c Client) List(listParams *stripe.FeeRefundListParams) *Iter
  • func (c Client) New(params *stripe.FeeRefundParams) (*stripe.FeeRefund, error)
  • func (c Client) Update(id string, params *stripe.FeeRefundParams) (*stripe.FeeRefund, error)
• type Iter
  • func List(params *stripe.FeeRefundListParams) *Iter
  • func (i *Iter) FeeRefund() *stripe.FeeRefund
  • func (i *Iter) FeeRefundList() *stripe.FeeRefundList

Functions

func Get

func Get(id string, params *stripe.FeeRefundParams) (*stripe.FeeRefund, error)

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.

func New

func New(params *stripe.FeeRefundParams) (*stripe.FeeRefund, error)

Refunds an application fee that has previously been collected but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected.

You can optionally refund only part of an application fee. You can do so multiple times, until the entire fee has been refunded.

Once entirely refunded, an application fee can't be refunded again. This method will raise an error when called on an already-refunded application fee, or when trying to refund more money than is left on an application fee.

func Update

func Update(id string, params *stripe.FeeRefundParams) (*stripe.FeeRefund, error)

Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request only accepts metadata as an argument.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /application_fees/{id}/refunds APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.FeeRefundParams) (*stripe.FeeRefund, error)

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.

func (Client) List

func (c Client) List(listParams *stripe.FeeRefundListParams) *Iter

You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

func (Client) New

func (c Client) New(params *stripe.FeeRefundParams) (*stripe.FeeRefund, error)

Refunds an application fee that has previously been collected but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected.

You can optionally refund only part of an application fee. You can do so multiple times, until the entire fee has been refunded.

Once entirely refunded, an application fee can't be refunded again. This method will raise an error when called on an already-refunded application fee, or when trying to refund more money than is left on an application fee.

func (Client) Update

func (c Client) Update(id string, params *stripe.FeeRefundParams) (*stripe.FeeRefund, error)

Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request only accepts metadata as an argument.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for fee refunds.

func List

func List(params *stripe.FeeRefundListParams) *Iter

You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

func (*Iter) FeeRefund

func (i *Iter) FeeRefund() *stripe.FeeRefund

FeeRefund returns the fee refund which the iterator is currently pointing to.

func (*Iter) FeeRefundList

func (i *Iter) FeeRefundList() *stripe.FeeRefundList

FeeRefundList returns the current list object which the iterator is currently using. List objects will change as new API calls are made to continue pagination.