return.created | FastSpring Docs

Results in FastSpring Documentation:

return.created

Overview

This article provides details about the return.created server webhook event.

The return.created server webhook event fires when a refund or a return has been created (e.g., by returning a customer's order via the FastSpring App). Remember that each post from FastSpring to your endpoint may contain multiple webhook events in the payload. See the Webhooks Overview for more information.

The return.created event will not fire on tax refunds.

Contents of Event Payload

Name	Type	Description
return	string	internal return ID
reference	string	customer-facing reference for the refund (not the original order)
completed	Boolean	false if the return has not been processed successfully
changed	integer	date of the last update to this refund record, in milliseconds
changedValue	integer	date of the last update to this refund record, in milliseconds (backward compatibility)
changedInSeconds	integer	date of the last update to this refund record, in seconds
changedDisplay	string	date of the last update to this refund record, formatted for display based on the language in which the order was processed, as selected by the customer
live	Boolean	false if the order that was returned was a test order
account	string (expansion disabled) object (expansion enabled)	FastSpring-generated account ID of the customer account (expansion disabled) account object with all account details (expansion enabled)
account.id	string	FastSpring-generated account ID of the customer account
account.account	string	FastSpring-generated account ID of the customer account (backward compatibility)
account.contact	object	customer's contact details from the customer account
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
currency	string	three-character ISO code for the order currency (and thus, the return currency)
payoutCurrency	string	three-character ISO code for the currency in which your disbursement will be made
totalReturn	number	total amount of the return in the original transaction's currency
totalReturnDisplay	string	total amount of the return, formatted for display based on the original transaction's currency
totalReturnInPayoutCurrency	number	total amount of the return, in the currency of your FastSpring disbursements
totalReturnInPayoutCurrencyDisplay	string	total amount of the return, formatted for display based on the currency of your FastSpring disbursements
tax	number	amount of tax returned, in the original transaction's currency
taxDisplay	string	amount of tax returned, formatted for display in the transaction's currency
taxInPayoutCurrency	number	amount of tax returned, in the currency of your FastSpring disbursements
taxInPayoutCurrencyDisplay	string	amount of tax returned, formatted for display in the currency of your FastSpring disbursements
subtotal	number	return subtotal (totalReturn - tax) in the transaction's currency
subtotalDisplay	string	return subtotal (totalReturn - tax), formatted for display in the transaction's currency
subtotalInPayoutCurrency	number	return subtotal in the currency of your FastSpring disbursements (totalReturnInPayoutCurrency - taxInPayoutCurrency)
subtotalInPayoutCurrencyDisplay	string	return subtotal, formatted for display in the currency of your FastSpring disbursements (totalReturnInPayoutCurrency - taxInPayoutCurrency)
totalRefundInPayoutCurrency	number	total amount of the return, in the currency of your FastSpring disbursements (backward compatibility)
payment	object	details about the original transaction's payment method (and thus, the payment method that is being refunded)
payment.type	string	payment method used for the order: "paypal", "amazon", "creditcard", "test", "bank", "alipay", "purchase-order", "free"
payment.creditcard	string	(appears when payment.type = creditcard); type of credit or debit card used for the order: "visa", "mastercard", "amex", "discover", "jcb", "carteblanche", "dinersclub", "unionpay"
payment.cardEnding	string	(appears when payment.type = creditcard); last four digits of the card number used for the order
payment.bank	string	(appears when payment.type = bank); type of bank transfer used to pay for the order: "wire", "brazilwire", "ideal", "giropay", "sofort", "ecard", "sepa", "alipay"
reason	string	return reason type selected by you (or FastSpring) at the time of processing the return
note	string	optional note regarding the return, entered by you (or FastSpring) at the time of processing the return
type	string	return type: CHARGEBACK, PAYMENTRISK, PAYPAL, RETURN
original	object	details of the order being returned
original.id	string	internal order ID of the order being returned
original.order	string	internal order ID of the order being returned (backward compatibility)
original.reference	string	customer-facing order reference of the order being returned
original.account	string	FastSpring-generated customer account ID associated with the original order (always matches the account/account.id)
original.currency	string	three-character ISO code for the order currency
original.payoutCurrency	string	three-character ISO code for the currency of your FastSpring disbursements
original.total	number	total amount of the order in the original.currency
original.totalDisplay	string	total amount of the order, formatted for display in the original.currency
original.totalInPayoutCurrency	number	total amount of the order in the original.payoutCurrency
original.totalInPayoutCurrencyDisplay	string	total amount of the order, formatted for display in the original.payoutCurrency
original.tax	number	amount of tax in the original.currency
original.taxDisplay	string	amount of tax, formatted for display in the original.currency
original.taxInPayoutCurrency	number	amount of tax in the original.payoutCurrency
original.taxInPayoutCurrencyDisplay	string	amount of tax, formatted for display in the original.payoutCurrency
original.subtotal	number	order subtotal in the original.currency
original.subtotalDisplay	string	order subtotal, formatted for display in the original.currency
original.subtotalInPayoutCurrency	number	order subtotal in the original.payoutCurrency
original.subtotalInPayoutCurrencyDisplay	string	order subtotal, formatted for display in the original.payoutCurrency
notes	array	order notes from the original order, entered by you (or FastSpring); consists of one JSON object per note with two strings per object ("note" and "creator")
subscriptions	array	strings identifying the subscription IDs being returned, if any
customer	object	information about the customer being refunded, from the original order record (as opposed to the customer's account)
customer.first	string	customer's first name
customer.last	string	customer's last name
customer.email	string	customer's email address
customer.company	string	customers company name
customer.phone	string	customer's telephone number
items	array	details of the products being returned, one object per product
items.product	string	product path/product ID of the product
items.quantity	integer	quantity of the current product being returned
items.display	string	display name of the current product being returned
items.sku	string	optional internal SKU ID (e.g., your part number) of the current product being returned
items.subtotal	number	subtotal for the current product being returned, in the original.currency
items.subtotalDisplay	string	subtotal for the current product being returned, formatted for display in the original.currency
items.subtotalInPayoutCurrency	number	subtotal for the current product being returned, in the payout.currency
items.subtotalInPayoutCurrencyDisplay	string	subtotal for the current product being returned, formatted for display in the payout.currency
items.subscription	string (expansion disabled) object (expansion enabled)	ID of the subscription associated with the product being returned, if applicable (expansion disabled) details of the subscription associated with the product being returned, if applicable (expansion enabled)
items.subscription.id	string	ID of the subscription
items.subscription.subscription	string	ID of the subscription (backward compatibility)
items.subscription.active	Boolean	is the current subscription active? ("false" if deactivated)
items.subscription.state	string	current status of the subscription: "active", "overdue", "canceled", "deactivated", "trial"
items.subscription.changed	integer	date of the most recent change to the subscription, in milliseconds
items.subscription.changedValue	integer	date of the most recent change to the subscription, in milliseconds (backward compatibility)
items.subscription.changedInSeconds	integer	date of the most recent change to the subscription, in seconds
items.subscription.changedDisplay	string	date of the most recent change to the subscription, formatted for display based on the currency of the original order
items.subscription.live	Boolean	"true" if not a test order
items.subscription.currency	string	three-character ISO code for the currency associated with the subscription
items.subscription.account	string	FastSpring-generated customer account ID
items.subscription.product	string	product path/product ID of the subscription product
items.subscription.sku	string	optional internal SKU ID (e.g. your part number) for the current product
items.subscription.display	string	customer-facing Display name of the subscription product
items.subscription.quantity	integer	subscribed quantity of the subscription product
items.subscription.adhoc	Boolean	"true" for managed subscriptions, "false" for standard subscriptions
items.subscription.autoRenew	Boolean	"true" for automatic subscriptions, "false" for manual renewal subscriptions
items.subscription.price	number	price of the subscription; amount of each subscription charge, in items.subscription.currency
items.subscription.priceDisplay	string	price of subscription, formatted for display in items.subscription.currency
items.subscription.priceInPayoutCurrency	number	price of the subscription, in the currency of your FastSpring disbursements
items.subscription.priceInPayoutCurrencyDisplay	string	price of the subscription, formatted for display in the currency of your FastSpring disbursements
items.subscription.discount	number	total amount of all discounts associated with the subscription, in items.subscription.currency
items.subscription.discountDisplay	string	total amount of all discounts associated with the subscription, formatted for display in the items.subscription.currency
items.subscription.discountInPayoutCurrency	number	total amount of all discounts associated with the subscription, in the currency of your FastSpring disbursements
items.subscription.discountInPayoutCurrencyDisplay	string	total amount of all discounts associated with the subscription, formatted for display in the currency of your FastSpring disbursements
items.subscription.subtotal	number	subtotal for the subscription,including items.subscription.price and items.subscription.discount, but before tax
items.subscription.subtotalDisplay	string	subtotal for the subscription, formatted for display in items.subscription.currency
items.subscription.subtotalInPayoutCurrency	number	subtotal for the subscription, in the currency of your FastSpring disbursements
items.subscription.subtotalInPayoutCurrencyDisplay	string	subtotal for the subscription, formatted for display in the currency of your FastSpring disbursements
items.subscription.attributes	object	multiple-field object containing optional product-level attributes for the subscription (inherited from the subscription product)
items.subscription.next	integer	date of the next scheduled charge, in milliseconds
items.subscription.nextValue	integer	date of the next scheduled subscription charge (backward compatibility)
items.subscription.nextInSeconds	integer	date of the next scheduled subscription charge, in seconds
items.subscription.nextDisplay	string	date of the next scheduled subscription charge, formatted for display based on the language selected for the original subscription order
items.subscription.end	integer	expected end date of the subscription (if any), in milliseconds (e.g., for subscriptions with a pre-defined number of charges)
items.subscription.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)
items.subscription.endInSeconds	integer	expected end date of the subscription (if any), in seconds (e.g., for subscriptions with a pre-defined number of charges)
items.subscription.endDisplay	string	expected end date of the subscription (if any), formatted for display based on the language selected for the original subscription order
items.subscription.canceledDate	integer	date on which the subscription was canceled, in milliseconds, if applicable
items.subscription.canceledDateValue	integer	date on which the subscription was canceled, in milliseconds, if applicable (backward compatibility)
items.subscription.canceledDateInSeconds	integer	date on which the subscription was canceled, in seconds, if applicable
items.subscription.canceledDateDisplay	string	date on which the subscription was canceled, if applicable, formatted for display based on the language selected for the original subscription order
items.subscription.deactivationDate	integer	date on which the subscription was or will be deactivated, if applicable, in milliseconds (null if deactivated immediately upon cancellation)
items.subscription.deactivationDateValue	integer	date on which the subscription was or will be deactivated, if applicable, in milliseconds (null if deactivated immediately upon cancellation) (backward compatibility)
items.subscription.deactivationDateInSeconds	integer	date on which the subscription was or will be deactivated, if applicable, in seconds (null if deactivated immediately upon cancellation)
items.subscription.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)
items.subscription.sequence	integer	sequence number of the current billing period
items.subscription.periods	integer	expected total number of billing periods (e.g., for subscriptions with a pre-defined number of charges)
items.subscription.remainingPeriods	integer	number of periods remaining based on total number expected items.subscription.periods
items.subscription.begin	integer	date on which the subscription began, in milliseconds
items.subscription.beginValue	integer	date on which the subscription began, in milliseconds (backward compatibility)
items.subscription.beginInSeconds	integer	date on which the subscription began, in seconds
items.subscription.beginDisplay	string	date on which the subscription began, formatted for display based on the language selected for the original subscription order
items.subscription.intervalUnit	string	unit of time used in conjunction with items.subscription.intervalLength to determine the subscription's charge interval: "adhoc", "day", "week", "month", "year"
items.subscription.intervalLength	integer	number of intervalUnits per billing period for the subscription
items.subscription.trialReminder	object	defines the timing of the customer-facing reminder email message that will be sent (if any) regarding the approaching end of a free trial period
items.subscription.trialReminder.intervalUnit	string	unit of time used in conjunction with items.subscription.trialReminder.intervalLength to determine how long prior to the date of the first subscription charge the trial reminder message will be sent: "day", "week", "month", "year"
items.subscription.trialReminder.intervalLength	integer	number of items.subscription.trialReminder.intervalUnits prior to the date of the first subscription charge the trial reminder message will be sent
items.subscription.paymentReminder	object	defines the timing of the customer-facing reminder email message sent before each scheduled subscription billing
items.subscription.paymentReminder.intervalUnit	string	unit of time used in conjunction with items.subscription.paymentReminder.intervalLength to determine how long prior to the date of the first subscription charge the trial reminder message will be sent: "day", "week", "month", "year"
items.subscription.paymentReminder.intervalLength	integer	number of items.subscription.paymentReminder.intervalUnits prior to each scheduled subscription billing that the pament reminder message will be sent
items.subscription.paymentOverdue	object	defines the timing of the customer-facing payment overdue notification message(s) sent when a scheduled billing has failed
items.subscription.paymentOverdue.intervalUnit	string	unit of time used in conjunction with items.subscription.paymentOverdue.intervalLength to determine how long after a failed subscription billing a payment overdue notification will be sent (or how long after a prior payment overdue notification message has been sent): "day", "week", "month", "year"
items.subscription.paymentOverdue.intervalLength	integer	number items.subscription.paymentOverdue.intervalUnits following the failed subscription billing that the first payment overdue notification will be sent - and number of items.subscription.paymentOverdue.intervalUnits between subsequent payment overdue notifications, if any
items.subscription.paymentOverdue.total	integer	total number of payment overdue notifications to be sent, including the first one
items.subscription.paymentOverdue.sent	integer	number of payment overdue notifcations that have been sent to date
items.subscription.cancellationSetting	object	defines the timing of automatic subscription cancellation in the event of a failed subscription billing
items.subscription.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"
items.subscription.cancellationSetting.intervalUnit	string	unit of time used in conjunction with items.subscription.cancellationSetting.intervalLength and items.subscription.cancellationSetting.cancellation to determine when a subscription will be canceled as a result of a failed subscription billing
items.subscription.cancellationSetting.intervalLength	integer	number of items.subscription.cancellationSetting.intervalUnits following the items.subscription.cancellationSetting.cancellation event trigger that the subscription will be canceled due to a failed subscription billing
items.subscription.discounts	array	information about the coupon applied to the subscription (if any)
items.subscription.discounts.totalDiscountValue	number	total amount of the discount that will be applied, based on items.subscription.discounts.discountValue multiplied by items.subscription.discounts.discountDuration (only present when the discount type is an amount rather than a percentage)
items.subscription.discounts.discountPath	string	coupon ID of the coupon applied to the subscription
items.subscription.discounts.discountDuration	integer	total number of billings, including the original order, to which the coupon discount will be applied
items.subscription.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)
items.subscription.discounts.discountValue	number	amount of the discount per billing period, in the items.subscription.currency (only present when the discount type is an amount rather than a percentage)
items.subscription.instructions	array	instructions for recurring billings
items.subscription.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)
items.subscription.instructions.periodStartDate	integer	date of the beginning of the instruction period, in milliseconds
items.subscription.instructions.periodStartDateValue	integer	date of the beginning of the instruction period, in milliseconds (backward compatiblity)
items.subscription.instructions.periodStartDateInSeconds	integer	date of the beginning of the instruction period, in seconds
items.subscription.instructions.periodStartDateDisplay	string	date of the beginning of the instruction period, formatted for display based on the language selected for the original subscription order
items.subscription.instructions.periodEndDate	integer	date of the end of the instruction period, in milliseconds
items.subscription.instructions.periodEndDateValue	integer	date of the end of the instruction period, in milliseconds (backward compatibility)
items.subscription.instructions.periodEndDateInSeconds	integer	date of the end of the instruction period, in seconds
items.subscription.instructions.periodEndDateDisplay	string	date of the end of the instruction period, formatted for display based on the language selected for the original subscription order
items.subscription.instructions.discountDurationUnit	string	only appears when type = "discounted" or "trial"; unit of time used in conjunction with discountDurationLength to determine the total discount duration: "day", "week", "month", or "year"
items.subscription.instructions.discountDurationLength	integer	only appears when type = "discounted" or "trial"; number of discountDurationUnits in the total discount period
items.subscription.instructions.discountPercent	integer	percentage of the discount for the current instruction period
items.subscription.instructions.discountPercentValue	integer	percentage of the discount for the current instruction period (backward compatibility)
items.subscription.instructions.discountPercentDisplay	string	percentage of the discount for the current instruction period, formatted for display
items.subscription.instructions.discountTotal	number	total amount of the discount for the current instruction period, in the items.subscription.currency
items.subscription.instructions.discountTotalDisplay	string	total amount of the discount for the current instruction period, formatted for display based on the items.subscription.currency
items.subscription.instructions.discountTotalInPayoutCurrency	number	total amount of the discount for the current instruction period, in the currency of your FastSpring disbursements
items.subscription.instructions.discountTotalInPayoutCurrencyDisplay	string	total amount of the discount for the current instruction period, formatted for display in the currency of your FastSpring disbursements
items.subscription.instructions.unitDiscount	number	discount amount per unit for the current instruction period, in the items.subscription.currency
items.subscription.instructions.unitDiscountDisplay	string	discount amount per unit for the current instruction period, formatted for display in the items.subscription.currency
items.subscription.instructions.unitDiscountInPayoutCurrency	number	discount amount per unit for the current instruction period, in the currency of your FastSpring disbursements
items.subscription.instructions.unitDiscountInPayoutCurrencyDisplay	string	discount amount per unit for the current instruction period, formatted for display in the currency of your FastSpring disbursements
items.subscription.instructions.price	number	list price of the product before any discounts, in the items.subscription.currency
items.subscription.instructions.priceDisplay	string	list price of the product before any discounts, formatted for display in the items.subscription.currency
items.subscription.instructions.priceInPayoutCurrency	number	list price of the product before any discounts, in the currency of your FastSpring disbursements
items.subscription.instructions.priceInPayoutCurrencyDisplay	string	list price of the product before any discounts, formatted for display in the currency of your FastSpring disbursements
items.subscription.instructions.priceTotal	number	product of (items.subscription.instructions.price * items.subscription.quantity), in the items.subscription.currency, for the current instruction period
items.subscription.instructions.priceTotalDisplay	string	product of (items.subscription.instructions.price * items.subscription.quantity), formatted for display in the items.subscription.currency, for the current instruction period
items.subscription.instructions.priceTotalInPayoutCurrency	number	product of (items.subscription.instructions.price * items.subscription.quantity), in the currency of your FastSpring disbursements, for the current instruction period
items.subscription.instructions.priceTotalInPayoutCurrencyDisplay	string	product of (items.subscription.instructions.price * items.subscription.quantity), formatted for display in the currency of your FastSpring disbursements, for the current instruction period
items.subscription.instructions.unitPrice	number	effective unit price after any discount, for the current instruction period, in the items.subscription.currency
items.subscription.instructions.unitPriceDisplay	string	effective unit price after any discount, for the current instruction period, formatted for display in the items.subscription.currency
items.subscription.instructions.unitPriceInPayoutCurrency	number	effective unit price after any discount, for the current instruction period, in the currency of your FastSpring disbursements
items.subscription.instructions.unitPriceInPayoutCurrencyDisplay	string	effective unit price after any discount, for the current instruction period, formatted for display in the currency of your FastSpring disbursements
items.subscription.instructions.total	number	product of (items.subscription.instructions.unitPrice * items.subscription.quantity) for the current instruction period, in the items.subscription.currency
items.subscription.instructions.totalDisplay	string	product of (items.subscription.instructions.unitPrice * items.subscription.quantity) for the current instruction period, formatted for display in the items.subscription.currency
items.subscription.instructions.totalInPayoutCurrency	number	product of (items.subscription.instructions.unitPrice * items.subscription.quantity) for the current instruction period, in the currency of your FastSpring disbursements
items.subscription.instructions.totalInPayoutCurrencyDisplay	string	product of (items.subscription.instructions.unitPrice * items.subscription.quantity) for the current instruction period, formatted for display in the currency of your FastSpring disbursements
items.subscription.customReferenceId	string (expansion enabled)	an optional value that you can add to a subscription instance via the FastSpring API using POST /subscriptions; only present when expansion is enabled
coupons	array	list of coupon IDs applied to the order (currently, only one coupon can be applied to an order)
quote	string	internal quote ID associated with the original order

Name

Type

Description

return

string

internal return ID

reference

string

customer-facing reference for the refund (not the original order)

completed

Boolean

false if the return has not been processed successfully

changed

integer

date of the last update to this refund record, in milliseconds

changedValue

integer

date of the last update to this refund record, in milliseconds (backward compatibility)

changedInSeconds

integer

date of the last update to this refund record, in seconds

changedDisplay

string

date of the last update to this refund record, formatted for display based on the language in which the order was processed, as selected by the customer

live

Boolean

false if the order that was returned was a test order

account

string (expansion disabled)
object (expansion enabled)

FastSpring-generated account ID of the customer account (expansion disabled)
account object with all account details (expansion enabled)

account.id

string

FastSpring-generated account ID of the customer account

account.account

string

FastSpring-generated account ID of the customer account (backward compatibility)

account.contact

object

customer's contact details from the customer account

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

currency

string

three-character ISO code for the order currency (and thus, the return currency)

payoutCurrency

string

three-character ISO code for the currency in which your disbursement will be made

totalReturn

number

total amount of the return in the original transaction's currency

totalReturnDisplay

string

total amount of the return, formatted for display based on the original transaction's currency

totalReturnInPayoutCurrency

number

total amount of the return, in the currency of your FastSpring disbursements

totalReturnInPayoutCurrencyDisplay

string

total amount of the return, formatted for display based on the currency of your FastSpring disbursements

tax

number

amount of tax returned, in the original transaction's currency

taxDisplay

string

amount of tax returned, formatted for display in the transaction's currency

taxInPayoutCurrency

number

amount of tax returned, in the currency of your FastSpring disbursements

taxInPayoutCurrencyDisplay

string

amount of tax returned, formatted for display in the currency of your FastSpring disbursements

subtotal

number

return subtotal (totalReturn - tax) in the transaction's currency

subtotalDisplay

string

return subtotal (totalReturn - tax), formatted for display in the transaction's currency

subtotalInPayoutCurrency

number

return subtotal in the currency of your FastSpring disbursements (totalReturnInPayoutCurrency - taxInPayoutCurrency)

subtotalInPayoutCurrencyDisplay

string

return subtotal, formatted for display in the currency of your FastSpring disbursements (totalReturnInPayoutCurrency - taxInPayoutCurrency)

totalRefundInPayoutCurrency

number

total amount of the return, in the currency of your FastSpring disbursements (backward compatibility)

payment

object

details about the original transaction's payment method (and thus, the payment method that is being refunded)

payment.type

string

payment method used for the order: "paypal", "amazon", "creditcard", "test", "bank", "alipay", "purchase-order", "free"

payment.creditcard

string

(appears when payment.type = creditcard); type of credit or debit card used for the order: "visa", "mastercard", "amex", "discover", "jcb", "carteblanche", "dinersclub", "unionpay"

payment.cardEnding

string

(appears when payment.type = creditcard); last four digits of the card number used for the order

payment.bank

string

(appears when payment.type = bank); type of bank transfer used to pay for the order: "wire", "brazilwire", "ideal", "giropay", "sofort", "ecard", "sepa", "alipay"

reason

string

return reason type selected by you (or FastSpring) at the time of processing the return

note

string

optional note regarding the return, entered by you (or FastSpring) at the time of processing the return

type

string

return type: CHARGEBACK, PAYMENTRISK, PAYPAL, RETURN

original

object

details of the order being returned

original.id

string

internal order ID of the order being returned

original.order

string

internal order ID of the order being returned (backward compatibility)

original.reference

string

customer-facing order reference of the order being returned

original.account

string

FastSpring-generated customer account ID associated with the original order (always matches the account/account.id)

original.currency

string

three-character ISO code for the order currency

original.payoutCurrency

string

three-character ISO code for the currency of your FastSpring disbursements

original.total

number

total amount of the order in the original.currency

original.totalDisplay

string

total amount of the order, formatted for display in the original.currency

original.totalInPayoutCurrency

number

total amount of the order in the original.payoutCurrency

original.totalInPayoutCurrencyDisplay

string

total amount of the order, formatted for display in the original.payoutCurrency

original.tax

number

amount of tax in the original.currency

original.taxDisplay

string

amount of tax, formatted for display in the original.currency

original.taxInPayoutCurrency

number

amount of tax in the original.payoutCurrency

original.taxInPayoutCurrencyDisplay

string

amount of tax, formatted for display in the original.payoutCurrency

original.subtotal

number

order subtotal in the original.currency

original.subtotalDisplay

string

order subtotal, formatted for display in the original.currency

original.subtotalInPayoutCurrency

number

order subtotal in the original.payoutCurrency

original.subtotalInPayoutCurrencyDisplay

string

order subtotal, formatted for display in the original.payoutCurrency

notes

array

order notes from the original order, entered by you (or FastSpring); consists of one JSON object per note with two strings per object ("note" and "creator")

subscriptions

array

strings identifying the subscription IDs being returned, if any

customer

object

information about the customer being refunded, from the original order record (as opposed to the customer's account)

customer.first

string

customer's first name

customer.last

string

customer's last name

customer.email

string

customer's email address

customer.company

string

customers company name

customer.phone

string

customer's telephone number

items

array

details of the products being returned, one object per product

items.product

string

product path/product ID of the product

items.quantity

integer

quantity of the current product being returned

items.display

string

display name of the current product being returned

items.sku

string

optional internal SKU ID (e.g., your part number) of the current product being returned

items.subtotal

number

subtotal for the current product being returned, in the original.currency

items.subtotalDisplay

string

subtotal for the current product being returned, formatted for display in the original.currency

items.subtotalInPayoutCurrency

number

subtotal for the current product being returned, in the payout.currency

items.subtotalInPayoutCurrencyDisplay

string

subtotal for the current product being returned, formatted for display in the payout.currency

items.subscription

string (expansion disabled)
object (expansion enabled)

ID of the subscription associated with the product being returned, if applicable (expansion disabled)
details of the subscription associated with the product being returned, if applicable (expansion enabled)

items.subscription.id

string

ID of the subscription

items.subscription.subscription

string

ID of the subscription (backward compatibility)

items.subscription.active

Boolean

is the current subscription active? ("false" if deactivated)

items.subscription.state

string

current status of the subscription: "active", "overdue", "canceled", "deactivated", "trial"

items.subscription.changed

integer

date of the most recent change to the subscription, in milliseconds

items.subscription.changedValue

integer

date of the most recent change to the subscription, in milliseconds (backward compatibility)

items.subscription.changedInSeconds

integer

date of the most recent change to the subscription, in seconds

items.subscription.changedDisplay

string

date of the most recent change to the subscription, formatted for display based on the currency of the original order

items.subscription.live

Boolean

"true" if not a test order

items.subscription.currency

string

three-character ISO code for the currency associated with the subscription

items.subscription.account

string

FastSpring-generated customer account ID

items.subscription.product

string

product path/product ID of the subscription product

items.subscription.sku

string

optional internal SKU ID (e.g. your part number) for the current product

items.subscription.display

string

customer-facing Display name of the subscription product

items.subscription.quantity

integer

subscribed quantity of the subscription product

items.subscription.adhoc

Boolean

"true" for managed subscriptions, "false" for standard subscriptions

items.subscription.autoRenew

Boolean

"true" for automatic subscriptions, "false" for manual renewal subscriptions

items.subscription.price

number

price of the subscription; amount of each subscription charge, in items.subscription.currency

items.subscription.priceDisplay

string

price of subscription, formatted for display in items.subscription.currency

items.subscription.priceInPayoutCurrency

number

price of the subscription, in the currency of your FastSpring disbursements

items.subscription.priceInPayoutCurrencyDisplay

string

price of the subscription, formatted for display in the currency of your FastSpring disbursements

items.subscription.discount

number

total amount of all discounts associated with the subscription, in items.subscription.currency

items.subscription.discountDisplay

string

total amount of all discounts associated with the subscription, formatted for display in the items.subscription.currency

items.subscription.discountInPayoutCurrency

number

total amount of all discounts associated with the subscription, in the currency of your FastSpring disbursements

items.subscription.discountInPayoutCurrencyDisplay

string

total amount of all discounts associated with the subscription, formatted for display in the currency of your FastSpring disbursements

items.subscription.subtotal

number

subtotal for the subscription,including items.subscription.price and items.subscription.discount, but before tax

items.subscription.subtotalDisplay

string

subtotal for the subscription, formatted for display in items.subscription.currency

items.subscription.subtotalInPayoutCurrency

number

subtotal for the subscription, in the currency of your FastSpring disbursements

items.subscription.subtotalInPayoutCurrencyDisplay

string

subtotal for the subscription, formatted for display in the currency of your FastSpring disbursements

items.subscription.attributes

object

multiple-field object containing optional product-level attributes for the subscription (inherited from the subscription product)

items.subscription.next

integer

date of the next scheduled charge, in milliseconds

items.subscription.nextValue

integer

date of the next scheduled subscription charge (backward compatibility)

items.subscription.nextInSeconds

integer

date of the next scheduled subscription charge, in seconds

items.subscription.nextDisplay

string

date of the next scheduled subscription charge, formatted for display based on the language selected for the original subscription order

items.subscription.end

integer

expected end date of the subscription (if any), in milliseconds (e.g., for subscriptions with a pre-defined number of charges)

items.subscription.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)

items.subscription.endInSeconds

integer

expected end date of the subscription (if any), in seconds (e.g., for subscriptions with a pre-defined number of charges)

items.subscription.endDisplay

string

expected end date of the subscription (if any), formatted for display based on the language selected for the original subscription order

items.subscription.canceledDate

integer

date on which the subscription was canceled, in milliseconds, if applicable

items.subscription.canceledDateValue

integer

date on which the subscription was canceled, in milliseconds, if applicable (backward compatibility)

items.subscription.canceledDateInSeconds

integer

date on which the subscription was canceled, in seconds, if applicable

items.subscription.canceledDateDisplay

string

date on which the subscription was canceled, if applicable, formatted for display based on the language selected for the original subscription order

items.subscription.deactivationDate

integer

date on which the subscription was or will be deactivated, if applicable, in milliseconds (null if deactivated immediately upon cancellation)

items.subscription.deactivationDateValue

integer

date on which the subscription was or will be deactivated, if applicable, in milliseconds (null if deactivated immediately upon cancellation) (backward compatibility)

items.subscription.deactivationDateInSeconds

integer

date on which the subscription was or will be deactivated, if applicable, in seconds (null if deactivated immediately upon cancellation)

items.subscription.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)

items.subscription.sequence

integer

sequence number of the current billing period

items.subscription.periods

integer

expected total number of billing periods (e.g., for subscriptions with a pre-defined number of charges)

items.subscription.remainingPeriods

integer

number of periods remaining based on total number expected items.subscription.periods

items.subscription.begin

integer

date on which the subscription began, in milliseconds

items.subscription.beginValue

integer

date on which the subscription began, in milliseconds (backward compatibility)

items.subscription.beginInSeconds

integer

date on which the subscription began, in seconds

items.subscription.beginDisplay

string

date on which the subscription began, formatted for display based on the language selected for the original subscription order

items.subscription.intervalUnit

string

unit of time used in conjunction with items.subscription.intervalLength to determine the subscription's charge interval: "adhoc", "day", "week", "month", "year"

items.subscription.intervalLength

integer

number of intervalUnits per billing period for the subscription

items.subscription.trialReminder

object

defines the timing of the customer-facing reminder email message that will be sent (if any) regarding the approaching end of a free trial period

items.subscription.trialReminder.intervalUnit

string

unit of time used in conjunction with items.subscription.trialReminder.intervalLength to determine how long prior to the date of the first subscription charge the trial reminder message will be sent: "day", "week", "month", "year"

items.subscription.trialReminder.intervalLength

integer

number of items.subscription.trialReminder.intervalUnits prior to the date of the first subscription charge the trial reminder message will be sent

items.subscription.paymentReminder

object

defines the timing of the customer-facing reminder email message sent before each scheduled subscription billing

items.subscription.paymentReminder.intervalUnit

string

unit of time used in conjunction with items.subscription.paymentReminder.intervalLength to determine how long prior to the date of the first subscription charge the trial reminder message will be sent: "day", "week", "month", "year"

items.subscription.paymentReminder.intervalLength

integer

number of items.subscription.paymentReminder.intervalUnits prior to each scheduled subscription billing that the pament reminder message will be sent

items.subscription.paymentOverdue

object

defines the timing of the customer-facing payment overdue notification message(s) sent when a scheduled billing has failed

items.subscription.paymentOverdue.intervalUnit

string

unit of time used in conjunction with items.subscription.paymentOverdue.intervalLength to determine how long after a failed subscription billing a payment overdue notification will be sent (or how long after a prior payment overdue notification message has been sent): "day", "week", "month", "year"

items.subscription.paymentOverdue.intervalLength

integer

number items.subscription.paymentOverdue.intervalUnits following the failed subscription billing that the first payment overdue notification will be sent - and number of items.subscription.paymentOverdue.intervalUnits between subsequent payment overdue notifications, if any

items.subscription.paymentOverdue.total

integer

total number of payment overdue notifications to be sent, including the first one

items.subscription.paymentOverdue.sent

integer

number of payment overdue notifcations that have been sent to date

items.subscription.cancellationSetting

object

defines the timing of automatic subscription cancellation in the event of a failed subscription billing

items.subscription.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"

items.subscription.cancellationSetting.intervalUnit

string

unit of time used in conjunction with items.subscription.cancellationSetting.intervalLength and items.subscription.cancellationSetting.cancellation to determine when a subscription will be canceled as a result of a failed subscription billing

items.subscription.cancellationSetting.intervalLength

integer

number of items.subscription.cancellationSetting.intervalUnits following the items.subscription.cancellationSetting.cancellation event trigger that the subscription will be canceled due to a failed subscription billing

items.subscription.discounts

array

information about the coupon applied to the subscription (if any)

items.subscription.discounts.totalDiscountValue

number

total amount of the discount that will be applied, based on items.subscription.discounts.discountValue multiplied by items.subscription.discounts.discountDuration (only present when the discount type is an amount rather than a percentage)

items.subscription.discounts.discountPath

string

coupon ID of the coupon applied to the subscription

items.subscription.discounts.discountDuration

integer

total number of billings, including the original order, to which the coupon discount will be applied

items.subscription.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)

items.subscription.discounts.discountValue

number

amount of the discount per billing period, in the items.subscription.currency (only present when the discount type is an amount rather than a percentage)

items.subscription.instructions

array

instructions for recurring billings

items.subscription.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)

items.subscription.instructions.periodStartDate

integer

date of the beginning of the instruction period, in milliseconds

items.subscription.instructions.periodStartDateValue

integer

date of the beginning of the instruction period, in milliseconds (backward compatiblity)

items.subscription.instructions.periodStartDateInSeconds

integer

date of the beginning of the instruction period, in seconds

items.subscription.instructions.periodStartDateDisplay

string

date of the beginning of the instruction period, formatted for display based on the language selected for the original subscription order

items.subscription.instructions.periodEndDate

integer

date of the end of the instruction period, in milliseconds

items.subscription.instructions.periodEndDateValue

integer

date of the end of the instruction period, in milliseconds (backward compatibility)

items.subscription.instructions.periodEndDateInSeconds

integer

date of the end of the instruction period, in seconds

items.subscription.instructions.periodEndDateDisplay

string

date of the end of the instruction period, formatted for display based on the language selected for the original subscription order

items.subscription.instructions.discountDurationUnit

string

only appears when type = "discounted" or "trial"; unit of time used in conjunction with discountDurationLength to determine the total discount duration: "day", "week", "month", or "year"

items.subscription.instructions.discountDurationLength

integer

only appears when type = "discounted" or "trial"; number of discountDurationUnits in the total discount period

items.subscription.instructions.discountPercent

integer

percentage of the discount for the current instruction period

items.subscription.instructions.discountPercentValue

integer

percentage of the discount for the current instruction period (backward compatibility)

items.subscription.instructions.discountPercentDisplay

string

percentage of the discount for the current instruction period, formatted for display

items.subscription.instructions.discountTotal

number

total amount of the discount for the current instruction period, in the items.subscription.currency

items.subscription.instructions.discountTotalDisplay

string

total amount of the discount for the current instruction period, formatted for display based on the items.subscription.currency

items.subscription.instructions.discountTotalInPayoutCurrency

number

total amount of the discount for the current instruction period, in the currency of your FastSpring disbursements

items.subscription.instructions.discountTotalInPayoutCurrencyDisplay

string

total amount of the discount for the current instruction period, formatted for display in the currency of your FastSpring disbursements

items.subscription.instructions.unitDiscount

number

discount amount per unit for the current instruction period, in the items.subscription.currency

items.subscription.instructions.unitDiscountDisplay

string

discount amount per unit for the current instruction period, formatted for display in the items.subscription.currency

items.subscription.instructions.unitDiscountInPayoutCurrency

number

discount amount per unit for the current instruction period, in the currency of your FastSpring disbursements

items.subscription.instructions.unitDiscountInPayoutCurrencyDisplay

string

discount amount per unit for the current instruction period, formatted for display in the currency of your FastSpring disbursements

items.subscription.instructions.price

number

list price of the product before any discounts, in the items.subscription.currency

items.subscription.instructions.priceDisplay

string

list price of the product before any discounts, formatted for display in the items.subscription.currency

items.subscription.instructions.priceInPayoutCurrency

number

list price of the product before any discounts, in the currency of your FastSpring disbursements

items.subscription.instructions.priceInPayoutCurrencyDisplay

string

list price of the product before any discounts, formatted for display in the currency of your FastSpring disbursements

items.subscription.instructions.priceTotal

number

product of (items.subscription.instructions.price * items.subscription.quantity), in the items.subscription.currency, for the current instruction period

items.subscription.instructions.priceTotalDisplay

string

product of (items.subscription.instructions.price * items.subscription.quantity), formatted for display in the items.subscription.currency, for the current instruction period

items.subscription.instructions.priceTotalInPayoutCurrency

number

product of (items.subscription.instructions.price * items.subscription.quantity), in the currency of your FastSpring disbursements, for the current instruction period

items.subscription.instructions.priceTotalInPayoutCurrencyDisplay

string

product of (items.subscription.instructions.price * items.subscription.quantity), formatted for display in the currency of your FastSpring disbursements, for the current instruction period

items.subscription.instructions.unitPrice

number

effective unit price after any discount, for the current instruction period, in the items.subscription.currency

items.subscription.instructions.unitPriceDisplay

string

effective unit price after any discount, for the current instruction period, formatted for display in the items.subscription.currency

items.subscription.instructions.unitPriceInPayoutCurrency

number

effective unit price after any discount, for the current instruction period, in the currency of your FastSpring disbursements

items.subscription.instructions.unitPriceInPayoutCurrencyDisplay

string

effective unit price after any discount, for the current instruction period, formatted for display in the currency of your FastSpring disbursements

items.subscription.instructions.total

number

product of (items.subscription.instructions.unitPrice * items.subscription.quantity) for the current instruction period, in the items.subscription.currency

items.subscription.instructions.totalDisplay

string

product of (items.subscription.instructions.unitPrice * items.subscription.quantity) for the current instruction period, formatted for display in the items.subscription.currency

items.subscription.instructions.totalInPayoutCurrency

number

product of (items.subscription.instructions.unitPrice * items.subscription.quantity) for the current instruction period, in the currency of your FastSpring disbursements

items.subscription.instructions.totalInPayoutCurrencyDisplay

string

product of (items.subscription.instructions.unitPrice * items.subscription.quantity) for the current instruction period, formatted for display in the currency of your FastSpring disbursements

items.subscription.customReferenceId

string (expansion enabled)

an optional value that you can add to a subscription instance via the FastSpring API using POST /subscriptions; only present when expansion is enabled

coupons

array

list of coupon IDs applied to the order (currently, only one coupon can be applied to an order)

quote

string

internal quote ID associated with the original order

Examples

Example 1 - Webhook Expansion Disabled

return.created webhook example (webhook expansion disabled)

{ 
   "return":"wgfKsP9wR2-1yxGu39ThFQ",
   "quote":"QUOT2J52LKCFCHPOYSW6UTRMNZJA"
   "reference":"YES200312-2758-26120X",
   "completed":true,
   "changed":1471644016684,
   "changedValue":1471644016684,
   "changedInSeconds":1471644016,
   "changedDisplay":"8/19/16",
   "live":false,
   "account":"pXtfQN3RQKmVYWZJFX2GVA",
   "currency":"USD",
   "payoutCurrency":"USD",
   "totalReturn":4.95,
   "totalReturnDisplay":"$4.95",
   "totalReturnInPayoutCurrency":4.95,
   "totalReturnInPayoutCurrencyDisplay":"$4.95",
   "tax":0.0,
   "taxDisplay":"$0.00",
   "taxInPayoutCurrency":0.0,
   "taxInPayoutCurrencyDisplay":"$0.00",
   "subtotal":4.95,
   "subtotalDisplay":"$4.95",
   "subtotalInPayoutCurrency":4.95,
   "subtotalInPayoutCurrencyDisplay":"$4.95",
   "totalRefundInPayoutCurrency":4.95,
   "payment":{ 
      "type":"test",
      "cardEnding":"4242"
   },
   "reason":"Other Reason",
   "note":"Mac OS 10.5 not supported",
   "original":{ 
      "id":"1wA1nOASTPOW6SL3sC16Ww",
      "order":"1wA1nOASTPOW6SL3sC16Ww",
      "reference":"FUR160819-7349-98162",
      "account":"pXtfQN3RQKmVYWZJFX2GVA",
      "currency":"USD",
      "payoutCurrency":"USD",
      "total":4.95,
      "totalDisplay":"$4.95",
      "totalInPayoutCurrency":4.95,
      "totalInPayoutCurrencyDisplay":"$4.95",
      "tax":0.0,
      "taxDisplay":"$0.00",
      "taxInPayoutCurrency":0.0,
      "taxInPayoutCurrencyDisplay":"$0.00",
      "subtotal":4.95,
      "subtotalDisplay":"$4.95",
      "subtotalInPayoutCurrency":4.95,
      "subtotalInPayoutCurrencyDisplay":"$4.95",
      "notes":[ 
         { 
            "note":"This customer likes chicken.",
            "creator":"admin@yourexamplestore.com"
         }
      ]
   },
   "customer":{ 
      "first":"Leeroy",
      "last":"Jenkins",
      "email":"ne21@all.com",
      "company":null,
      "phone":null
   },
   "items":[ 
      { 
         "product":"example-product-3",
         "quantity":1,
         "display":"Example Product 3",
         "sku":"skuex3",
         "subtotal":4.95,
         "subtotalDisplay":"$4.95",
         "subtotalInPayoutCurrency":4.95,
         "subtotalInPayoutCurrencyDisplay":"$4.95"
      }
   ]
}

Example 2 - Webhook Expansion Enabled

return.created webhook example (webhook expansion enabled)

{  
   "return":"YG2tFjVqR5S6vdIDzlmX8Q",
   "quote":"QUOT2J52LKCFCHPOYSW6UTRMNZJA"
   "reference":"YES200312-2389-98118X",
   "completed":true,
   "changed":1507576575966,
   "changedValue":1507576575966,
   "changedInSeconds":1507576575,
   "changedDisplay":"10/9/17",
   "live":false,
   "account":{  
      "id":"uKj7izONRfanVwBL9eiG_A",
      "account":"uKj7izONRfanVwBL9eiG_A",
      "contact":{  
         "first":"Leeroy",
         "last":"Jenkins",
         "email":"ne1@all.com",
         "company":"Chicken Danger, Inc.",
         "phone":null
      },
      "language":"en",
      "country":"US",
      "lookup":{  
         "global":"5a0fwLTeQV6OPD34t89flg"
      },
      "url":"https://yourexamplestore.onfastspring.com/account""
   },
   "currency":"USD",
   "payoutCurrency":"USD",
   "totalReturn":9.95,
   "totalReturnDisplay":"$9.95",
   "totalReturnInPayoutCurrency":9.95,
   "totalReturnInPayoutCurrencyDisplay":"$9.95",
   "tax":0.0,
   "taxDisplay":"$0.00",
   "taxInPayoutCurrency":0.0,
   "taxInPayoutCurrencyDisplay":"$0.00",
   "subtotal":9.95,
   "subtotalDisplay":"$9.95",
   "subtotalInPayoutCurrency":9.95,
   "subtotalInPayoutCurrencyDisplay":"$9.95",
   "totalRefundInPayoutCurrency":9.95,
   "payment":{  
      "type":"test",
      "cardEnding":"4242"
   },
   "reason":"Compatibility Issues",
   "note":"OS 10.5 not supported",
   "original":{  
      "id":"xCFl0ZGmTMydMCZsCNaCRw",
      "order":"xCFl0ZGmTMydMCZsCNaCRw",
      "reference":"FUR170915-3234-96145",
      "account":"uKj7izONRfanVwBL9eiG_A",
      "currency":"USD",
      "payoutCurrency":"USD",
      "total":9.95,
      "totalDisplay":"$9.95",
      "totalInPayoutCurrency":9.95,
      "totalInPayoutCurrencyDisplay":"$9.95",
      "tax":0.0,
      "taxDisplay":"$0.00",
      "taxInPayoutCurrency":0.0,
      "taxInPayoutCurrencyDisplay":"$0.00",
      "subtotal":9.95,
      "subtotalDisplay":"$9.95",
      "subtotalInPayoutCurrency":9.95,
      "subtotalInPayoutCurrencyDisplay":"$9.95",
      "notes":[  

      ],
      "subscriptions":[  
         "XJtAgTkfQ2Ke6T7EmAfRzQ"
      ]
   },
   "customer":{  
      "first":"Leeroy",
      "last":"Jenkins",
      "email":"ne1@all.com",
      "company":"Chicken Danger, Inc.",
      "phone":null
   },
   "items":[  
      {  
         "product":"example-monthly-subscription",
         "quantity":1,
         "display":"Example Monthly Subscription",
         "sku":"skusub1",
         "subtotal":9.95,
         "subtotalDisplay":"$9.95",
         "subtotalInPayoutCurrency":9.95,
         "subtotalInPayoutCurrencyDisplay":"$9.95",
         "subscription":{  
            "id":"XJtAgTkfQ2Ke6T7EmAfRzQ",
            "subscription":"XJtAgTkfQ2Ke6T7EmAfRzQ",
            "active":false,
            "state":"deactivated",
            "changed":1505499425887,
            "changedValue":1505499425887,
            "changedInSeconds":1505499425,
            "changedDisplay":"9/15/17",
            "live":false,
            "currency":"USD",
            "account":"uKj7izONRfanVwBL9eiG_A",
            "product":"example-monthly-subscription",
            "sku":"falcon11",
            "display":"Example Monthly Subscription",
            "quantity":1,
            "adhoc":false,
            "autoRenew":true,
            "price":9.95,
            "priceDisplay":"$9.95",
            "priceInPayoutCurrency":9.95,
            "priceInPayoutCurrencyDisplay":"$9.95",
            "discount":0.0,
            "discountDisplay":"$0.00",
            "discountInPayoutCurrency":0.0,
            "discountInPayoutCurrencyDisplay":"$0.00",
            "subtotal":9.95,
            "subtotalDisplay":"$9.95",
            "subtotalInPayoutCurrency":9.95,
            "subtotalInPayoutCurrencyDisplay":"$9.95",
            "next":1508025600000,
            "nextValue":1508025600000,
            "nextInSeconds":1508025600,
            "nextDisplay":"10/15/17",
            "end":1505433600000,
            "endValue":1505433600000,
            "endInSeconds":1505433600,
            "endDisplay":"9/15/17",
            "canceledDate":1505433600000,
            "canceledDateValue":1505433600000,
            "canceledDateInSeconds":1505433600,
            "canceledDateDisplay":"9/15/17",
            "deactivationDate":null,
            "deactivationDateValue":null,
            "deactivationDateInSeconds":null,
            "deactivationDateDisplay":null,
            "sequence":1,
            "periods":0,
            "remainingPeriods":0,
            "begin":1505433600000,
            "beginValue":1505433600000,
            "beginInSeconds":1505433600,
            "beginDisplay":"9/15/17",
            "intervalUnit":"month",
            "intervalLength":1,
            "paymentReminder":{  
               "intervalUnit":"day",
               "intervalLength":7
            },
            "paymentOverdue":{  
               "intervalUnit":"week",
               "intervalLength":1,
               "total":2,
               "sent":0
            },
            "cancellationSetting":{  
               "cancellation":"AFTER_LAST_NOTIFICATION",
               "intervalUnit":"week",
               "intervalLength":1
            },
            "instructions":[  
               {  
                  "type":"regular",
                  "periodStartDate":null,
                  "periodStartDateValue":null,
                  "periodStartDateInSeconds":null,
                  "periodStartDateDisplay":null,
                  "periodEndDate":1505433600000,
                  "periodEndDateValue":1505433600000,
                  "periodEndDateInSeconds":1505433600,
                  "periodEndDateDisplay":"9/15/17",
                  "discountPercent":0,
                  "discountPercentValue":0,
                  "discountPercentDisplay":"0%",
                  "discountTotal":0.0,
                  "discountTotalDisplay":"$0.00",
                  "discountTotalInPayoutCurrency":0.0,
                  "discountTotalInPayoutCurrencyDisplay":"$0.00",
                  "unitDiscount":0.0,
                  "unitDiscountDisplay":"$0.00",
                  "unitDiscountInPayoutCurrency":0.0,
                  "unitDiscountInPayoutCurrencyDisplay":"$0.00",
                  "price":9.95,
                  "priceDisplay":"$9.95",
                  "priceInPayoutCurrency":9.95,
                  "priceInPayoutCurrencyDisplay":"$9.95",
                  "priceTotal":9.95,
                  "priceTotalDisplay":"$9.95",
                  "priceTotalInPayoutCurrency":9.95,
                  "priceTotalInPayoutCurrencyDisplay":"$9.95",
                  "unitPrice":9.95,
                  "unitPriceDisplay":"$9.95",
                  "unitPriceInPayoutCurrency":9.95,
                  "unitPriceInPayoutCurrencyDisplay":"$9.95",
                  "total":9.95,
                  "totalDisplay":"$9.95",
                  "totalInPayoutCurrency":9.95,
                  "totalInPayoutCurrencyDisplay":"$9.95"
               }
            ],
            "customReferenceID":"867-5309"
         }
      }
   ]
}