Sha256: 5cb4c0313723dd40fcbcdc03034488e9ff70d99ddd93fa2eb186bcd50edb5eec

Contents?: true

Size: 1.61 KB

Versions: 20

Compression:

Stored size: 1.61 KB

Contents

# File generated from our OpenAPI spec
# frozen_string_literal: true

module Stripe
  class PromotionCodeService < StripeService
    # A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.
    def create(params = {}, opts = {})
      request(
        method: :post,
        path: "/v1/promotion_codes",
        params: params,
        opts: opts,
        base_address: :api
      )
    end

    # Returns a list of your promotion codes.
    def list(params = {}, opts = {})
      request(
        method: :get,
        path: "/v1/promotion_codes",
        params: params,
        opts: opts,
        base_address: :api
      )
    end

    # Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use [list](https://stripe.com/docs/api/promotion_codes/list) with the desired code.
    def retrieve(promotion_code, params = {}, opts = {})
      request(
        method: :get,
        path: format("/v1/promotion_codes/%<promotion_code>s", { promotion_code: CGI.escape(promotion_code) }),
        params: params,
        opts: opts,
        base_address: :api
      )
    end

    # Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.
    def update(promotion_code, params = {}, opts = {})
      request(
        method: :post,
        path: format("/v1/promotion_codes/%<promotion_code>s", { promotion_code: CGI.escape(promotion_code) }),
        params: params,
        opts: opts,
        base_address: :api
      )
    end
  end
end

Version data entries

20 entries across 20 versions & 1 rubygems

Version Path
stripe-13.5.0 lib/stripe/services/promotion_code_service.rb
stripe-13.4.1 lib/stripe/services/promotion_code_service.rb
stripe-13.4.0 lib/stripe/services/promotion_code_service.rb
stripe-13.3.1 lib/stripe/services/promotion_code_service.rb
stripe-13.3.0 lib/stripe/services/promotion_code_service.rb
stripe-13.3.0.pre.beta.3 lib/stripe/services/promotion_code_service.rb
stripe-13.3.0.pre.beta.2 lib/stripe/services/promotion_code_service.rb
stripe-13.3.0.pre.beta.1 lib/stripe/services/promotion_code_service.rb
stripe-13.2.0 lib/stripe/services/promotion_code_service.rb
stripe-13.1.2 lib/stripe/services/promotion_code_service.rb
stripe-13.2.0.pre.beta.3 lib/stripe/services/promotion_code_service.rb
stripe-13.2.0.pre.beta.2 lib/stripe/services/promotion_code_service.rb
stripe-13.1.1 lib/stripe/services/promotion_code_service.rb
stripe-13.2.0.pre.beta.1 lib/stripe/services/promotion_code_service.rb
stripe-13.1.0 lib/stripe/services/promotion_code_service.rb
stripe-13.0.2 lib/stripe/services/promotion_code_service.rb
stripe-13.1.0.pre.beta.3 lib/stripe/services/promotion_code_service.rb
stripe-13.0.1 lib/stripe/services/promotion_code_service.rb
stripe-13.1.0.pre.beta.2 lib/stripe/services/promotion_code_service.rb
stripe-13.0.0 lib/stripe/services/promotion_code_service.rb