order

Documentation

Overview

Package order provides the /climate/orders APIs

Index

• func Cancel(id string, params *stripe.ClimateOrderCancelParams) (*stripe.ClimateOrder, error)
• func Get(id string, params *stripe.ClimateOrderParams) (*stripe.ClimateOrder, error)
• func New(params *stripe.ClimateOrderParams) (*stripe.ClimateOrder, error)
• func Update(id string, params *stripe.ClimateOrderParams) (*stripe.ClimateOrder, error)
• type Client
  • func (c Client) Cancel(id string, params *stripe.ClimateOrderCancelParams) (*stripe.ClimateOrder, error)
  • func (c Client) Get(id string, params *stripe.ClimateOrderParams) (*stripe.ClimateOrder, error)
  • func (c Client) List(listParams *stripe.ClimateOrderListParams) *Iter
  • func (c Client) New(params *stripe.ClimateOrderParams) (*stripe.ClimateOrder, error)
  • func (c Client) Update(id string, params *stripe.ClimateOrderParams) (*stripe.ClimateOrder, error)
• type Iter
  • func List(params *stripe.ClimateOrderListParams) *Iter
  • func (i *Iter) ClimateOrder() *stripe.ClimateOrder
  • func (i *Iter) ClimateOrderList() *stripe.ClimateOrderList

Functions

func Cancel

func Cancel(id string, params *stripe.ClimateOrderCancelParams) (*stripe.ClimateOrder, error)

Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe provides 90 days advance notice and refunds the amount_total.

func Get

func Get(id string, params *stripe.ClimateOrderParams) (*stripe.ClimateOrder, error)

Retrieves the details of a Climate order object with the given ID.

func New

func New(params *stripe.ClimateOrderParams) (*stripe.ClimateOrder, error)

Creates a Climate order object for a given Climate product. The order will be processed immediately after creation and payment will be deducted your Stripe balance.

func Update

func Update(id string, params *stripe.ClimateOrderParams) (*stripe.ClimateOrder, error)

Updates the specified order by setting the values of the parameters passed.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /climate/orders APIs.

func (Client) Cancel

func (c Client) Cancel(id string, params *stripe.ClimateOrderCancelParams) (*stripe.ClimateOrder, error)

Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe provides 90 days advance notice and refunds the amount_total.

func (Client) Get

func (c Client) Get(id string, params *stripe.ClimateOrderParams) (*stripe.ClimateOrder, error)

Retrieves the details of a Climate order object with the given ID.

func (Client) List

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

Lists all Climate order objects. The orders are returned sorted by creation date, with the most recently created orders appearing first.

func (Client) New

func (c Client) New(params *stripe.ClimateOrderParams) (*stripe.ClimateOrder, error)

Creates a Climate order object for a given Climate product. The order will be processed immediately after creation and payment will be deducted your Stripe balance.

func (Client) Update

func (c Client) Update(id string, params *stripe.ClimateOrderParams) (*stripe.ClimateOrder, error)

Updates the specified order by setting the values of the parameters passed.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for climate orders.

func List

func List(params *stripe.ClimateOrderListParams) *Iter

Lists all Climate order objects. The orders are returned sorted by creation date, with the most recently created orders appearing first.

func (*Iter) ClimateOrder

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

ClimateOrder returns the climate order which the iterator is currently pointing to.

func (*Iter) ClimateOrderList

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

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