paymentlink

Documentation

Overview

Package paymentlink provides the /payment_links APIs

Index

• func Get(id string, params *stripe.PaymentLinkParams) (*stripe.PaymentLink, error)
• func New(params *stripe.PaymentLinkParams) (*stripe.PaymentLink, error)
• func Update(id string, params *stripe.PaymentLinkParams) (*stripe.PaymentLink, error)
• type Client
  • func (c Client) Get(id string, params *stripe.PaymentLinkParams) (*stripe.PaymentLink, error)
  • func (c Client) List(listParams *stripe.PaymentLinkListParams) *Iter
  • func (c Client) ListLineItems(listParams *stripe.PaymentLinkListLineItemsParams) *LineItemIter
  • func (c Client) New(params *stripe.PaymentLinkParams) (*stripe.PaymentLink, error)
  • func (c Client) Update(id string, params *stripe.PaymentLinkParams) (*stripe.PaymentLink, error)
• type Iter
  • func List(params *stripe.PaymentLinkListParams) *Iter
  • func (i *Iter) PaymentLink() *stripe.PaymentLink
  • func (i *Iter) PaymentLinkList() *stripe.PaymentLinkList
• type LineItemIter
  • func ListLineItems(params *stripe.PaymentLinkListLineItemsParams) *LineItemIter
  • func (i *LineItemIter) LineItem() *stripe.LineItem
  • func (i *LineItemIter) LineItemList() *stripe.LineItemList

Functions

func Get

func Get(id string, params *stripe.PaymentLinkParams) (*stripe.PaymentLink, error)

Retrieve a payment link.

func New

func New(params *stripe.PaymentLinkParams) (*stripe.PaymentLink, error)

Creates a payment link.

func Update

func Update(id string, params *stripe.PaymentLinkParams) (*stripe.PaymentLink, error)

Updates a payment link.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /payment_links APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.PaymentLinkParams) (*stripe.PaymentLink, error)

Retrieve a payment link.

func (Client) List

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

Returns a list of your payment links.

func (Client) ListLineItems

func (c Client) ListLineItems(listParams *stripe.PaymentLinkListLineItemsParams) *LineItemIter

When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

func (Client) New

func (c Client) New(params *stripe.PaymentLinkParams) (*stripe.PaymentLink, error)

Creates a payment link.

func (Client) Update

func (c Client) Update(id string, params *stripe.PaymentLinkParams) (*stripe.PaymentLink, error)

Updates a payment link.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for payment links.

func List

func List(params *stripe.PaymentLinkListParams) *Iter

Returns a list of your payment links.

func (*Iter) PaymentLink

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

PaymentLink returns the payment link which the iterator is currently pointing to.

func (*Iter) PaymentLinkList

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

PaymentLinkList 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 LineItemIter

type LineItemIter struct {
	*stripe.Iter
}

LineItemIter is an iterator for line items.

func ListLineItems

func ListLineItems(params *stripe.PaymentLinkListLineItemsParams) *LineItemIter

When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

func (*LineItemIter) LineItem

func (i *LineItemIter) LineItem() *stripe.LineItem

LineItem returns the line item which the iterator is currently pointing to.

func (*LineItemIter) LineItemList

func (i *LineItemIter) LineItemList() *stripe.LineItemList

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