margin

Documentation

Overview

Package margin provides the /billing/margins APIs

Index

• func Get(id string, params *stripe.MarginParams) (*stripe.Margin, error)
• func New(params *stripe.MarginParams) (*stripe.Margin, error)
• func Update(id string, params *stripe.MarginParams) (*stripe.Margin, error)
• type Client
  • func (c Client) Get(id string, params *stripe.MarginParams) (*stripe.Margin, error)
  • func (c Client) List(listParams *stripe.MarginListParams) *Iter
  • func (c Client) New(params *stripe.MarginParams) (*stripe.Margin, error)
  • func (c Client) Update(id string, params *stripe.MarginParams) (*stripe.Margin, error)
• type Iter
  • func List(params *stripe.MarginListParams) *Iter
  • func (i *Iter) Margin() *stripe.Margin
  • func (i *Iter) MarginList() *stripe.MarginList

Functions

func Get

func Get(id string, params *stripe.MarginParams) (*stripe.Margin, error)

Retrieve a margin object with the given ID.

func New

func New(params *stripe.MarginParams) (*stripe.Margin, error)

Create a margin object to be used with invoices, invoice items, and invoice line items for a customer to represent a partner discount. A margin has a percent_off which is the percent that will be taken off the subtotal after all items and other discounts and promotions) of any invoices for a customer. Calculation of prorations do not include any partner margins applied on the original invoice item.

func Update

func Update(id string, params *stripe.MarginParams) (*stripe.Margin, error)

Update the specified margin object. Certain fields of the margin object are not editable.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /billing/margins APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.MarginParams) (*stripe.Margin, error)

Retrieve a margin object with the given ID.

func (Client) List

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

Retrieve a list of your margins.

func (Client) New

func (c Client) New(params *stripe.MarginParams) (*stripe.Margin, error)

Create a margin object to be used with invoices, invoice items, and invoice line items for a customer to represent a partner discount. A margin has a percent_off which is the percent that will be taken off the subtotal after all items and other discounts and promotions) of any invoices for a customer. Calculation of prorations do not include any partner margins applied on the original invoice item.

func (Client) Update

func (c Client) Update(id string, params *stripe.MarginParams) (*stripe.Margin, error)

Update the specified margin object. Certain fields of the margin object are not editable.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for margins.

func List

func List(params *stripe.MarginListParams) *Iter

Retrieve a list of your margins.

func (*Iter) Margin

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

Margin returns the margin which the iterator is currently pointing to.

func (*Iter) MarginList

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

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