subscriptionschedule

Documentation

Overview

Package subscriptionschedule provides the /subscription_schedules APIs

Index

• func Amend(id string, params *stripe.SubscriptionScheduleAmendParams) (*stripe.SubscriptionSchedule, error)
• 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) Amend(id string, params *stripe.SubscriptionScheduleAmendParams) (*stripe.SubscriptionSchedule, error)
  • 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 Amend

func Amend(id string, params *stripe.SubscriptionScheduleAmendParams) (*stripe.SubscriptionSchedule, error)

Amends an existing subscription schedule.

func Cancel

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

Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.

func Get

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

Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.

func New

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

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

func Release

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

Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription's ID to the released_subscription property.

func Update

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

Updates an existing subscription schedule.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /subscription_schedules APIs.

func (Client) Amend

func (c Client) Amend(id string, params *stripe.SubscriptionScheduleAmendParams) (*stripe.SubscriptionSchedule, error)

Amends an existing subscription schedule.

func (Client) Cancel

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

Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.

func (Client) Get

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

Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.

func (Client) List

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

Retrieves the list of your subscription schedules.

func (Client) New

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

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

func (Client) Release

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

Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription's ID to the released_subscription property.

func (Client) Update

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

Updates an existing subscription schedule.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for subscription schedules.

func List

func List(params *stripe.SubscriptionScheduleListParams) *Iter

Retrieves the list of your 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.