sub

package
v72.108.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 19, 2022 License: MIT Imports: 3 Imported by: 20

Documentation

Overview

Package sub provides the /subscriptions APIs

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Cancel

Cancel removes a subscription.

func Get

Get returns the details of a subscription.

func New

New creates a new subscription.

func Update

func Update(id string, params *stripe.SubscriptionParams) (*stripe.Subscription, error)

Update updates a subscription's properties.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /subscriptions APIs.

func (Client) Cancel

Cancel removes a subscription.

func (Client) Get

Get returns the details of a subscription.

func (Client) List

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

List returns a list of subscriptions.

func (Client) New

New creates a new subscription.

func (Client) Search added in v72.97.0

func (c Client) Search(params *stripe.SubscriptionSearchParams) *SearchIter

Search returns a search result containing subscriptions.

func (Client) Update

func (c Client) Update(id string, params *stripe.SubscriptionParams) (*stripe.Subscription, error)

Update updates a subscription's properties.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for subscriptions.

func List

func List(params *stripe.SubscriptionListParams) *Iter

List returns a list of subscriptions.

func (*Iter) Subscription

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

Subscription returns the subscription which the iterator is currently pointing to.

func (*Iter) SubscriptionList

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

SubscriptionList 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 SearchIter added in v72.97.0

type SearchIter struct {
	*stripe.SearchIter
}

SearchIter is an iterator for subscriptions.

Search returns a search result containing subscriptions.

func (*SearchIter) Subscription added in v72.97.0

func (i *SearchIter) Subscription() *stripe.Subscription

Subscription returns the subscription which the iterator is currently pointing to.

func (*SearchIter) SubscriptionSearchResult added in v72.97.0

func (i *SearchIter) SubscriptionSearchResult() *stripe.SubscriptionSearchResult

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL