Sha256: ff39043a2277d169634c248701aed2c1aad68613b21f44670f07bfad77de673b

Contents?: true

Size: 1.36 KB

Versions: 39

Compression:

Stored size: 1.36 KB

Contents

# File generated from our OpenAPI spec
# frozen_string_literal: true

module Stripe
  # A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.
  #
  # When a customer opens a payment link it will open a new [checkout session](https://stripe.com/docs/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://stripe.com/docs/api/events/types#event_types-checkout.session.completed) to track payments through payment links.
  #
  # Related guide: [Payment Links API](https://stripe.com/docs/payment-links)
  class PaymentLink < APIResource
    extend Stripe::APIOperations::Create
    extend Stripe::APIOperations::List
    include Stripe::APIOperations::Save

    OBJECT_NAME = "payment_link"

    def list_line_items(params = {}, opts = {})
      request_stripe_object(
        method: :get,
        path: format("/v1/payment_links/%<payment_link>s/line_items", { payment_link: CGI.escape(self["id"]) }),
        params: params,
        opts: opts
      )
    end

    def self.list_line_items(payment_link, params = {}, opts = {})
      request_stripe_object(
        method: :get,
        path: format("/v1/payment_links/%<payment_link>s/line_items", { payment_link: CGI.escape(payment_link) }),
        params: params,
        opts: opts
      )
    end
  end
end

Version data entries

39 entries across 39 versions & 1 rubygems

Version Path
stripe-10.5.0.pre.beta.1 lib/stripe/resources/payment_link.rb
stripe-10.4.0 lib/stripe/resources/payment_link.rb
stripe-10.4.0.pre.beta.1 lib/stripe/resources/payment_link.rb
stripe-10.3.0 lib/stripe/resources/payment_link.rb
stripe-10.3.0.pre.beta.1 lib/stripe/resources/payment_link.rb
stripe-10.2.0 lib/stripe/resources/payment_link.rb
stripe-10.2.0.pre.beta.1 lib/stripe/resources/payment_link.rb
stripe-10.1.0 lib/stripe/resources/payment_link.rb
stripe-10.1.0.pre.beta.2 lib/stripe/resources/payment_link.rb
stripe-10.1.0.pre.beta.1 lib/stripe/resources/payment_link.rb
stripe-10.0.0 lib/stripe/resources/payment_link.rb
stripe-9.5.0.pre.beta.2 lib/stripe/resources/payment_link.rb
stripe-9.5.0.pre.beta.1 lib/stripe/resources/payment_link.rb
stripe-9.4.0 lib/stripe/resources/payment_link.rb
stripe-9.4.0.pre.beta.3 lib/stripe/resources/payment_link.rb
stripe-9.4.0.pre.beta.2 lib/stripe/resources/payment_link.rb
stripe-9.4.0.pre.beta.1 lib/stripe/resources/payment_link.rb
stripe-9.3.0 lib/stripe/resources/payment_link.rb
stripe-9.3.0.pre.beta.1 lib/stripe/resources/payment_link.rb
stripe-9.2.0 lib/stripe/resources/payment_link.rb