Coupon/List

List coupons connected to a product group or for the entire brand. To list a specific coupon provide a 'coupon_id'.

Parameters
Parameter Type Required Description
coupon_id string optional Provide a 'coupon_id' to list a specific coupon.
product_group_id string optional Provide to list coupons connected to a specific product group.
GET https://api.recurringstack.com/{format}/Coupon/List 
//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('coupon_id' => "",'product_group_id' => "");
try { $response = $rstack->request('Coupon/List','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <coupon coupon_id="b8d5bc14-a1ba-4ea0-9424-55d46ac8b0fe" creation_date="2022-03-12 00:47:40" product_group_id="e4d23994-d6e2-45a8-91b0-d882b248dc98" status="1">
      <name>Summer Sale</name>
      <description>The best time to join our service is in the Summer. Use this coupon for $10.00 off your plan forever. Not available for other product or first product ever.</description>
      <coupon_code>BIG103</coupon_code>
      <coupon_type>amount</coupon_type>
      <discount_amount>10.00</discount_amount>
      <settings>
         <expiration_date friendly_expiration_date="June 13th 2022">2022-06-13 00:00:00</expiration_date>
         <coupon_duration>forever</coupon_duration>
         <stackable>N</stackable>
         <max_use current_use="0">1000</max_use>
         <restricted_products>
            <product product_id="b0717d64-b569-467b-8181-5e4f6f0a0349">Other Product</product>
            <product product_id="4ffe6c40-270d-4796-ba43-472039ed0f6c">First Product Ever</product>
         </restricted_products>
      </settings>
      <status>1</status>
   </coupon>
</recurringstack>

{
    "coupon": {
        "@attributes": {
            "coupon_id": "b8d5bc14-a1ba-4ea0-9424-55d46ac8b0fe",
            "creation_date": "2022-03-12 00:47:40",
            "product_group_id": "e4d23994-d6e2-45a8-91b0-d882b248dc98",
            "status": "1"
        },
        "name": "Summer Sale",
        "description": "The best time to join our service is in the Summer. Use this coupon for $10.00 off your plan forever. Not available for other product or first product ever.",
        "coupon_code": "BIG103",
        "coupon_type": "amount",
        "discount_amount": "10.00",
        "settings": {
            "expiration_date": "2022-06-13 00:00:00",
            "coupon_duration": "forever",
            "stackable": "N",
            "max_use": "1000",
            "restricted_products": {
                "product": [
                    "Other Product",
                    "First Product Ever"
                ]
            }
        },
        "status": "1"
    }
}

API Simulator

Initiate a live call to the Coupon/List service using the API simulator.

Coupon/Create

Create a new coupon and assign it to specific products. All coupons must be assigned to a product group, meaning they will only work with products from that group.

Parameters
Parameter Type Required Description
product_group_id string required The 'product_group_id' you want this coupon to be available for.
name string required The name of the coupon for your reference.
description string required A short description of the value provided by the coupon.
coupon_code string required A unique code for the coupon customers will use to apply it to a subscription. Should be between 3 and 15 letters or numbers; special characters are not allowed.
coupon_type string required Either 'amount' or 'percent'.
coupon_duration string required Options are 'one-time' (discount will be applied one-time at the start of the subscription) or 'forever' (discount never ends even after the coupon code expires).
discount_amount string required The full dollar amount (either 'amount' or 'percent') of the discount; for example 20.00 or 15.25.
expiration_date string required Provide a date this coupon will expire in the YYYY-MM-DD format.
expiration_time string required Provide a time on the 'expiration_date' this coupon will expire in the HH:MM:SS format.
stackable string required Provide a 'Y' if this coupon can be used with other offers or a 'N' if not.
restricted_products string optional A comma seperated list of products (product_id) in the product group you don't want this coupon used with.
max_use string optional The maximum amount of times this coupon can be utilized for a new subscription.
POST https://api.recurringstack.com/{format}/Coupon/Create 
//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('product_group_id' => "",'name' => "",'description' => "",'coupon_code' => "",'coupon_type' => "",'coupon_duration' => "",'discount_amount' => "",'expiration_date' => "",'expiration_time' => "",'stackable' => "",'restricted_products' => "",'max_use' => "");
try { $response = $rstack->request('Coupon/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <coupon coupon_id="1b5245ca-726b-4f50-8a54-ba3cee5905b9" creation_date="2022-03-11 19:18:11" product_group_id="e4d23994-d6e2-45a8-91b0-d882b248dc98" status="1">
      <name>First Coupon</name>
      <description>Worth 10 bucks any day of the week.</description>
      <coupon_code>BIG10</coupon_code>
      <coupon_type>amount</coupon_type>
      <discount_amount>10.00</discount_amount>
      <settings>
         <expiration_date friendly_expiration_date="January 1st 2025">2025-01-01 00:00:00</expiration_date>
         <coupon_duration>forever</coupon_duration>
         <stackable>N</stackable>
         <max_use>1000</max_use>
         <restricted_products>
            <product product_id="b0717d64-b569-467b-8181-5e4f6f0a0349">Other Product</product>
            <product product_id="4ffe6c40-270d-4796-ba43-472039ed0f6c">First Product Ever</product>
         </restricted_products>
      </settings>
      <status>1</status>
   </coupon>
</recurringstack>

{
    "coupon": {
        "@attributes": {
            "coupon_id": "1b5245ca-726b-4f50-8a54-ba3cee5905b9",
            "creation_date": "2022-03-11 19:18:11",
            "product_group_id": "e4d23994-d6e2-45a8-91b0-d882b248dc98",
            "status": "1"
        },
        "name": "First Coupon",
        "description": "Worth 10 bucks any day of the week.",
        "coupon_code": "BIG10",
        "coupon_type": "amount",
        "discount_amount": "10.00",
        "settings": {
            "expiration_date": "2025-01-01 00:00:00",
            "coupon_duration": "forever",
            "stackable": "N",
            "max_use": "1000",
            "restricted_products": {
                "product": [
                    "Other Product",
                    "First Product Ever"
                ]
            }
        },
        "status": "1"
    }
}

API Simulator

Initiate a live call to the Coupon/Create service using the API simulator.

Coupon/Update

Update an existing coupon.

'product_group_id' is required but can't be updated.

Parameters
Parameter Type Required Description
coupon_id string required The 'coupon_id' of the coupon you wish to update.
product_group_id string required The 'product_group_id' you want this coupond to be available for.
name string required The name of the coupon.
description string required A short description of the value provided by the coupon.
coupon_code string required A unique code for the coupon customers will use to apply it to a subscription. Should be between 3 and 15 letters or numbers; special characters are not allowed.
coupon_type string required Either 'amount' or 'percent'.
coupon_duration string required Options are 'one-time' (discount will be applied one-time at the start of the subscription) or 'forever' (discount never ends even after the coupon code expires).
discount_amount string required The full dollar amount (either 'amount' or 'percent') of the discount; for example 20.00 or 15.25.
expiration_date string required Provide a date this coupon will expire in the YYYY-MM-DD format.
expiration_time string required Provide a time on the 'expiration_date' this coupon will expire in the HH:MM:SS format.
stackable string required Provide a 'Y' if this coupon can be used with other offers or a 'N' if not.
restricted_products string optional A comma seperated list of products (product_id) in the product group you don't want this coupon used with.
max_use string optional The maximum amount of times this coupon can be utilized for a new subscription.
PATCH https://api.recurringstack.com/{format}/Coupon/Update 
//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('coupon_id' => "",'product_group_id' => "",'name' => "",'description' => "",'coupon_code' => "",'coupon_type' => "",'coupon_duration' => "",'discount_amount' => "",'expiration_date' => "",'expiration_time' => "",'stackable' => "",'restricted_products' => "",'max_use' => "");
try { $response = $rstack->request('Coupon/Update','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <coupon coupon_id="e5aa4e2f-7f5c-48c9-8771-d14c4f521e72" creation_date="2022-03-11 19:32:53" product_group_id="e4d23994-d6e2-45a8-91b0-d882b248dc98" status="1">
      <name>Summer Sale</name>
      <description>Use this coupon code for 10 percent off anything in our store excluding shoes.</description>
      <coupon_code>10OFFALL</coupon_code>
      <coupon_type>percent</coupon_type>
      <discount_amount>10.00</discount_amount>
      <settings>
         <expiration_date friendly_expiration_date="June 13th 2022">2022-06-13 00:00:00</expiration_date>
         <coupon_duration>one-time</coupon_duration>
         <stackable>Y</stackable>
         <max_use current_use="0">500</max_use>
         <restricted_products>
            <product product_id="96027df1-7b53-42ef-b097-b1b3d70e207d">Jordan Shoes</product>
         </restricted_products>
      </settings>
      <status>1</status>
   </coupon>
</recurringstack>

{
    "coupon": {
        "@attributes": {
            "coupon_id": "e5aa4e2f-7f5c-48c9-8771-d14c4f521e72",
            "creation_date": "2022-03-11 19:32:53",
            "product_group_id": "e4d23994-d6e2-45a8-91b0-d882b248dc98",
            "status": "1"
        },
        "name": "Summer Sale",
        "description": "Use this coupon code for 10 percent off anything in our store excluding shoes.",
        "coupon_code": "10OFFALL",
        "coupon_type": "percent",
        "discount_amount": "10.00",
        "settings": {
            "expiration_date": "2022-06-13 00:00:00",
            "coupon_duration": "one-time",
            "stackable": "Y",
            "max_use": "500",
            "restricted_products": {
                "product": "Jordan Shoes"
            }
        },
        "status": "1"
    }
}

API Simulator

Initiate a live call to the Coupon/Update service using the API simulator.

Coupon/Delete

Delete a coupon.

This action is not reversable. Subscriptions currently taking advantge of the discounts offered by the coupon will have those discounts removed.

Parameters
Parameter Type Required Description
coupon_id string required The 'coupon_id' of the coupon you wish to delete.
DELETE https://api.recurringstack.com/{format}/Coupon/Delete 
//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('coupon_id' => "");
try { $response = $rstack->request('Coupon/Delete','DELETE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <coupon coupon_id="b8d5bc14-a1ba-4ea0-9424-55d46ac8b0fe" creation_date="2022-03-12 00:47:40" deletion_date="2022-03-12 00:57:42" status="3"/>
</recurringstack>

{
    "coupon": {
        "@attributes": {
            "coupon_id": "b8d5bc14-a1ba-4ea0-9424-55d46ac8b0fe",
            "creation_date": "2022-03-12 00:47:40",
            "deletion_date": "2022-03-12 00:57:42",
            "status": "3"
        }
    }
}

API Simulator

Initiate a live call to the Coupon/Delete service using the API simulator.
Your content here

Lorem ipsum dolor sit amet consectetur adipisicing elit. Qui, natus temporibus voluptate corporis possimus ab aut cumque.

Homepage

Quick Tips

You may remove all ID or Class names which contain _dm-, they are only used for demonstration.

Boxed Layout

Fluid Layout Remove the .boxed-layout and .centered-layout classes from the body.
Centered Layout Add a class .centered-layout to the body.
Boxed Layout Add a class .boxed-layout to the body.
Boxed Layout with background image

Add background image to the body.

<body class="boxed-layout" style='background-image: url("path_to_img/image.jpg");'>
    ..
    ..
</body>

Or it could be in your own class.

.bg-img {
background-image: url("path_to_img/image.jpg");
}
<body class="boxed-layout bg-img">
    ..
    ..
</body>

Color Schemes

Replace the current Bootstrap CSS and Nifty CSS path with the new path of the CSS color schemes you wish to use.

This is where you can change the color scheme of your app / website.

<head>
    ...
    <title>My Project</title>
    ...

    <!-- STYLESHEETS -->
    <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~--- -->

    <!-- Bootstrap CSS [ REQUIRED ] -->
    <link rel="stylesheet" href="documentation/assets/css/color-schemes/SELECTED-SCEHEMS/bootstrap.min.css">

    <!-- Nifty CSS [ REQUIRED ] -->
    <link rel="stylesheet" href="documentation/assets/css/color-schemes/SELECTED-SCEHEMS/nifty.min.css">

</head>

Header

Sticky header Add a class .hd--sticky to the #root.
Expanded header Add a class .hd--expanded to the #root.
Expanded header with overlapping content. Add a class .overlapping to the #content > .content__header.
Disable rounded header. Add a class .rounded-0 to the #content > .content__header.

Animations

Add the following class to the body to change the animation transition.

Transition function name Class name
In Quart .in-quart
Out Quart .out-quart
In Back .in-back
Out Back .out-back
In Out Back .in-out-back
easeInOutBack .easeInOutBack
steps .steps
jumping .jumping
rubber .rubber
Tips on this page :
RecurringStack Documentation
RecurringStack Docs
RecurringStack Simulator API Credentials
A valid API key associated with your RecurringStack™ account.
The user key associated with your RecurringStack™ login.
The 'brand_id' associated with one of your brands.
NOTE: Your credentials will not be validated.

Sign In

Background Images

Add an image to replace the solid background color
Blurred
Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image
Polygon & Geometric
Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image
Abstract
Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image
Layouts
Layouts
Transitions
Header
Additional Offcanvas New in BS v.5.0

Select the offcanvas placement.

Sidebars
Navigation
Right sidebar
Color Schemes
Light Completely bright color themes.
Dark Completely dark color themes.
Expanded Header
Fair Header
Full Header
Primary Nav
Brand
Tall Header New in v3.0
Scrollbars

Hides native scrollbars and creates custom styleable overlay scrollbars.

Offcanvas Header
Content Here

Lorem ipsum dolor sit amet, consectetur adipisicing elit. Sapiente eos nihil earum aliquam quod in dolor, aspernatur obcaecati et at. Dicta, ipsum aut, fugit nam dolore porro non est totam sapiente animi recusandae obcaecati dolorum, rem ullam cumque. Illum quidem reiciendis autem neque excepturi odit est accusantium, facilis provident molestias, dicta obcaecati itaque ducimus fuga iure in distinctio voluptate nesciunt dignissimos rem error a. Expedita officiis nam dolore dolores ea. Soluta repellendus delectus culpa quo. Ea tenetur impedit error quod exercitationem ut ad provident quisquam omnis! Nostrum quasi ex delectus vero, facilis aut recusandae deleniti beatae. Qui velit commodi inventore.