mirror of
https://github.com/stripe/stripe-ruby.git
synced 2025-10-06 00:02:18 -04:00
41f5d0a594
* Support for APIs in the new API version 2024-09-30.acacia (#1458) * remove parseSnapshotEvent (#1463) * Bump version to 13.0.0 * Fixed API Version --------- Co-authored-by: Ramya Rao <100975018+ramya-stripe@users.noreply.github.com> Co-authored-by: Ramya Rao <ramya@stripe.com> Co-authored-by: Prathmesh Ranaut <prathmesh@stripe.com>
52 lines
2.3 KiB
Ruby
52 lines
2.3 KiB
Ruby
# File generated from our OpenAPI spec
|
|
# frozen_string_literal: true
|
|
|
|
module Stripe
|
|
class CouponService < StripeService
|
|
# You can create coupons easily via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.
|
|
#
|
|
# A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice's subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.
|
|
def create(params = {}, opts = {})
|
|
request(method: :post, path: "/v1/coupons", params: params, opts: opts, base_address: :api)
|
|
end
|
|
|
|
# You can delete coupons via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can't redeem the coupon. You can also delete coupons via the API.
|
|
def delete(coupon, params = {}, opts = {})
|
|
request(
|
|
method: :delete,
|
|
path: format("/v1/coupons/%<coupon>s", { coupon: CGI.escape(coupon) }),
|
|
params: params,
|
|
opts: opts,
|
|
base_address: :api
|
|
)
|
|
end
|
|
|
|
# Returns a list of your coupons.
|
|
def list(params = {}, opts = {})
|
|
request(method: :get, path: "/v1/coupons", params: params, opts: opts, base_address: :api)
|
|
end
|
|
|
|
# Retrieves the coupon with the given ID.
|
|
def retrieve(coupon, params = {}, opts = {})
|
|
request(
|
|
method: :get,
|
|
path: format("/v1/coupons/%<coupon>s", { coupon: CGI.escape(coupon) }),
|
|
params: params,
|
|
opts: opts,
|
|
base_address: :api
|
|
)
|
|
end
|
|
|
|
# Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.
|
|
def update(coupon, params = {}, opts = {})
|
|
request(
|
|
method: :post,
|
|
path: format("/v1/coupons/%<coupon>s", { coupon: CGI.escape(coupon) }),
|
|
params: params,
|
|
opts: opts,
|
|
base_address: :api
|
|
)
|
|
end
|
|
end
|
|
end
|