order

Documentation

Overview

Package order provides the /orders APIs

Index

• func Get(id string, params *stripe.OrderParams) (*stripe.Order, error)
• func New(params *stripe.OrderParams) (*stripe.Order, error)
• func Pay(id string, params *stripe.OrderPayParams) (*stripe.Order, error)
• func Return(id string, params *stripe.OrderReturnParams) (*stripe.OrderReturn, error)
• func Update(id string, params *stripe.OrderUpdateParams) (*stripe.Order, error)
• type Client
  • func (c Client) Get(id string, params *stripe.OrderParams) (*stripe.Order, error)
  • func (c Client) List(listParams *stripe.OrderListParams) *Iter
  • func (c Client) New(params *stripe.OrderParams) (*stripe.Order, error)
  • func (c Client) Pay(id string, params *stripe.OrderPayParams) (*stripe.Order, error)
  • func (c Client) Return(id string, params *stripe.OrderReturnParams) (*stripe.OrderReturn, error)
  • func (c Client) Update(id string, params *stripe.OrderUpdateParams) (*stripe.Order, error)
• type Iter
  • func List(params *stripe.OrderListParams) *Iter
  • func (i *Iter) Order() *stripe.Order
  • func (i *Iter) OrderList() *stripe.OrderList

Functions

func Get

func Get(id string, params *stripe.OrderParams) (*stripe.Order, error)

Get returns the details of an order.

func New

func New(params *stripe.OrderParams) (*stripe.Order, error)

New creates a new order.

func Pay

func Pay(id string, params *stripe.OrderPayParams) (*stripe.Order, error)

Pay is the method for the `POST /v1/orders/{id}/pay` API.

func Return

func Return(id string, params *stripe.OrderReturnParams) (*stripe.OrderReturn, error)

Return is the method for the `POST /v1/orders/{id}/returns` API.

func Update

func Update(id string, params *stripe.OrderUpdateParams) (*stripe.Order, error)

Update updates an order's properties.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /orders APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.OrderParams) (*stripe.Order, error)

Get returns the details of an order.

func (Client) List

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

List returns a list of orders.

func (Client) New

func (c Client) New(params *stripe.OrderParams) (*stripe.Order, error)

New creates a new order.

func (Client) Pay

func (c Client) Pay(id string, params *stripe.OrderPayParams) (*stripe.Order, error)

Pay is the method for the `POST /v1/orders/{id}/pay` API.

func (Client) Return

func (c Client) Return(id string, params *stripe.OrderReturnParams) (*stripe.OrderReturn, error)

Return is the method for the `POST /v1/orders/{id}/returns` API.

func (Client) Update

func (c Client) Update(id string, params *stripe.OrderUpdateParams) (*stripe.Order, error)

Update updates an order's properties.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for orders.

func List

func List(params *stripe.OrderListParams) *Iter

List returns a list of orders.

func (*Iter) Order

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

Order returns the order which the iterator is currently pointing to.

func (*Iter) OrderList

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

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