usagerecordsummary

Documentation

Overview

Package usagerecordsummary provides the /subscription_items/{subscription_item}/usage_record_summaries APIs

Index

• type Client
  • func (c Client) List(listParams *stripe.UsageRecordSummaryListParams) *Iter
• type Iter
  • func List(params *stripe.UsageRecordSummaryListParams) *Iter
  • func (i *Iter) UsageRecordSummary() *stripe.UsageRecordSummary
  • func (i *Iter) UsageRecordSummaryList() *stripe.UsageRecordSummaryList

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /subscription_items/{subscription_item}/usage_record_summaries APIs.

func (Client) List

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

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that's been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn't ended yet. Since new usage records can still be added, the returned summary information for the subscription item's ID should be seen as unstable until the subscription billing period ends.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for usage record summaries.

func List

func List(params *stripe.UsageRecordSummaryListParams) *Iter

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that's been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn't ended yet. Since new usage records can still be added, the returned summary information for the subscription item's ID should be seen as unstable until the subscription billing period ends.

func (*Iter) UsageRecordSummary

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

UsageRecordSummary returns the usage record summary which the iterator is currently pointing to.

func (*Iter) UsageRecordSummaryList

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

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