Class: Stripe::PromotionCode

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Includes:
APIOperations::Save
Defined in:
lib/stripe/resources/promotion_code.rb

Overview

A Promotion Code represents a customer-redeemable code for a [coupon](stripe.com/docs/api#coupons). It can be used to create multiple codes for a single coupon.

Constant Summary collapse

OBJECT_NAME = 
"promotion_code"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::Save

included, #save

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Class Method Details

.create(params = {}, opts = {}) ⇒ Object

A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.



18
19
20
 
# File 'lib/stripe/resources/promotion_code.rb', line 18

def self.create(params = {}, opts = {})
  request_stripe_object(method: :post, path: "/v1/promotion_codes", params: params, opts: opts)
end

.list(filters = {}, opts = {}) ⇒ Object

Returns a list of your promotion codes.



23
24
25
 
# File 'lib/stripe/resources/promotion_code.rb', line 23

def self.list(filters = {}, opts = {})
  request_stripe_object(method: :get, path: "/v1/promotion_codes", params: filters, opts: opts)
end

.object_name ⇒ Object 



13
14
15
 
# File 'lib/stripe/resources/promotion_code.rb', line 13

def self.object_name
  "promotion_code"
end

.update(id, params = {}, opts = {}) ⇒ Object

Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.



28
29
30
31
32
33
34
35
 
# File 'lib/stripe/resources/promotion_code.rb', line 28

def self.update(id, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/promotion_codes/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts
  )
end