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) ListPaymentMethods(listParams *stripe.CustomerListPaymentMethodsParams) *PaymentMethodIter
  • 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
• type PaymentMethodIter
  • func ListPaymentMethods(params *stripe.CustomerListPaymentMethodsParams) *PaymentMethodIter
  • func (i *PaymentMethodIter) PaymentMethod() *stripe.PaymentMethod
  • func (i *PaymentMethodIter) PaymentMethodList() *stripe.PaymentMethodList

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) ListPaymentMethods

func (c Client) ListPaymentMethods(listParams *stripe.CustomerListPaymentMethodsParams) *PaymentMethodIter

ListPaymentMethods is the method for the `GET /v1/customers/{customer}/payment_methods` API.

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.

type PaymentMethodIter

type PaymentMethodIter struct {
	*stripe.Iter
}

PaymentMethodIter is an iterator for payment methods.

func ListPaymentMethods

func ListPaymentMethods(params *stripe.CustomerListPaymentMethodsParams) *PaymentMethodIter

ListPaymentMethods is the method for the `GET /v1/customers/{customer}/payment_methods` API.

func (*PaymentMethodIter) PaymentMethod

func (i *PaymentMethodIter) PaymentMethod() *stripe.PaymentMethod

PaymentMethod returns the payment method which the iterator is currently pointing to.

func (*PaymentMethodIter) PaymentMethodList

func (i *PaymentMethodIter) PaymentMethodList() *stripe.PaymentMethodList

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