recipient

Documentation

Overview

Package recipient provides the /recipients APIs

Index

• Constants
• func Del(id string) (*stripe.Recipient, error)
• func Get(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)
• func Update(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)
• type Client
  • func (c Client) Del(id string) (*stripe.Recipient, error)
  • func (c Client) Get(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)
  • func (c Client) List(params *stripe.RecipientListParams) *Iter
  • func (c Client) Update(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)
• type Iter
  • func List(params *stripe.RecipientListParams) *Iter
  • func (i *Iter) Recipient() *stripe.Recipient

Constants

const (
	Individual stripe.RecipientType = "individual"
	Corp       stripe.RecipientType = "corporation"
)

Functions

func Del

func Del(id string) (*stripe.Recipient, error)

Del removes a recipient. For more details see https://stripe.com/docs/api#delete_recipient.

func Get

func Get(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)

Get returns the details of a recipient. For more details see https://stripe.com/docs/api#retrieve_recipient.

func Update

func Update(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)

Update updates a recipient's properties. For more details see https://stripe.com/docs/api#update_recipient.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /recipients APIs.

func (Client) Del

func (c Client) Del(id string) (*stripe.Recipient, error)

func (Client) Get

func (c Client) Get(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)

func (Client) List

func (c Client) List(params *stripe.RecipientListParams) *Iter

func (Client) Update

func (c Client) Update(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for lists of Recipients. The embedded Iter carries methods with it; see its documentation for details.

func List

func List(params *stripe.RecipientListParams) *Iter

List returns a list of recipients. For more details see https://stripe.com/docs/api#list_recipients.

func (*Iter) Recipient

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

Recipient returns the most recent Recipient visited by a call to Next.