subscription_settings
The subscription settings resource contains properties used to configure how your store processes subscriptions. This includes dunning configuration, reattempt schedules, reminder emails, and cancellation behavior.
Required Scopes
store_full_access subscription_settings_read subscription_settings_write Actions
Properties (14)
automatically_charge_past_due_amount Boolean 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.
clear_past_due_amounts_on_success Boolean 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.
past_due_amount_handling String This setting determines how you'd like to handle past due amounts when a subscription 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.
incrementreplaceignore reset_nextdate_on_makeup_payment Boolean 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.
reattempt_schedule String 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, 15th, and 30th days after the initial transaction. 100 characters or less.
reattempt_bypass_logic String Used in conjunction with the reattempt_bypass_strings, this setting determines whether Foxy should reattempt the subscription charge if the transaction's previous error string does or doesn't contain specific text.
""skip_if_existsreattempt_if_exists reattempt_bypass_strings String A comma separated list of strings that should prevent or allow (based on reattempt_bypass_logic) a rebilling attempt. 400 characters or less.
expiring_soon_payment_reminder_schedule String 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. 100 characters or less.
reminder_email_schedule String 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. 100 characters or less.
cancellation_schedule Number 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).
cancel_enddate_config String This setting allows you to customise what the end date for a subscription should be when a customer cancels a subscription through the checkout. Setting it to 1d will cancel the subscription tomorrow, or setting it to next_transaction_date will leave the subscription active for the remainder of the period the customer has pre-paid for. If a subscription has a past due amount when cancelling, the end date will always be set to tomorrow.
1dnext_transaction_date send_email_receipts_for_automated_billing Boolean 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.
date_created String (nullable) · Read-only The date this resource was created.
date_modified String (nullable) · Read-only The date this resource was last modified.
Link Relations (2)
self Store Subscription Settings Example Representation
{
"_links": {
"curies": [
{
"name": "fx",
"href": "https://api.foxycart.com/rels/{rel}",
"templated": true
}
],
"self": {
"href": "https://api.foxycart.com/store_subscription_settings/456",
"title": "Store Subscription Settings"
},
"fx:store": {
"href": "https://api.foxycart.com/stores/456",
"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,
"cancel_enddate_config": "1d",
"send_email_receipts_for_automated_billing": true,
"date_created": "2013-08-19T10:58:39-0700",
"date_modified": "2013-08-19T10:58:39-0700"
}