subschedule

Documentation

Overview

Package subschedule provides the /subscription_schedules APIs

Index

• func Cancel(id string, params *stripe.SubscriptionScheduleCancelParams) (*stripe.SubscriptionSchedule, error)
• func Get(id string, params *stripe.SubscriptionScheduleParams) (*stripe.SubscriptionSchedule, error)
• func New(params *stripe.SubscriptionScheduleParams) (*stripe.SubscriptionSchedule, error)
• func Release(id string, params *stripe.SubscriptionScheduleReleaseParams) (*stripe.SubscriptionSchedule, error)
• func Update(id string, params *stripe.SubscriptionScheduleParams) (*stripe.SubscriptionSchedule, error)
• type Client
  • func (c Client) Cancel(id string, params *stripe.SubscriptionScheduleCancelParams) (*stripe.SubscriptionSchedule, error)
  • func (c Client) Get(id string, params *stripe.SubscriptionScheduleParams) (*stripe.SubscriptionSchedule, error)
  • func (c Client) List(listParams *stripe.SubscriptionScheduleListParams) *Iter
  • func (c Client) New(params *stripe.SubscriptionScheduleParams) (*stripe.SubscriptionSchedule, error)
  • func (c Client) Release(id string, params *stripe.SubscriptionScheduleReleaseParams) (*stripe.SubscriptionSchedule, error)
  • func (c Client) Update(id string, params *stripe.SubscriptionScheduleParams) (*stripe.SubscriptionSchedule, error)
• type Iter
  • func List(params *stripe.SubscriptionScheduleListParams) *Iter
  • func (i *Iter) SubscriptionSchedule() *stripe.SubscriptionSchedule
  • func (i *Iter) SubscriptionScheduleList() *stripe.SubscriptionScheduleList

Functions

func Cancel

func Cancel(id string, params *stripe.SubscriptionScheduleCancelParams) (*stripe.SubscriptionSchedule, error)

Cancel is the method for the `POST /v1/subscription_schedules/{schedule}/cancel` API.

func Get

func Get(id string, params *stripe.SubscriptionScheduleParams) (*stripe.SubscriptionSchedule, error)

Get returns the details of a subscription schedule.

func New

func New(params *stripe.SubscriptionScheduleParams) (*stripe.SubscriptionSchedule, error)

New creates a new subscription schedule.

func Release

func Release(id string, params *stripe.SubscriptionScheduleReleaseParams) (*stripe.SubscriptionSchedule, error)

Release is the method for the `POST /v1/subscription_schedules/{schedule}/release` API.

func Update

func Update(id string, params *stripe.SubscriptionScheduleParams) (*stripe.SubscriptionSchedule, error)

Update updates a subscription schedule's properties.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /subscription_schedules APIs.

func (Client) Cancel

func (c Client) Cancel(id string, params *stripe.SubscriptionScheduleCancelParams) (*stripe.SubscriptionSchedule, error)

Cancel is the method for the `POST /v1/subscription_schedules/{schedule}/cancel` API.

func (Client) Get

func (c Client) Get(id string, params *stripe.SubscriptionScheduleParams) (*stripe.SubscriptionSchedule, error)

Get returns the details of a subscription schedule.

func (Client) List

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

List returns a list of subscription schedules.

func (Client) New

func (c Client) New(params *stripe.SubscriptionScheduleParams) (*stripe.SubscriptionSchedule, error)

New creates a new subscription schedule.

func (Client) Release

func (c Client) Release(id string, params *stripe.SubscriptionScheduleReleaseParams) (*stripe.SubscriptionSchedule, error)

Release is the method for the `POST /v1/subscription_schedules/{schedule}/release` API.

func (Client) Update

func (c Client) Update(id string, params *stripe.SubscriptionScheduleParams) (*stripe.SubscriptionSchedule, error)

Update updates a subscription schedule's properties.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for subscription schedules.

func List

func List(params *stripe.SubscriptionScheduleListParams) *Iter

List returns a list of subscription schedules.

func (*Iter) SubscriptionSchedule

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

SubscriptionSchedule returns the subscription schedule which the iterator is currently pointing to.

func (*Iter) SubscriptionScheduleList

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

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