subscription_settings

Description

The subscription settings resource contains properties used to configure how your store process subscriptions. In the future, all dunning specific configuration values will be stored and modifiable here.

Sandbox Example

You can interact with this resource and run actions against the sandbox API via our HAL Brower.

Actions

GET
View subscription_settings
PATCH
Update subscription_settings (send only the properties you want to modify)
PUT
Replace subscription_settings (send the entire representation)
HEAD
Get just the header response
OPTIONS
Get a response explaining which HTTP methods are supported

Properties

Property Description Type Constraints
automatically_charge_past_due_amount If your customer's subscription payment fails and is configured to keep track of past due amounts, this option will automatically charge the past due amount in the next scheduled subscription. The default value is true. Boolean True or false. 1 or 0.
clear_past_due_amounts_on_success If you would like to keep track of past due amounts but not automatically charge them, this setting is helpful to reset them once a successful transaction for that subscription is processed. The default value is false. Boolean True or false. 1 or 0.
past_due_amount_handling This setting determines how you'd like to handle past due amounts when we try to process a subscription and that subscritpion fails. You can either increment the past due for each failure, only keep track of the most recent failure or ignore the amounts completely. The default value is increment. String Optional. increment, replace, or ignore
reset_nextdate_on_makeup_payment If a past due payment is paid directly by the customer, reset the next transaction date for the subscription to be one frequency out from the day that transaction is processed. Boolean True or false. 1 or 0.
reattempt_schedule A comma separated list of numbers. Each number represents the number of days after the initial failure that a reattempt should be made. For example, a setting of 1, 3, 5, 15, 30 would direct FoxyCart to attempt to collect the past-due amount on the 1st, 3rd, 5th, and 15th days after the initial transaction. String Optional. Comma separated values, 100 characters or less.
reattempt_bypass_logic Used in conjunction with the "bypass strings" below, this setting determines whether Foxy should reattempt the subscription charge if the transaction's previous error string does or doesn't contain specific text. String Optional. skip_if_exists or reattempt_if_exists
reattempt_bypass_strings A comma separated list of strings containing text strings that should prevent or allow (based on the above setting) a rebilling attempt. For example, setting the logic to "skip if the string is present" with a value for the "strings" field of Code: 8, Code: 37 would instruct FoxyCart to not initiate the rebilling process if the last error contained either Code: 8 or Code: 37, but to attempt the rebilling in all other cases. String Optional. Comma separated values, 400 characters or less.
expiring_soon_payment_reminder_schedule Enter a comma separated list of numbers. Each number represents the number of days until the payment card expires that an email notification should be sent to the customer. This only happens for customers with active subscriptions. For example, if you put in 20,15,5, 20 days before the end of the month, customers with payment cards that will expire that month will receive an email. Same with 15 days and 5 days before the end of the month. String Optional. Comma separated values, 100 characters or less.
reminder_email_schedule A comma separated list of numbers. Each number represents the number of days after the initial failure that an email notification to the customer should be sent. This only happens for active subscriptions which still have a past due amount. If a reattempt is successful, no additional reminder email will be sent. String Optional. Comma separated values, 100 characters or less.
cancellation_schedule A single number representing the number of days after the initial failure that a subscription should be set to cancel (assuming a successful payment hasn't been made in the meantime). For example, if a subscription is set to process on the 1st of the month and this value is 35, on the 5th of the next month (which is 35 days later, assuming the first month had 30 days), the subscription will be cancelled. (The end date will be set to that day, and it will be set to inactive.) Integer Optional. Positive number.
send_email_receipts_for_automated_billing When subscriptions run automatically to bill your customers, turning this setting off will prevent the normal receipt emails from being sent for their automated payment. The default value is true. Boolean True or false. 1 or 0.
date_created The date this resource was created. Date Read only
date_modified The date this resource was last modified. Date Read only

Example Representation

{
  "_links": {
    "curies": [
        {
            "name": "fx",
            "href": "https://api.foxycart.com/rels/{rel}",
            "templated": true
        }
    ],
    "self": {
      "href": "https://api.foxycart.com/store_subscription_settings/8",
      "title": "Store Subscription Settings"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/8",
      "title": "This Store"
    }
  },
  "automatically_charge_past_due_amount": true,
  "clear_past_due_amounts_on_success": true,
  "past_due_amount_handling": "increment",
  "reset_nextdate_on_makeup_payment": true,
  "reattempt_schedule": "1,3,5",
  "reattempt_bypass_logic": "skip_if_exists",
  "reattempt_bypass_strings": "Code 3:,Code 5:",
  "expiring_soon_payment_reminder_schedule": "15,30",
  "reminder_email_schedule": "1,7,10",
  "cancellation_schedule": "15",
  "send_email_receipts_for_automated_billing": true,
  "date_created": 2013-08-19T10:58:39-0700,
  "date_modified": "2013-08-19T10:58:39-0700"
}
<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api-sandbox.foxycart.com/store_subscription_settings/8" rel="https://api.foxycart.com/rels/subscription_settings">
  <link rel="self" href="https://api-sandbox.foxycart.com/store_subscription_settings/8" title="Store Subscription Settings"/>
  <link rel="https://api.foxycart.com/rels/store" href="https://api.foxycart.com/stores/8" title="This Store"/>
  <automatically_charge_past_due_amount>true</automatically_charge_past_due_amount>
  <clear_past_due_amounts_on_success>true</clear_past_due_amounts_on_success>
  <past_due_amount_handling>increment</past_due_amount_handling>
  <reset_nextdate_on_makeup_payment>increment</reset_nextdate_on_makeup_payment>
  <reattempt_schedule>1,3,5</reattempt_schedule>
  <reattempt_bypass_logic>skip_if_exists</reattempt_bypass_logic>
  <reattempt_bypass_strings>Code 3:,Code 5:</reattempt_bypass_strings>
  <expiring_soon_payment_reminder_schedule>15,30</expiring_soon_payment_reminder_schedule>
  <reminder_email_schedule>1,7,10</reminder_email_schedule>
  <cancellation_schedule>15</cancellation_schedule>
  <send_email_receipts_for_automated_billing>true</send_email_receipts_for_automated_billing>
  <date_created>2013-08-19T10:58:39-0700</date_created>
  <date_modified>2013-08-19T10:58:39-0700</date_modified>
</resource>
{
    "class": [
        "subscription_settings"
    ],
    "properties": {
        "automatically_charge_past_due_amount": true,
        "clear_past_due_amounts_on_success": true,
        "past_due_amount_handling": "increment",
        "reset_nextdate_on_makeup_payment": true,
        "reattempt_schedule": "1,3,5",
        "reattempt_bypass_logic": "skip_if_exists",
        "reattempt_bypass_strings": "Code 3:,Code 5:",
        "expiring_soon_payment_reminder_schedule": "15,30",
        "reminder_email_schedule": "1,7,10",
        "cancellation_schedule": "15",
        "send_email_receipts_for_automated_billing": true,
        "date_created": 2013-08-19T10:58:39-0700,
        "date_modified": "2013-08-19T10:58:39-0700"
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api.foxycart.com/store_subscription_settings/8"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/store"
            ],
            "href": "https://api.foxycart.com/stores/8"
        }
    ]
}

Zoomable Resources

This resource has no linked resources which can be "zoomed" in on, filtered and embedded within this resource.