List a Customer’s * PaymentMethods. * * @param null|array $params * @param null|array|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails * * @return \Stripe\Collection<\Stripe\PaymentMethod> */ public function all($params = null, $opts = null) { return $this->requestCollection('get', '/v1/payment_methods', $params, $opts); } /** * Attaches a PaymentMethod object to a Customer. * * To attach a new PaymentMethod to a customer for future payments, we recommend * you use a SetupIntent or a PaymentIntent * with setup_future_usage. * These approaches will perform any necessary steps to ensure that the * PaymentMethod can be used in a future payment. Using the * /v1/payment_methods/:id/attach endpoint does not ensure that future * payments can be made with the attached PaymentMethod. See Optimizing cards for future * payments 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, * on the Customer to the PaymentMethod’s ID. * * @param string $id * @param null|array $params * @param null|array|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails * * @return \Stripe\PaymentMethod */ public function attach($id, $params = null, $opts = null) { return $this->request('post', $this->buildPath('/v1/payment_methods/%s/attach', $id), $params, $opts); } /** * Creates a PaymentMethod object. Read the Stripe.js * reference 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 SetupIntent API to collect payment * method details ahead of a future payment. * * @param null|array $params * @param null|array|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails * * @return \Stripe\PaymentMethod */ public function create($params = null, $opts = null) { return $this->request('post', '/v1/payment_methods', $params, $opts); } /** * 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. * * @param string $id * @param null|array $params * @param null|array|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails * * @return \Stripe\PaymentMethod */ public function detach($id, $params = null, $opts = null) { return $this->request('post', $this->buildPath('/v1/payment_methods/%s/detach', $id), $params, $opts); } /** * Retrieves a PaymentMethod object. * * @param string $id * @param null|array $params * @param null|array|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails * * @return \Stripe\PaymentMethod */ public function retrieve($id, $params = null, $opts = null) { return $this->request('get', $this->buildPath('/v1/payment_methods/%s', $id), $params, $opts); } /** * Updates a PaymentMethod object. A PaymentMethod must be attached a customer to * be updated. * * @param string $id * @param null|array $params * @param null|array|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails * * @return \Stripe\PaymentMethod */ public function update($id, $params = null, $opts = null) { return $this->request('post', $this->buildPath('/v1/payment_methods/%s', $id), $params, $opts); } }