Skip to content

Latest commit

 

History

History
66 lines (54 loc) · 4.68 KB

File metadata and controls

66 lines (54 loc) · 4.68 KB

AutoOrderItem

Properties

Name Type Description Notes
addOns List<AutoOrderAddonItem> Array of addon objects instructing which items to add to auto order and how many times they should be added. [optional]
arbitraryItemId String Arbitrary item id that should be rebilled instead of the normal schedule [optional]
arbitraryPercentageDiscount BigDecimal An arbitrary percentage discount to provide on future rebills [optional]
arbitraryQuantity BigDecimal Arbitrary quantity to rebill [optional]
arbitraryScheduleDays Integer The number of days to rebill if the frequency is set to an arbitrary number of days [optional]
arbitraryUnitCost BigDecimal Arbitrary unit cost that rebills of this item should occur at [optional]
arbitraryUnitCostRemainingOrders Integer The number of rebills to give the arbitrary unit cost on before reverting to normal pricing. [optional]
autoOrderItemOid Integer Primary key of AutoOrderItem [optional]
calculatedNextShipmentDts String Calculated Date/time that this item is scheduled to rebill. Will be null if no more shipments are going to occur on this item [optional]
firstOrderDts String Date/time of the first order of this item. Null if item added to auto order and has not been rebilled yet. [optional]
frequency FrequencyEnum Frequency of the rebill if not a fixed schedule [optional]
futureSchedules List<AutoOrderItemFutureSchedule> The future rebill schedule for this item up to the next ten rebills [optional]
lastOrderDts String Date/time of the last order of this item [optional]
lifeTimeValue BigDecimal The life time value of this item including the original purchase [optional]
nextItemId String Calculated next item id [optional]
nextPreshipmentNoticeDts String The date/time of when the next pre-shipment notice should be sent [optional]
nextShipmentDts String Date/time that this item is scheduled to rebill [optional]
noOrderAfterDts String Date/time after which no additional rebills of this item should occur [optional]
numberOfRebills Integer The number of times this item has rebilled [optional]
options List<AutoOrderItemOption> Options associated with this item [optional]
originalItemId String The original item id purchased. This item controls scheduling. If you wish to modify a schedule, for example, from monthly to yearly, change this item from your monthly item to your yearly item, and then change the next_shipment_dts to your desired date. [optional]
originalQuantity BigDecimal The original quantity purchased [optional]
paused Boolean True if paused. This field is an object instead of a primitive for backwards compatibility. [optional]
paypalPayerId String The PayPal Payer ID tied to this item [optional]
paypalRecurringPaymentProfileId String The PayPal Profile ID tied to this item [optional]
preshipmentNoticeSent Boolean True if the preshipment notice associated with the next rebill has been sent [optional]
properties List<AutoOrderProperty> Array of property objects [optional]
rebillValue BigDecimal The value of the rebills of this item [optional]
remainingRepeatCount Integer The number of rebills remaining before this item is complete [optional]
simpleSchedule AutoOrderItemSimpleSchedule [optional]

Enum: FrequencyEnum

Name Value
WEEKLY "Weekly"
BIWEEKLY "Biweekly"
EVERY_ "Every..."
EVERY_10_DAYS "Every 10 Days"
EVERY_24_DAYS "Every 24 Days"
EVERY_28_DAYS "Every 28 Days"
MONTHLY "Monthly"
EVERY_45_DAYS "Every 45 Days"
EVERY_2_MONTHS "Every 2 Months"
EVERY_3_MONTHS "Every 3 Months"
EVERY_4_MONTHS "Every 4 Months"
EVERY_5_MONTHS "Every 5 Months"
EVERY_6_MONTHS "Every 6 Months"
YEARLY "Yearly"
EVERY_4_WEEKS "Every 4 Weeks"
EVERY_6_WEEKS "Every 6 Weeks"
EVERY_8_WEEKS "Every 8 Weeks"