person

Documentation

Overview

Package person provides the /accounts/{account}/persons APIs

Index

• func Del(id string, params *stripe.PersonParams) (*stripe.Person, error)
• func Get(id string, params *stripe.PersonParams) (*stripe.Person, error)
• func New(params *stripe.PersonParams) (*stripe.Person, error)
• func Update(id string, params *stripe.PersonParams) (*stripe.Person, error)
• type Client
  • func (c Client) Del(id string, params *stripe.PersonParams) (*stripe.Person, error)
  • func (c Client) Get(id string, params *stripe.PersonParams) (*stripe.Person, error)
  • func (c Client) List(listParams *stripe.PersonListParams) *Iter
  • func (c Client) New(params *stripe.PersonParams) (*stripe.Person, error)
  • func (c Client) Update(id string, params *stripe.PersonParams) (*stripe.Person, error)
• type Iter
  • func List(params *stripe.PersonListParams) *Iter
  • func (i *Iter) Person() *stripe.Person
  • func (i *Iter) PersonList() *stripe.PersonList

Functions

func Del

func Del(id string, params *stripe.PersonParams) (*stripe.Person, error)

Deletes an existing person's relationship to the account's legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

func Get

func Get(id string, params *stripe.PersonParams) (*stripe.Person, error)

Retrieves an existing person.

func New

func New(params *stripe.PersonParams) (*stripe.Person, error)

Creates a new person.

func Update

func Update(id string, params *stripe.PersonParams) (*stripe.Person, error)

Updates an existing person.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /accounts/{account}/persons APIs.

func (Client) Del

func (c Client) Del(id string, params *stripe.PersonParams) (*stripe.Person, error)

Deletes an existing person's relationship to the account's legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

func (Client) Get

func (c Client) Get(id string, params *stripe.PersonParams) (*stripe.Person, error)

Retrieves an existing person.

func (Client) List

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

Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

func (Client) New

func (c Client) New(params *stripe.PersonParams) (*stripe.Person, error)

Creates a new person.

func (Client) Update

func (c Client) Update(id string, params *stripe.PersonParams) (*stripe.Person, error)

Updates an existing person.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for persons.

func List

func List(params *stripe.PersonListParams) *Iter

Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

func (*Iter) Person

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

Person returns the person which the iterator is currently pointing to.

func (*Iter) PersonList

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

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