Order Callback Request Schema


The order callback requests you received from Subscribe Pro will contain full details about the order which is to be placed.

PropertyDetails
allowSomeFailedItems bool
Allow Some Failed Items
Default: false
The Subscribe Pro environment where this order was triggered is configured to allow partial orders - order attempts where at least 1 subscription item failed to be ordered and at least 1 item was successfully ordered.
customerId (required)string
Subscribe Pro Customer ID
customerEmail (required)string
Customer Email
platformCustomerId (required)string
eCommerce Platform Customer ID
salesOrderToken string
Sales Order Token
This is a unique token provided by Subscribe Pro when placing an order. It uniquely represents this request. Pass this token back to Subscribe Pro if it is necessary to make any API requests back to Subscribe Pro during the order placement process.
shippingMethodCode string
Shipping Method Code
Code that represents which shipping carrier and method should be used for this order.
Example: "flat_rate", "free_shipping" OR "ups_ground"

currency (required)string
Currency Code
3 Digit ISO Currency Code.
Example: "USD"

payment (required)object
Payment Details
Payment details specifying how this order should be paid.
payment.paymentToken string
Payment Token
Unique payment token that represents the payment method or payment profile which should be used to pay for this order.
payment.paymentProfileId string
Subscribe Pro Payment Profile ID
Unique ID of a Subscribe Pro payment profile which should be used to pay for this order.
payment.paymentProfileType string
Subscribe Pro Payment Profile Type
Type of a Subscribe Pro payment profile which should be used to pay for this order. See: GET /services/v2/vault/paymentprofiles/{id}
payment.paymentMethodType string
Subscribe Pro Payment Method Type
Type of payment method for payment profile.
Example: "creditcard"

payment.creditcardType string
Credit Card Type
One of: "visa", "master", "discover", "american_express", etc
payment.creditcardMonth string
Credit Card Expiration Month
2 digit expiration date month.
payment.creditcardYear string
Credit Card Expiration Year
4 digit expiration date year.
payment.creditcardLastDigits string
Credit Card Last Digits
Last 4 digits of card number that are safe to display.
couponCodes array
Coupon Codes
Array of coupon codes (string). These are listed in priority order and should be applied to the cart which is generated in this order.
billingAddress (required)object
Billing Address
Customer's billing address associated with the order.
billingAddress.firstName (required)string
First Name
billingAddress.lastName (required)string
Last Name
billingAddress.company string
Company
Company name associated with the address
billingAddress.street1 string
Street Address Line 1
billingAddress.street2 string
Street Address Line 2
billingAddress.city string
City
billingAddress.region string
Region
Region, state or province
billingAddress.postcode string
Postcode
billingAddress.country string
Country
Country name, code or abbreviation
billingAddress.countryName string
Country Name
billingAddress.phone string
Phone
The phone number associated with the address.
shippingAddress object
Shipping Address
Customer's shipping address associated with the order.
shippingAddress.firstName string
First Name
shippingAddress.lastName string
Last Name
shippingAddress.company string
Company
Company name associated with the address
shippingAddress.street1 string
Street Address Line 1
shippingAddress.street2 string
Street Address Line 2
shippingAddress.city string
City
shippingAddress.region string
Region
Region, state or province
shippingAddress.postcode string
Postcode
shippingAddress.country string
Country
Country name, code or abbreviation
shippingAddress.countryName string
Country Name
shippingAddress.phone string
Phone
The phone number associated with the address.
items (required)array
Items
Array of order line items for this order.
items[].productSku (required)string
Product SKU
The product SKU should be used to uniquely identify which product to order for this line item.
items[].shortDescription string
Line Item Short Description
This is the line item description for display on order emails, invoices, packing slips, etc.
items[].qty (required)string
Quantity
Quantity for the line item.
Example: "2.00"

items[].requiresShipping boolean
Requires Shipping
Default: true
Does this line item require shipping to the customer?
items[].useFixedPrice bool
Use Fixed Price
Default: false
Should a fixed price be used for this item?
items[].fixedPrice string
Fixed Price
Fixed price (unit price) to use for this line item. This price should override any pricing that would otherwise be calculated by the handling system.
Example: "30.2000"

items[].subscription object
Subscription
Details about the Subscribe Pro subscription record which is being ordered with this line item.
items[].subscription.id string
Subscription ID
Subscribe Pro subscription ID of the subscription item which is associated with this line item.
items[].subscription.interval string
Current Subscription Frequency Interval
The current frequency interval set on the subscription item at the time order was requested.
items[].subscription.scheduleName string
Current Subscription Schedule Name
The current schedule name of the schedule set on the subscription item at the time order was requested.
items[].subscription.reorderOrdinal string
Current Subscription Reorder Ordinal
The current order will represent the Nth order against this subscription item.
items[].subscription.nextOrderDate string
Subscription Next Order Date
The expected next order date for this subscription item (assuming the current order is successful).
items[].subscription.userDefinedFields array
Subscription User Defined Fields
An array of user defined fields which are currently stored on the subscription item.
items[].subscription.magento2ProductOptions array
Magento 2 Product Options
In the case that the order callback is used with a Magento 2 integration, this field contains an array of Magento 2 product options data which is stored on the subscription item.