customer

Documentation

Overview

Package customer provides the /customers APIs

Index

• func CreateFundingInstructions(id string, params *stripe.CustomerCreateFundingInstructionsParams) (*stripe.FundingInstructions, error)
• func Del(id string, params *stripe.CustomerParams) (*stripe.Customer, error)
• func DeleteDiscount(id string, params *stripe.CustomerDeleteDiscountParams) (*stripe.Customer, error)
• func Get(id string, params *stripe.CustomerParams) (*stripe.Customer, error)
• func New(params *stripe.CustomerParams) (*stripe.Customer, error)
• func RetrievePaymentMethod(id string, params *stripe.CustomerRetrievePaymentMethodParams) (*stripe.PaymentMethod, error)
• func Update(id string, params *stripe.CustomerParams) (*stripe.Customer, error)
• type Client
  • func (c Client) CreateFundingInstructions(id string, params *stripe.CustomerCreateFundingInstructionsParams) (*stripe.FundingInstructions, error)
  • func (c Client) Del(id string, params *stripe.CustomerParams) (*stripe.Customer, error)
  • func (c Client) DeleteDiscount(id string, params *stripe.CustomerDeleteDiscountParams) (*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) RetrievePaymentMethod(id string, params *stripe.CustomerRetrievePaymentMethodParams) (*stripe.PaymentMethod, error)
  • func (c Client) Search(params *stripe.CustomerSearchParams) *SearchIter
  • 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
• type SearchIter
  • func Search(params *stripe.CustomerSearchParams) *SearchIter
  • func (i *SearchIter) Customer() *stripe.Customer
  • func (i *SearchIter) CustomerSearchResult() *stripe.CustomerSearchResult

Functions

func CreateFundingInstructions

func CreateFundingInstructions(id string, params *stripe.CustomerCreateFundingInstructionsParams) (*stripe.FundingInstructions, error)

CreateFundingInstructions is the method for the `POST /v1/customers/{customer}/funding_instructions` API.

func Del

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

Del removes a customer.

func DeleteDiscount

func DeleteDiscount(id string, params *stripe.CustomerDeleteDiscountParams) (*stripe.Customer, error)

DeleteDiscount is the method for the `DELETE /v1/customers/{customer}/discount` API.

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 RetrievePaymentMethod

func RetrievePaymentMethod(id string, params *stripe.CustomerRetrievePaymentMethodParams) (*stripe.PaymentMethod, error)

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

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

func (c Client) CreateFundingInstructions(id string, params *stripe.CustomerCreateFundingInstructionsParams) (*stripe.FundingInstructions, error)

CreateFundingInstructions is the method for the `POST /v1/customers/{customer}/funding_instructions` API.

func (Client) Del

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

Del removes a customer.

func (Client) DeleteDiscount

func (c Client) DeleteDiscount(id string, params *stripe.CustomerDeleteDiscountParams) (*stripe.Customer, error)

DeleteDiscount is the method for the `DELETE /v1/customers/{customer}/discount` API.

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

func (c Client) RetrievePaymentMethod(id string, params *stripe.CustomerRetrievePaymentMethodParams) (*stripe.PaymentMethod, error)

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

func (Client) Search

func (c Client) Search(params *stripe.CustomerSearchParams) *SearchIter

Search returns a search result containing customers.

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.

type SearchIter

type SearchIter struct {
	*stripe.SearchIter
}

SearchIter is an iterator for customers.

func Search

func Search(params *stripe.CustomerSearchParams) *SearchIter

Search returns a search result containing customers.

func (*SearchIter) Customer

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

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

func (*SearchIter) CustomerSearchResult

func (i *SearchIter) CustomerSearchResult() *stripe.CustomerSearchResult

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