Documentation
¶
Overview ¶
Package subscription provides the /subscriptions APIs
Index ¶
- func Cancel(id string, params *stripe.SubscriptionCancelParams) (*stripe.Subscription, error)
- func DeleteDiscount(id string, params *stripe.SubscriptionDeleteDiscountParams) (*stripe.Subscription, error)
- func Get(id string, params *stripe.SubscriptionParams) (*stripe.Subscription, error)
- func New(params *stripe.SubscriptionParams) (*stripe.Subscription, error)
- func Resume(id string, params *stripe.SubscriptionResumeParams) (*stripe.Subscription, error)
- func Update(id string, params *stripe.SubscriptionParams) (*stripe.Subscription, error)
- type Client
- func (c Client) Cancel(id string, params *stripe.SubscriptionCancelParams) (*stripe.Subscription, error)
- func (c Client) DeleteDiscount(id string, params *stripe.SubscriptionDeleteDiscountParams) (*stripe.Subscription, error)
- func (c Client) Get(id string, params *stripe.SubscriptionParams) (*stripe.Subscription, error)
- func (c Client) List(listParams *stripe.SubscriptionListParams) *Iter
- func (c Client) New(params *stripe.SubscriptionParams) (*stripe.Subscription, error)
- func (c Client) Resume(id string, params *stripe.SubscriptionResumeParams) (*stripe.Subscription, error)
- func (c Client) Search(params *stripe.SubscriptionSearchParams) *SearchIter
- func (c Client) Update(id string, params *stripe.SubscriptionParams) (*stripe.Subscription, error)
- type Iter
- type SearchIter
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Cancel ¶
func Cancel(id string, params *stripe.SubscriptionCancelParams) (*stripe.Subscription, error)
Cancels a customer's subscription immediately. The customer will not be charged again for the subscription.
Note, however, that any pending invoice items that you've created will still be charged for at the end of the period, unless manually [deleted](https://stripe.com/docs/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.
By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
func DeleteDiscount ¶
func DeleteDiscount(id string, params *stripe.SubscriptionDeleteDiscountParams) (*stripe.Subscription, error)
Removes the currently applied discount on a subscription.
func Get ¶
func Get(id string, params *stripe.SubscriptionParams) (*stripe.Subscription, error)
Retrieves the subscription with the given ID.
func New ¶
func New(params *stripe.SubscriptionParams) (*stripe.Subscription, error)
Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.
When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request. The payment_behavior parameter determines the exact behavior of the initial payment.
To start subscriptions where the first invoice always begins in a draft status, use [subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules#managing) instead. Schedules provide the flexibility to model more complex billing configurations that change over time.
func Resume ¶
func Resume(id string, params *stripe.SubscriptionResumeParams) (*stripe.Subscription, error)
Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date.
func Update ¶
func Update(id string, params *stripe.SubscriptionParams) (*stripe.Subscription, error)
Updates an existing subscription to match the specified parameters. When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes. To preview how the proration is calculated, use the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint.
By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they'll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they'll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month's 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.
Switching prices does not normally change the billing date or generate an immediate charge unless:
The billing interval is changed (for example, from monthly to yearly). The subscription moves from free to paid. A trial starts or ends.
In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how [Stripe immediately attempts payment for subscription changes](https://stripe.com/billing/subscriptions/upgrade-downgrade#immediate-payment).
If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription's renewal date, you need to manually [invoice the customer](https://stripe.com/docs/api/invoices/create).
If you don't want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don't generate any credits for the old subscription's unused time. We still reset the billing date and bill immediately for the new subscription.
Updating the quantity on a subscription many times in an hour may result in [rate limiting. If you need to bill for a frequently changing quantity, consider integrating <a href="/docs/billing/subscriptions/usage-based">usage-based billing](https://stripe.com/docs/rate-limits) instead.
Types ¶
type Client ¶
Client is used to invoke /subscriptions APIs.
func (Client) Cancel ¶
func (c Client) Cancel(id string, params *stripe.SubscriptionCancelParams) (*stripe.Subscription, error)
Cancels a customer's subscription immediately. The customer will not be charged again for the subscription.
Note, however, that any pending invoice items that you've created will still be charged for at the end of the period, unless manually [deleted](https://stripe.com/docs/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.
By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
func (Client) DeleteDiscount ¶
func (c Client) DeleteDiscount(id string, params *stripe.SubscriptionDeleteDiscountParams) (*stripe.Subscription, error)
Removes the currently applied discount on a subscription.
func (Client) Get ¶
func (c Client) Get(id string, params *stripe.SubscriptionParams) (*stripe.Subscription, error)
Retrieves the subscription with the given ID.
func (Client) List ¶
func (c Client) List(listParams *stripe.SubscriptionListParams) *Iter
By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.
func (Client) New ¶
func (c Client) New(params *stripe.SubscriptionParams) (*stripe.Subscription, error)
Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.
When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request. The payment_behavior parameter determines the exact behavior of the initial payment.
To start subscriptions where the first invoice always begins in a draft status, use [subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules#managing) instead. Schedules provide the flexibility to model more complex billing configurations that change over time.
func (Client) Resume ¶
func (c Client) Resume(id string, params *stripe.SubscriptionResumeParams) (*stripe.Subscription, error)
Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date.
func (Client) Search ¶
func (c Client) Search(params *stripe.SubscriptionSearchParams) *SearchIter
Search for subscriptions you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language). Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.
func (Client) Update ¶
func (c Client) Update(id string, params *stripe.SubscriptionParams) (*stripe.Subscription, error)
Updates an existing subscription to match the specified parameters. When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes. To preview how the proration is calculated, use the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint.
By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they'll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they'll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month's 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.
Switching prices does not normally change the billing date or generate an immediate charge unless:
The billing interval is changed (for example, from monthly to yearly). The subscription moves from free to paid. A trial starts or ends.
In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how [Stripe immediately attempts payment for subscription changes](https://stripe.com/billing/subscriptions/upgrade-downgrade#immediate-payment).
If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription's renewal date, you need to manually [invoice the customer](https://stripe.com/docs/api/invoices/create).
If you don't want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don't generate any credits for the old subscription's unused time. We still reset the billing date and bill immediately for the new subscription.
Updating the quantity on a subscription many times in an hour may result in [rate limiting. If you need to bill for a frequently changing quantity, consider integrating <a href="/docs/billing/subscriptions/usage-based">usage-based billing](https://stripe.com/docs/rate-limits) instead.
type Iter ¶
Iter is an iterator for subscriptions.
func List ¶
func List(params *stripe.SubscriptionListParams) *Iter
By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.
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 ¶
type SearchIter struct {
*stripe.SearchIter
}
SearchIter is an iterator for subscriptions.
func Search ¶
func Search(params *stripe.SubscriptionSearchParams) *SearchIter
Search for subscriptions you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language). Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.
func (*SearchIter) Subscription ¶
func (i *SearchIter) Subscription() *stripe.Subscription
Subscription returns the subscription which the iterator is currently pointing to.
func (*SearchIter) SubscriptionSearchResult ¶
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.
Source Files