configuration

Documentation

Overview

Package configuration provides the /billing_portal/configurations APIs

Index

• func Get(id string, params *stripe.BillingPortalConfigurationParams) (*stripe.BillingPortalConfiguration, error)
• func New(params *stripe.BillingPortalConfigurationParams) (*stripe.BillingPortalConfiguration, error)
• func Update(id string, params *stripe.BillingPortalConfigurationParams) (*stripe.BillingPortalConfiguration, error)
• type Client
  • func (c Client) Get(id string, params *stripe.BillingPortalConfigurationParams) (*stripe.BillingPortalConfiguration, error)
  • func (c Client) List(listParams *stripe.BillingPortalConfigurationListParams) *Iter
  • func (c Client) New(params *stripe.BillingPortalConfigurationParams) (*stripe.BillingPortalConfiguration, error)
  • func (c Client) Update(id string, params *stripe.BillingPortalConfigurationParams) (*stripe.BillingPortalConfiguration, error)
• type Iter
  • func List(params *stripe.BillingPortalConfigurationListParams) *Iter
  • func (i *Iter) BillingPortalConfiguration() *stripe.BillingPortalConfiguration
  • func (i *Iter) BillingPortalConfigurationList() *stripe.BillingPortalConfigurationList

Functions

func Get

func Get(id string, params *stripe.BillingPortalConfigurationParams) (*stripe.BillingPortalConfiguration, error)

Retrieves a configuration that describes the functionality of the customer portal.

func New

func New(params *stripe.BillingPortalConfigurationParams) (*stripe.BillingPortalConfiguration, error)

Creates a configuration that describes the functionality and behavior of a PortalSession

func Update

func Update(id string, params *stripe.BillingPortalConfigurationParams) (*stripe.BillingPortalConfiguration, error)

Updates a configuration that describes the functionality of the customer portal.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /billing_portal/configurations APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.BillingPortalConfigurationParams) (*stripe.BillingPortalConfiguration, error)

Retrieves a configuration that describes the functionality of the customer portal.

func (Client) List

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

Returns a list of configurations that describe the functionality of the customer portal.

func (Client) New

func (c Client) New(params *stripe.BillingPortalConfigurationParams) (*stripe.BillingPortalConfiguration, error)

Creates a configuration that describes the functionality and behavior of a PortalSession

func (Client) Update

func (c Client) Update(id string, params *stripe.BillingPortalConfigurationParams) (*stripe.BillingPortalConfiguration, error)

Updates a configuration that describes the functionality of the customer portal.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for billing portal configurations.

func List

func List(params *stripe.BillingPortalConfigurationListParams) *Iter

Returns a list of configurations that describe the functionality of the customer portal.

func (*Iter) BillingPortalConfiguration

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

BillingPortalConfiguration returns the billing portal configuration which the iterator is currently pointing to.

func (*Iter) BillingPortalConfigurationList

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

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