Class: AdvancedBilling::CouponsController

You can archive a Coupon via the API with the archive method. Archiving makes that Coupon unavailable for future use, but allows it to remain attached and functional on existing Subscriptions that are using it. The ‘archived_at` date and time will be assigned. the product family to which the coupon belongs coupon

Parameters:

product_family_id (Integer) —

Required parameter: The Chargify id of
coupon_id (Integer) —

Required parameter: The Chargify id of the

Returns:

(CouponResponse) —

response from the API call.

# File 'lib/advanced_billing/controllers/coupons_controller.rb', line 641

def archive_coupon(product_family_id,
                   coupon_id)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::DELETE,
                                 '/product_families/{product_family_id}/coupons/{coupon_id}.json',
                                 Server::DEFAULT)
               .template_param(new_parameter(product_family_id, key: 'product_family_id')
                                .is_required(true)
                                .should_encode(true))
               .template_param(new_parameter(coupon_id, key: 'coupon_id')
                                .is_required(true)
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('BasicAuth')))
    .response(new_response_handler
                .is_nullify404(true)
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CouponResponse.method(:from_hash)))
    .execute
end

#create_coupon(product_family_id, body: nil) ⇒ `CouponResponse`

## Coupons Documentation Coupons can be administered in the Chargify application or created via API. Please view our section on [creating coupons](maxio-chargify.zendesk.com/hc/en-us/articles/540474283073 3) for more information. Additionally, for documentation on how to apply a coupon to a subscription within the Chargify UI, please see our documentation [here](maxio-chargify.zendesk.com/hc/en-us/articles/5404761012877) . ## Create Coupon This request will create a coupon, based on the provided information. When creating a coupon, you must specify a product family using the ‘product_family_id`. If no `product_family_id` is passed, the first product family available is used. You will also need to formulate your URL to cite the Product Family ID in your request. You can restrict a coupon to only apply to specific products / components by optionally passing in hashes of `restricted_products` and/or `restricted_components` in the format: `{ “<product/component_id>”: boolean_value }` the product family to which the coupon belongs

Parameters:

product_family_id (Integer) —

Required parameter: The Chargify id of
body (CreateOrUpdateCoupon | nil) (defaults to: nil) —

Optional parameter: Example:

Returns:

(CouponResponse) —

response from the API call.

# File 'lib/advanced_billing/controllers/coupons_controller.rb', line 566

def create_coupon(product_family_id,
                  body: nil)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/product_families/{product_family_id}/coupons.json',
                                 Server::DEFAULT)
               .template_param(new_parameter(product_family_id, key: 'product_family_id')
                                .is_required(true)
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .validator(proc do |value|
                              UnionTypeLookUp.get(:CreateCouponBody)
                                             .validate(value)
                            end))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(Single.new('BasicAuth')))
    .response(new_response_handler
                .is_nullify404(true)
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CouponResponse.method(:from_hash))
                .local_error('422',
                             'Unprocessable Entity (WebDAV)',
                             ErrorListResponseException))
    .execute
end

#create_coupon_subcodes(coupon_id, body: nil) ⇒ `CouponSubcodesResponse`

## Coupon Subcodes Intro Coupon Subcodes allow you to create a set of unique codes that allow you to expand the use of one coupon. For example: Master Coupon Code: + SPRING2020 Coupon Subcodes: + SPRING90210 + DP80302 + SPRINGBALTIMORE Coupon subcodes can be administered in the Admin Interface or via the API. When creating a coupon subcode, you must specify a coupon to attach it to using the coupon_id. Valid coupon subcodes are all capital letters, contain only letters and numbers, and do not have any spaces. Lowercase letters will be capitalized before the subcode is created. ## Coupon Subcodes Documentation Full documentation on how to create coupon subcodes in the Chargify UI can be located [here](chargify.zendesk.com/hc/en-us/articles/4407755909531#coupon -codes). Additionally, for documentation on how to apply a coupon to a Subscription within the Chargify UI, please see our documentation [here](chargify.zendesk.com/hc/en-us/articles/4407884887835#coupon ). ## Create Coupon Subcode This request allows you to create specific subcodes underneath an existing coupon code. Note: If you are using any of the allowed special characters (“%”, “@”, “+”, “-”, “_”, and “.”), you must encode them for use in the URL.

% to %25
@ to %40
+ to %2B
- to %2D
_ to %5F
. to %2E

So, if the coupon subcode is ‘20%OFF`, the URL to delete this coupon subcode would be: `https://<subdomain>.chargify.com/coupons/567/codes/20%25OFF.<format>` coupon

Parameters:

coupon_id (Integer) —

Required parameter: The Chargify id of the
body (CouponSubcodes) (defaults to: nil) —

Optional parameter: Example:

Returns:

(CouponSubcodesResponse) —

response from the API call.

# File 'lib/advanced_billing/controllers/coupons_controller.rb', line 476

def create_coupon_subcodes(coupon_id,
                           body: nil)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/coupons/{coupon_id}/codes.json',
                                 Server::DEFAULT)
               .template_param(new_parameter(coupon_id, key: 'coupon_id')
                                .is_required(true)
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(Single.new('BasicAuth')))
    .response(new_response_handler
                .is_nullify404(true)
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CouponSubcodesResponse.method(:from_hash)))
    .execute
end

#delete_coupon_subcode(coupon_id, subcode) ⇒ `void`

This method returns an undefined value.

## Example Given a coupon with an ID of 567, and a coupon subcode of 20OFF, the URL to ‘DELETE` this coupon subcode would be: “` subdomain.chargify.com/coupons/567/codes/20OFF.<format> “` Note: If you are using any of the allowed special characters (“%”, “@”, “+”, “-”, “_”, and “.”), you must encode them for use in the URL. | Special character | Encoding | |——————-|———-| | % | %25 | | @ | %40 | | + | %2B | | – | %2D | | _ | %5F | | . | %2E | ## Percent Encoding Example Or if the coupon subcode is 20%OFF, the URL to delete this coupon subcode would be: @https://<subdomain>.chargify.com/coupons/567/codes/20%25OFF.<format> coupon to which the subcode belongs

Parameters:

coupon_id (Integer) —

Required parameter: The Chargify id of the
subcode (String) —

Required parameter: The subcode of the coupon

# File 'lib/advanced_billing/controllers/coupons_controller.rb', line 521

def delete_coupon_subcode(coupon_id,
                          subcode)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::DELETE,
                                 '/coupons/{coupon_id}/codes/{subcode}.json',
                                 Server::DEFAULT)
               .template_param(new_parameter(coupon_id, key: 'coupon_id')
                                .is_required(true)
                                .should_encode(true))
               .template_param(new_parameter(subcode, key: 'subcode')
                                .is_required(true)
                                .should_encode(true))
               .auth(Single.new('BasicAuth')))
    .response(new_response_handler
                .is_nullify404(true)
                .is_response_void(true)
                .local_error('404',
                             'Not Found',
                             APIException))
    .execute
end

#list_coupon_subcodes(options = {}) ⇒ `CouponSubcodes`

This request allows you to request the subcodes that are attached to a coupon. coupon pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned. Use in query ‘page=1`. many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200. Use in query `per_page=200`.

Parameters:

coupon_id (Integer) —

Required parameter: The Chargify id of the
page (Integer) —

Optional parameter: Result records are organized in
per_page (Integer) —

Optional parameter: This parameter indicates how

Returns:

(CouponSubcodes) —

response from the API call.

# File 'lib/advanced_billing/controllers/coupons_controller.rb', line 140

def list_coupon_subcodes(options = {})
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/coupons/{coupon_id}/codes.json',
                                 Server::DEFAULT)
               .template_param(new_parameter(options['coupon_id'], key: 'coupon_id')
                                .is_required(true)
                                .should_encode(true))
               .query_param(new_parameter(options['page'], key: 'page'))
               .query_param(new_parameter(options['per_page'], key: 'per_page'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('BasicAuth')))
    .response(new_response_handler
                .is_nullify404(true)
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CouponSubcodes.method(:from_hash)))
    .execute
end

#list_coupons(options = {}) ⇒ `Array[CouponResponse]`

You can retrieve a list of coupons. If the coupon is set to ‘use_site_exchange_rate: true`, it will return pricing based on the current exchange rate. If the flag is set to false, it will return all of the defined prices for each currency. pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned. Use in query `page=1`. many records to fetch in each request. Default value is 30. The maximum allowed values is 200; any per_page value over 200 will be changed to 200. Use in query `per_page=200`. deprecated: on January 20, 2022. We recommend using filter instead to achieve the same result. The type of filter you would like to apply to your search. on January 20, 2022. We recommend using filter instead to achieve the same result. The start date (format YYYY-MM-DD) with which to filter the date_field. Returns coupons with a timestamp at or after midnight (12:00:00 AM) in your site’s time zone on the date specified. January 20, 2022. We recommend using filter instead to achieve the same result. The end date (format YYYY-MM-DD) with which to filter the date_field. Returns coupons with a timestamp up to and including 11:59:59PM in your site’s time zone on the date specified. deprecated: on January 20, 2022. We recommend using filter instead to achieve the same result. The start date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns coupons with a timestamp at or after exact time provided in query. You can specify timezone in query - otherwise your site’s time zone will be used. If provided, this parameter will be used instead of start_date. on January 20, 2022. We recommend using filter instead to achieve the same result. The end date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns coupons with a timestamp at or before exact time provided in query. You can specify timezone in query - otherwise your site’s time zone will be used. If provided, this parameter will be used instead of end_date. coupons with matching id based on provided values. Use in query ‘filter=1,2,3`. coupons with matching code based on provided values. Use in query `filter=1,2,3`. fetching coupons, if you have defined multiple currencies at the site level, you can optionally pass the `?currency_prices=true` query param to include an array of currency price data in the response. Use in query `currency_prices=true`. YYYY-MM-DD) with which to filter the date_field. Returns coupons with a timestamp up to and including 11:59:59PM in your site’s time zone on the date specified. Use in query `filter=2011-12-17`. time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns coupons with a timestamp at or before exact time provided in query. You can specify timezone in query - otherwise your site’s time zone will be used. If provided, this parameter will be used instead of end_date. Use in query ‘filter=2011-12-19T10:15:30+01:00`. (format YYYY-MM-DD) with which to filter the date_field. Returns coupons with a timestamp at or after midnight (12:00:00 AM) in your site’s time zone on the date specified. Use in query `filter=2011-12-19`. and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns coupons with a timestamp at or after exact time provided in query. You can specify timezone in query - otherwise your site’s time zone will be used. If provided, this parameter will be used instead of start_date. Use in query ‘filter=2011-12-19T10:15:30+01:00`. filter you would like to apply to your search. Use in query `filter=updated_at`. parameter: Allows fetching coupons with matching use_site_exchange_rate based on provided value. Use in query `filter=true`.

Parameters:

page (Integer) —

Optional parameter: Result records are organized in
per_page (Integer) —

Optional parameter: This parameter indicates how
date_field (BasicDateField) —

Optional parameter: The field was
start_date (String) —

Optional parameter: The field was deprecated:
end_date (String) —

Optional parameter: The field was deprecated: on
start_datetime (String) —

Optional parameter: The field was
end_datetime (String) —

Optional parameter: The field was deprecated:
filter_ids (Array[Integer]) —

Optional parameter: Allows fetching
filter_codes (Array[String]) —

Optional parameter: Allows fetching
currency_prices (TrueClass | FalseClass) —

Optional parameter: When
filter_end_date (String) —

Optional parameter: The end date (format
filter_end_datetime (String) —

Optional parameter: The end date and
filter_start_date (String) —

Optional parameter: The start date
filter_start_datetime (String) —

Optional parameter: The start date
filter_date_field (BasicDateField) —

Optional parameter: The type of
filter_use_site_exchange_rate (TrueClass | FalseClass) —

Optional

Returns:

(Array[CouponResponse]) —

response from the API call.

# File 'lib/advanced_billing/controllers/coupons_controller.rb', line 369

def list_coupons(options = {})
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/coupons.json',
                                 Server::DEFAULT)
               .query_param(new_parameter(options['page'], key: 'page'))
               .query_param(new_parameter(options['per_page'], key: 'per_page'))
               .query_param(new_parameter(options['date_field'], key: 'date_field'))
               .query_param(new_parameter(options['start_date'], key: 'start_date'))
               .query_param(new_parameter(options['end_date'], key: 'end_date'))
               .query_param(new_parameter(options['start_datetime'], key: 'start_datetime'))
               .query_param(new_parameter(options['end_datetime'], key: 'end_datetime'))
               .query_param(new_parameter(options['filter_ids'], key: 'filter[ids]'))
               .query_param(new_parameter(options['filter_codes'], key: 'filter[codes]'))
               .query_param(new_parameter(options['currency_prices'], key: 'currency_prices'))
               .query_param(new_parameter(options['filter_end_date'], key: 'filter[end_date]'))
               .query_param(new_parameter(options['filter_end_datetime'], key: 'filter[end_datetime]'))
               .query_param(new_parameter(options['filter_start_date'], key: 'filter[start_date]'))
               .query_param(new_parameter(options['filter_start_datetime'], key: 'filter[start_datetime]'))
               .query_param(new_parameter(options['filter_date_field'], key: 'filter[date_field]'))
               .query_param(new_parameter(options['filter_use_site_exchange_rate'], key: 'filter[use_site_exchange_rate]'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('BasicAuth'))
               .array_serialization_format(ArraySerializationFormat::CSV))
    .response(new_response_handler
                .is_nullify404(true)
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CouponResponse.method(:from_hash))
                .is_response_array(true))
    .execute
end

#list_coupons_for_product_family(options = {}) ⇒ `Array[CouponResponse]`

List coupons for a specific Product Family in a Site. If the coupon is set to ‘use_site_exchange_rate: true`, it will return pricing based on the current exchange rate. If the flag is set to false, it will return all of the defined prices for each currency. the product family to which the coupon belongs pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned. Use in query `page=1`. many records to fetch in each request. Default value is 30. The maximum allowed values is 200; any per_page value over 200 will be changed to 200. Use in query `per_page=200`. filter you would like to apply to your search. Use in query `filter=created_at`. YYYY-MM-DD) with which to filter the date_field. Returns coupons with a timestamp up to and including 11:59:59PM in your site’s time zone on the date specified. Use in query `filter=2011-12-15`. time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns coupons with a timestamp at or before exact time provided in query. You can specify timezone in query - otherwise your site’s time zone will be used. If provided, this parameter will be used instead of end_date. Use in query ‘?filter=2011-12-1T10:15:30+01:00`. (format YYYY-MM-DD) with which to filter the date_field. Returns coupons with a timestamp at or after midnight (12:00:00 AM) in your site’s time zone on the date specified. Use in query `filter=2011-12-17`. and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns coupons with a timestamp at or after exact time provided in query. You can specify timezone in query - otherwise your site’s time zone will be used. If provided, this parameter will be used instead of start_date. Use in query ‘filter=2011-12-19T10:15:30+01:00`. coupons with matching id based on provided values. Use in query `filter=1,2,3`. coupons with matching codes based on provided values. Use in query `filter=free,free_trial`. fetching coupons, if you have defined multiple currencies at the site level, you can optionally pass the `?currency_prices=true` query param to include an array of currency price data in the response. Use in query `currency_prices=true`. parameter: Allows fetching coupons with matching use_site_exchange_rate based on provided value. Use in query `filter=true`.

Parameters:

product_family_id (Integer) —

Required parameter: The Chargify id of
page (Integer) —

Optional parameter: Result records are organized in
per_page (Integer) —

Optional parameter: This parameter indicates how
filter_date_field (BasicDateField) —

Optional parameter: The type of
filter_end_date (String) —

Optional parameter: The end date (format
filter_end_datetime (String) —

Optional parameter: The end date and
filter_start_date (String) —

Optional parameter: The start date
filter_start_datetime (String) —

Optional parameter: The start date
filter_ids (Array[Integer]) —

Optional parameter: Allows fetching
filter_codes (Array[String]) —

Optional parameter: Allows fetching
currency_prices (TrueClass | FalseClass) —

Optional parameter: When
filter_use_site_exchange_rate (TrueClass | FalseClass) —

Optional

Returns:

(Array[CouponResponse]) —

response from the API call.

# File 'lib/advanced_billing/controllers/coupons_controller.rb', line 66

def list_coupons_for_product_family(options = {})
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/product_families/{product_family_id}/coupons.json',
                                 Server::DEFAULT)
               .template_param(new_parameter(options['product_family_id'], key: 'product_family_id')
                                .is_required(true)
                                .should_encode(true))
               .query_param(new_parameter(options['page'], key: 'page'))
               .query_param(new_parameter(options['per_page'], key: 'per_page'))
               .query_param(new_parameter(options['filter_date_field'], key: 'filter[date_field]'))
               .query_param(new_parameter(options['filter_end_date'], key: 'filter[end_date]'))
               .query_param(new_parameter(options['filter_end_datetime'], key: 'filter[end_datetime]'))
               .query_param(new_parameter(options['filter_start_date'], key: 'filter[start_date]'))
               .query_param(new_parameter(options['filter_start_datetime'], key: 'filter[start_datetime]'))
               .query_param(new_parameter(options['filter_ids'], key: 'filter[ids]'))
               .query_param(new_parameter(options['filter_codes'], key: 'filter[codes]'))
               .query_param(new_parameter(options['currency_prices'], key: 'currency_prices'))
               .query_param(new_parameter(options['filter_use_site_exchange_rate'], key: 'filter[use_site_exchange_rate]'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('BasicAuth'))
               .array_serialization_format(ArraySerializationFormat::CSV))
    .response(new_response_handler
                .is_nullify404(true)
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CouponResponse.method(:from_hash))
                .is_response_array(true))
    .execute
end

#read_coupon(product_family_id, coupon_id) ⇒ `CouponResponse`

You can retrieve the Coupon via the API with the Show method. You must identify the Coupon in this call by the ID parameter that Chargify assigns. If instead you would like to find a Coupon using a Coupon code, see the Coupon Find method. When fetching a coupon, if you have defined multiple currencies at the site level, you can optionally pass the ‘?currency_prices=true` query param to include an array of currency price data in the response. If the coupon is set to `use_site_exchange_rate: true`, it will return pricing based on the current exchange rate. If the flag is set to false, it will return all of the defined prices for each currency. the product family to which the coupon belongs coupon

Parameters:

product_family_id (Integer) —

Required parameter: The Chargify id of
coupon_id (Integer) —

Required parameter: The Chargify id of the

Returns:

(CouponResponse) —

response from the API call.

# File 'lib/advanced_billing/controllers/coupons_controller.rb', line 610

def read_coupon(product_family_id,
                coupon_id)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/product_families/{product_family_id}/coupons/{coupon_id}.json',
                                 Server::DEFAULT)
               .template_param(new_parameter(product_family_id, key: 'product_family_id')
                                .is_required(true)
                                .should_encode(true))
               .template_param(new_parameter(coupon_id, key: 'coupon_id')
                                .is_required(true)
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('BasicAuth')))
    .response(new_response_handler
                .is_nullify404(true)
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CouponResponse.method(:from_hash)))
    .execute
end

#read_coupon_by_code(product_family_id: nil, code: nil) ⇒ `CouponResponse`

You can search for a coupon via the API with the find method. By passing a code parameter, the find will attempt to locate a coupon that matches that code. If no coupon is found, a 404 is returned. If you have more than one product family and if the coupon you are trying to find does not belong to the default product family in your site, then you will need to specify (either in the url or as a query string param) the product family id. the product family to which the coupon belongs

Parameters:

product_family_id (Integer) (defaults to: nil) —

Optional parameter: The Chargify id of
code (String) (defaults to: nil) —

Optional parameter: The code of the coupon

Returns:

(CouponResponse) —

response from the API call.

# File 'lib/advanced_billing/controllers/coupons_controller.rb', line 107

def read_coupon_by_code(product_family_id: nil,
                        code: nil)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/coupons/find.json',
                                 Server::DEFAULT)
               .query_param(new_parameter(product_family_id, key: 'product_family_id'))
               .query_param(new_parameter(code, key: 'code'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('BasicAuth')))
    .response(new_response_handler
                .is_nullify404(true)
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CouponResponse.method(:from_hash)))
    .execute
end

#read_coupon_usage(product_family_id, coupon_id) ⇒ `Array[CouponUsage]`

This request will provide details about the coupon usage as an array of data hashes, one per product. the product family to which the coupon belongs coupon

Parameters:

product_family_id (Integer) —

Required parameter: The Chargify id of
coupon_id (Integer) —

Required parameter: The Chargify id of the

Returns:

(Array[CouponUsage]) —

response from the API call.

# File 'lib/advanced_billing/controllers/coupons_controller.rb', line 669

def read_coupon_usage(product_family_id,
                      coupon_id)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/product_families/{product_family_id}/coupons/{coupon_id}/usage.json',
                                 Server::DEFAULT)
               .template_param(new_parameter(product_family_id, key: 'product_family_id')
                                .is_required(true)
                                .should_encode(true))
               .template_param(new_parameter(coupon_id, key: 'coupon_id')
                                .is_required(true)
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('BasicAuth')))
    .response(new_response_handler
                .is_nullify404(true)
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CouponUsage.method(:from_hash))
                .is_response_array(true))
    .execute
end

#update_coupon(product_family_id, coupon_id, body: nil) ⇒ `CouponResponse`

## Update Coupon You can update a Coupon via the API with a PUT request to the resource endpoint. You can restrict a coupon to only apply to specific products / components by optionally passing in hashes of ‘restricted_products` and/or `restricted_components` in the format: `{ “<product/component_id>”: boolean_value }` the product family to which the coupon belongs coupon

Parameters:

product_family_id (Integer) —

Required parameter: The Chargify id of
coupon_id (Integer) —

Required parameter: The Chargify id of the
body (CreateOrUpdateCoupon | nil) (defaults to: nil) —

Optional parameter: Example:

Returns:

(CouponResponse) —

response from the API call.

# File 'lib/advanced_billing/controllers/coupons_controller.rb', line 257

def update_coupon(product_family_id,
                  coupon_id,
                  body: nil)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::PUT,
                                 '/product_families/{product_family_id}/coupons/{coupon_id}.json',
                                 Server::DEFAULT)
               .template_param(new_parameter(product_family_id, key: 'product_family_id')
                                .is_required(true)
                                .should_encode(true))
               .template_param(new_parameter(coupon_id, key: 'coupon_id')
                                .is_required(true)
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .validator(proc do |value|
                              UnionTypeLookUp.get(:UpdateCouponBody)
                                             .validate(value)
                            end))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(Single.new('BasicAuth')))
    .response(new_response_handler
                .is_nullify404(true)
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CouponResponse.method(:from_hash)))
    .execute
end

#update_coupon_currency_prices(coupon_id, body: nil) ⇒ `Array[CouponCurrency]`

This endpoint allows you to create and/or update currency prices for an existing coupon. Multiple prices can be created or updated in a single request but each of the currencies must be defined on the site level already and the coupon must be an amount-based coupon, not percentage. Currency pricing for coupons must mirror the setup of the primary coupon pricing - if the primary coupon is percentage based, you will not be able to define pricing in non-primary currencies. coupon

Parameters:

coupon_id (Integer) —

Required parameter: The Chargify id of the
body (CouponCurrencyRequest) (defaults to: nil) —

Optional parameter: Example:

Returns:

(Array[CouponCurrency]) —

response from the API call.

# File 'lib/advanced_billing/controllers/coupons_controller.rb', line 412

def update_coupon_currency_prices(coupon_id,
                                  body: nil)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::PUT,
                                 '/coupon/{coupon_id}/currency_prices.json',
                                 Server::DEFAULT)
               .template_param(new_parameter(coupon_id, key: 'coupon_id')
                                .is_required(true)
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(Single.new('BasicAuth')))
    .response(new_response_handler
                .is_nullify404(true)
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CouponCurrency.method(:from_hash))
                .is_response_array(true))
    .execute
end

#update_coupon_subcodes(coupon_id, body: nil) ⇒ `CouponSubcodesResponse`

You can update the subcodes for the given Coupon via the API with a PUT request to the resource endpoint. Send an array of new coupon subcodes. Note: All current subcodes for that Coupon will be deleted first, and replaced with the list of subcodes sent to this endpoint. The response will contain: + The created subcodes, + Subcodes that were not created because they already exist, + Any subcodes not created because they are invalid. coupon

Parameters:

coupon_id (Integer) —

Required parameter: The Chargify id of the
body (CouponSubcodes) (defaults to: nil) —

Optional parameter: Example:

Returns:

(CouponSubcodesResponse) —

response from the API call.

# File 'lib/advanced_billing/controllers/coupons_controller.rb', line 172

def update_coupon_subcodes(coupon_id,
                           body: nil)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::PUT,
                                 '/coupons/{coupon_id}/codes.json',
                                 Server::DEFAULT)
               .template_param(new_parameter(coupon_id, key: 'coupon_id')
                                .is_required(true)
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(Single.new('BasicAuth')))
    .response(new_response_handler
                .is_nullify404(true)
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CouponSubcodesResponse.method(:from_hash)))
    .execute
end

#validate_coupon(code, product_family_id: nil) ⇒ `CouponResponse`

You can verify if a specific coupon code is valid using the ‘validate` method. This method is useful for validating coupon codes that are entered by a customer. If the coupon is found and is valid, the coupon will be returned with a 200 status code. If the coupon is invalid, the status code will be 404 and the response will say why it is invalid. If the coupon is valid, the status code will be 200 and the coupon will be returned. The following reasons for invalidity are supported: + Coupon not found + Coupon is invalid + Coupon expired If you have more than one product family and if the coupon you are validating does not belong to the first product family in your site, then you will need to specify the product family, either in the url or as a query string param. This can be done by supplying the id or the handle in the `handle:my-family` format. Eg. “` https://<subdomain>.chargify.com/product_families/handle:<product_family_h andle>/coupons/validate.<format>?code=<coupon_code> “` Or: “` https://<subdomain>.chargify.com/coupons/validate.<format>?code=<coupon_co de>&product_family_id=<id> “` the product family to which the coupon belongs

Parameters:

code (String) —

Required parameter: The code of the coupon
product_family_id (Integer) (defaults to: nil) —

Optional parameter: The Chargify id of

Returns:

(CouponResponse) —

response from the API call.

# File 'lib/advanced_billing/controllers/coupons_controller.rb', line 223

def validate_coupon(code,
                    product_family_id: nil)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/coupons/validate.json',
                                 Server::DEFAULT)
               .query_param(new_parameter(code, key: 'code')
                             .is_required(true))
               .query_param(new_parameter(product_family_id, key: 'product_family_id'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('BasicAuth')))
    .response(new_response_handler
                .is_nullify404(true)
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CouponResponse.method(:from_hash))
                .local_error('404',
                             'Not Found',
                             SingleStringErrorResponseException))
    .execute
end

Class: AdvancedBilling::CouponsController

Overview

Constant Summary

Constants inherited from BaseController

Instance Attribute Summary

Attributes inherited from BaseController

Instance Method Summary collapse

Methods inherited from BaseController

Constructor Details

Instance Method Details

#archive_coupon(product_family_id, coupon_id) ⇒ CouponResponse

#create_coupon(product_family_id, body: nil) ⇒ CouponResponse

#create_coupon_subcodes(coupon_id, body: nil) ⇒ CouponSubcodesResponse

#delete_coupon_subcode(coupon_id, subcode) ⇒ void

#list_coupon_subcodes(options = {}) ⇒ CouponSubcodes

#list_coupons(options = {}) ⇒ Array[CouponResponse]

#list_coupons_for_product_family(options = {}) ⇒ Array[CouponResponse]

#read_coupon(product_family_id, coupon_id) ⇒ CouponResponse

#read_coupon_by_code(product_family_id: nil, code: nil) ⇒ CouponResponse

#read_coupon_usage(product_family_id, coupon_id) ⇒ Array[CouponUsage]

#update_coupon(product_family_id, coupon_id, body: nil) ⇒ CouponResponse

#update_coupon_currency_prices(coupon_id, body: nil) ⇒ Array[CouponCurrency]

#update_coupon_subcodes(coupon_id, body: nil) ⇒ CouponSubcodesResponse

#validate_coupon(code, product_family_id: nil) ⇒ CouponResponse

#archive_coupon(product_family_id, coupon_id) ⇒ `CouponResponse`

#create_coupon(product_family_id, body: nil) ⇒ `CouponResponse`

#create_coupon_subcodes(coupon_id, body: nil) ⇒ `CouponSubcodesResponse`

#delete_coupon_subcode(coupon_id, subcode) ⇒ `void`

#list_coupon_subcodes(options = {}) ⇒ `CouponSubcodes`

#list_coupons(options = {}) ⇒ `Array[CouponResponse]`

#list_coupons_for_product_family(options = {}) ⇒ `Array[CouponResponse]`

#read_coupon(product_family_id, coupon_id) ⇒ `CouponResponse`

#read_coupon_by_code(product_family_id: nil, code: nil) ⇒ `CouponResponse`

#read_coupon_usage(product_family_id, coupon_id) ⇒ `Array[CouponUsage]`

#update_coupon(product_family_id, coupon_id, body: nil) ⇒ `CouponResponse`

#update_coupon_currency_prices(coupon_id, body: nil) ⇒ `Array[CouponCurrency]`

#update_coupon_subcodes(coupon_id, body: nil) ⇒ `CouponSubcodesResponse`

#validate_coupon(code, product_family_id: nil) ⇒ `CouponResponse`