Documentation ¶
Overview ¶
Package paymentmethod provides the /payment_methods APIs
Index ¶
- func Attach(id string, params *stripe.PaymentMethodAttachParams) (*stripe.PaymentMethod, error)
- func Detach(id string, params *stripe.PaymentMethodDetachParams) (*stripe.PaymentMethod, error)
- func Get(id string, params *stripe.PaymentMethodParams) (*stripe.PaymentMethod, error)
- func New(params *stripe.PaymentMethodParams) (*stripe.PaymentMethod, error)
- func Update(id string, params *stripe.PaymentMethodParams) (*stripe.PaymentMethod, error)
- type Client
- func (c Client) Attach(id string, params *stripe.PaymentMethodAttachParams) (*stripe.PaymentMethod, error)
- func (c Client) Detach(id string, params *stripe.PaymentMethodDetachParams) (*stripe.PaymentMethod, error)
- func (c Client) Get(id string, params *stripe.PaymentMethodParams) (*stripe.PaymentMethod, error)
- func (c Client) List(listParams *stripe.PaymentMethodListParams) *Iter
- func (c Client) New(params *stripe.PaymentMethodParams) (*stripe.PaymentMethod, error)
- func (c Client) Update(id string, params *stripe.PaymentMethodParams) (*stripe.PaymentMethod, error)
- type Iter
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Attach ¶
func Attach(id string, params *stripe.PaymentMethodAttachParams) (*stripe.PaymentMethod, error)
Attaches a PaymentMethod object to a Customer.
To attach a new PaymentMethod to a customer for future payments, we recommend you use a [SetupIntent](https://stripe.com/docs/api/setup_intents) or a PaymentIntent with [setup_future_usage](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage). These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for future use, which makes later declines and payment friction more likely. See [Optimizing cards for future payments](https://stripe.com/docs/payments/payment-intents#future-usage) for more information about setting up future payments.
To use this PaymentMethod as the default for invoice or subscription payments, set [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method), on the Customer to the PaymentMethod's ID.
func Detach ¶
func Detach(id string, params *stripe.PaymentMethodDetachParams) (*stripe.PaymentMethod, error)
Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.
func Get ¶
func Get(id string, params *stripe.PaymentMethodParams) (*stripe.PaymentMethod, error)
Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use [Retrieve a Customer's PaymentMethods](https://stripe.com/docs/api/payment_methods/customer)
func New ¶
func New(params *stripe.PaymentMethodParams) (*stripe.PaymentMethod, error)
Creates a PaymentMethod object. Read the [Stripe.js reference](https://stripe.com/docs/stripe-js/reference#stripe-create-payment-method) to learn how to create PaymentMethods via Stripe.js.
Instead of creating a PaymentMethod directly, we recommend using the [PaymentIntents API to accept a payment immediately or the <a href="/docs/payments/save-and-reuse">SetupIntent](https://stripe.com/docs/payments/accept-a-payment) API to collect payment method details ahead of a future payment.
func Update ¶
func Update(id string, params *stripe.PaymentMethodParams) (*stripe.PaymentMethod, error)
Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.
Types ¶
type Client ¶
Client is used to invoke /payment_methods APIs.
func (Client) Attach ¶
func (c Client) Attach(id string, params *stripe.PaymentMethodAttachParams) (*stripe.PaymentMethod, error)
Attaches a PaymentMethod object to a Customer.
To attach a new PaymentMethod to a customer for future payments, we recommend you use a [SetupIntent](https://stripe.com/docs/api/setup_intents) or a PaymentIntent with [setup_future_usage](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage). These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for future use, which makes later declines and payment friction more likely. See [Optimizing cards for future payments](https://stripe.com/docs/payments/payment-intents#future-usage) for more information about setting up future payments.
To use this PaymentMethod as the default for invoice or subscription payments, set [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method), on the Customer to the PaymentMethod's ID.
func (Client) Detach ¶
func (c Client) Detach(id string, params *stripe.PaymentMethodDetachParams) (*stripe.PaymentMethod, error)
Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.
func (Client) Get ¶
func (c Client) Get(id string, params *stripe.PaymentMethodParams) (*stripe.PaymentMethod, error)
Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use [Retrieve a Customer's PaymentMethods](https://stripe.com/docs/api/payment_methods/customer)
func (Client) List ¶
func (c Client) List(listParams *stripe.PaymentMethodListParams) *Iter
Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the [List a Customer's PaymentMethods](https://stripe.com/docs/api/payment_methods/customer_list) API instead.
func (Client) New ¶
func (c Client) New(params *stripe.PaymentMethodParams) (*stripe.PaymentMethod, error)
Creates a PaymentMethod object. Read the [Stripe.js reference](https://stripe.com/docs/stripe-js/reference#stripe-create-payment-method) to learn how to create PaymentMethods via Stripe.js.
Instead of creating a PaymentMethod directly, we recommend using the [PaymentIntents API to accept a payment immediately or the <a href="/docs/payments/save-and-reuse">SetupIntent](https://stripe.com/docs/payments/accept-a-payment) API to collect payment method details ahead of a future payment.
func (Client) Update ¶
func (c Client) Update(id string, params *stripe.PaymentMethodParams) (*stripe.PaymentMethod, error)
Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.
type Iter ¶
Iter is an iterator for payment methods.
func List ¶
func List(params *stripe.PaymentMethodListParams) *Iter
Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the [List a Customer's PaymentMethods](https://stripe.com/docs/api/payment_methods/customer_list) API instead.
func (*Iter) PaymentMethod ¶
func (i *Iter) PaymentMethod() *stripe.PaymentMethod
PaymentMethod returns the payment method which the iterator is currently pointing to.
func (*Iter) PaymentMethodList ¶
func (i *Iter) PaymentMethodList() *stripe.PaymentMethodList
PaymentMethodList returns the current list object which the iterator is currently using. List objects will change as new API calls are made to continue pagination.