Subscription/List

List existing subscriptions. Maximum resuts is 100 subscriptions.

Coupons that are no longer compatible with the subscription (either because their status, because they've expired, because they are one-time coupons, or because this product is restricted) will be returned in the coupon namespace with an attribute named "qualification_status" which will be set to "disqualified".

Parameters
Parameter Type Required Description
subscription_id string optional To list the details of a specific subscription.
customer_account_id string optional The 'customer_account_id' of an active customer if you want to search using it.
status string optional Provide a status to search for subscriptions in a specific state. For example; '1' for active.
custom_field_1 string optional The value of your first custom field.
custom_field_2 string optional The value of your first custom field.
GET https://api.recurringstack.com/{format}/Subscription/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('subscription_id' => "",'customer_account_id' => "",'status' => "",'custom_field_1' => "",'custom_field_2' => "");
try { $response = $rstack->request('Subscription/List','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <subscription subscription_id="ffd64e83-1271-4a5a-b952-c1cc159eb6a1" customer_account_id="769062f9-566b-49d9-8274-0678ca7e21e8" product_group_id="e4d23994-d6e2-45a8-91b0-d882b248dc98" creation_date="2022-02-17 21:41:25" deletion_date="" status="1">
      <product product_id="96027df1-7b53-42ef-b097-b1b3d70e207d">
         <name>Shared Hosting Package</name>
         <description>Includes access to shared hosting services.</description>
         <setup_fee>15.00</setup_fee>
         <recurring_price>500.00</recurring_price>
      </product>
      <coupons>
         <coupon coupon_id="b8d5bc14-a1ba-4ea0-9424-55d46ac8b0fe" qualification_status="disqualified">
            <name>New Customer Special</name>
            <coupon_code>BIG10334f</coupon_code>
            <coupon_type>percent</coupon_type>
            <coupon_duration>one-time</coupon_duration>
            <discount_amount>10.00</discount_amount>
            <discount_total>0.00</discount_total>
         </coupon>
         <coupon coupon_id="1e7c832d-0dd7-48ab-93d9-928ae33b8419" qualification_status="qualified">
            <name>50 Off for Life</name>
            <coupon_code>50OFF</coupon_code>
            <coupon_type>amount</coupon_type>
            <coupon_duration>forever</coupon_duration>
            <discount_amount>50.00</discount_amount>
            <discount_total>50.00</discount_total>
         </coupon>
      </coupons>
      <components>
         <component component_id="16b9873a-0e40-4240-8875-60637ae24511">
            <name>IP Address</name>
            <description>Each additional IP address is $5.00, there is no setup fee. Shared IP address is included with your subscription.</description>
            <included_units>0</included_units>
            <component_type>quantitive</component_type>
            <setup_fee>0.00</setup_fee>
            <unit_price units="3">5.00</unit_price>
            <total_due>15.00</total_due>
         </component>
      </components>
      <recurring auto_pay="Y" pay_method_id="8rf444f-0e40-4240-8875-60637ae24908">
         <product_total>500.00</product_total>
         <component_total>15.00</component_total>
         <tax_total>0.00</tax_total>
         <next_payment_date expiration_interval="10" friendly_expiration_interval="">3/31/2022</next_payment_date>
         <next_payment_amount coupon_discount_amount="50.00">465.00</next_payment_amount>
         <discount>
            <auto_pay_discount>Y</auto_pay_discount>
            <auto_pay_discount_amount>5.00</auto_pay_discount_amount>
            <auto_pay_total>460.00</auto_pay_total>
         </discount>
      </recurring>
   </subscription>
</recurringstack>

{
    "subscription": {
        "@attributes": {
            "subscription_id": "ffd64e83-1271-4a5a-b952-c1cc159eb6a1",
            "customer_account_id": "769062f9-566b-49d9-8274-0678ca7e21e8",
            "product_group_id": "e4d23994-d6e2-45a8-91b0-d882b248dc98",
            "creation_date": "2022-02-17 21:41:25",
            "deletion_date": "",
            "status": "1"
        },
        "product": {
            "@attributes": {
                "product_id": "96027df1-7b53-42ef-b097-b1b3d70e207d"
            },
            "name": "Shared Hosting Package",
            "description": "Includes access to shared hosting services.",
            "setup_fee": "15.00",
            "recurring_price": "500.00"
        },
        "coupons": {
            "coupon": [
                {
                    "@attributes": {
                        "coupon_id": "b8d5bc14-a1ba-4ea0-9424-55d46ac8b0fe",
                        "qualification_status": "disqualified"
                    },
                    "name": "New Customer Special",
                    "coupon_code": "BIG10334f",
                    "coupon_type": "percent",
                    "coupon_duration": "one-time",
                    "discount_amount": "10.00",
                    "discount_total": "0.00"
                },
                {
                    "@attributes": {
                        "coupon_id": "1e7c832d-0dd7-48ab-93d9-928ae33b8419",
                        "qualification_status": "qualified"
                    },
                    "name": "50 Off for Life",
                    "coupon_code": "50OFF",
                    "coupon_type": "amount",
                    "coupon_duration": "forever",
                    "discount_amount": "50.00",
                    "discount_total": "50.00"
                }
            ]
        },
        "components": {
            "component": {
                "@attributes": {
                    "component_id": "16b9873a-0e40-4240-8875-60637ae24511"
                },
                "name": "IP Address",
                "description": "Each additional IP address is $5.00, there is no setup fee. Shared IP address is included with your subscription.",
                "included_units": "0",
                "component_type": "quantitive",
                "setup_fee": "0.00",
                "unit_price": "5.00",
                "total_due": "15.00"
            }
        },
        "recurring": {
            "@attributes": {
                "auto_pay": "Y",
                "pay_method_id": "8rf444f-0e40-4240-8875-60637ae24908"
            },
            "product_total": "500.00",
            "component_total": "15.00",
            "tax_total": "0.00",
            "next_payment_date": "3\/31\/2022",
            "next_payment_amount": "465.00",
            "discount": {
                "auto_pay_discount": "Y",
                "auto_pay_discount_amount": "5.00",
                "auto_pay_total": "460.00"
            }
        }
    }
}

API Simulator

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

Subscription/Estimate

Estimate the cost of creating a new subscription for a customer. This endpoint allows you to calculate and optionally display the up-front and future cost of a subscription to a customer.

To subscribe the customer to one or more components format the components in JSON format, being sure to provide the number of 'units'. For 'traditional' components the 'units' must be 1.

Example JSON:
[{"component_id":"16b9873a-0e40-4240-8875-60637ae24511","units":"5"},{"component_id":"85EReh89H-0B40-5858-EE33-6063EUB3882S","units":"1"}]
Tax calculations have not been implemented into this API yet.

Parameters
Parameter Type Required Description
customer_account_id string required The 'customer_account_id' of the customer starting the new subscription.
product_id string required The 'product_id' the customer wants to subscribe to.
attached_components string optional A JSON formatted list of components with the appropriate options; see above example. Components must be from the same product group as the product.
coupon_code string optional One or more coupon codes in comma seperated format. To use multiple coupons all coupons provided must be stackable.
pay_method_id string optional The 'pay_method_id' of the payment method the customer will use to pay for the subscription. Only provide if you want to confirm the pay methods status before charging.
override_initial_billing string optional Provide a 'Y' to skip the initial billing of the subscription and mark the invoice as PAID. Useful if you've already charged the customer via PayPal or other payment method.
GET https://api.recurringstack.com/{format}/Subscription/Estimate 
//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('customer_account_id' => "",'product_id' => "",'attached_components' => "",'coupon_code' => "",'pay_method_id' => "",'override_initial_billing' => "");
try { $response = $rstack->request('Subscription/Estimate','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <subscription product_group_id="e4d23994-d6e2-45a8-91b0-d882b248dc98">
      <estimate>
         <product product_id="96027df1-7b53-42ef-b097-b1b3d70e207d">
            <name>Shared Hosting Package</name>
            <description>Includes access to shared hosting services.</description>
            <setup_fee>15.00</setup_fee>
            <recurring_price>500.00</recurring_price>
         </product>
         <coupons>
            <coupon coupon_id="1e7c832d-0dd7-48ab-93d9-928ae33b8419" apply_to_trial="Y">
               <name>Second Coupon</name>
               <coupon_code>50OFF</coupon_code>
               <coupon_type>amount</coupon_type>
               <coupon_duration>forever</coupon_duration>
               <discount_amount>50.00</discount_amount>
               <discount_total>50.00</discount_total>
            </coupon>
         </coupons>
         <components>
            <component component_id="16b9873a-0e40-4240-8875-60637ae24511">
               <name>IP Address</name>
               <description>Each additional IP address is $5.00, there is no setup fee. Shared IP address is included with your subscription.</description>
               <included_units>0</included_units>
               <component_type>quantitive</component_type>
               <setup_fee>0.00</setup_fee>
               <unit_price units="1">5.00</unit_price>
               <total_today>5.00</total_today>
            </component>
         </components>
         <today has_trial="N" trial_period="" trial_price="">
            <setup_fee>15.00</setup_fee>
            <recurring_price coupon_discount_amount="50.00">450.00</recurring_price>
            <component_total>5.00</component_total>
            <total>470.00</total>
         </today>
         <recurring auto_pay="Y" pay_method_id="8rf444f-0e40-4240-8875-60637ae24908">
            <product_total>500.00</product_total>
            <component_total>5.00</component_total>
            <tax_total>0.00</tax_total>
            <next_payment_date expiration_interval="10" friendly_expiration_interval="10 Day(s)">4/3/2022</next_payment_date>
            <next_payment_amount coupon_discount_amount="50.00">455.00</next_payment_amount>
            <discount>
               <auto_pay_discount>Y</auto_pay_discount>
               <auto_pay_discount_amount>5.00</auto_pay_discount_amount>
               <auto_pay_total>450.00</auto_pay_total>
            </discount>
         </recurring>
      </estimate>
   </subscription>
</recurringstack>

{
    "subscription": {
        "@attributes": {
            "product_group_id": "e4d23994-d6e2-45a8-91b0-d882b248dc98"
        },
        "estimate": {
            "product": {
                "@attributes": {
                    "product_id": "96027df1-7b53-42ef-b097-b1b3d70e207d"
                },
                "name": "Shared Hosting Package",
                "description": "Includes access to shared hosting services.",
                "setup_fee": "15.00",
                "recurring_price": "500.00"
            },
            "coupons": {
                "coupon": {
                    "@attributes": {
                        "coupon_id": "1e7c832d-0dd7-48ab-93d9-928ae33b8419",
                        "apply_to_trial": "Y"
                    },
                    "name": "Second Coupon",
                    "coupon_code": "50OFF",
                    "coupon_type": "amount",
                    "coupon_duration": "forever",
                    "discount_amount": "50.00",
                    "discount_total": "50.00"
                }
            },
            "components": {
                "component": {
                    "@attributes": {
                        "component_id": "16b9873a-0e40-4240-8875-60637ae24511"
                    },
                    "name": "IP Address",
                    "description": "Each additional IP address is $5.00, there is no setup fee. Shared IP address is included with your subscription.",
                    "included_units": "0",
                    "component_type": "quantitive",
                    "setup_fee": "0.00",
                    "unit_price": "5.00",
                    "total_today": "5.00"
                }
            },
            "today": {
                "@attributes": {
                    "has_trial": "N",
                    "trial_period": "",
                    "trial_price": ""
                },
                "setup_fee": "15.00",
                "recurring_price": "450.00",
                "component_total": "5.00",
                "total": "470.00"
            },
            "recurring": {
                "@attributes": {
                    "auto_pay": "Y",
                    "pay_method_id": "8rf444f-0e40-4240-8875-60637ae24908"
                },
                "product_total": "500.00",
                "component_total": "5.00",
                "tax_total": "0.00",
                "next_payment_date": "4\/3\/2022",
                "next_payment_amount": "455.00",
                "discount": {
                    "auto_pay_discount": "Y",
                    "auto_pay_discount_amount": "5.00",
                    "auto_pay_total": "450.00"
                }
            }
        }
    }
}

API Simulator

Initiate a live call to the Subscription/Estimate service using the API simulator.

Subscription/Create

Create a new subscription for a customer.

When creating a subscription, you must specify a product (product_id) and a customer (customer_account_id). One or more components can be attached to the subscription at the time of it's creation or you can attach components at any time in the future.

To subscribe the customer to one or more components format the components in JSON format, being sure to provide the number of 'units'. For 'traditional' components the 'units' must be 1.

Example JSON:
[{"component_id":"16b9873a-0e40-4240-8875-60637ae24511","units":"5"},{"component_id":"85EReh89H-0B40-5858-EE33-6063EUB3882S","units":"1"}]
This service will attempt to charge the customers 'pay_method_id' for the initial charges due (utilize the 'Subscription/Estimate' service to determine and display intial charges). Unverified pay methods cannot be utilized. To use/add a new pay method call the 'PayMethod/Create' service first, being sure to provide a 'N' for the 'require_verification' parameter if you want the customer to utilize the pay method instantly.

To skip real-time billing and use a third party payment service (eg. BitPay or PayPal) provide a 'Y' for the 'override_initial_billing' parameter.

Parameters
Parameter Type Required Description
customer_account_id string required The 'customer_account_id' of the customer starting the new subscription.
product_id string required The 'product_id' the customer wants to subscribe to.
attached_components string optional A JSON formatted list of components with the appropriate options; see above example. Components must be from the same product group as the product.
coupon_code string optional One or more coupon codes in comma seperated format. To use multiple coupons all coupons provided must be stackable.
pay_method_id string optional The 'pay_method_id' of the payment method the customer will use to pay for the initial cost of the subscription. If the subscription charge is $0.00 the payment method wont be charged but will be utilized for future billing if 'auto_pay' is set to 'Y'.
override_initial_billing string required Provide a 'Y' to skip the initial billing of the subscription and mark the invoice as PAID. Useful if you've already charged the customer via PayPal or other payment method.
payment_gateway string optional Provide a payment gateway name (ie. PayPal) if using a third party payment gatway; 'override_initial_billing' must be set to 'Y'.
payment_transaction_id string optional You can provide a payment transaction id if a thrid party payment service (ie. PayPal) was used to bill the customer; 'override_initial_billing' must be 'Y'.
auto_pay string required Provide a 'Y' to automatically charge the 'pay_method_id' for any invoices related to the subscription on the renewal date (invoices are automatically generated 72 hours prior to the renewal date). Provide an 'N' to disable auto pay. If no 'pay_method_id' is specified on the subscription the customers default 'pay_method_id' will be utiilized if set (PayMethod/SetDefault).
custom_field_1 string optional A custom field of your choice.
custom_field_2 string optional A custom field of your choice.
VAR1 string optional The value of VAR1 that corresponds to the variable on the product group. If the variable type is 'Options' the value must be one of those options.
VAR2 string optional The value of VAR2 that corresponds to the variable on the product group. If the variable type is 'Options' the value must be one of those options.
VAR3 string optional The value of VAR3 that corresponds to the variable on the product group. If the variable type is 'Options' the value must be one of those options.
VAR4 string optional The value of VAR4 that corresponds to the variable on the product group. If the variable type is 'Options' the value must be one of those options.
VAR5 string optional The value of VAR5 that corresponds to the variable on the product group. If the variable type is 'Options' the value must be one of those options.
VAR6 string optional The value of VAR6 that corresponds to the variable on the product group. If the variable type is 'Options' the value must be one of those options.
VAR7 string optional The value of VAR7 that corresponds to the variable on the product group. If the variable type is 'Options' the value must be one of those options.
VAR8 string optional The value of VAR8 that corresponds to the variable on the product group. If the variable type is 'Options' the value must be one of those options.
VAR9 string optional The value of VAR9 that corresponds to the variable on the product group. If the variable type is 'Options' the value must be one of those options.
VAR10 string optional The value of VAR10 that corresponds to the variable on the product group. If the variable type is 'Options' the value must be one of those options.
POST https://api.recurringstack.com/{format}/Subscription/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('customer_account_id' => "",'product_id' => "",'attached_components' => "",'coupon_code' => "",'pay_method_id' => "",'override_initial_billing' => "",'payment_gateway' => "",'payment_transaction_id' => "",'auto_pay' => "",'custom_field_1' => "",'custom_field_2' => "",'VAR1' => "",'VAR2' => "",'VAR3' => "",'VAR4' => "",'VAR5' => "",'VAR6' => "",'VAR7' => "",'VAR8' => "",'VAR9' => "",'VAR10' => "");
try { $response = $rstack->request('Subscription/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack transaction_id="434f433-43f34nc384-ewwu32mio-90937732">
   <subscription subscription_id="8d780f3f-269b-4e79-8500-c757c9fe7562" invoice_id="f8349565-8a5f-41aa-8caa-4e06c2244bd2" payment_id="ReBer34f-269b-4e79-14878-c757c9fe7569"/>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "434f433-43f34nc384-ewwu32mio-90937732"
    },
    "subscription": {
        "@attributes": {
            "subscription_id": "8d780f3f-269b-4e79-8500-c757c9fe7562",
            "invoice_id": "f8349565-8a5f-41aa-8caa-4e06c2244bd2",
            "payment_id": "ReBer34f-269b-4e79-14878-c757c9fe7569"
        }
    }
}

API Simulator

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

Subscription/Update

Update an existing subscription.

Changes made to a subscription will take effect immediately. If changes are made before the billing cycle renewal date the next payment will be calculated using the updated data (after the change), not the old data (before the change).

Because a subscription contains a large amount of information and parameters, unlike other 'update' services, certain parameters will not be updated if a value is not provided. This prevents you from having to provide information about a subscription that doesn't need updating.

Exempt parameters (exempt meaning they will not be updated or validated if not provided) include:

payment_transaction_id
renewal_date

All other parameters work like every other service and will update to the value you provide or if you provide no value will be cleared.
This service is NOT used to update the usage for a metered or quantitative component, instead use the 'Subscription/ReportUsage' service.

Parameters
Parameter Type Required Description
subscription_id string required The id of the subscription you want to update.
customer_account_id string required The 'customer_account_id' of the subscribed customer. Although not required on most 'Update' services; the 'customer_account_id' is required to update a subscriptiption to ensure data validity.
attached_components string optional A JSON formatted list of components with the appropriate options; see above example. Components must be from the same product group as the product.
coupon_code string optional One or more coupon codes in comma seperated format. To use multiple coupons all coupons provided must be stackable.
payment_transaction_id string optional You can provide a payment transaction id if a thrid party payment service (ie. PayPal) was used to bill the customer; 'override_initial_billing' must have been 'Y' at the time the subscription was created.
renewal_date string optional To change the next renewal date for the subscription provide a new renewal date in the 'm/d/yyyy' format.
pay_method_id string optional The 'pay_method_id' of the payment method the customer will use to pay for the subscription on a recurring basis. Only utilized if 'auto-pay' is set to 'Y'. If no 'pay_method_id' is specified on the subscription the customers default 'pay_method_id' will be utiilized if set (PayMethod/SetDefault).
auto_pay string required Provide a 'Y' to automatically charge the 'pay_method_id' for any invoices related to the subscription on the renewal date (invoices are automatically generated 72 hours prior to the renewal date). Provide an 'N' to disable auto pay. If no 'pay_method_id' is specified on the subscription the customers default 'pay_method_id' will be utiilized if set (PayMethod/SetDefault).
custom_field_1 string optional A custom field of your choice.
custom_field_2 string optional A custom field of your choice.
VAR1 string optional The value of VAR1 that corresponds to the variable on the product group. If the variable type is 'Options' the value must be one of those options.
VAR2 string optional The value of VAR2 that corresponds to the variable on the product group. If the variable type is 'Options' the value must be one of those options.
VAR3 string optional The value of VAR3 that corresponds to the variable on the product group. If the variable type is 'Options' the value must be one of those options.
VAR4 string optional The value of VAR4 that corresponds to the variable on the product group. If the variable type is 'Options' the value must be one of those options.
VAR5 string optional The value of VAR5 that corresponds to the variable on the product group. If the variable type is 'Options' the value must be one of those options.
VAR6 string optional The value of VAR6 that corresponds to the variable on the product group. If the variable type is 'Options' the value must be one of those options.
VAR7 string optional The value of VAR7 that corresponds to the variable on the product group. If the variable type is 'Options' the value must be one of those options.
VAR8 string optional The value of VAR8 that corresponds to the variable on the product group. If the variable type is 'Options' the value must be one of those options.
VAR9 string optional The value of VAR9 that corresponds to the variable on the product group. If the variable type is 'Options' the value must be one of those options.
VAR10 string optional The value of VAR10 that corresponds to the variable on the product group. If the variable type is 'Options' the value must be one of those options.
POST https://api.recurringstack.com/{format}/Subscription/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('subscription_id' => "",'customer_account_id' => "",'attached_components' => "",'coupon_code' => "",'payment_transaction_id' => "",'renewal_date' => "",'pay_method_id' => "",'auto_pay' => "",'custom_field_1' => "",'custom_field_2' => "",'VAR1' => "",'VAR2' => "",'VAR3' => "",'VAR4' => "",'VAR5' => "",'VAR6' => "",'VAR7' => "",'VAR8' => "",'VAR9' => "",'VAR10' => "");
try { $response = $rstack->request('Subscription/Update','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <subscription subscription_id="ffd64e83-1271-4a5a-b952-c1cc159eb6a1" customer_account_id="769062f9-566b-49d9-8274-0678ca7e21e8" product_group_id="e4d23994-d6e2-45a8-91b0-d882b248dc98" creation_date="2022-02-17 21:41:25" deletion_date="" status="1">
      <product product_id="96027df1-7b53-42ef-b097-b1b3d70e207d">
         <name>Shared Hosting Package</name>
         <description>Includes access to shared hosting services.</description>
         <setup_fee>15.00</setup_fee>
         <recurring_price>500.00</recurring_price>
      </product>
      <coupons>
         <coupon coupon_id="b8d5bc14-a1ba-4ea0-9424-55d46ac8b0fe" qualification_status="disqualified">
            <name>New Customer Special</name>
            <coupon_code>BIG10334f</coupon_code>
            <coupon_type>percent</coupon_type>
            <coupon_duration>one-time</coupon_duration>
            <discount_amount>10.00</discount_amount>
            <discount_total>0.00</discount_total>
         </coupon>
         <coupon coupon_id="1e7c832d-0dd7-48ab-93d9-928ae33b8419" qualification_status="qualified">
            <name>50 Off for Life</name>
            <coupon_code>50OFF</coupon_code>
            <coupon_type>amount</coupon_type>
            <coupon_duration>forever</coupon_duration>
            <discount_amount>50.00</discount_amount>
            <discount_total>50.00</discount_total>
         </coupon>
      </coupons>
      <components>
         <component component_id="16b9873a-0e40-4240-8875-60637ae24511">
            <name>IP Address</name>
            <description>Each additional IP address is $5.00, there is no setup fee. Shared IP address is included with your subscription.</description>
            <included_units>0</included_units>
            <component_type>quantitive</component_type>
            <setup_fee>0.00</setup_fee>
            <unit_price units="3">5.00</unit_price>
            <total_due>15.00</total_due>
         </component>
      </components>
      <recurring auto_pay="Y" pay_method_id="8rf444f-0e40-4240-8875-60637ae24908">
         <product_total>500.00</product_total>
         <component_total>15.00</component_total>
         <tax_total>0.00</tax_total>
         <next_payment_date expiration_interval="10" friendly_expiration_interval="">3/31/2022</next_payment_date>
         <next_payment_amount coupon_discount_amount="50.00">465.00</next_payment_amount>
         <discount>
            <auto_pay_discount>Y</auto_pay_discount>
            <auto_pay_discount_amount>5.00</auto_pay_discount_amount>
            <auto_pay_total>460.00</auto_pay_total>
         </discount>
      </recurring>
   </subscription>
</recurringstack>

{
    "subscription": {
        "@attributes": {
            "subscription_id": "ffd64e83-1271-4a5a-b952-c1cc159eb6a1",
            "customer_account_id": "769062f9-566b-49d9-8274-0678ca7e21e8",
            "product_group_id": "e4d23994-d6e2-45a8-91b0-d882b248dc98",
            "creation_date": "2022-02-17 21:41:25",
            "deletion_date": "",
            "status": "1"
        },
        "product": {
            "@attributes": {
                "product_id": "96027df1-7b53-42ef-b097-b1b3d70e207d"
            },
            "name": "Shared Hosting Package",
            "description": "Includes access to shared hosting services.",
            "setup_fee": "15.00",
            "recurring_price": "500.00"
        },
        "coupons": {
            "coupon": [
                {
                    "@attributes": {
                        "coupon_id": "b8d5bc14-a1ba-4ea0-9424-55d46ac8b0fe",
                        "qualification_status": "disqualified"
                    },
                    "name": "New Customer Special",
                    "coupon_code": "BIG10334f",
                    "coupon_type": "percent",
                    "coupon_duration": "one-time",
                    "discount_amount": "10.00",
                    "discount_total": "0.00"
                },
                {
                    "@attributes": {
                        "coupon_id": "1e7c832d-0dd7-48ab-93d9-928ae33b8419",
                        "qualification_status": "qualified"
                    },
                    "name": "50 Off for Life",
                    "coupon_code": "50OFF",
                    "coupon_type": "amount",
                    "coupon_duration": "forever",
                    "discount_amount": "50.00",
                    "discount_total": "50.00"
                }
            ]
        },
        "components": {
            "component": {
                "@attributes": {
                    "component_id": "16b9873a-0e40-4240-8875-60637ae24511"
                },
                "name": "IP Address",
                "description": "Each additional IP address is $5.00, there is no setup fee. Shared IP address is included with your subscription.",
                "included_units": "0",
                "component_type": "quantitive",
                "setup_fee": "0.00",
                "unit_price": "5.00",
                "total_due": "15.00"
            }
        },
        "recurring": {
            "@attributes": {
                "auto_pay": "Y",
                "pay_method_id": "8rf444f-0e40-4240-8875-60637ae24908"
            },
            "product_total": "500.00",
            "component_total": "15.00",
            "tax_total": "0.00",
            "next_payment_date": "3\/31\/2022",
            "next_payment_amount": "465.00",
            "discount": {
                "auto_pay_discount": "Y",
                "auto_pay_discount_amount": "5.00",
                "auto_pay_total": "460.00"
            }
        }
    }
}

API Simulator

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

Subscription/ChangeProduct

Change the product associated with an existing subscription.

If the new product ('product_id') is not from the same product group as the existing product existing components associated with the subscription will not be valid and a error will be returned. To remove all components from the subscription provide a 'Y' for 'remove_components'. To remove all coupon codes from a subscription provide a 'Y' for 'remove_coupons'.

Should you need to update the components or the coupon(s) at a later time you should use the 'Subscription/Update' service.

Parameters
Parameter Type Required Description
subscription_id string required The id of the subscription you want to update.
customer_account_id string required The 'customer_account_id' of the subscribed customer.
product_id string required The id of the product you want associated with the subscription.
remove_components string optional Provide a 'Y' to remove all existing components assoiated with the subscription.
remove_coupons string optional Provide a 'Y' to remove all existing coupons assoiated with the subscription.
POST https://api.recurringstack.com/{format}/Subscription/ChangeProduct 
//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('subscription_id' => "",'customer_account_id' => "",'product_id' => "",'remove_components' => "",'remove_coupons' => "");
try { $response = $rstack->request('Subscription/ChangeProduct','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <subscription subscription_id="ffd64e83-1271-4a5a-b952-c1cc159eb6a1" customer_account_id="769062f9-566b-49d9-8274-0678ca7e21e8" product_group_id="e4d23994-d6e2-45a8-91b0-d882b248dc98">
      <product product_id="96027df1-7b53-42ef-b097-b1b3d70e207d">
         <name>Shared Hosting Package</name>
         <description>Includes access to shared hosting services.</description>
         <setup_fee>15.00</setup_fee>
         <recurring_price>500.00</recurring_price>
      </product>
      <coupons>
         <coupon coupon_id="b8d5bc14-a1ba-4ea0-9424-55d46ac8b0fe" qualification_status="disqualified">
            <name>New Customer Special</name>
            <coupon_code>BIG10334f</coupon_code>
            <coupon_type>percent</coupon_type>
            <coupon_duration>one-time</coupon_duration>
            <discount_amount>10.00</discount_amount>
            <discount_total>0.00</discount_total>
         </coupon>
         <coupon coupon_id="1e7c832d-0dd7-48ab-93d9-928ae33b8419" qualification_status="qualified">
            <name>50 Off for Life</name>
            <coupon_code>50OFF</coupon_code>
            <coupon_type>amount</coupon_type>
            <coupon_duration>forever</coupon_duration>
            <discount_amount>50.00</discount_amount>
            <discount_total>50.00</discount_total>
         </coupon>
      </coupons>
      <components>
         <component component_id="16b9873a-0e40-4240-8875-60637ae24511">
            <name>IP Address</name>
            <description>Each additional IP address is $5.00, there is no setup fee. Shared IP address is included with your subscription.</description>
            <included_units>0</included_units>
            <component_type>quantitive</component_type>
            <setup_fee>0.00</setup_fee>
            <unit_price units="3">5.00</unit_price>
            <total_due>15.00</total_due>
         </component>
      </components>
      <recurring auto_pay="Y" pay_method_id="8rf444f-0e40-4240-8875-60637ae24908">
         <product_total>500.00</product_total>
         <component_total>15.00</component_total>
         <tax_total>0.00</tax_total>
         <next_payment_date expiration_interval="10" friendly_expiration_interval="">3/31/2022</next_payment_date>
         <next_payment_amount coupon_discount_amount="50.00">465.00</next_payment_amount>
         <discount>
            <auto_pay_discount>Y</auto_pay_discount>
            <auto_pay_discount_amount>5.00</auto_pay_discount_amount>
            <auto_pay_total>460.00</auto_pay_total>
         </discount>
      </recurring>
   </subscription>
</recurringstack>

{
    "subscription": {
        "@attributes": {
            "subscription_id": "ffd64e83-1271-4a5a-b952-c1cc159eb6a1",
            "customer_account_id": "769062f9-566b-49d9-8274-0678ca7e21e8",
            "product_group_id": "e4d23994-d6e2-45a8-91b0-d882b248dc98"
        },
        "product": {
            "@attributes": {
                "product_id": "96027df1-7b53-42ef-b097-b1b3d70e207d"
            },
            "name": "Shared Hosting Package",
            "description": "Includes access to shared hosting services.",
            "setup_fee": "15.00",
            "recurring_price": "500.00"
        },
        "coupons": {
            "coupon": [
                {
                    "@attributes": {
                        "coupon_id": "b8d5bc14-a1ba-4ea0-9424-55d46ac8b0fe",
                        "qualification_status": "disqualified"
                    },
                    "name": "New Customer Special",
                    "coupon_code": "BIG10334f",
                    "coupon_type": "percent",
                    "coupon_duration": "one-time",
                    "discount_amount": "10.00",
                    "discount_total": "0.00"
                },
                {
                    "@attributes": {
                        "coupon_id": "1e7c832d-0dd7-48ab-93d9-928ae33b8419",
                        "qualification_status": "qualified"
                    },
                    "name": "50 Off for Life",
                    "coupon_code": "50OFF",
                    "coupon_type": "amount",
                    "coupon_duration": "forever",
                    "discount_amount": "50.00",
                    "discount_total": "50.00"
                }
            ]
        },
        "components": {
            "component": {
                "@attributes": {
                    "component_id": "16b9873a-0e40-4240-8875-60637ae24511"
                },
                "name": "IP Address",
                "description": "Each additional IP address is $5.00, there is no setup fee. Shared IP address is included with your subscription.",
                "included_units": "0",
                "component_type": "quantitive",
                "setup_fee": "0.00",
                "unit_price": "5.00",
                "total_due": "15.00"
            }
        },
        "recurring": {
            "@attributes": {
                "auto_pay": "Y",
                "pay_method_id": "8rf444f-0e40-4240-8875-60637ae24908"
            },
            "product_total": "500.00",
            "component_total": "15.00",
            "tax_total": "0.00",
            "next_payment_date": "3\/31\/2022",
            "next_payment_amount": "465.00",
            "discount": {
                "auto_pay_discount": "Y",
                "auto_pay_discount_amount": "5.00",
                "auto_pay_total": "460.00"
            }
        }
    }
}

API Simulator

Initiate a live call to the Subscription/ChangeProduct service using the API simulator.

Subscription/Suspend

Place a active subscription in a suspended state.

Parameters
Parameter Type Required Description
subscription_id string required The id of the subscription you want to suspend.
PATCH https://api.recurringstack.com/{format}/Subscription/Suspend 
//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('subscription_id' => "");
try { $response = $rstack->request('Subscription/Suspend','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <subscription subscription_id="ffd64e83-1271-4a5a-b952-c1cc159eb6a1" creation_date="2022-03-29 23:52:14" status="2"/>
</recurringstack>

{
    "subscription": {
        "@attributes": {
            "subscription_id": "ffd64e83-1271-4a5a-b952-c1cc159eb6a1",
            "creation_date": "2022-03-29 23:52:14",
            "status": "2"
        }
    }
}

API Simulator

Initiate a live call to the Subscription/Suspend service using the API simulator.

Subscription/Delete

Cancel/delete a subscription.

Parameters
Parameter Type Required Description
subscription_id string required The id of the subscription you want to delete.
DELETE https://api.recurringstack.com/{format}/Subscription/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('subscription_id' => "");
try { $response = $rstack->request('Subscription/Delete','DELETE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <subscription subscription_id="ffd64e83-1271-4a5a-b952-c1cc159eb6a1" creation_date="2022-03-29 23:52:14" status="3"/>
</recurringstack>

{
    "subscription": {
        "@attributes": {
            "subscription_id": "ffd64e83-1271-4a5a-b952-c1cc159eb6a1",
            "creation_date": "2022-03-29 23:52:14",
            "status": "3"
        }
    }
}

API Simulator

Initiate a live call to the Subscription/Delete service using the API simulator.

Subscription/ReportUsage

This service allows you to report usage for a compnent already attached to a subscription.

You may choose to report metered or prepaid usage as you wish. If usage events occur in your system very frequently (hundreads of times an hour or more), it is best to accumulate usage into batches on your side, and then report those batches less frequently, such as daily. This will ensure you remain below any API throttling limits.

Parameters
Parameter Type Required Description
subscription_id string required The id of the subscription with the component you wish to report usage for.
customer_account_id string required The 'customer_account_id' of the subscribed customer.
component_id string required The id of the component you want to update.
units string required The amount of units to update on the component.
expression_type string required Choices are 'additive' ('units' are added to the existing 'unit' total) and 'cumulative' ('units' is the entirety of the unit total).
PATCH https://api.recurringstack.com/{format}/Subscription/ReportUsage 
//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('subscription_id' => "",'customer_account_id' => "",'component_id' => "",'units' => "",'expression_type' => "");
try { $response = $rstack->request('Subscription/ReportUsage','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <subscription subscription_id="ffd64e83-1271-4a5a-b952-c1cc159eb6a1" customer_account_id="769062f9-566b-49d9-8274-0678ca7e21e8" product_group_id="e4d23994-d6e2-45a8-91b0-d882b248dc98">
      <product product_id="96027df1-7b53-42ef-b097-b1b3d70e207d">
         <name>Shared Hosting Package</name>
         <description>Includes access to shared hosting services.</description>
         <setup_fee>15.00</setup_fee>
         <recurring_price>500.00</recurring_price>
      </product>
      <coupons>
         <coupon coupon_id="b8d5bc14-a1ba-4ea0-9424-55d46ac8b0fe" qualification_status="disqualified">
            <name>New Customer Special</name>
            <coupon_code>BIG10334f</coupon_code>
            <coupon_type>percent</coupon_type>
            <coupon_duration>one-time</coupon_duration>
            <discount_amount>10.00</discount_amount>
            <discount_total>0.00</discount_total>
         </coupon>
         <coupon coupon_id="1e7c832d-0dd7-48ab-93d9-928ae33b8419" qualification_status="qualified">
            <name>50 Off for Life</name>
            <coupon_code>50OFF</coupon_code>
            <coupon_type>amount</coupon_type>
            <coupon_duration>forever</coupon_duration>
            <discount_amount>50.00</discount_amount>
            <discount_total>50.00</discount_total>
         </coupon>
      </coupons>
      <components>
         <component component_id="16b9873a-0e40-4240-8875-60637ae24511">
            <name>IP Address</name>
            <description>Each additional IP address is $5.00, there is no setup fee. Shared IP address is included with your subscription.</description>
            <included_units>0</included_units>
            <component_type>quantitive</component_type>
            <setup_fee>0.00</setup_fee>
            <unit_price units="3">5.00</unit_price>
            <total_due>15.00</total_due>
         </component>
      </components>
      <recurring auto_pay="Y" pay_method_id="8rf444f-0e40-4240-8875-60637ae24908">
         <product_total>500.00</product_total>
         <component_total>15.00</component_total>
         <tax_total>0.00</tax_total>
         <next_payment_date expiration_interval="10" friendly_expiration_interval="">3/31/2022</next_payment_date>
         <next_payment_amount coupon_discount_amount="50.00">465.00</next_payment_amount>
         <discount>
            <auto_pay_discount>Y</auto_pay_discount>
            <auto_pay_discount_amount>5.00</auto_pay_discount_amount>
            <auto_pay_total>460.00</auto_pay_total>
         </discount>
      </recurring>
   </subscription>
</recurringstack>

{
    "subscription": {
        "@attributes": {
            "subscription_id": "ffd64e83-1271-4a5a-b952-c1cc159eb6a1",
            "customer_account_id": "769062f9-566b-49d9-8274-0678ca7e21e8",
            "product_group_id": "e4d23994-d6e2-45a8-91b0-d882b248dc98"
        },
        "product": {
            "@attributes": {
                "product_id": "96027df1-7b53-42ef-b097-b1b3d70e207d"
            },
            "name": "Shared Hosting Package",
            "description": "Includes access to shared hosting services.",
            "setup_fee": "15.00",
            "recurring_price": "500.00"
        },
        "coupons": {
            "coupon": [
                {
                    "@attributes": {
                        "coupon_id": "b8d5bc14-a1ba-4ea0-9424-55d46ac8b0fe",
                        "qualification_status": "disqualified"
                    },
                    "name": "New Customer Special",
                    "coupon_code": "BIG10334f",
                    "coupon_type": "percent",
                    "coupon_duration": "one-time",
                    "discount_amount": "10.00",
                    "discount_total": "0.00"
                },
                {
                    "@attributes": {
                        "coupon_id": "1e7c832d-0dd7-48ab-93d9-928ae33b8419",
                        "qualification_status": "qualified"
                    },
                    "name": "50 Off for Life",
                    "coupon_code": "50OFF",
                    "coupon_type": "amount",
                    "coupon_duration": "forever",
                    "discount_amount": "50.00",
                    "discount_total": "50.00"
                }
            ]
        },
        "components": {
            "component": {
                "@attributes": {
                    "component_id": "16b9873a-0e40-4240-8875-60637ae24511"
                },
                "name": "IP Address",
                "description": "Each additional IP address is $5.00, there is no setup fee. Shared IP address is included with your subscription.",
                "included_units": "0",
                "component_type": "quantitive",
                "setup_fee": "0.00",
                "unit_price": "5.00",
                "total_due": "15.00"
            }
        },
        "recurring": {
            "@attributes": {
                "auto_pay": "Y",
                "pay_method_id": "8rf444f-0e40-4240-8875-60637ae24908"
            },
            "product_total": "500.00",
            "component_total": "15.00",
            "tax_total": "0.00",
            "next_payment_date": "3\/31\/2022",
            "next_payment_amount": "465.00",
            "discount": {
                "auto_pay_discount": "Y",
                "auto_pay_discount_amount": "5.00",
                "auto_pay_total": "460.00"
            }
        }
    }
}

API Simulator

Initiate a live call to the Subscription/ReportUsage service using the API simulator.

Subscription/Restore

If you suspended or paused a subscription for any reason you can utilize this service to restore it.

RecurringStack™ may also suspend a subscription in accordance with your dunning rules (usually when a customer has unpaid invoices), this service may be used to override these kind of suspension as well.

Deleted subscriptions cannot be restored.
If the subscription was suspended automatically by RecurringStack™ in accordance with your dunning rules it's important to keep in mind that RecurringStack™ will likely suspend the subscription again if the customer has any outstanding invoices connected to the subscription. To avoid this situation you may need to cure any outstanding invoices.

Parameters
Parameter Type Required Description
subscription_id string required The 'subscription_id' of the subscription you want to restore.
PATCH https://api.recurringstack.com/{format}/Subscription/Restore 
//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('subscription_id' => "");
try { $response = $rstack->request('Subscription/Restore','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack transaction_id="479054">
   <subscription subscription_id="67a4c338-fc04-414f-8e0b-908b3d21d916" creation_date="2022-06-15 12:19:23" status="1"/>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "479054"
    },
    "subscription": {
        "@attributes": {
            "subscription_id": "67a4c338-fc04-414f-8e0b-908b3d21d916",
            "creation_date": "2022-06-15 12:19:23",
            "status": "1"
        }
    }
}

API Simulator

Initiate a live call to the Subscription/Restore service using the API simulator.

Subscription/UpdateAutoPay

Updtae the auto pay status and pay method for a subscription.

Parameters
Parameter Type Required Description
subscription_id string required The id of the subscription you want to update.
customer_account_id string required The 'customer_account_id' of the subscribed customer. Although not required on most 'Update' services; the 'customer_account_id' is required to update a subscriptiption to ensure data validity.
auto_pay string required Provide a 'Y' to automatically charge the 'pay_method_id' for any invoices related to the subscription on the renewal date (invoices are automatically generated 72 hours prior to the renewal date). Provide an 'N' to disable auto pay. If no 'pay_method_id' is specified on the subscription the customers default 'pay_method_id' will be utiilized if set (PayMethod/SetDefault).
pay_method_id string optional The 'pay_method_id' of the payment method the customer will use to pay for the subscription on a recurring basis. Only utilized if 'auto-pay' is set to 'Y'. If no 'pay_method_id' is specified on the subscription the customers default 'pay_method_id' will be utiilized if set (PayMethod/SetDefault).
PATCH https://api.recurringstack.com/{format}/Subscription/UpdateAutoPay 
//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('subscription_id' => "",'customer_account_id' => "",'auto_pay' => "",'pay_method_id' => "");
try { $response = $rstack->request('Subscription/UpdateAutoPay','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <subscription subscription_id="ffd64e83-1271-4a5a-b952-c1cc159eb6a1" customer_account_id="769062f9-566b-49d9-8274-0678ca7e21e8" product_group_id="e4d23994-d6e2-45a8-91b0-d882b248dc98">
      <product product_id="96027df1-7b53-42ef-b097-b1b3d70e207d">
         <name>Shared Hosting Package</name>
         <description>Includes access to shared hosting services.</description>
         <setup_fee>15.00</setup_fee>
         <recurring_price>500.00</recurring_price>
      </product>
      <coupons>
         <coupon coupon_id="b8d5bc14-a1ba-4ea0-9424-55d46ac8b0fe" qualification_status="disqualified">
            <name>New Customer Special</name>
            <coupon_code>BIG10334f</coupon_code>
            <coupon_type>percent</coupon_type>
            <coupon_duration>one-time</coupon_duration>
            <discount_amount>10.00</discount_amount>
            <discount_total>0.00</discount_total>
         </coupon>
         <coupon coupon_id="1e7c832d-0dd7-48ab-93d9-928ae33b8419" qualification_status="qualified">
            <name>50 Off for Life</name>
            <coupon_code>50OFF</coupon_code>
            <coupon_type>amount</coupon_type>
            <coupon_duration>forever</coupon_duration>
            <discount_amount>50.00</discount_amount>
            <discount_total>50.00</discount_total>
         </coupon>
      </coupons>
      <components>
         <component component_id="16b9873a-0e40-4240-8875-60637ae24511">
            <name>IP Address</name>
            <description>Each additional IP address is $5.00, there is no setup fee. Shared IP address is included with your subscription.</description>
            <included_units>0</included_units>
            <component_type>quantitive</component_type>
            <setup_fee>0.00</setup_fee>
            <unit_price units="3">5.00</unit_price>
            <total_due>15.00</total_due>
         </component>
      </components>
      <recurring auto_pay="Y" pay_method_id="8rf444f-0e40-4240-8875-60637ae24908">
         <product_total>500.00</product_total>
         <component_total>15.00</component_total>
         <tax_total>0.00</tax_total>
         <next_payment_date expiration_interval="10" friendly_expiration_interval="">3/31/2022</next_payment_date>
         <next_payment_amount coupon_discount_amount="50.00">465.00</next_payment_amount>
         <discount>
            <auto_pay_discount>Y</auto_pay_discount>
            <auto_pay_discount_amount>5.00</auto_pay_discount_amount>
            <auto_pay_total>460.00</auto_pay_total>
         </discount>
      </recurring>
   </subscription>
</recurringstack>

{
    "subscription": {
        "@attributes": {
            "subscription_id": "ffd64e83-1271-4a5a-b952-c1cc159eb6a1",
            "customer_account_id": "769062f9-566b-49d9-8274-0678ca7e21e8",
            "product_group_id": "e4d23994-d6e2-45a8-91b0-d882b248dc98"
        },
        "product": {
            "@attributes": {
                "product_id": "96027df1-7b53-42ef-b097-b1b3d70e207d"
            },
            "name": "Shared Hosting Package",
            "description": "Includes access to shared hosting services.",
            "setup_fee": "15.00",
            "recurring_price": "500.00"
        },
        "coupons": {
            "coupon": [
                {
                    "@attributes": {
                        "coupon_id": "b8d5bc14-a1ba-4ea0-9424-55d46ac8b0fe",
                        "qualification_status": "disqualified"
                    },
                    "name": "New Customer Special",
                    "coupon_code": "BIG10334f",
                    "coupon_type": "percent",
                    "coupon_duration": "one-time",
                    "discount_amount": "10.00",
                    "discount_total": "0.00"
                },
                {
                    "@attributes": {
                        "coupon_id": "1e7c832d-0dd7-48ab-93d9-928ae33b8419",
                        "qualification_status": "qualified"
                    },
                    "name": "50 Off for Life",
                    "coupon_code": "50OFF",
                    "coupon_type": "amount",
                    "coupon_duration": "forever",
                    "discount_amount": "50.00",
                    "discount_total": "50.00"
                }
            ]
        },
        "components": {
            "component": {
                "@attributes": {
                    "component_id": "16b9873a-0e40-4240-8875-60637ae24511"
                },
                "name": "IP Address",
                "description": "Each additional IP address is $5.00, there is no setup fee. Shared IP address is included with your subscription.",
                "included_units": "0",
                "component_type": "quantitive",
                "setup_fee": "0.00",
                "unit_price": "5.00",
                "total_due": "15.00"
            }
        },
        "recurring": {
            "@attributes": {
                "auto_pay": "Y",
                "pay_method_id": "8rf444f-0e40-4240-8875-60637ae24908"
            },
            "product_total": "500.00",
            "component_total": "15.00",
            "tax_total": "0.00",
            "next_payment_date": "3\/31\/2022",
            "next_payment_amount": "465.00",
            "discount": {
                "auto_pay_discount": "Y",
                "auto_pay_discount_amount": "5.00",
                "auto_pay_total": "460.00"
            }
        }
    }
}

API Simulator

Initiate a live call to the Subscription/UpdateAutoPay 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.