Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SubscriptionSettings

Hierarchy

Index

Properties

child?: Core.Graph
curie: "fx:subscription_settings"
links: { fx:store: Backend.Rels.Store; self: SubscriptionSettings }

Type declaration

props: { automatically_charge_past_due_amount: boolean; cancellation_schedule: number; clear_past_due_amounts_on_success: boolean; date_created: null | string; date_modified: null | string; expiring_soon_payment_reminder_schedule: string; past_due_amount_handling: "replace" | "increment" | "ignore"; reattempt_bypass_logic: "" | "skip_if_exists" | "reattempt_if_exists"; reattempt_bypass_strings: string; reattempt_schedule: string; reminder_email_schedule: string; reset_nextdate_on_makeup_payment: boolean; send_email_receipts_for_automated_billing: boolean }

Type declaration

  • 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.

  • 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). 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.)

  • 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.

  • date_created: null | string

    The date this resource was created.

  • date_modified: null | string

    The date this resource was last modified.

  • expiring_soon_payment_reminder_schedule: string

    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.

  • past_due_amount_handling: "replace" | "increment" | "ignore"

    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.

  • reattempt_bypass_logic: "" | "skip_if_exists" | "reattempt_if_exists"

    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.

  • reattempt_bypass_strings: string

    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.

  • 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, and 15th days after the initial transaction.

  • 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.

  • 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.

  • 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.

zooms?: Readonly<Record<string, undefined | Core.Graph>>

Generated using TypeDoc