subscription.trial.reminder
Overview
This article provides details about the subscription.trial.reminder webhook event.
The subscription.trial.reminder server webhook event fires when an email message is sent to the customer before the first billing following a free trial period. You can configure a free trial period via the Free Trial Days field in the Pricing popup dialog of the Dashboard, or via the trial field inside the pricing node of a POST to the /products endpoint of the FastSpring API.
About Webhook Expansion
When webhook expansion is enabled, subscription.trial.reminder includes the complete account object and product object, rather than just the account ID and the product ID.IMPORTANT
Each post from FastSpring to your endpoint may contain more than one webhook event in its payload. For more information, please see About Webhooks.
Contents of Event Payload
| Name | Type | Description |
| id | string | ID of the subscription |
| subscription | string | ID of the subscription (backward compatibility) |
| active | Boolean | is the current subscription active? ("false" if deactivated) |
| state | string | current status of the subscription: "active", "overdue", "canceled", "deactivated", "trial" |
| changed | integer | date of the most recent change to the subscription, in milliseconds |
| changedValue | integer | date of the most recent change to the subscription, in milliseconds (backward compatibility) |
| changedInSeconds | integer | date of the most recent change to the subscription, in seconds |
| changedDisplay | string | date of the most recent change to the subscription, formatted display based on the language of the original subscription order |
| live | Boolean | "true" if not a test order |
| currency | string | three-character ISO code for the currency associated with the subscription |
| account | string (expansion disabled) object (expansion enabled) | FastSpring-generated customer account ID (expansion disabled) details of the customer account (expansion enabled) |
| account.id | string | FastSpring-generated customer account ID |
| account.account | string | FastSpring-generated customer account ID |
| account.contact | object | customer's contact details |
| account.contact.first | string | customer's first name |
| account.contact.last | string | customer's last name |
| account.contact.email | string | customer's email address |
| account.contact.company | string | customer's company name |
| account.contact.phone | string | customer's telephone number |
| account.language | string | two-character ISO code for the language associated with the customer's account |
| account.country | string | two-character ISO code for the country associated with the customer's account |
| account.lookup | object | multiple-field object containing lookup IDs for the customer account (e.g., for use with the /accounts endpoint of the FastSpring API) |
| account.lookup.global | string | external customer account ID, generated by FastSpring |
| account.lookup.custom | string | optional custom account ID specified via the /accounts endpoint of the FastSpring API (not shown in examples below) |
| account.url | string | URL for the Store's default account management page |
| product | string (expansion disabled) object (expansion enabled) | product path/product ID of the subscription product (expansion disabled) details about the product associated with the subscription |
| product.product | string | product ID/product path |
| product.parent | string | if the product is a product variation, this field indicates the product ID/product path of the parent product; otherwise, this has a null value |
| product.display | object | customer-facing Display name; may contain multiple strings, one for each localized language with format "ISO language code":"string" |
| product.description | object | contents of the product's Summary, Long Description, and Call to Action fields |
| product.description.summary | object | contents of the product's Summary field; may contain multiple strings, one for each localized language with format "ISO language code":"string" |
| product.description.action | object | contents of the product's Call to Action field; may contain multiple strings, one for each localized language with format "ISO language code":"string" |
| product.description.full | object | contents of the product's Long Description field; may contain multiple strings, one for each localized language with format "ISO language code":"string" |
| product.image | string | URL for the FastSpring-hosted product icon image file |
| product.sku | string | optional internal SKU ID (e.g., your part number) for the current product |
| product.fulfillments | object | details of the product's fulfillment actions |
| product.fulfillments.instructions | object | contents of the product's Post-Order Instructions field; may contain multiple strings, one for each localized language with format "ISO language code":"string" |
| product.fulfillments.<fulfillment action name> | object | details of each fulfillment action assigned to the product; this object is repeated once for each fulfillment action |
| product.fulfillments.<fulfillment action name>.fulfillment | string | name of the current fulfillment action |
| product.fulfillments.<fulfillment action name>.name | string | description of the current fulfillment action type (includes file name for file downloads) |
| product.fulfillments.<fulfillment action name>.applicability | string | setting from the current fulfillment action's Fulfillment Applicability field: "ALWAYS", "BASE", "REBILL ONLY", "CONFIGURATION", or "NON_REBILL_ONLY" |
| product.fulfillments.<fulfillment action name>.display | string | when the current fulfillment action is a remote URL download, displays the download's Name |
| product.fulfillments.<fulfillment action name>.url | string | when the current fulfillment action is a remote URL download, displays the URL from which the file is to be downloaded |
| product.fulfillments.<fulfillment action name>.size | number | when the current fulfillment action is a remote URL download, displays the size of the download file, in bytes |
| product.fulfillments.<fulfillment action name>.behavior | string | when the current fulfillment action is a download, indicates the setting of the current fulfillment action's Download Version Behavior field: "PREFER_EXPLICIT" or "CURRENT" |
| product.fulfillments.<fulfillment action name>.previous | array | when the current fulfillment action is a download and you have updated the download file from the original version, provides details of the previous version |
| product.fulfillments.<fulfillment action name>.previous.display | string | filename of the previous version file for this download fulfillment |
| product.fulfillments.<fulfillment action name>.previous.size | integer | size of the previous version file for this download fulfillment |
| product.fulfillments.<fulfillment action name>.previous.type | string | type of the previous version file for this download fulfillment (e.g. "application/octet-stream") |
| product.fulfillments.<fulfillment action name>.previous.modified | integer | last modified date of the previous version file for this download fulfillment, in milliseconds |
| product.format | string | product format: "digital", "physical" or "digital-and-physical" |
| product.attributes | object | optional product-level attributes; may contain multiple strings consisting of "key":"value" pairs |
| product.pricing | object | product pricing details |
| product.pricing.trial | integer | if Free Trial Days are configured, specifies the number of days |
| product.pricing.renew | string | disregard this field - manual renewal subscriptions are currently controlled in Storefront Settings |
| product.pricing.interval | string | frequency of subscription billings: "day", "month", |
| product.pricing.intervalLength | integer | number of product.pricing.intervals between scheduled billings |
| product.pricing.intervalCount | integer | indicates the total number of expected billing periods |
| product.pricing.quantityBehavior | string | indicates the behavior of the quantity field for the product: "allow", "lock", or "hide" |
| product.pricing.quantityDefault | integer | default quantity for the product |
| product.pricing.price | object | product price; may contain multiple "string":number pairings, one for each specified currency (e.g. "USD":14.95) |
| product.pricing.quantityDiscounts | object | when Use Volume Discounts is selected, indicates the quantity thresholds and corresponding discount amounts or percentages (e.g. "2":10.0, "5":15.0 or "2":{"EUR":1.75,"USD":2.0}, "5":{"EUR":2.25,"USD":3.0}) when Use Volume Discounts is not selected, indicates the amount or percentage of the product-level discount (e.g., "1":{"USD":3.75}) |
| product.pricing.dateLimitsEnabled | Boolean | indicate whether or not beginning and end dates have been specified for product-level discounts |
| product.pricing.dateLimits | object | when product.pricing.dateLimitsEnabled is true, indicates the beginning and or ending date and time for the discount to be applied on an initial transaction |
| product.pricing.dateLimits.start | string | beginning date and time when the discount will be applied |
| product.pricing.dateLimits.end | string | ending date and time, after which the discount will no longer be applied |
| product.pricing.discountReason | object | optional, customer-facing explanation of the product-level discount; may contain multiple strings, one for each localized language with format "ISO language code":"string" |
| product.pricing.discountDuration | integer | when a product-level discount is configured, indicates the number of subscription billings (including the initial transaction) to which the discount will be applied |
| product.pricing.reminderNotification | object | details of any payment reminder notification email messages configured for the subscription product |
| product.pricing.reminderNotification.enabled | Boolean | indicates whether or not payment reminders are enabled for the subscription product |
| product.pricing.reminderNotification.interval | string | interval unit that controls the frequency of payment reminder notification email messages: "DAY", "WEEK", "MONTH", or "YEAR" |
| product.pricing.reminderNotification.intervalLength | integer | number of product.pricing.reminderNotification.intervals before the scheduled billing date that FastSpring will send the reminder notification email message |
| product.pricing.overdueNotification | object | details of any payment overdue notification email messages configured for the subscription product; these are messages sent when a subscription billing has failed or been declined |
| product.pricing.overdueNotification.enabled | Boolean | indicates whether or not payment overdue notification messages are enabled for the subscription product |
| product.pricing.overdueNotification.interval | string | interval unit that controls the frequency of payment overdue notification email messages: "DAY", "WEEK", "MONTH", or "YEAR" |
| product.pricing.overdueNotification.intervalLength | integer | number of product.pricing.overdueNotification.intervals following a declined subscription billing that FastSpring will send the first payment overdue notification message, and the number of intervals between subsequent notification messages |
| product.pricing.overdueNotification.amount | integer | total number of payment overdue notification messages that FastSpring will send |
| product.pricing.cancellation | object | cancellation settings to be used in the event of a failed subscription billing |
| product.pricing.cancellation.interval | string | interval unit that controls when the subscription will automatically be canceled in the event of a failed billing: "DAY", "WEEK", "MONTH", "YEAR" |
| product.pricing.cancellation.intervalLength | integer | number of product.pricing.cancellation.intervals following a declined subscription billing - OR following the last payment overdue notification, if product.pricing.overdueNotification.enabled is true - after which the subscription will be canceled automatically |
| sku | string | optional internal SKU ID (e.g., your part number) for the current product |
| display | string | customer-facing Display name of the subscription product |
| quantity | integer | subscribed quantity of the subscription product |
| adhoc | Boolean | "true" for managed subscriptions, "false" for standard subscriptions |
| autoRenew | Boolean | "true" for automatic subscriptions, "false" for manual renewal subscriptions |
| price | number | price of the subscription; the amount of each subscription charge, in currency |
| priceDisplay | string | price of subscription, formatted for display in currency |
| priceInPayoutCurrency | number | price of the subscription, in the currency of your FastSpring disbursements |
| priceInPayoutCurrencyDisplay | string | price of the subscription, formatted for display in the currency of your FastSpring disbursements |
| discount | number | total amount of all discounts associated with the subscription, in currency |
| discountDisplay | string | total amount of all discounts associated with the subscription, formatted for display in the currency |
| discountInPayoutCurrency | number | total amount of all discounts associated with the subscription, in the currency of your FastSpring disbursements |
| discountInPayoutCurrencyDisplay | string | total amount of all discounts associated with the subscription, formatted for display in the currency of your FastSpring disbursements |
| subtotal | number | subtotal for the subscription, including price and discount, but before tax |
| subtotalDisplay | string | subtotal for the subscription, formatted for display in currency |
| subtotalInPayoutCurrency | number | subtotal for the subscription, in the currency of your FastSpring disbursements |
| subtotalInPayoutCurrencyDisplay | string | subtotal for the subscription, formatted for display in the currency of your FastSpring disbursements |
| attributes | object | multiple-field object containing optional product-level attributes for the subscription (inherited from the subscription product) |
| tags | object | multiple-field object containing optional order-level tags for the subscription (inherited from the original transaction) |
| next | integer | date of the next scheduled subscription charge, in milliseconds |
| nextValue | integer | date of the next scheduled subscription charge (backward compatibility) |
| nextInSeconds | integer | date of the next scheduled subscription charge, in seconds |
| nextDisplay | string | date of the next scheduled subscription charge, formatted for display based on the language selected for the original subscription order |
| end | integer | expected end date of the subscription (if any), in milliseconds (e.g., for subscriptions with a pre-defined number of charges) |
| endValue | integer | expected end date of the subscription (if any), in milliseconds (e.g., for subscriptions with a pre-defined number of charges) (backward compatibility) |
| endInSeconds | integer | expected end date of the subscription (if any), in seconds (e.g., for subscriptions with a pre-defined number of charges) |
| endDisplay | string | expected end date of the subscription (if any), formatted for display based on the language selected for the original subscription order |
| canceledDate | integer | date on which the subscription was canceled, in milliseconds, if applicable |
| canceledDateValue | integer | date on which the subscription was canceled, in milliseconds, if applicable (backward compatibility) |
| canceledDateInSeconds | integer | date on which the subscription was canceled, in seconds, if applicable |
| canceledDateDisplay | string | date on which the subscription was canceled, if applicable, formatted for display based on the language selected for the original subscription order |
| deactivationDate | integer | date on which the subscription was or will be deactivated, if applicable, in milliseconds (null if deactivated immediately upon cancellation) |
| deactivationDateValue | integer | date on which the subscription was or will be deactivated, if applicable, in milliseconds (null if deactivated immediately upon cancellation) (backward compatibility) |
| deactivationDateInSeconds | integer | date on which the subscription was or will be deactivated, if applicable, in seconds (null if deactivated immediately upon cancellation) |
| deactivationDateDisplay | integer | date on which the subscription was or will be deactivated, if applicable, formatted for display based on the language selected for the original subscription order (null if deactivated immediately upon cancellation) |
| sequence | integer | sequence number of the current billing period |
| periods | integer | expected total number of billing periods (e.g., for subscriptions with a pre-defined number of charges) |
| remainingPeriods | integer | number of periods remaining based on the total number expected periods |
| begin | integer | date on which the subscription began, in milliseconds |
| beginValue | integer | date on which the subscription began, in milliseconds (backward compatibility) |
| beginInSeconds | integer | date on which the subscription began, in seconds |
| beginDisplay | string | date on which the subscription began, formatted for display based on the language selected for the original subscription order |
| intervalUnit | string | unit of time used in conjunction with intervalLength to determine the subscription's charge interval: "adhoc", "day", "week", "month", "year" |
| intervalLength | integer | number of intervalUnits per billing period for the subscription |
| intervalCount | integer | only appears when the subscription product is scheduled to end or renew into a different product following a fixed number of periods; indicates the total number of expected billing periods |
| nextChargeCurrency | string | three-character ISO code of the currency to be used for the next charge |
| nextChargeDate | integer | date of the next upcoming charge, in milliseconds |
| nextChargeDateValue | integer | date of the next upcoming charge, in milliseconds (backward compatibility) |
| nextChargeDateInSeconds | integer | date of the next upcoming charge, in seconds |
| nextChargeDateDisplay | string | date of the next upcoming charge, formatted for display based on the language selected for the original subscription order |
| nextChargePreTax | integer | amount of the next upcoming charge without taxes |
| nextChargePreTaxDisplay | string | amount of the next upcoming charge without taxes, formatted for display based on the nextChargeCurrency |
| nextChargePreTaxInPayoutCurrency | integer | amount of the next upcoming charge without taxes, in the currency of your FastSpring disbursements |
| nextChargePreTaxInPayoutCurrencyDisplay | string | amount of the next upcoming charge without taxes, formatted for display in the currency of your FastSpring disbursements |
| nextChargeTotal | number | amount of the next upcoming charge, in the nextChargeCurrency |
| nextChargeTotalDisplay | string | amount of the next upcoming charge, formatted for display based on the nextChargeCurrency |
| nextChargeTotalInPayoutCurrency | number | amount of the next upcoming charge, in the currency of your FastSpring disbursements |
| nextChargeTotalInPayoutCurrencyDisplay | string | amount of the next upcoming charge, formatted for display in the currency of your FastSpring disbursements |
| nextNotificationType | string | type of next customer-facing email notification message: "TRIAL_REMINDER", "PAYMENT_REMINDER", "PAYMENT_OVERDUE" |
| nextNotificationDate | integer | date of the next customer-facing email notification message, in milliseconds |
| nextNotificationDateValue | integer | date of the next customer-facing email notification message, in milliseconds (backward compatibility) |
| nextNotificationDateInSeconds | integer | date of the next customer-facing email notification message, in seconds |
| nextNotificationDateDisplay | string | date of the next customer-facing email notification message, formatted for display based on the language of the original subscription order |
| trialReminder | object | defines the timing of the customer-facing reminder email message that FastSpring will send (if any) regarding the approaching end of a free trial period |
| trialReminder.intervalUnit | string | unit of time used in conjunction with trialReminder.intervalLength to determine how long before the date of the first subscription charge FastSpring will send the trial reminder message: "day", "week", "month", "year" |
| trialReminder.intervalLength | integer | number of trialReminder.intervalUnits before the date of the first subscription charge the trial reminder message will be sent |
| paymentReminder | object | defines the timing of the customer-facing reminder email message sent before each scheduled subscription billing |
| paymentReminder.intervalUnit | string | unit of time used in conjunction with paymentReminder.intervalLength to determine how long before the date of the first subscription charge the trial reminder message will be sent: "day", "week", "month", "year" |
| paymentReminder.intervalLength | integer | number of paymentReminder.intervalUnits before each scheduled subscription billing that FastSpring will send the payment reminder message |
| paymentOverdue | object | defines the timing of the customer-facing payment overdue notification message(s) sent when a scheduled billing has failed |
| paymentOverdue.intervalUnit | string | unit of time used in conjunction with paymentOverdue.intervalLength to determine how long after a failed subscription billing FastSpring will send a payment overdue notification (or how long after a prior payment overdue notification message has been sent): "day", "week", "month", "year" |
| paymentOverdue.intervalLength | integer | number paymentOverdue.intervalUnits following the failed subscription billing that FastSpring will send the first payment overdue notification - and the number of paymentOverdue.intervalUnits between subsequent payment overdue notifications, if any |
| paymentOverdue.total | integer | total number of payment overdue notifications to be sent, including the first one |
| paymentOverdue.sent | integer | number of payment overdue notifications that have been sent to date |
| cancellationSetting | object | defines the timing of automatic subscription cancellation in the event of a failed subscription billing |
| cancellationSetting.cancellation | string | event trigger used in determining the timing of automatic subscription cancellation, as configured for the subscription product: "AFTER_LAST_NOTIFICATION" or "AFTER_PAYMENT_FAILURE" |
| cancellationSetting.intervalUnit | string | unit of time used in conjunction with cancellationSetting.intervalLength and cancellationSetting.cancellation to determine when a subscription will be canceled as a result of a failed subscription billing |
| cancellationSetting.intervalLength | integer | number of cancellationSetting.intervalUnits following the cancellationSetting.cancellation event trigger that the subscription will be canceled due to a failed subscription billing |
| addons | array | array consisting of all subscription addons included in the subscription, if any (only appears if addons are included in the subscription) |
| addons.product | string | product ID/product path of the current subscription addon product |
| addons.sku | string | optional internal SKU ID (e.g., your part number) for the current subscription addon product |
| addons.display | string | customer-facing Display name of the current subscription addon product |
| addons.quantity | integer | subscribed quantity of the current subscription addon product |
| addons.price | number | price per quantity of the current subscription addon product, in the base currency of the Store |
| addons.priceDisplay | string | price per quantity of the current subscription addon product, in the base currency of the Store, formatted for display |
| addons.priceInPayoutCurrency | number | price per quantity of the current subscription addon product, in the currency of your FastSping disbursements |
| addons.priceInPayoutCurrencyDisplay | string | price per quantity of the current subscription addon product, in the currency of your FastSping disbursements, formatted for display |
| addons.discount | number | amount of the coupon applied to the current subscription addon product (if any) |
| addons.discountDisplay | string | amount of the coupon applied to the current subscription addon product (if any), formatted for display |
| addons.discountInPayoutCurrency | number | amount of the coupon applied to the current subscription addon product (if any), in the currency of your FastSpring disbursements |
| addons.discountInPayoutCurrencyDisplay | string | amount of the coupon applied to the current subscription addon product (if any), formatted for display in the currency of your FastSpring disbursements |
| addons.subtotal | number | product of (addons.price - addons.discount) * addons.quantity |
| addons.subtotalDisplay | string | product of (addons.price - addons.discount) * addons.quantity, formatted for display |
| addons.subtotalInPayoutCurrency | number | product of (addons.price - addons.discount) * addons.quantity, in the currency of your FastSpring disbursements |
| addons.subtotalInPayoutCurrencyDisplay | string | product of (addons.price - addons.discount) * addons.quantity, formatted for display in the currency of your FastSpring disbursements |
| addons.discounts | array | array consisting of coupon codes applied to the current subscription addon product (Note: At this time, only one coupon can be applied to an order.) |
| discounts | array | information about the coupon applied to the subscription (if any) |
| discounts.totalDiscountValue | number | total amount of the discount that will be applied, based on discounts.discountValue multiplied by discounts.discountDuration (only present when the discount type is an amount rather than a percentage) |
| discounts.discountPath | string | coupon ID of the coupon applied to the subscription |
| discounts.discountDuration | integer | total number of billings, including the original order, to which the coupon discount will be applied |
| discounts.percentValue | number | percentage of the coupon discount applied to the subscription (only present when the discount type is a percentage rather than an amount) |
| discounts.discountValue | number | amount of the discount per billing period, in the currency (only present when the discount type is an amount rather than a percentage) |
| setupFee | object | provides details of the one-time setup fee associated with the subscription instance, if any |
| setupFee.price | object | indicates the currency and amount of the one-time setup fee associated with the subscription instance, if any (e.g., "USD": 5) |
| setupFee.title | object | indicates the language and description shown to the customer for the one-time setup fee associated with the subscription instance, if any (e.g. "en": "Setup Fee Description") |
| fulfillments | object | details of the fulfillments associated with the subscription instance |
| fulfillments.<fulfillment action name>.license | string | license key(s) associated with the subscription instances |
| fulfillments.<fulfillment action name>.display | string | customer-facing display name of the current fulfillment action (e.g., "License Key" or the filename of the download file or signed PDF file) |
| fulfillments.<fulfillment action name>.type | string | type of the current fulfillment action: "license" or "file" |
| fulfillments.<fulfillment action name>.size | integer | when type = "file", indicates the file size in bytes |
| fulfillments.<fulfillment action name>.file | string | when type = "file", indicates the unique download URL for the fulfillment file |
| fulfillments.instructions | string | HTML text of the subscription product's Post Order Instructions |
| instructions | array | instructions for recurring billings |
| instructions.product | string | indicates the product id/product path for the current instructions |
| instructions.type | string | type of instructions for the current instruction object; subscription may have more than one instruction object when applicable: "trial", (only exists if there's a free trial) "discounted", (only exists if there's a product-level discount) "regular" (always present) |
| instructions.periodStartDate | integer | date of the beginning of the instruction period, in milliseconds |
| instructions.periodStartDateValue | integer | date of the beginning of the instruction period, in milliseconds (backward compatibility) |
| instructions.periodStartDateInSeconds | integer | date of the beginning of the instruction period, in seconds |
| instructions.periodStartDateDisplay | string | date of the beginning of the instruction period, formatted for display based on the language selected for the original subscription order |
| instructions.periodEndDate | integer | date of the end of the instruction period, in milliseconds |
| instructions.periodEndDateValue | integer | date of the end of the instruction period, in milliseconds (backward compatibility) |
| instructions.periodEndDateInSeconds | integer | date of the end of the instruction period, in seconds |
| instructions.periodEndDateDisplay | string | date of the end of the instruction period, formatted for display based on the language selected for the original subscription order |
| instructions.intervalUnit | string | unit of time used in conjunction with instructions.intervalLength to determine the duration of the current instruction period: "adhoc", "day", "week", "month", "year" |
| instructions.intervalLength | integer | duration of the current instruction period in instructions.intervalUnits |
| instructions.discountIntervalUnit | string | only appears when type = "discounted" or "trial"; unit of time used in conjunction with discountIntervalLength to determine the duration of the current discount period: "day", "week", "month", or "year" |
| instructions.discountIntervalLength | integer | only appears when type = "discounted" or "trial"; number of discountIntervalUnits in the current discount period |
| instructions.discountDuration | integer | only appears when type = "discounted" or "trial"; number of discountIntervalUnits remaining, excluding the current discount period |
| instructions.discountDurationUnit | string | only appears when type = "discounted" or "trial"; unit of time used in conjunction with discountDurationLength to determine the remaining discount duration, excluding the current discount period: "day", "week", "month", or "year" (backward compatibility) |
| instructions.discountDurationLength | integer | only appears when type = "discounted" or "trial"; number of discountDurationUnits remaining, excluding the current discount period (backward compatibility) |
| instructions.discountPercent | integer | percentage of the discount for the current instruction period |
| instructions.discountPercentValue | integer | percentage of the discount for the current instruction period (backward compatibility) |
| instructions.discountPercentDisplay | string | percentage of the discount for the current instruction period, formatted for display |
| instructions.unitDiscount | number | discount amount per unit for the current instruction period, in the currency |
| instructions.unitDiscountDisplay | string | discount amount per unit for the current instruction period, formatted for display in the currency |
| instructions.unitDiscountInPayoutCurrency | number | discount amount per unit for the current instruction period, in the currency of your FastSpring disbursements |
| instructions.unitDiscountInPayoutCurrencyDisplay | string | discount amount per unit for the current instruction period, formatted for display in the currency of your FastSpring disbursements |
| instructions.discountTotal | number | total amount of the discount for the current instruction period, in the currency |
| instructions.discountTotalDisplay | string | total amount of the discount for the current instruction period, formatted for display based on the currency |
| instructions.discountTotalInPayoutCurrency | number | total amount of the discount for the current instruction period, in the currency of your FastSpring disbursements |
| instructions.discountTotalInPayoutCurrencyDisplay | string | total amount of the discount for the current instruction period, formatted for display in the currency of your FastSpring disbursements |
| instructions.price | number | list price of the product before any discounts, in the currency |
| instructions.priceDisplay | string | list price of the product before any discounts, formatted for display in the currency |
| instructions.priceInPayoutCurrency | number | list price of the product before any discounts, in the currency of your FastSpring disbursements |
| instructions.priceInPayoutCurrencyDisplay | string | list price of the product before any discounts, formatted for display in the currency of your FastSpring disbursements |
| instructions.priceTotal | number | product of (instructions.price * quantity), in the currency, for the current instruction period |
| instructions.priceTotalDisplay | string | product of (instructions.price * quantity), formatted for display in the currency, for the current instruction period |
| instructions.priceTotalInPayoutCurrency | number | product of (instructions.price * quantity), in the currency of your FastSpring disbursements, for the current instruction period |
| instructions.priceTotalInPayoutCurrencyDisplay | string | product of (instructions.price * quantity), formatted for display in the currency of your FastSpring disbursements, for the current instruction period |
| instructions.unitPrice | number | effective unit price after any discount, for the current instruction period, in the currency |
| instructions.unitPriceDisplay | string | effective unit price after any discount, for the current instruction period, formatted for display in the currency |
| instructions.unitPriceInPayoutCurrency | number | effective unit price after any discount, for the current instruction period, in the currency of your FastSpring disbursements |
| instructions.unitPriceInPayoutCurrencyDisplay | string | effective unit price after any discount, for the current instruction period, formatted for display in the currency of your FastSpring disbursements |
| instructions.total | number | product of (instructions.unitPrice * quantity) for the current instruction period, in the currency |
| instructions.totalDisplay | string | product of (instructions.unitPrice * quantity) for the current instruction period, formatted for display in the currency |
| instructions.totalInPayoutCurrency | number | product of (instructions.unitPrice * quantity) for the current instruction period, in the currency of your FastSpring disbursements |
| instructions.totalInPayoutCurrencyDisplay | string | product of (instructions.unitPrice * quantity) for the current instruction period, formatted for display in the currency of your FastSpring disbursements |
| customReferenceID | string | an optional value that you can add to a subscription instance via the FastSpring API using POST /subscriptions |
Examples
Example 1: Webhook Expansion Disabled
subscription.trial.reminder webhook example (webhook expansion disabled)
{
"id": "6_3ZvvJoQvOUmqCY9uPFow",
"subscription": "6_3ZvvJoQvOUmqCY9uPFow",
"active": true,
"state": "trial",
"changed": 1585927115803,
"changedValue": 1585927115803,
"changedInSeconds": 1585927115,
"changedDisplay": "4/3/20",
"live": false,
"currency": "USD",
"account": "gB_slATyQBqSpAxA7-1YAg",
"product": "example-subscription-monthly",
"sku": "SKU1234",
"display": "Example Subscription - Monthly",
"quantity": 1,
"adhoc": false,
"autoRenew": true,
"price": 30,
"priceDisplay": "$30.00",
"priceInPayoutCurrency": 30,
"priceInPayoutCurrencyDisplay": "$30.00",
"discount": 0,
"discountDisplay": "$0.00",
"discountInPayoutCurrency": 0,
"discountInPayoutCurrencyDisplay": "$0.00",
"subtotal": 30,
"subtotalDisplay": "$30.00",
"subtotalInPayoutCurrency": 30,
"subtotalInPayoutCurrencyDisplay": "$30.00",
"next": 1586476800000,
"nextValue": 1586476800000,
"nextInSeconds": 1586476800,
"nextDisplay": "4/10/20",
"end": null,
"endValue": null,
"endInSeconds": null,
"endDisplay": null,
"canceledDate": null,
"canceledDateValue": null,
"canceledDateInSeconds": null,
"canceledDateDisplay": null,
"deactivationDate": null,
"deactivationDateValue": null,
"deactivationDateInSeconds": null,
"deactivationDateDisplay": null,
"sequence": 1,
"periods": null,
"remainingPeriods": null,
"begin": 1585872000000,
"beginValue": 1585872000000,
"beginInSeconds": 1585872000,
"beginDisplay": "4/3/20",
"intervalUnit": "month",
"intervalLength": 1,
"nextChargeCurrency": "USD",
"nextChargeDate": 1586476800000,
"nextChargeDateValue": 1586476800000,
"nextChargeDateInSeconds": 1586476800,
"nextChargeDateDisplay": "4/10/20",
"nextChargePreTax": 30,
"nextChargePreTaxDisplay": "$30.00",
"nextChargePreTaxInPayoutCurrency": 30,
"nextChargePreTaxInPayoutCurrencyDisplay": "$30.00",
"nextChargeTotal": 30,
"nextChargeTotalDisplay": "$30.00",
"nextChargeTotalInPayoutCurrency": 30,
"nextChargeTotalInPayoutCurrencyDisplay": "$30.00",
"nextNotificationType": "TRIAL_REMINDER",
"nextNotificationDate": 1586217600000,
"nextNotificationDateValue": 1586217600000,
"nextNotificationDateInSeconds": 1586217600,
"nextNotificationDateDisplay": "4/7/20",
"trialReminder": {
"intervalUnit": "day",
"intervalLength": 3
},
"paymentReminder": {
"intervalUnit": "week",
"intervalLength": 1
},
"paymentOverdue": {
"intervalUnit": "week",
"intervalLength": 1,
"total": 1,
"sent": 0
},
"cancellationSetting": {
"cancellation": "AFTER_LAST_NOTIFICATION",
"intervalUnit": "week",
"intervalLength": 1
},
"fulfillments": {
"example-subscription-monthly_license_0": [
{
"license": "vXlPBm4EEOfzHoMC4jqT",
"display": "License Key",
"type": "license"
}
],
"example-subscription-monthly_file_0": [
{
"display": "Example.pdf",
"size": 224143,
"file": "https://yourexamplestore.onfastspring.com/account/file/YOU200403-5980-90158F",
"type": "file"
}
],
"instructions": "Thank you for subscribing to Example Subscription Monthly. Please download the file using the button or link found on this page. Once you have installed the product, go to Help | About | Register and enter the license key shown above. Then, just click ACTIVATE to complete your registration."
},
"instructions": [
{
"type": "trial",
"periodStartDate": 1585872000000,
"periodStartDateValue": 1585872000000,
"periodStartDateInSeconds": 1585872000,
"periodStartDateDisplay": "4/3/20",
"periodEndDate": 1586390400000,
"periodEndDateValue": 1586390400000,
"periodEndDateInSeconds": 1586390400,
"periodEndDateDisplay": "4/9/20",
"discountDurationUnit": "day",
"discountDurationLength": 7,
"discountPercent": 100,
"discountPercentValue": 100,
"discountPercentDisplay": "100%",
"unitDiscount": 30,
"unitDiscountDisplay": "$30.00",
"unitDiscountInPayoutCurrency": 30,
"unitDiscountInPayoutCurrencyDisplay": "$30.00",
"discountTotal": 30,
"discountTotalDisplay": "$30.00",
"discountTotalInPayoutCurrency": 30,
"discountTotalInPayoutCurrencyDisplay": "$30.00",
"total": 0,
"totalDisplay": "$0.00",
"totalInPayoutCurrency": 0,
"totalInPayoutCurrencyDisplay": "$0.00",
"price": 30,
"priceDisplay": "$30.00",
"priceInPayoutCurrency": 30,
"priceInPayoutCurrencyDisplay": "$30.00",
"priceTotal": 30,
"priceTotalDisplay": "$30.00",
"priceTotalInPayoutCurrency": 30,
"priceTotalInPayoutCurrencyDisplay": "$30.00",
"unitPrice": 0,
"unitPriceDisplay": "$0.00",
"unitPriceInPayoutCurrency": 0,
"unitPriceInPayoutCurrencyDisplay": "$0.00"
},
{
"product": "example-subscription-monthly",
"type": "regular",
"periodStartDate": 1586476800000,
"periodStartDateValue": 1586476800000,
"periodStartDateInSeconds": 1586476800,
"periodStartDateDisplay": "4/10/20",
"periodEndDate": null,
"periodEndDateValue": null,
"periodEndDateInSeconds": null,
"periodEndDateDisplay": null,
"intervalUnit": "month",
"intervalLength": 1,
"discountPercent": 0,
"discountPercentValue": 0,
"discountPercentDisplay": "0%",
"discountTotal": 0,
"discountTotalDisplay": "$0.00",
"discountTotalInPayoutCurrency": 0,
"discountTotalInPayoutCurrencyDisplay": "$0.00",
"unitDiscount": 0,
"unitDiscountDisplay": "$0.00",
"unitDiscountInPayoutCurrency": 0,
"unitDiscountInPayoutCurrencyDisplay": "$0.00",
"price": 30,
"priceDisplay": "$30.00",
"priceInPayoutCurrency": 30,
"priceInPayoutCurrencyDisplay": "$30.00",
"priceTotal": 30,
"priceTotalDisplay": "$30.00",
"priceTotalInPayoutCurrency": 30,
"priceTotalInPayoutCurrencyDisplay": "$30.00",
"unitPrice": 30,
"unitPriceDisplay": "$30.00",
"unitPriceInPayoutCurrency": 30,
"unitPriceInPayoutCurrencyDisplay": "$30.00",
"total": 30,
"totalDisplay": "$30.00",
"totalInPayoutCurrency": 30,
"totalInPayoutCurrencyDisplay": "$30.00"
}
]
}
Example 2 - Webhook Expansion Enabled
subscription.trial.reminder webhook example (webhook expansion enabled)
{
"id": "To4TBBJfRSGlNLsJ2dL2sg",
"subscription": "To4TBBJfRSGlNLsJ2dL2sg",
"active": true,
"state": "trial",
"changed": 1585936267665,
"changedValue": 1585936267665,
"changedInSeconds": 1585936267,
"changedDisplay": "4/3/20",
"live": false,
"currency": "USD",
"account": {
"id": "gB_slATyQBqSpAxA7-1YAg",
"account": "gB_slATyQBqSpAxA7-1YAg",
"contact": {
"first": "John",
"last": "Doe",
"email": "ne1@all.com",
"company": null,
"phone": null
},
"language": "en",
"country": "US",
"lookup": {
"global": "VKMqlZ--TIuD44BvXdNkbg"
},
"url": "https://yourexamplestore.onfastspring.com/account"
},
"product": {
"product": "example-subscription-monthly",
"parent": null,
"display": {
"en": "Example Subscription - Monthly"
},
"description": {
"summary": {
"en": "This is the **Summary** description for Example Subscription - Monthly."
},
"action": {
"en": "Buy Now"
},
"full": {
"en": "This is the **Long Description** for Example Subscription - Monthly."
}
},
"image": "https://d8y8nchqlnmka.cloudfront.net/p31bZYrcQUs/_CW0gCU8SR0/example-subscription-monthly_256.png",
"sku": "SKU1234",
"fulfillments": {
"instructions": {
"en": "Thank you for subscribing to _Example Subscription Monthly_. Please download the installer file using the button or link found on this page. Your license key is also displayed here."
},
"example-subscription-monthly_email_0": {
"fulfillment": "example-subscription-monthly_email_0",
"name": "Email (Your #{orderItem.display} Deli...)",
"applicability": "NON_REBILL_ONLY"
},
"example-subscription-monthly_file_0": {
"fulfillment": "example-subscription-monthly_file_0",
"name": "File Download (Example.pdf)",
"applicability": "NON_REBILL_ONLY",
"display": null,
"url": null,
"size": null,
"behavior": "PREFER_EXPLICIT",
"previous": []
},
"example-subscription-monthly_license_0": {
"fulfillment": "example-subscription-monthly_license_0",
"name": "License Generator (Pre-defined List)",
"applicability": "NON_REBILL_ONLY"
},
"example-subscription-monthly_license_1": {
"fulfillment": "example-subscription-monthly_license_1",
"name": "Signed PDF Generator (Example Fulfillment File.pdf)",
"applicability": "NON_REBILL_ONLY"
}
},
"format": "digital",
"pricing": {
"trial": 7,
"interval": "month",
"intervalLength": 1,
"intervalCount": null,
"quantityBehavior": "allow",
"quantityDefault": 1,
"price": {
"USD": 30
},
"dateLimitsEnabled": false,
"reminderNotification": {
"enabled": true,
"interval": "week",
"intervalLength": 1
},
"overdueNotification": {
"enabled": true,
"interval": "week",
"intervalLength": 1,
"amount": 1
},
"cancellation": {
"interval": "week",
"intervalLength": 1
}
}
},
"sku": "SKU1234",
"display": "Example Subscription - Monthly",
"quantity": 1,
"adhoc": false,
"autoRenew": true,
"price": 30,
"priceDisplay": "$30.00",
"priceInPayoutCurrency": 30,
"priceInPayoutCurrencyDisplay": "$30.00",
"discount": 0,
"discountDisplay": "$0.00",
"discountInPayoutCurrency": 0,
"discountInPayoutCurrencyDisplay": "$0.00",
"subtotal": 30,
"subtotalDisplay": "$30.00",
"subtotalInPayoutCurrency": 30,
"subtotalInPayoutCurrencyDisplay": "$30.00",
"next": 1586476800000,
"nextValue": 1586476800000,
"nextInSeconds": 1586476800,
"nextDisplay": "4/10/20",
"end": null,
"endValue": null,
"endInSeconds": null,
"endDisplay": null,
"canceledDate": null,
"canceledDateValue": null,
"canceledDateInSeconds": null,
"canceledDateDisplay": null,
"deactivationDate": null,
"deactivationDateValue": null,
"deactivationDateInSeconds": null,
"deactivationDateDisplay": null,
"sequence": 1,
"periods": null,
"remainingPeriods": null,
"begin": 1585872000000,
"beginValue": 1585872000000,
"beginInSeconds": 1585872000,
"beginDisplay": "4/3/20",
"intervalUnit": "month",
"intervalLength": 1,
"nextChargeCurrency": "USD",
"nextChargeDate": 1586476800000,
"nextChargeDateValue": 1586476800000,
"nextChargeDateInSeconds": 1586476800,
"nextChargeDateDisplay": "4/10/20",
"nextChargePreTax": 30,
"nextChargePreTaxDisplay": "$30.00",
"nextChargePreTaxInPayoutCurrency": 30,
"nextChargePreTaxInPayoutCurrencyDisplay": "$30.00",
"nextChargeTotal": 30,
"nextChargeTotalDisplay": "$30.00",
"nextChargeTotalInPayoutCurrency": 30,
"nextChargeTotalInPayoutCurrencyDisplay": "$30.00",
"nextNotificationType": "TRIAL_REMINDER",
"nextNotificationDate": 1586217600000,
"nextNotificationDateValue": 1586217600000,
"nextNotificationDateInSeconds": 1586217600,
"nextNotificationDateDisplay": "4/7/20",
"trialReminder": {
"intervalUnit": "day",
"intervalLength": 3
},
"paymentReminder": {
"intervalUnit": "week",
"intervalLength": 1
},
"paymentOverdue": {
"intervalUnit": "week",
"intervalLength": 1,
"total": 1,
"sent": 0
},
"cancellationSetting": {
"cancellation": "AFTER_LAST_NOTIFICATION",
"intervalUnit": "week",
"intervalLength": 1
},
"fulfillments": {
"example-subscription-monthly_license_0": [
{
"license": "dOvOkW4iomHjTYk4aN7K",
"display": "License Key",
"type": "license"
}
],
"example-subscription-monthly_file_0": [
{
"display": "Example.pdf",
"size": 224143,
"file": "https://yourexamplestore.onfastspring.com/account/file/YOU200403-5980-53325F",
"type": "file"
}
],
"example-subscription-monthly_license_1": [
{
"display": "Example Fulfillment File.pdf",
"size": 325134,
"file": "https://yourexamplestore.onfastspring.com/account/file/YOU200403-5980-60306L",
"type": "file"
}
],
"instructions": "Thank you for subscribing to Example Subscription Monthly. Please download the installer file using the button or link found on this page. Your license key is also displayed here."
},
"instructions": [
{
"type": "trial",
"periodStartDate": 1585872000000,
"periodStartDateValue": 1585872000000,
"periodStartDateInSeconds": 1585872000,
"periodStartDateDisplay": "4/3/20",
"periodEndDate": 1586390400000,
"periodEndDateValue": 1586390400000,
"periodEndDateInSeconds": 1586390400,
"periodEndDateDisplay": "4/9/20",
"discountDurationUnit": "day",
"discountDurationLength": 7,
"discountPercent": 100,
"discountPercentValue": 100,
"discountPercentDisplay": "100%",
"unitDiscount": 30,
"unitDiscountDisplay": "$30.00",
"unitDiscountInPayoutCurrency": 30,
"unitDiscountInPayoutCurrencyDisplay": "$30.00",
"discountTotal": 30,
"discountTotalDisplay": "$30.00",
"discountTotalInPayoutCurrency": 30,
"discountTotalInPayoutCurrencyDisplay": "$30.00",
"total": 0,
"totalDisplay": "$0.00",
"totalInPayoutCurrency": 0,
"totalInPayoutCurrencyDisplay": "$0.00",
"price": 30,
"priceDisplay": "$30.00",
"priceInPayoutCurrency": 30,
"priceInPayoutCurrencyDisplay": "$30.00",
"priceTotal": 30,
"priceTotalDisplay": "$30.00",
"priceTotalInPayoutCurrency": 30,
"priceTotalInPayoutCurrencyDisplay": "$30.00",
"unitPrice": 0,
"unitPriceDisplay": "$0.00",
"unitPriceInPayoutCurrency": 0,
"unitPriceInPayoutCurrencyDisplay": "$0.00"
},
{
"product": "example-subscription-monthly",
"type": "regular",
"periodStartDate": 1586476800000,
"periodStartDateValue": 1586476800000,
"periodStartDateInSeconds": 1586476800,
"periodStartDateDisplay": "4/10/20",
"periodEndDate": null,
"periodEndDateValue": null,
"periodEndDateInSeconds": null,
"periodEndDateDisplay": null,
"intervalUnit": "month",
"intervalLength": 1,
"discountPercent": 0,
"discountPercentValue": 0,
"discountPercentDisplay": "0%",
"discountTotal": 0,
"discountTotalDisplay": "$0.00",
"discountTotalInPayoutCurrency": 0,
"discountTotalInPayoutCurrencyDisplay": "$0.00",
"unitDiscount": 0,
"unitDiscountDisplay": "$0.00",
"unitDiscountInPayoutCurrency": 0,
"unitDiscountInPayoutCurrencyDisplay": "$0.00",
"price": 30,
"priceDisplay": "$30.00",
"priceInPayoutCurrency": 30,
"priceInPayoutCurrencyDisplay": "$30.00",
"priceTotal": 30,
"priceTotalDisplay": "$30.00",
"priceTotalInPayoutCurrency": 30,
"priceTotalInPayoutCurrencyDisplay": "$30.00",
"unitPrice": 30,
"unitPriceDisplay": "$30.00",
"unitPriceInPayoutCurrency": 30,
"unitPriceInPayoutCurrencyDisplay": "$30.00",
"total": 30,
"totalDisplay": "$30.00",
"totalInPayoutCurrency": 30,
"totalInPayoutCurrencyDisplay": "$30.00"
}
]
}