---
title: "Bulk Retry the Bills"
method: PUT
path: "/vendor/bill/bulk-retry"
tags: ["Bill"]
---
# Bulk Retry the Bills
`PUT /vendor/bill/bulk-retry`
## Query parameters
- `pageSize` string
- `pageNumber` string
- `orderBy` object
- `filterLike` object
- `filterBefore` object
- `filterAfter` object
## Request body
- object
- `billIds` string[]
## Response `200`
Successful response
- IBillWithPurchStAndCustomerRelationshipPaginatedResponse
- `totalCount` number, required
- `totalPages` number, required
- `pageSize` number, required
- `pageNumber` number, required
- `data` IBillWithPurchStAndCustomerRelationship[], required
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `id` number, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `uniqueId` string, required
- `billPaymentExternalId` string
- `billAmount` string, required
- `billCurrency` string, required
- `status` 'pending' | 'processing' | 'succeeded' | 'failed' | 'canceled', required
- `metadata` object, required
- `billingDate` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `retryCount` number, required
- `order` ISmartrrOrder
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyId` string
- `receivedFromShopifyDate` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyUpdateDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `totalFromLineItems` string, required
- `totalLineItemsDiscount` string, required
- `totalLineItemsAfterDiscount` string, required
- `totalShipping` string, required
- `totalDiscount` string, required
- `shopifyOrderLabel` string
- `orderProcessedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `orderStatus` 'open' | 'closed' | 'cancelled', required — - `open`: being fulfilled / is fulfilled - `closed`: either fulfilled or "archived" by vendor - `cancelled`: cancelled by vendor
- `financialStatus` 'failed' | 'pending' | 'authorized' | 'paid' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'voided', required — Shopify has all except `failed`
- `fulfillmentStatus` 'unshipped' | 'partial' | 'fulfilled' | 'restocked', required — `partial` means partially shipped
- `deliveryAddress` IMailingAddressJson
- `latitude` number, nullable
- `longitude` number, nullable
- `city` string
- `province` string
- `provinceCode` string — The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.
- `zip` string
- `country` string
- `countryCode` 'AF' | 'AX' | 'AL' | 'DZ' | 'AD' | 'AO' | 'AI' | 'AG' | 'AR' | 'AM' | 'AW' | 'AC' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CA' | 'CV' | 'BQ' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'CI' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'XK' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MK' | 'NO' | 'OM' | 'PK' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'QA' | 'CM' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'KR' | 'SS' | 'ES' | 'LK' | 'VC' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TA' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'ZZ' — ISO 3166-1 alpha-2 country codes with some differences
- `address1` string
- `address2` string
- `shopifyId` string
- `email` string
- `phone` string — Formatted using E.164 standard. For example, _+16135551111_.
- `firstName` string
- `lastName` string
- `company` string
- `deliveryLatitude` number
- `deliveryLongitude` number
- `deliveryProvinceCode` string
- `deliveryCountryCode` string
- `orderSource` 'Shopify' | 'Smartrr' | 'Recharge' | 'Other', required
- `orderCurrency` 'STN' | 'VED' | 'USD' | 'USDC' | 'EUR' | 'GBP' | 'CAD' | 'AFN' | 'ALL' | 'DZD' | 'AOA' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'BBD' | 'AZN' | 'BDT' | 'BSD' | 'BHD' | 'BIF' | 'BZD' | 'BMD' | 'BTN' | 'BAM' | 'BRL' | 'BOB' | 'BWP' | 'BND' | 'BGN' | 'MMK' | 'KHR' | 'CVE' | 'KYD' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DOP' | 'XCD' | 'EGP' | 'ETB' | 'XPF' | 'FJD' | 'GMD' | 'GHS' | 'GTQ' | 'GYD' | 'GEL' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'ILS' | 'IQD' | 'JMD' | 'JPY' | 'JEP' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'KGS' | 'LAK' | 'LVL' | 'LBP' | 'LSL' | 'LRD' | 'LTL' | 'MGA' | 'MKD' | 'MOP' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MUR' | 'MDL' | 'MAD' | 'MNT' | 'MZN' | 'NAD' | 'NPR' | 'ANG' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PAB' | 'PKR' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'WST' | 'SAR' | 'STD' | 'RSD' | 'SCR' | 'SGD' | 'SDG' | 'SYP' | 'ZAR' | 'KRW' | 'SSP' | 'SBD' | 'LKR' | 'SRD' | 'SZL' | 'SEK' | 'CHF' | 'TWD' | 'THB' | 'TZS' | 'TTD' | 'TND' | 'TRY' | 'TMT' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VUV' | 'VND' | 'XOF' | 'YER' | 'ZMW' | 'BYN' | 'BYR' | 'DJF' | 'ERN' | 'FKP' | 'GIP' | 'GNF' | 'IRR' | 'KID' | 'LYD' | 'MRU' | 'SLL' | 'SHP' | 'SOS' | 'TJS' | 'TOP' | 'VEF' | 'VES' | 'XXX', required
- `shopIncome` string, required
- `totalBeforeDiscountsAndRefunds` string, required
- `totalNetBeforeRefunds` string, required
- `totalTax` string, required
- `totalTip` string, required
- `totalRefund` string, required
- `totalNet` string, required
- `cancelReason` string
- `cancelledAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `totalOneTimeShopIncome` string, required
- `totalSubscriptionShopIncome` string, required
- `totalAddonShopIncome` string, required
- `items` ISmartrrOrderLineItem[], required
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyId` string
- `receivedFromShopifyDate` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyUpdateDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `quantity` number, required
- `shopIncome` string, required
- `price` string, required
- `priceCurrency` 'STN' | 'VED' | 'USD' | 'USDC' | 'EUR' | 'GBP' | 'CAD' | 'AFN' | 'ALL' | 'DZD' | 'AOA' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'BBD' | 'AZN' | 'BDT' | 'BSD' | 'BHD' | 'BIF' | 'BZD' | 'BMD' | 'BTN' | 'BAM' | 'BRL' | 'BOB' | 'BWP' | 'BND' | 'BGN' | 'MMK' | 'KHR' | 'CVE' | 'KYD' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DOP' | 'XCD' | 'EGP' | 'ETB' | 'XPF' | 'FJD' | 'GMD' | 'GHS' | 'GTQ' | 'GYD' | 'GEL' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'ILS' | 'IQD' | 'JMD' | 'JPY' | 'JEP' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'KGS' | 'LAK' | 'LVL' | 'LBP' | 'LSL' | 'LRD' | 'LTL' | 'MGA' | 'MKD' | 'MOP' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MUR' | 'MDL' | 'MAD' | 'MNT' | 'MZN' | 'NAD' | 'NPR' | 'ANG' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PAB' | 'PKR' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'WST' | 'SAR' | 'STD' | 'RSD' | 'SCR' | 'SGD' | 'SDG' | 'SYP' | 'ZAR' | 'KRW' | 'SSP' | 'SBD' | 'LKR' | 'SRD' | 'SZL' | 'SEK' | 'CHF' | 'TWD' | 'THB' | 'TZS' | 'TTD' | 'TND' | 'TRY' | 'TMT' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VUV' | 'VND' | 'XOF' | 'YER' | 'ZMW' | 'BYN' | 'BYR' | 'DJF' | 'ERN' | 'FKP' | 'GIP' | 'GNF' | 'IRR' | 'KID' | 'LYD' | 'MRU' | 'SLL' | 'SHP' | 'SOS' | 'TJS' | 'TOP' | 'VEF' | 'VES' | 'XXX', required
- `discountAmount` string, required
- `discountAllocations` IOrderLineItemDiscount[], required
- `allocationMethod` 0 | 1 | 2 — - 0: ACROSS - 1: EACH - 2: ONE
- `code` string
- `currency` 'STN' | 'VED' | 'USD' | 'USDC' | 'EUR' | 'GBP' | 'CAD' | 'AFN' | 'ALL' | 'DZD' | 'AOA' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'BBD' | 'AZN' | 'BDT' | 'BSD' | 'BHD' | 'BIF' | 'BZD' | 'BMD' | 'BTN' | 'BAM' | 'BRL' | 'BOB' | 'BWP' | 'BND' | 'BGN' | 'MMK' | 'KHR' | 'CVE' | 'KYD' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DOP' | 'XCD' | 'EGP' | 'ETB' | 'XPF' | 'FJD' | 'GMD' | 'GHS' | 'GTQ' | 'GYD' | 'GEL' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'ILS' | 'IQD' | 'JMD' | 'JPY' | 'JEP' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'KGS' | 'LAK' | 'LVL' | 'LBP' | 'LSL' | 'LRD' | 'LTL' | 'MGA' | 'MKD' | 'MOP' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MUR' | 'MDL' | 'MAD' | 'MNT' | 'MZN' | 'NAD' | 'NPR' | 'ANG' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PAB' | 'PKR' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'WST' | 'SAR' | 'STD' | 'RSD' | 'SCR' | 'SGD' | 'SDG' | 'SYP' | 'ZAR' | 'KRW' | 'SSP' | 'SBD' | 'LKR' | 'SRD' | 'SZL' | 'SEK' | 'CHF' | 'TWD' | 'THB' | 'TZS' | 'TTD' | 'TND' | 'TRY' | 'TMT' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VUV' | 'VND' | 'XOF' | 'YER' | 'ZMW' | 'BYN' | 'BYR' | 'DJF' | 'ERN' | 'FKP' | 'GIP' | 'GNF' | 'IRR' | 'KID' | 'LYD' | 'MRU' | 'SLL' | 'SHP' | 'SOS' | 'TJS' | 'TOP' | 'VEF' | 'VES' | 'XXX'
- `description` string
- `rejectionReason` string
- `recurringCycleLimit` number
- `targetSelection` 0 | 1 | 2 — - 0: ALL - 1: ENTITLED - 2: EXPLICIT
- `targetType` 0 | 1 — - 0: LINE_ITEM - 1: SHIPPING_LINE
- `title` string
- `type` 0 | 1 | 2 | 3, required — - 0: MANUAL - 1: SCRIPT - 2: DISCOUNT_CODE - 3: AUTOMATIC
- `value` number, required
- `valueType` 0 | 1, required — - 0: FIXED - 1: PERCENTAGE
- `vendorId` string
- `calculatedValue` number, required
- `isAddOn` boolean, required
- `shopifySubscriptionId` string
- `vnt` IPurchasableVariant
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyId` string
- `receivedFromShopifyDate` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyUpdateDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyProductVariantStorefrontId` string
- `purchasableVariantName` string
- `purchasableVariantImages` string[]
- `purchasableVariantSmallImages` string[]
- `isActiveInShopify` boolean, required
- `isDraftOrArchived` boolean
- `shopifyInventoryId` string
- `requiresShipping` boolean, required
- `sku` string
- `unitCost` number
- `presentmentPrices` PresentmentPrice[], required
- `price` string, required
- `priceCurrency` 'STN' | 'VED' | 'USD' | 'USDC' | 'EUR' | 'GBP' | 'CAD' | 'AFN' | 'ALL' | 'DZD' | 'AOA' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'BBD' | 'AZN' | 'BDT' | 'BSD' | 'BHD' | 'BIF' | 'BZD' | 'BMD' | 'BTN' | 'BAM' | 'BRL' | 'BOB' | 'BWP' | 'BND' | 'BGN' | 'MMK' | 'KHR' | 'CVE' | 'KYD' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DOP' | 'XCD' | 'EGP' | 'ETB' | 'XPF' | 'FJD' | 'GMD' | 'GHS' | 'GTQ' | 'GYD' | 'GEL' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'ILS' | 'IQD' | 'JMD' | 'JPY' | 'JEP' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'KGS' | 'LAK' | 'LVL' | 'LBP' | 'LSL' | 'LRD' | 'LTL' | 'MGA' | 'MKD' | 'MOP' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MUR' | 'MDL' | 'MAD' | 'MNT' | 'MZN' | 'NAD' | 'NPR' | 'ANG' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PAB' | 'PKR' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'WST' | 'SAR' | 'STD' | 'RSD' | 'SCR' | 'SGD' | 'SDG' | 'SYP' | 'ZAR' | 'KRW' | 'SSP' | 'SBD' | 'LKR' | 'SRD' | 'SZL' | 'SEK' | 'CHF' | 'TWD' | 'THB' | 'TZS' | 'TTD' | 'TND' | 'TRY' | 'TMT' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VUV' | 'VND' | 'XOF' | 'YER' | 'ZMW' | 'BYN' | 'BYR' | 'DJF' | 'ERN' | 'FKP' | 'GIP' | 'GNF' | 'IRR' | 'KID' | 'LYD' | 'MRU' | 'SLL' | 'SHP' | 'SOS' | 'TJS' | 'TOP' | 'VEF' | 'VES' | 'XXX', required
- `inventoryQuantity` number, nullable
- `inventoryPolicy` 'DENY' | 'CONTINUE', nullable — The inventory policy for a product variant controls whether customers can continue to buy the variant when it is out of stock. When the value is continue, customers are able to buy the variant when it's out of stock. When the value is deny, customers can't buy the variant when it's out of stock. * DENY: Stop selling a product variant when it is out of stock. * CONTINUE: Continue selling a product variant when it is out of stock.
- `taxLineItems` ISmartrrTaxLineItem[], required
- `price` number, required
- `rate` number, required
- `title` string, required
- `shippingLineItems` ISmartrrShippingLineItem[], required
- `price` number, required
- `title` string, required
- `shopifyHandle` string
- `discountApplications` IOrderDiscount[], required
- `allocationMethod` 0 | 1 | 2 — - 0: ACROSS - 1: EACH - 2: ONE
- `code` string
- `currency` 'STN' | 'VED' | 'USD' | 'USDC' | 'EUR' | 'GBP' | 'CAD' | 'AFN' | 'ALL' | 'DZD' | 'AOA' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'BBD' | 'AZN' | 'BDT' | 'BSD' | 'BHD' | 'BIF' | 'BZD' | 'BMD' | 'BTN' | 'BAM' | 'BRL' | 'BOB' | 'BWP' | 'BND' | 'BGN' | 'MMK' | 'KHR' | 'CVE' | 'KYD' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DOP' | 'XCD' | 'EGP' | 'ETB' | 'XPF' | 'FJD' | 'GMD' | 'GHS' | 'GTQ' | 'GYD' | 'GEL' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'ILS' | 'IQD' | 'JMD' | 'JPY' | 'JEP' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'KGS' | 'LAK' | 'LVL' | 'LBP' | 'LSL' | 'LRD' | 'LTL' | 'MGA' | 'MKD' | 'MOP' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MUR' | 'MDL' | 'MAD' | 'MNT' | 'MZN' | 'NAD' | 'NPR' | 'ANG' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PAB' | 'PKR' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'WST' | 'SAR' | 'STD' | 'RSD' | 'SCR' | 'SGD' | 'SDG' | 'SYP' | 'ZAR' | 'KRW' | 'SSP' | 'SBD' | 'LKR' | 'SRD' | 'SZL' | 'SEK' | 'CHF' | 'TWD' | 'THB' | 'TZS' | 'TTD' | 'TND' | 'TRY' | 'TMT' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VUV' | 'VND' | 'XOF' | 'YER' | 'ZMW' | 'BYN' | 'BYR' | 'DJF' | 'ERN' | 'FKP' | 'GIP' | 'GNF' | 'IRR' | 'KID' | 'LYD' | 'MRU' | 'SLL' | 'SHP' | 'SOS' | 'TJS' | 'TOP' | 'VEF' | 'VES' | 'XXX'
- `description` string
- `rejectionReason` string
- `recurringCycleLimit` number
- `targetSelection` 0 | 1 | 2 — - 0: ALL - 1: ENTITLED - 2: EXPLICIT
- `targetType` 0 | 1 — - 0: LINE_ITEM - 1: SHIPPING_LINE
- `title` string
- `type` 0 | 1 | 2 | 3, required — - 0: MANUAL - 1: SCRIPT - 2: DISCOUNT_CODE - 3: AUTOMATIC
- `value` number, required
- `valueType` 0 | 1, required — - 0: FIXED - 1: PERCENTAGE
- `vendorId` string
- `refundLineItems` ISmartrrRefundLineItem[], required
- `price` number, required
- `lineItemId` string
- `refundOrderAdjustments` ISmartrrOrderAdjustment[], required
- `price` number, required
- `reason` string, required
- `trackingInfo` ISmartrrTrackingInfo[], required
- union
- ISmartrrCompanyAndNumberTrackingInfo
- `trackingCompany` string, required
- `trackingNumbers` string[], required
- `trackingUrls` string[]
- ISmartrrUrlTrackingInfo
- `trackingCompany` string
- `trackingNumbers` string[]
- `trackingUrls` string[], required
- `pmtMthJson` IPaymentMethodJson
- `maskedNumber` string, nullable
- `cardBrand` string, nullable
- `cardExpirationMonth` number, nullable
- `cardExpirationYear` number, nullable
- `lastDigits` string, nullable
- `custRel` ICustomerRelationship
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyId` string
- `receivedFromShopifyDate` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyUpdateDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `email` string
- `phone` string
- `inferredPhone` string
- `firstName` string
- `lastName` string
- `isSuperUser` boolean
- `role` 'individualCustomer' | 'customerOrgAdmin' | 'customerOrgEmployee', required
- `__stripeCustomerId__` string
- `customerCurrency` 'STN' | 'VED' | 'USD' | 'USDC' | 'EUR' | 'GBP' | 'CAD' | 'AFN' | 'ALL' | 'DZD' | 'AOA' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'BBD' | 'AZN' | 'BDT' | 'BSD' | 'BHD' | 'BIF' | 'BZD' | 'BMD' | 'BTN' | 'BAM' | 'BRL' | 'BOB' | 'BWP' | 'BND' | 'BGN' | 'MMK' | 'KHR' | 'CVE' | 'KYD' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DOP' | 'XCD' | 'EGP' | 'ETB' | 'XPF' | 'FJD' | 'GMD' | 'GHS' | 'GTQ' | 'GYD' | 'GEL' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'ILS' | 'IQD' | 'JMD' | 'JPY' | 'JEP' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'KGS' | 'LAK' | 'LVL' | 'LBP' | 'LSL' | 'LRD' | 'LTL' | 'MGA' | 'MKD' | 'MOP' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MUR' | 'MDL' | 'MAD' | 'MNT' | 'MZN' | 'NAD' | 'NPR' | 'ANG' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PAB' | 'PKR' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'WST' | 'SAR' | 'STD' | 'RSD' | 'SCR' | 'SGD' | 'SDG' | 'SYP' | 'ZAR' | 'KRW' | 'SSP' | 'SBD' | 'LKR' | 'SRD' | 'SZL' | 'SEK' | 'CHF' | 'TWD' | 'THB' | 'TZS' | 'TTD' | 'TND' | 'TRY' | 'TMT' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VUV' | 'VND' | 'XOF' | 'YER' | 'ZMW' | 'BYN' | 'BYR' | 'DJF' | 'ERN' | 'FKP' | 'GIP' | 'GNF' | 'IRR' | 'KID' | 'LYD' | 'MRU' | 'SLL' | 'SHP' | 'SOS' | 'TJS' | 'TOP' | 'VEF' | 'VES' | 'XXX', required
- `orderCount` number, required
- `customAttributes` object
- `totalSpent` string, required
- `hasLoggedIn` boolean
- `defaultAddress` object
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyId` string
- `receivedFromShopifyDate` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyUpdateDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `latitude` number, nullable
- `longitude` number, nullable
- `city` string
- `province` string
- `provinceCode` string — The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.
- `zip` string
- `country` string
- `countryCode` 'AF' | 'AX' | 'AL' | 'DZ' | 'AD' | 'AO' | 'AI' | 'AG' | 'AR' | 'AM' | 'AW' | 'AC' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CA' | 'CV' | 'BQ' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'CI' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'XK' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MK' | 'NO' | 'OM' | 'PK' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'QA' | 'CM' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'KR' | 'SS' | 'ES' | 'LK' | 'VC' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TA' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'ZZ' — ISO 3166-1 alpha-2 country codes with some differences
- `address1` string
- `address2` string
- `email` string
- `phone` string — Formatted using E.164 standard. For example, _+16135551111_.
- `firstName` string
- `lastName` string
- `company` string
- `addressType` 'FOR_CUSTOMER' | 'GIFTING', required — * FOR_CUSTOMER: this type is for both a billing and mailing address: https://shopify.dev/docs/admin-api/graphql/reference/common-objects/mailingaddress
- `sellingOrganization` IOrganization, required
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `billingTime` string, required — A time component in ISO format: HH:mm:ss
- `billingTimezone` 'Africa/Abidjan' | 'Africa/Accra' | 'Africa/Addis_Ababa' | 'Africa/Algiers' | 'Africa/Asmara' | 'Africa/Asmera' | 'Africa/Bamako' | 'Africa/Bangui' | 'Africa/Banjul' | 'Africa/Blantyre' | 'Africa/Brazzaville' | 'Africa/Bujumbura' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/Conakry' | 'Africa/Dakar' | 'Africa/Dar_es_Salaam' | 'Africa/Djibouti' | 'Africa/Douala' | 'Africa/El_Aaiun' | 'Africa/Freetown' | 'Africa/Gaborone' | 'Africa/Harare' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Kampala' | 'Africa/Khartoum' | 'Africa/Kigali' | 'Africa/Kinshasa' | 'Africa/Lagos' | 'Africa/Libreville' | 'Africa/Lome' | 'Africa/Luanda' | 'Africa/Lubumbashi' | 'Africa/Lusaka' | 'Africa/Malabo' | 'Africa/Maputo' | 'Africa/Maseru' | 'Africa/Mbabane' | 'Africa/Mogadishu' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Niamey' | 'Africa/Nouakchott' | 'Africa/Ouagadougou' | 'Africa/Porto-Novo' | 'Africa/Sao_Tome' | 'Africa/Timbuktu' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Anguilla' | 'America/Antigua' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/ComodRivadavia' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Aruba' | 'America/Asuncion' | 'America/Atikokan' | 'America/Atka' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Blanc-Sablon' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Buenos_Aires' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Catamarca' | 'America/Cayenne' | 'America/Cayman' | 'America/Chicago' | 'America/Chihuahua' | 'America/Coral_Harbour' | 'America/Cordoba' | 'America/Costa_Rica' | 'America/Creston' | 'America/Cuiaba' | 'America/Curacao' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Dominica' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Ensenada' | 'America/Fort_Wayne' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Godthab' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Grenada' | 'America/Guadeloupe' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Valparaiso' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Indianapolis' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Jujuy' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/Knox_IN' | 'America/Kralendijk' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Louisville' | 'America/Lower_Princes' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Marigot' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Mendoza' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/Montreal' | 'America/Montserrat' | 'America/Nassau' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port_of_Spain' | 'America/Port-au-Prince' | 'America/Porto_Acre' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Rosario' | 'America/Santa_Isabel' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Shiprock' | 'America/Sitka' | 'America/St_Barthelemy' | 'America/St_Johns' | 'America/St_Kitts' | 'America/St_Lucia' | 'America/St_Thomas' | 'America/St_Vincent' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Tortola' | 'America/Vancouver' | 'America/Virgin' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/DumontDUrville' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/McMurdo' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/South_Pole' | 'Antarctica/Syowa' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Arctic/Longyearbyen' | 'Asia/Aden' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Ashkhabad' | 'Asia/Baghdad' | 'Asia/Bahrain' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Calcutta' | 'Asia/Choibalsan' | 'Asia/Chongqing' | 'Asia/Chungking' | 'Asia/Colombo' | 'Asia/Dacca' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Gaza' | 'Asia/Harbin' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Istanbul' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kashgar' | 'Asia/Kathmandu' | 'Asia/Katmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Kuwait' | 'Asia/Macao' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Muscat' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Phnom_Penh' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qyzylorda' | 'Asia/Rangoon' | 'Asia/Riyadh' | 'Asia/Saigon' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Tel_Aviv' | 'Asia/Thimbu' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Ujung_Pandang' | 'Asia/Ulaanbaatar' | 'Asia/Ulan_Bator' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vientiane' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faeroe' | 'Atlantic/Faroe' | 'Atlantic/Jan_Mayen' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/St_Helena' | 'Atlantic/Stanley' | 'Australia/ACT' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Canberra' | 'Australia/Currie' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/LHI' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/North' | 'Australia/NSW' | 'Australia/Perth' | 'Australia/Queensland' | 'Australia/South' | 'Australia/Sydney' | 'Australia/Tasmania' | 'Australia/Victoria' | 'Australia/West' | 'Australia/Yancowinna' | 'Brazil/Acre' | 'Brazil/DeNoronha' | 'Brazil/East' | 'Brazil/West' | 'Canada/Atlantic' | 'Canada/Central' | 'Canada/Eastern' | 'Canada/East-Saskatchewan' | 'Canada/Mountain' | 'Canada/Newfoundland' | 'Canada/Pacific' | 'Canada/Saskatchewan' | 'Canada/Yukon' | 'Chile/Continental' | 'Chile/EasterIsland' | 'Cuba' | 'Egypt' | 'Eire' | 'Etc/GMT' | 'Etc/GMT+0' | 'Etc/UCT' | 'Etc/Universal' | 'Etc/UTC' | 'Etc/Zulu' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Athens' | 'Europe/Belfast' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Bratislava' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Busingen' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Guernsey' | 'Europe/Helsinki' | 'Europe/Isle_of_Man' | 'Europe/Istanbul' | 'Europe/Jersey' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Lisbon' | 'Europe/Ljubljana' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Mariehamn' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Nicosia' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Podgorica' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/San_Marino' | 'Europe/Sarajevo' | 'Europe/Simferopol' | 'Europe/Skopje' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Tiraspol' | 'Europe/Uzhgorod' | 'Europe/Vaduz' | 'Europe/Vatican' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zagreb' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'GB' | 'GB-Eire' | 'GMT' | 'GMT+0' | 'GMT0' | 'GMT-0' | 'Greenwich' | 'Hongkong' | 'Iceland' | 'Indian/Antananarivo' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Comoro' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Mayotte' | 'Indian/Reunion' | 'Iran' | 'Israel' | 'Jamaica' | 'Japan' | 'Kwajalein' | 'Libya' | 'Mexico/BajaNorte' | 'Mexico/BajaSur' | 'Mexico/General' | 'Navajo' | 'NZ' | 'NZ-CHAT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Enderbury' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Johnston' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Midway' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Ponape' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Saipan' | 'Pacific/Samoa' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Truk' | 'Pacific/Wake' | 'Pacific/Wallis' | 'Pacific/Yap' | 'Poland' | 'Portugal' | 'PRC' | 'ROC' | 'ROK' | 'Singapore' | 'Turkey' | 'UCT' | 'Universal' | 'US/Alaska' | 'US/Aleutian' | 'US/Arizona' | 'US/Central' | 'US/Eastern' | 'US/East-Indiana' | 'US/Hawaii' | 'US/Indiana-Starke' | 'US/Michigan' | 'US/Mountain' | 'US/Pacific' | 'US/Samoa' | 'UTC' | 'W-SU' | 'Zulu', required
- `numBillingRetries` number
- `delayBetweenRetries` number
- `orgName` string, required
- `logo` string
- `myShopifyDomain` string
- `stripeAccessKey` string
- `numFailedCyclesBeforeCancel` number
- `initialSubscriptionImportComplete` boolean, required
- `cancellationMessage` string
- `account` IOrganizationAccount, required
- `unlockedPlanNames` string[]
- `outOfStockItemRemovalEnabled` boolean
- `instantDigitalItemFulfillmentEnabled` boolean
- `vendorUsers` IOrganizationVendorUserRole[], required
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `vendorShopifyUserId` string
- `isShopifyAccountOwner` boolean
- `isShopifyCollaborator` boolean
- `isShopOperator` boolean
- `isShopifyEmailVerified` boolean
- `role` 'vendorAdmin' | 'vendorEmployee', required
- `organization` IOrganization, required — recursive
- `user` IVendorUser, required
- …
- `sts` IPurchaseState[], required
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `totalFromLineItems` string, required
- `totalLineItemsDiscount` string, required
- `totalLineItemsAfterDiscount` string, required
- `totalShipping` string, required
- `totalDiscount` string, required
- `shopifyId` string
- `receivedFromShopifyDate` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyUpdateDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `purchaseStateStatus` 'ACTIVE' | 'PAUSED' | 'CANCELLED' | 'EXPIRED' | 'FAILED', required
- `createdViaCustomerPortal` boolean, required
- `initialSubmissionDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `externalSubscriptionCreatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `cancelledAt` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `pausedAt` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `externalSubscriptionCancelledAt` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `nextBillingDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `isRepeatCustomer` boolean, required
- `sellingPlanId` string
- `currency` 'STN' | 'VED' | 'USD' | 'USDC' | 'EUR' | 'GBP' | 'CAD' | 'AFN' | 'ALL' | 'DZD' | 'AOA' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'BBD' | 'AZN' | 'BDT' | 'BSD' | 'BHD' | 'BIF' | 'BZD' | 'BMD' | 'BTN' | 'BAM' | 'BRL' | 'BOB' | 'BWP' | 'BND' | 'BGN' | 'MMK' | 'KHR' | 'CVE' | 'KYD' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DOP' | 'XCD' | 'EGP' | 'ETB' | 'XPF' | 'FJD' | 'GMD' | 'GHS' | 'GTQ' | 'GYD' | 'GEL' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'ILS' | 'IQD' | 'JMD' | 'JPY' | 'JEP' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'KGS' | 'LAK' | 'LVL' | 'LBP' | 'LSL' | 'LRD' | 'LTL' | 'MGA' | 'MKD' | 'MOP' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MUR' | 'MDL' | 'MAD' | 'MNT' | 'MZN' | 'NAD' | 'NPR' | 'ANG' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PAB' | 'PKR' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'WST' | 'SAR' | 'STD' | 'RSD' | 'SCR' | 'SGD' | 'SDG' | 'SYP' | 'ZAR' | 'KRW' | 'SSP' | 'SBD' | 'LKR' | 'SRD' | 'SZL' | 'SEK' | 'CHF' | 'TWD' | 'THB' | 'TZS' | 'TTD' | 'TND' | 'TRY' | 'TMT' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VUV' | 'VND' | 'XOF' | 'YER' | 'ZMW' | 'BYN' | 'BYR' | 'DJF' | 'ERN' | 'FKP' | 'GIP' | 'GNF' | 'IRR' | 'KID' | 'LYD' | 'MRU' | 'SLL' | 'SHP' | 'SOS' | 'TJS' | 'TOP' | 'VEF' | 'VES' | 'XXX', required
- `totalEstimatedTax` string
- `totalShippingDiscount` string
- `totalEstimatedNet` string, required
- `discounts` IPurchaseStateDiscount[], required
- …
- `shippingAddress` IMailingAddressJson, required
- …
- `externalSubscriptionId` string
- `externalSubscriptionType` 'RECHARGE'
- `externalSubscriptionStatus` 'ACTIVE' | 'PAUSED' | 'CANCELLED' | 'EXPIRED' | 'FAILED'
- `originalExternalSubscriptionStatus` 'ACTIVE' | 'PAUSED' | 'CANCELLED' | 'EXPIRED' | 'FAILED'
- `schedule` ISchedule, required
- …
- `gifts` IGift[]
- …
- `organization` IOrganization, required — recursive
- `pmtMth` IPaymentMethod, required
- …
- `stLineItems` IPurchaseStateLineItem[], required
- …
- `shopifyStoreData` IShopifyData
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `rawShopifyStoreId` number, required
- `myShopifyDomain` string, required
- `shopify_app_script_id` string
- `address1` string, nullable, required
- `address2` string
- `city` string, nullable, required
- `cookie_consent_level` string, required
- `country` string, required
- `country_code` string, required
- `country_name` string, required
- `created_at` string, required
- `currency` 'STN' | 'VED' | 'USD' | 'USDC' | 'EUR' | 'GBP' | 'CAD' | 'AFN' | 'ALL' | 'DZD' | 'AOA' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'BBD' | 'AZN' | 'BDT' | 'BSD' | 'BHD' | 'BIF' | 'BZD' | 'BMD' | 'BTN' | 'BAM' | 'BRL' | 'BOB' | 'BWP' | 'BND' | 'BGN' | 'MMK' | 'KHR' | 'CVE' | 'KYD' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DOP' | 'XCD' | 'EGP' | 'ETB' | 'XPF' | 'FJD' | 'GMD' | 'GHS' | 'GTQ' | 'GYD' | 'GEL' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'ILS' | 'IQD' | 'JMD' | 'JPY' | 'JEP' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'KGS' | 'LAK' | 'LVL' | 'LBP' | 'LSL' | 'LRD' | 'LTL' | 'MGA' | 'MKD' | 'MOP' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MUR' | 'MDL' | 'MAD' | 'MNT' | 'MZN' | 'NAD' | 'NPR' | 'ANG' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PAB' | 'PKR' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'WST' | 'SAR' | 'STD' | 'RSD' | 'SCR' | 'SGD' | 'SDG' | 'SYP' | 'ZAR' | 'KRW' | 'SSP' | 'SBD' | 'LKR' | 'SRD' | 'SZL' | 'SEK' | 'CHF' | 'TWD' | 'THB' | 'TZS' | 'TTD' | 'TND' | 'TRY' | 'TMT' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VUV' | 'VND' | 'XOF' | 'YER' | 'ZMW' | 'BYN' | 'BYR' | 'DJF' | 'ERN' | 'FKP' | 'GIP' | 'GNF' | 'IRR' | 'KID' | 'LYD' | 'MRU' | 'SLL' | 'SHP' | 'SOS' | 'TJS' | 'TOP' | 'VEF' | 'VES' | 'XXX', required
- `customer_email` string, required
- `email` string, required
- `enabled_presentment_currencies` CurrencyCode[], required
- `google_apps_domain` string
- `google_apps_login_enabled` string
- `iana_timezone` string, required
- `latitude` number, nullable
- `longitude` number, nullable
- `money_format` string, required
- `money_in_emails_format` string, required
- `money_with_currency_format` string, required
- `money_with_currency_in_emails_format` string, required
- `domain` string, required
- `name` string, required
- `phone` string, nullable, required
- `plan_display_name` string, required
- `plan_name` string, required
- `primary_locale` string, required
- `primary_location_id` string, required
- `province` string, nullable, required
- `province_code` string
- `shop_owner` string, required
- `source` string
- `timezone` string, required
- `updated_at` string, required
- `visitor_tracking_consent_preference` string, required
- `weight_unit` string, required
- `zip` string, nullable, required
- `checkout_api_supported` boolean, required
- `finances` boolean, required
- `force_ssl` boolean, required
- `has_discounts` boolean, required
- `has_gift_cards` boolean, required
- `has_storefront` boolean, required
- `multi_location_enabled` boolean, required
- `county_taxes` boolean, required
- `tax_shipping` boolean
- `eligible_for_payments` boolean, required
- `password_enabled` boolean, required
- `eligible_for_card_reader_giveaway` boolean, required
- `pre_launch_enabled` boolean, required
- `requires_extra_payments_agreement` boolean, required
- `setup_required` boolean, required
- `taxes_included` boolean, required
- `error` string, nullable
- `st` IPurchaseStateWithCustomerRelationship, required
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `totalFromLineItems` string, required
- `totalLineItemsDiscount` string, required
- `totalLineItemsAfterDiscount` string, required
- `totalShipping` string, required
- `totalDiscount` string, required
- `shopifyId` string
- `receivedFromShopifyDate` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyUpdateDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `purchaseStateStatus` 'ACTIVE' | 'PAUSED' | 'CANCELLED' | 'EXPIRED' | 'FAILED', required
- `createdViaCustomerPortal` boolean, required
- `initialSubmissionDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `externalSubscriptionCreatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `cancelledAt` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `pausedAt` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `externalSubscriptionCancelledAt` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `nextBillingDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `isRepeatCustomer` boolean, required
- `sellingPlanId` string
- `currency` 'STN' | 'VED' | 'USD' | 'USDC' | 'EUR' | 'GBP' | 'CAD' | 'AFN' | 'ALL' | 'DZD' | 'AOA' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'BBD' | 'AZN' | 'BDT' | 'BSD' | 'BHD' | 'BIF' | 'BZD' | 'BMD' | 'BTN' | 'BAM' | 'BRL' | 'BOB' | 'BWP' | 'BND' | 'BGN' | 'MMK' | 'KHR' | 'CVE' | 'KYD' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DOP' | 'XCD' | 'EGP' | 'ETB' | 'XPF' | 'FJD' | 'GMD' | 'GHS' | 'GTQ' | 'GYD' | 'GEL' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'ILS' | 'IQD' | 'JMD' | 'JPY' | 'JEP' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'KGS' | 'LAK' | 'LVL' | 'LBP' | 'LSL' | 'LRD' | 'LTL' | 'MGA' | 'MKD' | 'MOP' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MUR' | 'MDL' | 'MAD' | 'MNT' | 'MZN' | 'NAD' | 'NPR' | 'ANG' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PAB' | 'PKR' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'WST' | 'SAR' | 'STD' | 'RSD' | 'SCR' | 'SGD' | 'SDG' | 'SYP' | 'ZAR' | 'KRW' | 'SSP' | 'SBD' | 'LKR' | 'SRD' | 'SZL' | 'SEK' | 'CHF' | 'TWD' | 'THB' | 'TZS' | 'TTD' | 'TND' | 'TRY' | 'TMT' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VUV' | 'VND' | 'XOF' | 'YER' | 'ZMW' | 'BYN' | 'BYR' | 'DJF' | 'ERN' | 'FKP' | 'GIP' | 'GNF' | 'IRR' | 'KID' | 'LYD' | 'MRU' | 'SLL' | 'SHP' | 'SOS' | 'TJS' | 'TOP' | 'VEF' | 'VES' | 'XXX', required
- `totalEstimatedTax` string
- `totalShippingDiscount` string
- `totalEstimatedNet` string, required
- `discounts` IPurchaseStateDiscount[], required
- `allocationMethod` 0 | 1 | 2 — - 0: ACROSS - 1: EACH - 2: ONE
- `code` string
- `currency` 'STN' | 'VED' | 'USD' | 'USDC' | 'EUR' | 'GBP' | 'CAD' | 'AFN' | 'ALL' | 'DZD' | 'AOA' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'BBD' | 'AZN' | 'BDT' | 'BSD' | 'BHD' | 'BIF' | 'BZD' | 'BMD' | 'BTN' | 'BAM' | 'BRL' | 'BOB' | 'BWP' | 'BND' | 'BGN' | 'MMK' | 'KHR' | 'CVE' | 'KYD' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DOP' | 'XCD' | 'EGP' | 'ETB' | 'XPF' | 'FJD' | 'GMD' | 'GHS' | 'GTQ' | 'GYD' | 'GEL' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'ILS' | 'IQD' | 'JMD' | 'JPY' | 'JEP' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'KGS' | 'LAK' | 'LVL' | 'LBP' | 'LSL' | 'LRD' | 'LTL' | 'MGA' | 'MKD' | 'MOP' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MUR' | 'MDL' | 'MAD' | 'MNT' | 'MZN' | 'NAD' | 'NPR' | 'ANG' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PAB' | 'PKR' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'WST' | 'SAR' | 'STD' | 'RSD' | 'SCR' | 'SGD' | 'SDG' | 'SYP' | 'ZAR' | 'KRW' | 'SSP' | 'SBD' | 'LKR' | 'SRD' | 'SZL' | 'SEK' | 'CHF' | 'TWD' | 'THB' | 'TZS' | 'TTD' | 'TND' | 'TRY' | 'TMT' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VUV' | 'VND' | 'XOF' | 'YER' | 'ZMW' | 'BYN' | 'BYR' | 'DJF' | 'ERN' | 'FKP' | 'GIP' | 'GNF' | 'IRR' | 'KID' | 'LYD' | 'MRU' | 'SLL' | 'SHP' | 'SOS' | 'TJS' | 'TOP' | 'VEF' | 'VES' | 'XXX'
- `description` string
- `rejectionReason` string
- `recurringCycleLimit` number
- `targetSelection` 0 | 1 | 2 — - 0: ALL - 1: ENTITLED - 2: EXPLICIT
- `targetType` 0 | 1 — - 0: LINE_ITEM - 1: SHIPPING_LINE
- `title` string
- `type` 0 | 1 | 2 | 3, required — - 0: MANUAL - 1: SCRIPT - 2: DISCOUNT_CODE - 3: AUTOMATIC
- `value` number, required
- `valueType` 0 | 1, required — - 0: FIXED - 1: PERCENTAGE
- `vendorId` string
- `usageCount` number, required
- `shippingAddress` IMailingAddressJson, required
- `latitude` number, nullable
- `longitude` number, nullable
- `city` string
- `province` string
- `provinceCode` string — The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.
- `zip` string
- `country` string
- `countryCode` 'AF' | 'AX' | 'AL' | 'DZ' | 'AD' | 'AO' | 'AI' | 'AG' | 'AR' | 'AM' | 'AW' | 'AC' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CA' | 'CV' | 'BQ' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'CI' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'XK' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MK' | 'NO' | 'OM' | 'PK' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'QA' | 'CM' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'KR' | 'SS' | 'ES' | 'LK' | 'VC' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TA' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'ZZ' — ISO 3166-1 alpha-2 country codes with some differences
- `address1` string
- `address2` string
- `shopifyId` string
- `email` string
- `phone` string — Formatted using E.164 standard. For example, _+16135551111_.
- `firstName` string
- `lastName` string
- `company` string
- `externalSubscriptionId` string
- `externalSubscriptionType` 'RECHARGE'
- `externalSubscriptionStatus` 'ACTIVE' | 'PAUSED' | 'CANCELLED' | 'EXPIRED' | 'FAILED'
- `originalExternalSubscriptionStatus` 'ACTIVE' | 'PAUSED' | 'CANCELLED' | 'EXPIRED' | 'FAILED'
- `schedule` ISchedule, required
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `anchor` object, required
- `extendOnUserSkip` boolean, required
- `extendOnHiddenSkip` boolean, required
- `ignorePastIndicesWhenExtending` boolean, required
- `initialSequenceStartDate` string, date-time, required
- `billedCycleStartDate` string, date-time
- `billedDeliveriesCount` number
- `totalOrdersCount` number
- `totalBillingCycles` number
- `deliveryFrequencyMultiple` number, required
- `paymentFrequencyMultiple` number, required
- `skips` SkipArrValue[], required
- `userSkipped` boolean, required
- `hiddenSkipped` boolean, required
- `deliveryRRuleString` string, required
- `gifts` IGift[]
- `to` IShopifyLikeMailingAddress, required
- `address1` string
- `address2` string
- `city` string
- `company` string
- `country` string
- `countryCode` string
- `firstName` string
- `lastName` string
- `phone` string — Formatted using E.164 standard. For example, _+16135551111_.
- `province` string
- `provinceCode` string — The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.
- `zip` string
- `stId` string, required
- `skdIdx` number, required
- `email` string
- `phone` string
- `note` string
- `notifyBy` 'email' | 'text' | 'email+text', required
- `id` string, required
- `organization` IOrganization, required
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `billingTime` string, required — A time component in ISO format: HH:mm:ss
- `billingTimezone` 'Africa/Abidjan' | 'Africa/Accra' | 'Africa/Addis_Ababa' | 'Africa/Algiers' | 'Africa/Asmara' | 'Africa/Asmera' | 'Africa/Bamako' | 'Africa/Bangui' | 'Africa/Banjul' | 'Africa/Blantyre' | 'Africa/Brazzaville' | 'Africa/Bujumbura' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/Conakry' | 'Africa/Dakar' | 'Africa/Dar_es_Salaam' | 'Africa/Djibouti' | 'Africa/Douala' | 'Africa/El_Aaiun' | 'Africa/Freetown' | 'Africa/Gaborone' | 'Africa/Harare' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Kampala' | 'Africa/Khartoum' | 'Africa/Kigali' | 'Africa/Kinshasa' | 'Africa/Lagos' | 'Africa/Libreville' | 'Africa/Lome' | 'Africa/Luanda' | 'Africa/Lubumbashi' | 'Africa/Lusaka' | 'Africa/Malabo' | 'Africa/Maputo' | 'Africa/Maseru' | 'Africa/Mbabane' | 'Africa/Mogadishu' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Niamey' | 'Africa/Nouakchott' | 'Africa/Ouagadougou' | 'Africa/Porto-Novo' | 'Africa/Sao_Tome' | 'Africa/Timbuktu' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Anguilla' | 'America/Antigua' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/ComodRivadavia' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Aruba' | 'America/Asuncion' | 'America/Atikokan' | 'America/Atka' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Blanc-Sablon' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Buenos_Aires' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Catamarca' | 'America/Cayenne' | 'America/Cayman' | 'America/Chicago' | 'America/Chihuahua' | 'America/Coral_Harbour' | 'America/Cordoba' | 'America/Costa_Rica' | 'America/Creston' | 'America/Cuiaba' | 'America/Curacao' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Dominica' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Ensenada' | 'America/Fort_Wayne' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Godthab' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Grenada' | 'America/Guadeloupe' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Valparaiso' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Indianapolis' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Jujuy' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/Knox_IN' | 'America/Kralendijk' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Louisville' | 'America/Lower_Princes' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Marigot' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Mendoza' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/Montreal' | 'America/Montserrat' | 'America/Nassau' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port_of_Spain' | 'America/Port-au-Prince' | 'America/Porto_Acre' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Rosario' | 'America/Santa_Isabel' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Shiprock' | 'America/Sitka' | 'America/St_Barthelemy' | 'America/St_Johns' | 'America/St_Kitts' | 'America/St_Lucia' | 'America/St_Thomas' | 'America/St_Vincent' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Tortola' | 'America/Vancouver' | 'America/Virgin' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/DumontDUrville' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/McMurdo' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/South_Pole' | 'Antarctica/Syowa' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Arctic/Longyearbyen' | 'Asia/Aden' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Ashkhabad' | 'Asia/Baghdad' | 'Asia/Bahrain' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Calcutta' | 'Asia/Choibalsan' | 'Asia/Chongqing' | 'Asia/Chungking' | 'Asia/Colombo' | 'Asia/Dacca' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Gaza' | 'Asia/Harbin' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Istanbul' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kashgar' | 'Asia/Kathmandu' | 'Asia/Katmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Kuwait' | 'Asia/Macao' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Muscat' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Phnom_Penh' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qyzylorda' | 'Asia/Rangoon' | 'Asia/Riyadh' | 'Asia/Saigon' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Tel_Aviv' | 'Asia/Thimbu' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Ujung_Pandang' | 'Asia/Ulaanbaatar' | 'Asia/Ulan_Bator' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vientiane' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faeroe' | 'Atlantic/Faroe' | 'Atlantic/Jan_Mayen' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/St_Helena' | 'Atlantic/Stanley' | 'Australia/ACT' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Canberra' | 'Australia/Currie' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/LHI' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/North' | 'Australia/NSW' | 'Australia/Perth' | 'Australia/Queensland' | 'Australia/South' | 'Australia/Sydney' | 'Australia/Tasmania' | 'Australia/Victoria' | 'Australia/West' | 'Australia/Yancowinna' | 'Brazil/Acre' | 'Brazil/DeNoronha' | 'Brazil/East' | 'Brazil/West' | 'Canada/Atlantic' | 'Canada/Central' | 'Canada/Eastern' | 'Canada/East-Saskatchewan' | 'Canada/Mountain' | 'Canada/Newfoundland' | 'Canada/Pacific' | 'Canada/Saskatchewan' | 'Canada/Yukon' | 'Chile/Continental' | 'Chile/EasterIsland' | 'Cuba' | 'Egypt' | 'Eire' | 'Etc/GMT' | 'Etc/GMT+0' | 'Etc/UCT' | 'Etc/Universal' | 'Etc/UTC' | 'Etc/Zulu' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Athens' | 'Europe/Belfast' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Bratislava' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Busingen' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Guernsey' | 'Europe/Helsinki' | 'Europe/Isle_of_Man' | 'Europe/Istanbul' | 'Europe/Jersey' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Lisbon' | 'Europe/Ljubljana' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Mariehamn' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Nicosia' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Podgorica' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/San_Marino' | 'Europe/Sarajevo' | 'Europe/Simferopol' | 'Europe/Skopje' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Tiraspol' | 'Europe/Uzhgorod' | 'Europe/Vaduz' | 'Europe/Vatican' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zagreb' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'GB' | 'GB-Eire' | 'GMT' | 'GMT+0' | 'GMT0' | 'GMT-0' | 'Greenwich' | 'Hongkong' | 'Iceland' | 'Indian/Antananarivo' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Comoro' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Mayotte' | 'Indian/Reunion' | 'Iran' | 'Israel' | 'Jamaica' | 'Japan' | 'Kwajalein' | 'Libya' | 'Mexico/BajaNorte' | 'Mexico/BajaSur' | 'Mexico/General' | 'Navajo' | 'NZ' | 'NZ-CHAT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Enderbury' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Johnston' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Midway' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Ponape' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Saipan' | 'Pacific/Samoa' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Truk' | 'Pacific/Wake' | 'Pacific/Wallis' | 'Pacific/Yap' | 'Poland' | 'Portugal' | 'PRC' | 'ROC' | 'ROK' | 'Singapore' | 'Turkey' | 'UCT' | 'Universal' | 'US/Alaska' | 'US/Aleutian' | 'US/Arizona' | 'US/Central' | 'US/Eastern' | 'US/East-Indiana' | 'US/Hawaii' | 'US/Indiana-Starke' | 'US/Michigan' | 'US/Mountain' | 'US/Pacific' | 'US/Samoa' | 'UTC' | 'W-SU' | 'Zulu', required
- `numBillingRetries` number
- `delayBetweenRetries` number
- `orgName` string, required
- `logo` string
- `myShopifyDomain` string
- `stripeAccessKey` string
- `numFailedCyclesBeforeCancel` number
- `initialSubscriptionImportComplete` boolean, required
- `cancellationMessage` string
- `account` IOrganizationAccount, required
- `unlockedPlanNames` string[]
- `outOfStockItemRemovalEnabled` boolean
- `instantDigitalItemFulfillmentEnabled` boolean
- `vendorUsers` IOrganizationVendorUserRole[], required
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `vendorShopifyUserId` string
- `isShopifyAccountOwner` boolean
- `isShopifyCollaborator` boolean
- `isShopOperator` boolean
- `isShopifyEmailVerified` boolean
- `role` 'vendorAdmin' | 'vendorEmployee', required
- `organization` IOrganization, required — recursive
- `user` IVendorUser, required
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `originalFirstName` string
- `originalLastName` string
- `originalEmail` string
- `originalPhoneNumber` string
- `isSuperUser` boolean
- `hasPassword` boolean
- `userPhoto` string
- `gender` string
- `googleId` string
- `googlePhoto` string
- `vendorOrgRoles` IOrganizationVendorUserRole[]
- `sts` IPurchaseState[], required
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `totalFromLineItems` string, required
- `totalLineItemsDiscount` string, required
- `totalLineItemsAfterDiscount` string, required
- `totalShipping` string, required
- `totalDiscount` string, required
- `shopifyId` string
- `receivedFromShopifyDate` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyUpdateDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `purchaseStateStatus` 'ACTIVE' | 'PAUSED' | 'CANCELLED' | 'EXPIRED' | 'FAILED', required
- `createdViaCustomerPortal` boolean, required
- `initialSubmissionDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `externalSubscriptionCreatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `cancelledAt` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `pausedAt` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `externalSubscriptionCancelledAt` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `nextBillingDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `isRepeatCustomer` boolean, required
- `sellingPlanId` string
- `currency` 'STN' | 'VED' | 'USD' | 'USDC' | 'EUR' | 'GBP' | 'CAD' | 'AFN' | 'ALL' | 'DZD' | 'AOA' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'BBD' | 'AZN' | 'BDT' | 'BSD' | 'BHD' | 'BIF' | 'BZD' | 'BMD' | 'BTN' | 'BAM' | 'BRL' | 'BOB' | 'BWP' | 'BND' | 'BGN' | 'MMK' | 'KHR' | 'CVE' | 'KYD' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DOP' | 'XCD' | 'EGP' | 'ETB' | 'XPF' | 'FJD' | 'GMD' | 'GHS' | 'GTQ' | 'GYD' | 'GEL' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'ILS' | 'IQD' | 'JMD' | 'JPY' | 'JEP' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'KGS' | 'LAK' | 'LVL' | 'LBP' | 'LSL' | 'LRD' | 'LTL' | 'MGA' | 'MKD' | 'MOP' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MUR' | 'MDL' | 'MAD' | 'MNT' | 'MZN' | 'NAD' | 'NPR' | 'ANG' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PAB' | 'PKR' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'WST' | 'SAR' | 'STD' | 'RSD' | 'SCR' | 'SGD' | 'SDG' | 'SYP' | 'ZAR' | 'KRW' | 'SSP' | 'SBD' | 'LKR' | 'SRD' | 'SZL' | 'SEK' | 'CHF' | 'TWD' | 'THB' | 'TZS' | 'TTD' | 'TND' | 'TRY' | 'TMT' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VUV' | 'VND' | 'XOF' | 'YER' | 'ZMW' | 'BYN' | 'BYR' | 'DJF' | 'ERN' | 'FKP' | 'GIP' | 'GNF' | 'IRR' | 'KID' | 'LYD' | 'MRU' | 'SLL' | 'SHP' | 'SOS' | 'TJS' | 'TOP' | 'VEF' | 'VES' | 'XXX', required
- `totalEstimatedTax` string
- `totalShippingDiscount` string
- `totalEstimatedNet` string, required
- `discounts` IPurchaseStateDiscount[], required
- `allocationMethod` 0 | 1 | 2 — - 0: ACROSS - 1: EACH - 2: ONE
- `code` string
- `currency` 'STN' | 'VED' | 'USD' | 'USDC' | 'EUR' | 'GBP' | 'CAD' | 'AFN' | 'ALL' | 'DZD' | 'AOA' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'BBD' | 'AZN' | 'BDT' | 'BSD' | 'BHD' | 'BIF' | 'BZD' | 'BMD' | 'BTN' | 'BAM' | 'BRL' | 'BOB' | 'BWP' | 'BND' | 'BGN' | 'MMK' | 'KHR' | 'CVE' | 'KYD' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DOP' | 'XCD' | 'EGP' | 'ETB' | 'XPF' | 'FJD' | 'GMD' | 'GHS' | 'GTQ' | 'GYD' | 'GEL' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'ILS' | 'IQD' | 'JMD' | 'JPY' | 'JEP' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'KGS' | 'LAK' | 'LVL' | 'LBP' | 'LSL' | 'LRD' | 'LTL' | 'MGA' | 'MKD' | 'MOP' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MUR' | 'MDL' | 'MAD' | 'MNT' | 'MZN' | 'NAD' | 'NPR' | 'ANG' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PAB' | 'PKR' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'WST' | 'SAR' | 'STD' | 'RSD' | 'SCR' | 'SGD' | 'SDG' | 'SYP' | 'ZAR' | 'KRW' | 'SSP' | 'SBD' | 'LKR' | 'SRD' | 'SZL' | 'SEK' | 'CHF' | 'TWD' | 'THB' | 'TZS' | 'TTD' | 'TND' | 'TRY' | 'TMT' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VUV' | 'VND' | 'XOF' | 'YER' | 'ZMW' | 'BYN' | 'BYR' | 'DJF' | 'ERN' | 'FKP' | 'GIP' | 'GNF' | 'IRR' | 'KID' | 'LYD' | 'MRU' | 'SLL' | 'SHP' | 'SOS' | 'TJS' | 'TOP' | 'VEF' | 'VES' | 'XXX'
- `description` string
- `rejectionReason` string
- `recurringCycleLimit` number
- `targetSelection` 0 | 1 | 2 — - 0: ALL - 1: ENTITLED - 2: EXPLICIT
- `targetType` 0 | 1 — - 0: LINE_ITEM - 1: SHIPPING_LINE
- `title` string
- `type` 0 | 1 | 2 | 3, required — - 0: MANUAL - 1: SCRIPT - 2: DISCOUNT_CODE - 3: AUTOMATIC
- `value` number, required
- `valueType` 0 | 1, required — - 0: FIXED - 1: PERCENTAGE
- `vendorId` string
- `usageCount` number, required
- `shippingAddress` IMailingAddressJson, required
- `latitude` number, nullable
- `longitude` number, nullable
- `city` string
- `province` string
- `provinceCode` string — The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.
- `zip` string
- `country` string
- `countryCode` 'AF' | 'AX' | 'AL' | 'DZ' | 'AD' | 'AO' | 'AI' | 'AG' | 'AR' | 'AM' | 'AW' | 'AC' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CA' | 'CV' | 'BQ' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'CI' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'XK' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MK' | 'NO' | 'OM' | 'PK' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'QA' | 'CM' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'KR' | 'SS' | 'ES' | 'LK' | 'VC' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TA' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'ZZ' — ISO 3166-1 alpha-2 country codes with some differences
- `address1` string
- `address2` string
- `shopifyId` string
- `email` string
- `phone` string — Formatted using E.164 standard. For example, _+16135551111_.
- `firstName` string
- `lastName` string
- `company` string
- `externalSubscriptionId` string
- `externalSubscriptionType` 'RECHARGE'
- `externalSubscriptionStatus` 'ACTIVE' | 'PAUSED' | 'CANCELLED' | 'EXPIRED' | 'FAILED'
- `originalExternalSubscriptionStatus` 'ACTIVE' | 'PAUSED' | 'CANCELLED' | 'EXPIRED' | 'FAILED'
- `schedule` ISchedule, required
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `anchor` object, required
- `extendOnUserSkip` boolean, required
- `extendOnHiddenSkip` boolean, required
- `ignorePastIndicesWhenExtending` boolean, required
- `initialSequenceStartDate` string, date-time, required
- `billedCycleStartDate` string, date-time
- `billedDeliveriesCount` number
- `totalOrdersCount` number
- `totalBillingCycles` number
- `deliveryFrequencyMultiple` number, required
- `paymentFrequencyMultiple` number, required
- `skips` SkipArrValue[], required
- …
- `deliveryRRuleString` string, required
- `gifts` IGift[]
- `to` IShopifyLikeMailingAddress, required
- …
- `stId` string, required
- `skdIdx` number, required
- `email` string
- `phone` string
- `note` string
- `notifyBy` 'email' | 'text' | 'email+text', required
- `id` string, required
- `organization` IOrganization, required — recursive
- `pmtMth` IPaymentMethod, required
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyId` string
- `receivedFromShopifyDate` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyUpdateDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `maskedNumber` string, nullable
- `cardBrand` string, nullable
- `cardExpirationMonth` number, nullable
- `cardExpirationYear` number, nullable
- `lastDigits` string, nullable
- `__paymentMethodKey__` string, required
- `paymentMethodName` string, nullable
- `paymentMethodInternalCustomerId` string, required
- `stLineItems` IPurchaseStateLineItem[], required
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyId` string
- `receivedFromShopifyDate` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyUpdateDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `idempotencyKey` string
- `discounts` IPurchaseStateLineItemDiscount[], required
- …
- `basePrice` string, required
- `priceAfterDiscounts` string, required
- `priceCurrency` 'STN' | 'VED' | 'USD' | 'USDC' | 'EUR' | 'GBP' | 'CAD' | 'AFN' | 'ALL' | 'DZD' | 'AOA' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'BBD' | 'AZN' | 'BDT' | 'BSD' | 'BHD' | 'BIF' | 'BZD' | 'BMD' | 'BTN' | 'BAM' | 'BRL' | 'BOB' | 'BWP' | 'BND' | 'BGN' | 'MMK' | 'KHR' | 'CVE' | 'KYD' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DOP' | 'XCD' | 'EGP' | 'ETB' | 'XPF' | 'FJD' | 'GMD' | 'GHS' | 'GTQ' | 'GYD' | 'GEL' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'ILS' | 'IQD' | 'JMD' | 'JPY' | 'JEP' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'KGS' | 'LAK' | 'LVL' | 'LBP' | 'LSL' | 'LRD' | 'LTL' | 'MGA' | 'MKD' | 'MOP' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MUR' | 'MDL' | 'MAD' | 'MNT' | 'MZN' | 'NAD' | 'NPR' | 'ANG' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PAB' | 'PKR' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'WST' | 'SAR' | 'STD' | 'RSD' | 'SCR' | 'SGD' | 'SDG' | 'SYP' | 'ZAR' | 'KRW' | 'SSP' | 'SBD' | 'LKR' | 'SRD' | 'SZL' | 'SEK' | 'CHF' | 'TWD' | 'THB' | 'TZS' | 'TTD' | 'TND' | 'TRY' | 'TMT' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VUV' | 'VND' | 'XOF' | 'YER' | 'ZMW' | 'BYN' | 'BYR' | 'DJF' | 'ERN' | 'FKP' | 'GIP' | 'GNF' | 'IRR' | 'KID' | 'LYD' | 'MRU' | 'SLL' | 'SHP' | 'SOS' | 'TJS' | 'TOP' | 'VEF' | 'VES' | 'XXX', required
- `quantity` number, required
- `pricingPolicy` IPurchaseStateLineItemPricingPolicy
- …
- `isAddOn` boolean, required
- `attributionSource` string
- `vnt` IPurchasableVariant, required
- …
- `sellingPlanId` string
- `skdIdx` number
- `shopifyStoreData` IShopifyData
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `rawShopifyStoreId` number, required
- `myShopifyDomain` string, required
- `shopify_app_script_id` string
- `address1` string, nullable, required
- `address2` string
- `city` string, nullable, required
- `cookie_consent_level` string, required
- `country` string, required
- `country_code` string, required
- `country_name` string, required
- `created_at` string, required
- `currency` 'STN' | 'VED' | 'USD' | 'USDC' | 'EUR' | 'GBP' | 'CAD' | 'AFN' | 'ALL' | 'DZD' | 'AOA' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'BBD' | 'AZN' | 'BDT' | 'BSD' | 'BHD' | 'BIF' | 'BZD' | 'BMD' | 'BTN' | 'BAM' | 'BRL' | 'BOB' | 'BWP' | 'BND' | 'BGN' | 'MMK' | 'KHR' | 'CVE' | 'KYD' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DOP' | 'XCD' | 'EGP' | 'ETB' | 'XPF' | 'FJD' | 'GMD' | 'GHS' | 'GTQ' | 'GYD' | 'GEL' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'ILS' | 'IQD' | 'JMD' | 'JPY' | 'JEP' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'KGS' | 'LAK' | 'LVL' | 'LBP' | 'LSL' | 'LRD' | 'LTL' | 'MGA' | 'MKD' | 'MOP' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MUR' | 'MDL' | 'MAD' | 'MNT' | 'MZN' | 'NAD' | 'NPR' | 'ANG' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PAB' | 'PKR' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'WST' | 'SAR' | 'STD' | 'RSD' | 'SCR' | 'SGD' | 'SDG' | 'SYP' | 'ZAR' | 'KRW' | 'SSP' | 'SBD' | 'LKR' | 'SRD' | 'SZL' | 'SEK' | 'CHF' | 'TWD' | 'THB' | 'TZS' | 'TTD' | 'TND' | 'TRY' | 'TMT' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VUV' | 'VND' | 'XOF' | 'YER' | 'ZMW' | 'BYN' | 'BYR' | 'DJF' | 'ERN' | 'FKP' | 'GIP' | 'GNF' | 'IRR' | 'KID' | 'LYD' | 'MRU' | 'SLL' | 'SHP' | 'SOS' | 'TJS' | 'TOP' | 'VEF' | 'VES' | 'XXX', required
- `customer_email` string, required
- `email` string, required
- `enabled_presentment_currencies` CurrencyCode[], required
- `google_apps_domain` string
- `google_apps_login_enabled` string
- `iana_timezone` string, required
- `latitude` number, nullable
- `longitude` number, nullable
- `money_format` string, required
- `money_in_emails_format` string, required
- `money_with_currency_format` string, required
- `money_with_currency_in_emails_format` string, required
- `domain` string, required
- `name` string, required
- `phone` string, nullable, required
- `plan_display_name` string, required
- `plan_name` string, required
- `primary_locale` string, required
- `primary_location_id` string, required
- `province` string, nullable, required
- `province_code` string
- `shop_owner` string, required
- `source` string
- `timezone` string, required
- `updated_at` string, required
- `visitor_tracking_consent_preference` string, required
- `weight_unit` string, required
- `zip` string, nullable, required
- `checkout_api_supported` boolean, required
- `finances` boolean, required
- `force_ssl` boolean, required
- `has_discounts` boolean, required
- `has_gift_cards` boolean, required
- `has_storefront` boolean, required
- `multi_location_enabled` boolean, required
- `county_taxes` boolean, required
- `tax_shipping` boolean
- `eligible_for_payments` boolean, required
- `password_enabled` boolean, required
- `eligible_for_card_reader_giveaway` boolean, required
- `pre_launch_enabled` boolean, required
- `requires_extra_payments_agreement` boolean, required
- `setup_required` boolean, required
- `taxes_included` boolean, required
- `pmtMth` IPaymentMethod, required
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyId` string
- `receivedFromShopifyDate` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyUpdateDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `maskedNumber` string, nullable
- `cardBrand` string, nullable
- `cardExpirationMonth` number, nullable
- `cardExpirationYear` number, nullable
- `lastDigits` string, nullable
- `__paymentMethodKey__` string, required
- `paymentMethodName` string, nullable
- `paymentMethodInternalCustomerId` string, required
- `stLineItems` IPurchaseStateLineItem[], required
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyId` string
- `receivedFromShopifyDate` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyUpdateDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `idempotencyKey` string
- `discounts` IPurchaseStateLineItemDiscount[], required
- `allocationMethod` 0 | 1 | 2 — - 0: ACROSS - 1: EACH - 2: ONE
- `code` string
- `currency` 'STN' | 'VED' | 'USD' | 'USDC' | 'EUR' | 'GBP' | 'CAD' | 'AFN' | 'ALL' | 'DZD' | 'AOA' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'BBD' | 'AZN' | 'BDT' | 'BSD' | 'BHD' | 'BIF' | 'BZD' | 'BMD' | 'BTN' | 'BAM' | 'BRL' | 'BOB' | 'BWP' | 'BND' | 'BGN' | 'MMK' | 'KHR' | 'CVE' | 'KYD' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DOP' | 'XCD' | 'EGP' | 'ETB' | 'XPF' | 'FJD' | 'GMD' | 'GHS' | 'GTQ' | 'GYD' | 'GEL' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'ILS' | 'IQD' | 'JMD' | 'JPY' | 'JEP' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'KGS' | 'LAK' | 'LVL' | 'LBP' | 'LSL' | 'LRD' | 'LTL' | 'MGA' | 'MKD' | 'MOP' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MUR' | 'MDL' | 'MAD' | 'MNT' | 'MZN' | 'NAD' | 'NPR' | 'ANG' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PAB' | 'PKR' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'WST' | 'SAR' | 'STD' | 'RSD' | 'SCR' | 'SGD' | 'SDG' | 'SYP' | 'ZAR' | 'KRW' | 'SSP' | 'SBD' | 'LKR' | 'SRD' | 'SZL' | 'SEK' | 'CHF' | 'TWD' | 'THB' | 'TZS' | 'TTD' | 'TND' | 'TRY' | 'TMT' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VUV' | 'VND' | 'XOF' | 'YER' | 'ZMW' | 'BYN' | 'BYR' | 'DJF' | 'ERN' | 'FKP' | 'GIP' | 'GNF' | 'IRR' | 'KID' | 'LYD' | 'MRU' | 'SLL' | 'SHP' | 'SOS' | 'TJS' | 'TOP' | 'VEF' | 'VES' | 'XXX'
- `description` string
- `rejectionReason` string
- `recurringCycleLimit` number
- `targetSelection` 0 | 1 | 2 — - 0: ALL - 1: ENTITLED - 2: EXPLICIT
- `targetType` 0 | 1 — - 0: LINE_ITEM - 1: SHIPPING_LINE
- `title` string
- `type` 0 | 1 | 2 | 3, required — - 0: MANUAL - 1: SCRIPT - 2: DISCOUNT_CODE - 3: AUTOMATIC
- `value` number, required
- `valueType` 0 | 1, required — - 0: FIXED - 1: PERCENTAGE
- `vendorId` string
- `usageCount` number, required
- `basePrice` string, required
- `priceAfterDiscounts` string, required
- `priceCurrency` 'STN' | 'VED' | 'USD' | 'USDC' | 'EUR' | 'GBP' | 'CAD' | 'AFN' | 'ALL' | 'DZD' | 'AOA' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'BBD' | 'AZN' | 'BDT' | 'BSD' | 'BHD' | 'BIF' | 'BZD' | 'BMD' | 'BTN' | 'BAM' | 'BRL' | 'BOB' | 'BWP' | 'BND' | 'BGN' | 'MMK' | 'KHR' | 'CVE' | 'KYD' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DOP' | 'XCD' | 'EGP' | 'ETB' | 'XPF' | 'FJD' | 'GMD' | 'GHS' | 'GTQ' | 'GYD' | 'GEL' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'ILS' | 'IQD' | 'JMD' | 'JPY' | 'JEP' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'KGS' | 'LAK' | 'LVL' | 'LBP' | 'LSL' | 'LRD' | 'LTL' | 'MGA' | 'MKD' | 'MOP' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MUR' | 'MDL' | 'MAD' | 'MNT' | 'MZN' | 'NAD' | 'NPR' | 'ANG' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PAB' | 'PKR' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'WST' | 'SAR' | 'STD' | 'RSD' | 'SCR' | 'SGD' | 'SDG' | 'SYP' | 'ZAR' | 'KRW' | 'SSP' | 'SBD' | 'LKR' | 'SRD' | 'SZL' | 'SEK' | 'CHF' | 'TWD' | 'THB' | 'TZS' | 'TTD' | 'TND' | 'TRY' | 'TMT' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VUV' | 'VND' | 'XOF' | 'YER' | 'ZMW' | 'BYN' | 'BYR' | 'DJF' | 'ERN' | 'FKP' | 'GIP' | 'GNF' | 'IRR' | 'KID' | 'LYD' | 'MRU' | 'SLL' | 'SHP' | 'SOS' | 'TJS' | 'TOP' | 'VEF' | 'VES' | 'XXX', required
- `quantity` number, required
- `pricingPolicy` IPurchaseStateLineItemPricingPolicy
- `basePrice` MoneyV2, required
- `amount` number, required
- `currencyCode` 'STN' | 'VED' | 'USD' | 'USDC' | 'EUR' | 'GBP' | 'CAD' | 'AFN' | 'ALL' | 'DZD' | 'AOA' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'BBD' | 'AZN' | 'BDT' | 'BSD' | 'BHD' | 'BIF' | 'BZD' | 'BMD' | 'BTN' | 'BAM' | 'BRL' | 'BOB' | 'BWP' | 'BND' | 'BGN' | 'MMK' | 'KHR' | 'CVE' | 'KYD' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DOP' | 'XCD' | 'EGP' | 'ETB' | 'XPF' | 'FJD' | 'GMD' | 'GHS' | 'GTQ' | 'GYD' | 'GEL' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'ILS' | 'IQD' | 'JMD' | 'JPY' | 'JEP' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'KGS' | 'LAK' | 'LVL' | 'LBP' | 'LSL' | 'LRD' | 'LTL' | 'MGA' | 'MKD' | 'MOP' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MUR' | 'MDL' | 'MAD' | 'MNT' | 'MZN' | 'NAD' | 'NPR' | 'ANG' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PAB' | 'PKR' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'WST' | 'SAR' | 'STD' | 'RSD' | 'SCR' | 'SGD' | 'SDG' | 'SYP' | 'ZAR' | 'KRW' | 'SSP' | 'SBD' | 'LKR' | 'SRD' | 'SZL' | 'SEK' | 'CHF' | 'TWD' | 'THB' | 'TZS' | 'TTD' | 'TND' | 'TRY' | 'TMT' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VUV' | 'VND' | 'XOF' | 'YER' | 'ZMW' | 'BYN' | 'BYR' | 'DJF' | 'ERN' | 'FKP' | 'GIP' | 'GNF' | 'IRR' | 'KID' | 'LYD' | 'MRU' | 'SLL' | 'SHP' | 'SOS' | 'TJS' | 'TOP' | 'VEF' | 'VES' | 'XXX', required
- `cycleDiscounts` object[], required
- `adjustmentType` 'PERCENTAGE' | 'FIXED_AMOUNT' | 'PRICE', required
- `adjustmentValue` union, required
- …
- `afterCycle` number, required
- `computedPrice` MoneyV2, required
- …
- `isAddOn` boolean, required
- `attributionSource` string
- `vnt` IPurchasableVariant, required
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyId` string
- `receivedFromShopifyDate` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyUpdateDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyProductVariantStorefrontId` string
- `purchasableVariantName` string
- `purchasableVariantImages` string[]
- `purchasableVariantSmallImages` string[]
- `isActiveInShopify` boolean, required
- `isDraftOrArchived` boolean
- `shopifyInventoryId` string
- `requiresShipping` boolean, required
- `sku` string
- `unitCost` number
- `presentmentPrices` PresentmentPrice[], required
- `price` string, required
- `priceCurrency` 'STN' | 'VED' | 'USD' | 'USDC' | 'EUR' | 'GBP' | 'CAD' | 'AFN' | 'ALL' | 'DZD' | 'AOA' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'BBD' | 'AZN' | 'BDT' | 'BSD' | 'BHD' | 'BIF' | 'BZD' | 'BMD' | 'BTN' | 'BAM' | 'BRL' | 'BOB' | 'BWP' | 'BND' | 'BGN' | 'MMK' | 'KHR' | 'CVE' | 'KYD' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DOP' | 'XCD' | 'EGP' | 'ETB' | 'XPF' | 'FJD' | 'GMD' | 'GHS' | 'GTQ' | 'GYD' | 'GEL' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'ILS' | 'IQD' | 'JMD' | 'JPY' | 'JEP' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'KGS' | 'LAK' | 'LVL' | 'LBP' | 'LSL' | 'LRD' | 'LTL' | 'MGA' | 'MKD' | 'MOP' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MUR' | 'MDL' | 'MAD' | 'MNT' | 'MZN' | 'NAD' | 'NPR' | 'ANG' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PAB' | 'PKR' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'WST' | 'SAR' | 'STD' | 'RSD' | 'SCR' | 'SGD' | 'SDG' | 'SYP' | 'ZAR' | 'KRW' | 'SSP' | 'SBD' | 'LKR' | 'SRD' | 'SZL' | 'SEK' | 'CHF' | 'TWD' | 'THB' | 'TZS' | 'TTD' | 'TND' | 'TRY' | 'TMT' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VUV' | 'VND' | 'XOF' | 'YER' | 'ZMW' | 'BYN' | 'BYR' | 'DJF' | 'ERN' | 'FKP' | 'GIP' | 'GNF' | 'IRR' | 'KID' | 'LYD' | 'MRU' | 'SLL' | 'SHP' | 'SOS' | 'TJS' | 'TOP' | 'VEF' | 'VES' | 'XXX', required
- `inventoryQuantity` number, nullable
- `inventoryPolicy` 'DENY' | 'CONTINUE', nullable — The inventory policy for a product variant controls whether customers can continue to buy the variant when it is out of stock. When the value is continue, customers are able to buy the variant when it's out of stock. When the value is deny, customers can't buy the variant when it's out of stock. * DENY: Stop selling a product variant when it is out of stock. * CONTINUE: Continue selling a product variant when it is out of stock.
- `sellingPlanId` string
- `skdIdx` number
- `custRel` ICustomerRelationshipSellingOrgShallow
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyId` string
- `receivedFromShopifyDate` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `shopifyUpdateDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `email` string
- `phone` string
- `inferredPhone` string
- `firstName` string
- `lastName` string
- `isSuperUser` boolean
- `role` 'individualCustomer' | 'customerOrgAdmin' | 'customerOrgEmployee', required
- `__stripeCustomerId__` string
- `customerCurrency` 'STN' | 'VED' | 'USD' | 'USDC' | 'EUR' | 'GBP' | 'CAD' | 'AFN' | 'ALL' | 'DZD' | 'AOA' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'BBD' | 'AZN' | 'BDT' | 'BSD' | 'BHD' | 'BIF' | 'BZD' | 'BMD' | 'BTN' | 'BAM' | 'BRL' | 'BOB' | 'BWP' | 'BND' | 'BGN' | 'MMK' | 'KHR' | 'CVE' | 'KYD' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DOP' | 'XCD' | 'EGP' | 'ETB' | 'XPF' | 'FJD' | 'GMD' | 'GHS' | 'GTQ' | 'GYD' | 'GEL' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'ILS' | 'IQD' | 'JMD' | 'JPY' | 'JEP' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'KGS' | 'LAK' | 'LVL' | 'LBP' | 'LSL' | 'LRD' | 'LTL' | 'MGA' | 'MKD' | 'MOP' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MUR' | 'MDL' | 'MAD' | 'MNT' | 'MZN' | 'NAD' | 'NPR' | 'ANG' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PAB' | 'PKR' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'WST' | 'SAR' | 'STD' | 'RSD' | 'SCR' | 'SGD' | 'SDG' | 'SYP' | 'ZAR' | 'KRW' | 'SSP' | 'SBD' | 'LKR' | 'SRD' | 'SZL' | 'SEK' | 'CHF' | 'TWD' | 'THB' | 'TZS' | 'TTD' | 'TND' | 'TRY' | 'TMT' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VUV' | 'VND' | 'XOF' | 'YER' | 'ZMW' | 'BYN' | 'BYR' | 'DJF' | 'ERN' | 'FKP' | 'GIP' | 'GNF' | 'IRR' | 'KID' | 'LYD' | 'MRU' | 'SLL' | 'SHP' | 'SOS' | 'TJS' | 'TOP' | 'VEF' | 'VES' | 'XXX', required
- `orderCount` number, required
- `customAttributes` object
- `totalSpent` string, required
- `hasLoggedIn` boolean
- `sellingOrganization` IOrganizationShallowWithIDs, required
- `id` string, required
- `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
- `billingTime` string, required — A time component in ISO format: HH:mm:ss
- `billingTimezone` 'Africa/Abidjan' | 'Africa/Accra' | 'Africa/Addis_Ababa' | 'Africa/Algiers' | 'Africa/Asmara' | 'Africa/Asmera' | 'Africa/Bamako' | 'Africa/Bangui' | 'Africa/Banjul' | 'Africa/Blantyre' | 'Africa/Brazzaville' | 'Africa/Bujumbura' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/Conakry' | 'Africa/Dakar' | 'Africa/Dar_es_Salaam' | 'Africa/Djibouti' | 'Africa/Douala' | 'Africa/El_Aaiun' | 'Africa/Freetown' | 'Africa/Gaborone' | 'Africa/Harare' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Kampala' | 'Africa/Khartoum' | 'Africa/Kigali' | 'Africa/Kinshasa' | 'Africa/Lagos' | 'Africa/Libreville' | 'Africa/Lome' | 'Africa/Luanda' | 'Africa/Lubumbashi' | 'Africa/Lusaka' | 'Africa/Malabo' | 'Africa/Maputo' | 'Africa/Maseru' | 'Africa/Mbabane' | 'Africa/Mogadishu' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Niamey' | 'Africa/Nouakchott' | 'Africa/Ouagadougou' | 'Africa/Porto-Novo' | 'Africa/Sao_Tome' | 'Africa/Timbuktu' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Anguilla' | 'America/Antigua' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/ComodRivadavia' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Aruba' | 'America/Asuncion' | 'America/Atikokan' | 'America/Atka' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Blanc-Sablon' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Buenos_Aires' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Catamarca' | 'America/Cayenne' | 'America/Cayman' | 'America/Chicago' | 'America/Chihuahua' | 'America/Coral_Harbour' | 'America/Cordoba' | 'America/Costa_Rica' | 'America/Creston' | 'America/Cuiaba' | 'America/Curacao' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Dominica' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Ensenada' | 'America/Fort_Wayne' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Godthab' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Grenada' | 'America/Guadeloupe' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Valparaiso' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Indianapolis' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Jujuy' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/Knox_IN' | 'America/Kralendijk' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Louisville' | 'America/Lower_Princes' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Marigot' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Mendoza' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/Montreal' | 'America/Montserrat' | 'America/Nassau' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port_of_Spain' | 'America/Port-au-Prince' | 'America/Porto_Acre' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Rosario' | 'America/Santa_Isabel' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Shiprock' | 'America/Sitka' | 'America/St_Barthelemy' | 'America/St_Johns' | 'America/St_Kitts' | 'America/St_Lucia' | 'America/St_Thomas' | 'America/St_Vincent' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Tortola' | 'America/Vancouver' | 'America/Virgin' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/DumontDUrville' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/McMurdo' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/South_Pole' | 'Antarctica/Syowa' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Arctic/Longyearbyen' | 'Asia/Aden' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Ashkhabad' | 'Asia/Baghdad' | 'Asia/Bahrain' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Calcutta' | 'Asia/Choibalsan' | 'Asia/Chongqing' | 'Asia/Chungking' | 'Asia/Colombo' | 'Asia/Dacca' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Gaza' | 'Asia/Harbin' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Istanbul' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kashgar' | 'Asia/Kathmandu' | 'Asia/Katmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Kuwait' | 'Asia/Macao' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Muscat' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Phnom_Penh' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qyzylorda' | 'Asia/Rangoon' | 'Asia/Riyadh' | 'Asia/Saigon' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Tel_Aviv' | 'Asia/Thimbu' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Ujung_Pandang' | 'Asia/Ulaanbaatar' | 'Asia/Ulan_Bator' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vientiane' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faeroe' | 'Atlantic/Faroe' | 'Atlantic/Jan_Mayen' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/St_Helena' | 'Atlantic/Stanley' | 'Australia/ACT' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Canberra' | 'Australia/Currie' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/LHI' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/North' | 'Australia/NSW' | 'Australia/Perth' | 'Australia/Queensland' | 'Australia/South' | 'Australia/Sydney' | 'Australia/Tasmania' | 'Australia/Victoria' | 'Australia/West' | 'Australia/Yancowinna' | 'Brazil/Acre' | 'Brazil/DeNoronha' | 'Brazil/East' | 'Brazil/West' | 'Canada/Atlantic' | 'Canada/Central' | 'Canada/Eastern' | 'Canada/East-Saskatchewan' | 'Canada/Mountain' | 'Canada/Newfoundland' | 'Canada/Pacific' | 'Canada/Saskatchewan' | 'Canada/Yukon' | 'Chile/Continental' | 'Chile/EasterIsland' | 'Cuba' | 'Egypt' | 'Eire' | 'Etc/GMT' | 'Etc/GMT+0' | 'Etc/UCT' | 'Etc/Universal' | 'Etc/UTC' | 'Etc/Zulu' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Athens' | 'Europe/Belfast' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Bratislava' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Busingen' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Guernsey' | 'Europe/Helsinki' | 'Europe/Isle_of_Man' | 'Europe/Istanbul' | 'Europe/Jersey' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Lisbon' | 'Europe/Ljubljana' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Mariehamn' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Nicosia' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Podgorica' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/San_Marino' | 'Europe/Sarajevo' | 'Europe/Simferopol' | 'Europe/Skopje' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Tiraspol' | 'Europe/Uzhgorod' | 'Europe/Vaduz' | 'Europe/Vatican' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zagreb' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'GB' | 'GB-Eire' | 'GMT' | 'GMT+0' | 'GMT0' | 'GMT-0' | 'Greenwich' | 'Hongkong' | 'Iceland' | 'Indian/Antananarivo' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Comoro' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Mayotte' | 'Indian/Reunion' | 'Iran' | 'Israel' | 'Jamaica' | 'Japan' | 'Kwajalein' | 'Libya' | 'Mexico/BajaNorte' | 'Mexico/BajaSur' | 'Mexico/General' | 'Navajo' | 'NZ' | 'NZ-CHAT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Enderbury' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Johnston' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Midway' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Ponape' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Saipan' | 'Pacific/Samoa' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Truk' | 'Pacific/Wake' | 'Pacific/Wallis' | 'Pacific/Yap' | 'Poland' | 'Portugal' | 'PRC' | 'ROC' | 'ROK' | 'Singapore' | 'Turkey' | 'UCT' | 'Universal' | 'US/Alaska' | 'US/Aleutian' | 'US/Arizona' | 'US/Central' | 'US/Eastern' | 'US/East-Indiana' | 'US/Hawaii' | 'US/Indiana-Starke' | 'US/Michigan' | 'US/Mountain' | 'US/Pacific' | 'US/Samoa' | 'UTC' | 'W-SU' | 'Zulu', required
- `numBillingRetries` number
- `delayBetweenRetries` number
- `orgName` string, required
- `logo` string
- `myShopifyDomain` string
- `stripeAccessKey` string
- `numFailedCyclesBeforeCancel` number
- `initialSubscriptionImportComplete` boolean, required
- `cancellationMessage` string
- `account` IOrganizationAccount, required
- `unlockedPlanNames` string[]
- `outOfStockItemRemovalEnabled` boolean
- `instantDigitalItemFulfillmentEnabled` boolean
---
[API](https://skmtc.net/smartrr/apis/smartrr-api.md) · [All operations](https://skmtc.net/smartrr/apis/smartrr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smartrr/smartrr-api/revisions/da24e062ff11/schema)