customer

Documentation

Overview

Package customer provides the /customers APIs

Index

• func Del(id string, params *stripe.CustomerParams) (*stripe.Customer, error)
• func Get(id string, params *stripe.CustomerParams) (*stripe.Customer, error)
• func New(params *stripe.CustomerParams) (*stripe.Customer, error)
• func Update(id string, params *stripe.CustomerParams) (*stripe.Customer, error)
• type Client
  • func (c Client) Del(id string, params *stripe.CustomerParams) (*stripe.Customer, error)
  • func (c Client) Get(id string, params *stripe.CustomerParams) (*stripe.Customer, error)
  • func (c Client) List(listParams *stripe.CustomerListParams) *Iter
  • func (c Client) New(params *stripe.CustomerParams) (*stripe.Customer, error)
  • func (c Client) Update(id string, params *stripe.CustomerParams) (*stripe.Customer, error)
• type Iter
  • func List(params *stripe.CustomerListParams) *Iter
  • func (i *Iter) Customer() *stripe.Customer
  • func (i *Iter) CustomerList() *stripe.CustomerList

Functions

func Del

func Del(id string, params *stripe.CustomerParams) (*stripe.Customer, error)

Del removes a customer.

func Get

func Get(id string, params *stripe.CustomerParams) (*stripe.Customer, error)

Get returns the details of a customer.

func New

func New(params *stripe.CustomerParams) (*stripe.Customer, error)

New creates a new customer.

func Update

func Update(id string, params *stripe.CustomerParams) (*stripe.Customer, error)

Update updates a customer's properties.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /customers APIs.

func (Client) Del

func (c Client) Del(id string, params *stripe.CustomerParams) (*stripe.Customer, error)

Del removes a customer.

func (Client) Get

func (c Client) Get(id string, params *stripe.CustomerParams) (*stripe.Customer, error)

Get returns the details of a customer.

func (Client) List

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

List returns a list of customers.

func (Client) New

func (c Client) New(params *stripe.CustomerParams) (*stripe.Customer, error)

New creates a new customer.

func (Client) Update

func (c Client) Update(id string, params *stripe.CustomerParams) (*stripe.Customer, error)

Update updates a customer's properties.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for customers.

func List

func List(params *stripe.CustomerListParams) *Iter

List returns a list of customers.

func (*Iter) Customer

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

Customer returns the customer which the iterator is currently pointing to.

func (*Iter) CustomerList

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

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