id | string (<= 32) | Item SKU | Yes | |
desc | string (<= 255) | Item Description | Yes | |
amt | float | Item Unit Price/Amount (item unit amount is multiplied by item quantity to calculate the item total) | Yes | |
qty | int | Item Quantity | No1 | 1 |
hide_qty | boolean | Set to 'true' to hide item quantity for display purposes if quantity is not applicable for the item | No1 | false |
is_pledge | boolean | Set to 'true' to have the software treat the item amount as a total pledge amount and work backwards to figure out what the recurring installment amounts should be | No1 | false |
amt_today | float | Different amount to charge today from the regular installment amount; omit or set to 0 to charge regular installment amount today3 | No1 | 0 |
first_charge_date | date | When to process the charge for this item (defaults to today); max 6 months | No1 | 2024-12-26 |
recur_first_charge_date | date | When to process the first follow-on charge for this item3 | No1 | |
recur_freq | int | 0 (One Time), 1 (Weekly), 2 (Every Other Week), 3 (Monthly), 4 (Quarterly), 5 (Half-Yearly), 6 (Yearly) | No1 | 0 |
recur_end_criteria | int | 02 (Ongoing), 1 (End After Number of Payments), 22 (End After Total Amount Paid), 3 (End By Given Date)3 | No1 | 0 |
recur_end_value | string (<= 18) | if 'recur_end_criteria' == 1 then int (number of payments to process), if 'recur_end_criteria' == 2 then float (total amount to process), if 'recur_end_criteria' == 3 then date (date to end processing)3 | No1 | |
sub_id1 | string (<= 64) | Item Sub ID | No1 | |
sub_id2 | string (<= 64) | Item Sub ID | No1 | |
sub_id3 | string (<= 64) | Item Sub ID | No1 | |
sub_id4 | string (<= 64) | Item Sub ID | No1 | |
sub_id5 | string (<= 64) | Item Sub ID | No1 | |
sub_id6 | string (<= 64) | Item Sub ID | No1 | |
sub_id7 | string (<= 64) | Item Sub ID | No1 | |