Skip to main content
POST
/
commerce
/
subscriptions
Error
A valid request URL is required to generate request examples
{
  "adjustment": {
    "amount": 123,
    "description": "<string>",
    "internalComment": "<string>"
  },
  "attributes": [
    {
      "attributeDefinitionId": 123,
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "fullyQualifiedName": "<string>",
      "values": [
        "<unknown>"
      ]
    }
  ],
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "changeMessages": [
    {
      "amount": 123,
      "appId": "<string>",
      "appKey": "<string>",
      "appName": "<string>",
      "attributes": {},
      "correlationId": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "identifier": "<string>",
      "message": "<string>",
      "metadata": "<unknown>",
      "newValue": "<string>",
      "oldValue": "<string>",
      "subject": "<string>",
      "subjectType": "<string>",
      "success": true,
      "userFirstName": "<string>",
      "userId": "<string>",
      "userLastName": "<string>",
      "userScopeType": "<string>",
      "verb": "<string>"
    }
  ],
  "channelCode": "<string>",
  "couponCodes": [
    "<string>"
  ],
  "currencyCode": "<string>",
  "customerAccountId": 123,
  "customerInteractionType": "<string>",
  "customerTaxId": "<string>",
  "data": {},
  "discountedSubtotal": 123,
  "dutyAmount": 123,
  "dutyTotal": 123,
  "email": "<string>",
  "externalId": "<string>",
  "feeTotal": 123,
  "frequency": {
    "unit": "<string>",
    "value": 123
  },
  "frequencyAuditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "fulfillmentInfo": {
    "auditInfo": {
      "createBy": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "updateBy": "<string>",
      "updateDate": "2023-11-07T05:31:56Z"
    },
    "data": {},
    "fulfillmentContact": {
      "address": {
        "address1": "<string>",
        "address2": "<string>",
        "address3": "<string>",
        "address4": "<string>",
        "addressType": "<string>",
        "cityOrTown": "<string>",
        "countryCode": "<string>",
        "isValidated": true,
        "postalOrZipCode": "<string>",
        "stateOrProvince": "<string>"
      },
      "companyOrOrganization": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "id": 123,
      "lastNameOrSurname": "<string>",
      "middleNameOrInitial": "<string>",
      "phoneNumbers": {
        "home": "<string>",
        "mobile": "<string>",
        "work": "<string>"
      }
    },
    "isDestinationCommercial": true,
    "shippingMethodCode": "<string>",
    "shippingMethodName": "<string>"
  },
  "handlingAdjustment": {
    "amount": 123,
    "description": "<string>",
    "internalComment": "<string>"
  },
  "handlingAmount": 123,
  "handlingDiscounts": [
    {
      "couponCode": "<string>",
      "data": {},
      "discount": {
        "expirationDate": "2023-11-07T05:31:56Z",
        "hasMultipleTargetProducts": true,
        "id": 123,
        "itemIds": [
          "<string>"
        ],
        "name": "<string>"
      },
      "excluded": true,
      "groupId": "<string>",
      "impact": 123
    }
  ],
  "handlingSubTotal": 123,
  "handlingTax": 123,
  "handlingTaxTotal": 123,
  "handlingTotal": 123,
  "hasDraft": true,
  "id": "<string>",
  "invalidCoupons": [
    {
      "couponCode": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "discountId": 123,
      "reason": "<string>",
      "reasonCode": 123
    }
  ],
  "ipAddress": "<string>",
  "isDraft": true,
  "isImport": true,
  "isOrderReminderEmailSent": true,
  "isPartialDraft": true,
  "isReactivationReminderEmailSent": true,
  "isTaxExempt": true,
  "itemLevelAdjustmentsTotal": 123,
  "itemLevelHandlingDiscountTotal": 123,
  "itemLevelProductDiscountTotal": 123,
  "itemLevelShippingDiscountTotal": 123,
  "itemTaxTotal": 123,
  "itemTotal": 123,
  "items": [
    {
      "adjustedLineItemSubtotal": 123,
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "autoAddDiscountId": 123,
      "childItemIds": [
        "<string>"
      ],
      "data": {},
      "discountTotal": 123,
      "discountedTotal": 123,
      "dutyAmount": 123,
      "extendedTotal": 123,
      "feeTotal": 123,
      "handlingAmount": 123,
      "inventoryTags": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "isAssemblyRequired": true,
      "isRecurring": true,
      "isTaxable": true,
      "itemTaxTotal": 123,
      "lineId": 123,
      "lineItemAdjustment": 123,
      "localeCode": "<string>",
      "parentItemId": "<string>",
      "product": {
        "allocationExpiration": "2023-11-07T05:31:56Z",
        "allocationId": 123,
        "description": "<string>",
        "fulfillmentStatus": "<string>",
        "goodsType": "<string>",
        "isPackagedStandAlone": true,
        "measurements": {
          "height": {
            "unit": "<string>",
            "value": 123
          },
          "length": {
            "unit": "<string>",
            "value": 123
          },
          "weight": {
            "unit": "<string>",
            "value": 123
          },
          "width": {
            "unit": "<string>",
            "value": 123
          }
        },
        "name": "<string>",
        "productCode": "<string>",
        "productReservationId": 123,
        "stock": {
          "aggregateInventory": 123,
          "availableDate": "2023-11-07T05:31:56Z",
          "availableFutureInventories": 123,
          "futureInventories": [
            {
              "allocated": 123,
              "available": 123,
              "createDate": "2023-11-07T05:31:56Z",
              "deliveryDate": "2023-11-07T05:31:56Z",
              "futureInventoryID": 123,
              "onhand": 123,
              "pending": 123
            }
          ],
          "isOnBackOrder": true,
          "isSubstitutable": true,
          "manageStock": true,
          "stockAvailable": 123,
          "totalAvailableStock": 123
        },
        "bundledProducts": [
          {
            "allocationExpiration": "2023-11-07T05:31:56Z",
            "allocationId": 123,
            "description": "<string>",
            "fulfillmentStatus": "<string>",
            "goodsType": "<string>",
            "isPackagedStandAlone": true,
            "measurements": {
              "height": {
                "unit": "<string>",
                "value": 123
              },
              "length": {
                "unit": "<string>",
                "value": 123
              },
              "weight": {
                "unit": "<string>",
                "value": 123
              },
              "width": {
                "unit": "<string>",
                "value": 123
              }
            },
            "name": "<string>",
            "productCode": "<string>",
            "productReservationId": 123,
            "stock": {
              "aggregateInventory": 123,
              "availableDate": "2023-11-07T05:31:56Z",
              "availableFutureInventories": 123,
              "futureInventories": [
                {
                  "allocated": 123,
                  "available": 123,
                  "createDate": "2023-11-07T05:31:56Z",
                  "deliveryDate": "2023-11-07T05:31:56Z",
                  "futureInventoryID": 123,
                  "onhand": 123,
                  "pending": 123
                }
              ],
              "isOnBackOrder": true,
              "isSubstitutable": true,
              "manageStock": true,
              "stockAvailable": 123,
              "totalAvailableStock": 123
            },
            "creditValue": 123,
            "deltaPrice": 123,
            "imageUrl": "<string>",
            "optionAttributeFQN": "<string>",
            "optionValue": "<unknown>",
            "quantity": 123
          }
        ],
        "categories": [
          {
            "id": 123,
            "parent": {}
          }
        ],
        "condition": "<string>",
        "discountsRestricted": true,
        "discountsRestrictedEndDate": "2023-11-07T05:31:56Z",
        "discountsRestrictedStartDate": "2023-11-07T05:31:56Z",
        "fulfillmentFields": [
          {
            "name": "<string>",
            "required": true,
            "userEnteredValue": null
          }
        ],
        "fulfillmentTypesSupported": [
          "<string>"
        ],
        "imageAlternateText": "<string>",
        "imageUrl": "<string>",
        "isRecurring": true,
        "isTaxable": true,
        "mfgPartNumber": "<string>",
        "options": [
          {
            "attributeFQN": "<string>",
            "dataType": "<string>",
            "name": "<string>",
            "shopperEnteredValue": "<unknown>",
            "stringValue": "<string>",
            "value": "<unknown>"
          }
        ],
        "price": {
          "creditValue": 123,
          "isOverRidePriceSalePrice": true,
          "msrp": 123,
          "price": 123,
          "priceListCode": "<string>",
          "priceListEntryMode": "<string>",
          "salePrice": 123,
          "tenantOverridePrice": 123
        },
        "productType": "<string>",
        "productUsage": "<string>",
        "properties": [
          {
            "attributeFQN": "<string>",
            "dataType": "<string>",
            "isMultiValue": true,
            "name": "<string>",
            "values": [
              {
                "stringValue": "<string>",
                "value": null
              }
            ]
          }
        ],
        "serialNumber": "<string>",
        "sku": "<string>",
        "upc": "<string>",
        "variationProductCode": "<string>"
      },
      "productDiscount": {
        "couponCode": "<string>",
        "data": {},
        "discount": {
          "expirationDate": "2023-11-07T05:31:56Z",
          "hasMultipleTargetProducts": true,
          "id": 123,
          "itemIds": [
            "<string>"
          ],
          "name": "<string>"
        },
        "excluded": true,
        "groupId": "<string>",
        "impact": 123,
        "appliesToSalePrice": true,
        "impactPerUnit": 123,
        "productQuantity": 123,
        "discountQuantity": 123
      },
      "productDiscounts": [
        {
          "couponCode": "<string>",
          "data": {},
          "discount": {
            "expirationDate": "2023-11-07T05:31:56Z",
            "hasMultipleTargetProducts": true,
            "id": 123,
            "itemIds": [
              "<string>"
            ],
            "name": "<string>"
          },
          "excluded": true,
          "groupId": "<string>",
          "impact": 123,
          "appliesToSalePrice": true,
          "impactPerUnit": 123,
          "productQuantity": 123,
          "discountQuantity": 123
        }
      ],
      "purchaseLocation": "<string>",
      "quantity": 123,
      "shippingAmountBeforeDiscountsAndAdjustments": 123,
      "shippingDiscounts": [
        {
          "discount": {
            "couponCode": "<string>",
            "data": {},
            "discount": {
              "expirationDate": "2023-11-07T05:31:56Z",
              "hasMultipleTargetProducts": true,
              "id": 123,
              "itemIds": [
                "<string>"
              ],
              "name": "<string>"
            },
            "excluded": true,
            "groupId": "<string>",
            "impact": 123
          },
          "methodCode": "<string>",
          "discountQuantity": 123,
          "impactPerUnit": 123
        }
      ],
      "shippingTaxTotal": 123,
      "shippingTotal": 123,
      "substituteInfo": {
        "optIn": "<string>",
        "substituteProductCode": "<string>",
        "substituteVariantCode": "<string>"
      },
      "subtotal": 123,
      "taxData": {},
      "taxableTotal": 123,
      "total": 123,
      "totalWithWeightedShippingAndHandling": 123,
      "totalWithoutWeightedShippingAndHandling": 123,
      "unitPrice": {
        "extendedAmount": 123,
        "listAmount": 123,
        "overrideAmount": 123,
        "saleAmount": 123
      },
      "weightedOrderAdjustment": 123,
      "weightedOrderDiscount": 123,
      "weightedOrderDuty": 123,
      "weightedOrderHandlingAdjustment": 123,
      "weightedOrderHandlingFee": 123,
      "weightedOrderHandlingFeeDiscount": 123,
      "weightedOrderHandlingFeeTax": 123,
      "weightedOrderShipping": 123,
      "weightedOrderShippingDiscount": 123,
      "weightedOrderShippingManualAdjustment": 123,
      "weightedOrderShippingTax": 123,
      "weightedOrderTax": 123,
      "fulfillmentLocationCode": "<string>",
      "fulfillmentMethod": "<string>",
      "id": "<string>",
      "isOnetimeItem": true,
      "parentItemCode": "<string>",
      "shippingMethodCode": "<string>",
      "shippingMethodName": "<string>"
    }
  ],
  "lastContinuityOrderDateOnSubPaused": "2023-11-07T05:31:56Z",
  "lastOrderNowDate": "2023-11-07T05:31:56Z",
  "lineItemSubtotalWithOrderAdjustments": 123,
  "locationCode": "<string>",
  "nextOrderDate": "2023-11-07T05:31:56Z",
  "nextOrderDateAuditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "nextOrderDateOffsetCounter": 123,
  "notes": [
    {
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "id": "<string>",
      "text": "<string>"
    }
  ],
  "number": 123,
  "orderDiscounts": [
    {
      "couponCode": "<string>",
      "data": {},
      "discount": {
        "expirationDate": "2023-11-07T05:31:56Z",
        "hasMultipleTargetProducts": true,
        "id": 123,
        "itemIds": [
          "<string>"
        ],
        "name": "<string>"
      },
      "excluded": true,
      "groupId": "<string>",
      "impact": 123
    }
  ],
  "orderLevelHandlingDiscountTotal": 123,
  "orderLevelProductDiscountTotal": 123,
  "orderLevelShippingDiscountTotal": 123,
  "ordinal": 123,
  "parentOrderId": "<string>",
  "pauseDate": "2023-11-07T05:31:56Z",
  "payment": {
    "amountCollected": 123,
    "amountCredited": 123,
    "amountRequested": 123,
    "auditInfo": {
      "createBy": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "updateBy": "<string>",
      "updateDate": "2023-11-07T05:31:56Z"
    },
    "availableActions": [
      "<string>"
    ],
    "billingInfo": {
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "billingContact": {
        "address": {
          "address1": "<string>",
          "address2": "<string>",
          "address3": "<string>",
          "address4": "<string>",
          "addressType": "<string>",
          "cityOrTown": "<string>",
          "countryCode": "<string>",
          "isValidated": true,
          "postalOrZipCode": "<string>",
          "stateOrProvince": "<string>"
        },
        "companyOrOrganization": "<string>",
        "email": "<string>",
        "firstName": "<string>",
        "id": 123,
        "lastNameOrSurname": "<string>",
        "middleNameOrInitial": "<string>",
        "phoneNumbers": {
          "home": "<string>",
          "mobile": "<string>",
          "work": "<string>"
        }
      },
      "card": {
        "bin": "<string>",
        "cardNumberPartOrMask": "<string>",
        "expireMonth": 123,
        "expireYear": 123,
        "paymentOrCardType": "<string>",
        "ccLastFour": "<string>",
        "isCardInfoSaved": true,
        "isTokenized": true,
        "isUsedRecurring": true,
        "nameOnCard": "<string>",
        "paymentServiceCardId": "<string>"
      },
      "check": {
        "checkNumber": "<string>"
      },
      "customCreditType": "<string>",
      "data": {},
      "externalTransactionId": "<string>",
      "isRecurring": true,
      "isSameBillingShippingAddress": true,
      "paymentType": "<string>",
      "paymentWorkflow": "<string>",
      "purchaseOrder": {
        "customFields": [
          {
            "code": "<string>",
            "label": "<string>",
            "value": "<string>"
          }
        ],
        "paymentTerm": {
          "code": "<string>",
          "description": "<string>"
        },
        "purchaseOrderNumber": "<string>"
      },
      "recurringTransactionId": "<string>",
      "storeCreditCode": "<string>",
      "storeCreditType": "<string>",
      "token": {
        "paymentServiceTokenId": "<string>",
        "type": "<string>"
      }
    },
    "changeMessages": [
      {
        "amount": 123,
        "appId": "<string>",
        "appKey": "<string>",
        "appName": "<string>",
        "attributes": {},
        "correlationId": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "identifier": "<string>",
        "message": "<string>",
        "metadata": "<unknown>",
        "newValue": "<string>",
        "oldValue": "<string>",
        "subject": "<string>",
        "subjectType": "<string>",
        "success": true,
        "userFirstName": "<string>",
        "userId": "<string>",
        "userLastName": "<string>",
        "userScopeType": "<string>",
        "verb": "<string>"
      }
    ],
    "data": {},
    "externalTransactionId": "<string>",
    "gatewayGiftCard": {
      "amount": 123,
      "cardNumber": "<string>",
      "cardPin": "<string>",
      "currencyCode": "<string>",
      "id": "<string>"
    },
    "groupId": {
      "targetId": "<string>",
      "targetNumber": 123,
      "targetType": "<string>"
    },
    "id": "<string>",
    "installmentPlanCode": "<string>",
    "interactions": [
      {
        "amount": 123,
        "auditInfo": {
          "createBy": "<string>",
          "createDate": "2023-11-07T05:31:56Z",
          "updateBy": "<string>",
          "updateDate": "2023-11-07T05:31:56Z"
        },
        "capturableShipmentsSummary": [
          {
            "amountApplied": 123,
            "shipmentNumber": 123,
            "shipmentTotal": 123
          }
        ],
        "checkNumber": "<string>",
        "currencyCode": "<string>",
        "gatewayAVSCodes": "<string>",
        "gatewayAuthCode": "<string>",
        "gatewayCVV2Codes": "<string>",
        "gatewayInteractionId": 123,
        "gatewayResponseCode": "<string>",
        "gatewayResponseData": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ],
        "gatewayResponseText": "<string>",
        "gatewayTransactionId": "<string>",
        "id": "<string>",
        "interactionDate": "2023-11-07T05:31:56Z",
        "interactionType": "<string>",
        "isManual": true,
        "isPending": true,
        "isRecurring": true,
        "note": "<string>",
        "orderId": "<string>",
        "paymentEntryStatus": "<string>",
        "paymentId": "<string>",
        "paymentTransactionInteractionIdReference": 123,
        "refundId": "<string>",
        "returnId": "<string>",
        "status": "<string>",
        "target": {
          "targetId": "<string>",
          "targetNumber": 123,
          "targetType": "<string>"
        }
      }
    ],
    "isRecurring": true,
    "orderId": "<string>",
    "paymentServiceTransactionId": "<string>",
    "paymentType": "<string>",
    "paymentWorkflow": "<string>",
    "status": "<string>",
    "subPayments": [
      {
        "amountCollected": 123,
        "amountCredited": 123,
        "amountRefunded": 123,
        "amountRequested": 123,
        "status": "<string>",
        "target": {
          "targetId": "<string>",
          "targetNumber": 123,
          "targetType": "<string>"
        }
      }
    ]
  },
  "paymentErrorCode": "<string>",
  "previousFrequency": {
    "unit": "<string>",
    "value": 123
  },
  "previousNextOrderDate": "2023-11-07T05:31:56Z",
  "priceListCode": "<string>",
  "processingErrorMessage": "<string>",
  "reactivationDate": "2023-11-07T05:31:56Z",
  "reasons": [
    {
      "actionName": "<string>",
      "description": "<string>",
      "moreInfo": "<string>",
      "reasonCode": "<string>"
    }
  ],
  "shippingAdjustment": {
    "amount": 123,
    "description": "<string>",
    "internalComment": "<string>"
  },
  "shippingAmount": 123,
  "shippingDiscounts": [
    {
      "discount": {
        "couponCode": "<string>",
        "data": {},
        "discount": {
          "expirationDate": "2023-11-07T05:31:56Z",
          "hasMultipleTargetProducts": true,
          "id": 123,
          "itemIds": [
            "<string>"
          ],
          "name": "<string>"
        },
        "excluded": true,
        "groupId": "<string>",
        "impact": 123
      },
      "methodCode": "<string>"
    }
  ],
  "shippingSubTotal": 123,
  "shippingTax": 123,
  "shippingTaxTotal": 123,
  "shippingTotal": 123,
  "siteId": 123,
  "skipCounter": 123,
  "sourceDevice": "<string>",
  "status": "<string>",
  "subTotal": 123,
  "taxData": {},
  "tenantId": 123,
  "total": 123,
  "trial": {
    "duration": 123,
    "enabled": true,
    "substituteProductCode": "<string>",
    "substituteProductOptions": [
      {
        "attributeFQN": "<string>",
        "dataType": "<string>",
        "name": "<string>",
        "shopperEnteredValue": "<unknown>",
        "stringValue": "<string>",
        "value": "<unknown>"
      }
    ],
    "substituteProductQuantity": 123,
    "substituteVariationProductCode": "<string>"
  },
  "userId": "<string>",
  "visitId": "<string>",
  "webSessionId": "<string>"
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Body

application/json

The subscription.

​
adjustment
object
​
attributes
object[] | null
​
auditInfo
object
​
changeMessages
object[] | null

Change Messages

​
channelCode
string | null

Unique identifier of the channel for this item.

​
couponCodes
string[] | null

Coupon codes associated with this Subscription.

​
currencyCode
string | null

ISO Currency Code.

​
customerAccountId
integer<int32> | null

Unique identifier of the customer account.

​
customerInteractionType
string | null

Determines the interaction type that a customer will use to create this object. Valid values are: Website, Store, Call, Unknown

​
data
object

Custom data for a given vendor set within the commerce process.

​
discountedSubtotal
number<double>

Discounted Subtotal

​
dutyAmount
number<double> | null
​
dutyTotal
number<double>
​
email
string | null

Email address for checkout

​
externalId
string | null
​
feeTotal
number<double>
​
frequency
object
​
frequencyAuditInfo
object
​
fulfillmentInfo
object

Shipment information, which includes the shipping address, price, estimated delivery date, tracking information, method (for example, Ground, Overnight, or Pick-up), carrier (for example, USPS, UPS, FedEx), and current status (for example, Not Shipped, In Transit, Delayed, or Returned To Sender).

​
handlingAdjustment
object
​
handlingAmount
number<double> | null
​
handlingDiscounts
object[] | null
​
handlingSubTotal
number<double>
​
handlingTax
number<double> | null
​
handlingTaxTotal
number<double>
​
handlingTotal
number<double>
​
hasDraft
boolean | null

Does this subscription have a draft version.

​
id
string | null

Unique identifier.

​
invalidCoupons
object[] | null

A list of invalid coupons that were attempted on the Subscription

​
ipAddress
string | null

IP address of the user placing the order. (User or customer?)

​
isDraft
boolean | null

Is this subscription a draft version

​
isImport
boolean
​
isOrderReminderEmailSent
boolean

Has order reminder email sent.

​
isPartialDraft
boolean

Is this subscription draft is a partial draft.

​
isReactivationReminderEmailSent
boolean

Has reactivation reminder email sent.

​
itemLevelAdjustmentsTotal
number<double>

The total value of all line item adjustments

​
itemLevelHandlingDiscountTotal
number<double>
​
itemLevelProductDiscountTotal
number<double>

The total value of item-level product discounts.

​
itemLevelShippingDiscountTotal
number<double>
​
itemTaxTotal
number<double>

Total tax on products.

​
itemTotal
number<double>

The total product cost, accounting for discounts and tax.

​
items
object[] | null

List of items in the Subscription.

​
lastContinuityOrderDateOnSubPaused
string<date-time> | null
​
lastOrderNowDate
string<date-time> | null

Indicate when "order now" and "partial order now" performed last time.

​
lineItemSubtotalWithOrderAdjustments
number<double> | null

Line Item Subtotals with Order Adjustments

​
locationCode
string | null

Identifies the location at which the order was placed if the order was placed externally.

​
nextOrderDate
string<date-time> | null
​
nextOrderDateAuditInfo
object
​
nextOrderDateOffsetCounter
integer<int32> | null

counter to keep track of nextOrderDate limit.

​
notes
object[] | null

Notes

​
number
integer<int32>

Subscription number.

​
orderDiscounts
object[] | null
​
orderLevelHandlingDiscountTotal
number<double>
​
orderLevelProductDiscountTotal
number<double>

The total value of order-level (group-level) product discounts.

​
orderLevelShippingDiscountTotal
number<double>
​
ordinal
integer<int32>
​
parentOrderId
string | null

The parent order id from which the subscription was created.

​
pauseDate
string<date-time> | null
​
payment
object

Payment transaction associated with this order. It is the entire payment interchange between the merchant who is forwarding the customer's payment information and the payment service who is authorizing and capturing payment. Payment can be either by credit card, check, or PayPal. (PayPal not currently supported.)

​
paymentErrorCode
string | null
​
previousFrequency
object
​
previousNextOrderDate
string<date-time> | null
​
priceListCode
string | null

Price-list code for the Subscription

​
processingErrorMessage
string | null

LastErrorMessage from subscription ProcessingInfo.

​
reactivationDate
string<date-time>

This property is being used for reactivation email templete

​
reasons
object[] | null
​
shippingAdjustment
object
​
shippingAmount
number<double>
​
shippingDiscounts
object[] | null
​
shippingSubTotal
number<double>
​
shippingTax
number<double> | null
​
shippingTaxTotal
number<double>
​
shippingTotal
number<double>
​
siteId
integer<int32>

Unique identifier of the Site.

​
skipCounter
integer<int32> | null

counter to keep track of skip limit

​
sourceDevice
string | null

Source device of the user placing the order. (User or customer?)

​
status
string | null
​
subTotal
number<double>

Subtotal before any coupon codes, taxes, fees, etc.

​
taxData
object

Storage for any additional/custom tax data.

​
tenantId
integer<int32>

Unique identifier of the Tenant.

​
total
number<double>

Final total

​
trial
object
​
userId
string | null
​
visitId
string | null

Identifies the Visit ID that was current when the order was placed or when the cart was last updated.

​
webSessionId
string | null

Identifies the web session used to place the order or last update the cart.

Response

Success

​
adjustment
object
​
attributes
object[] | null
​
auditInfo
object
​
changeMessages
object[] | null

Change Messages

​
channelCode
string | null

Unique identifier of the channel for this item.

​
couponCodes
string[] | null

Coupon codes associated with this Subscription.

​
currencyCode
string | null

ISO Currency Code.

​
customerAccountId
integer<int32> | null

Unique identifier of the customer account.

​
customerInteractionType
string | null

Determines the interaction type that a customer will use to create this object. Valid values are: Website, Store, Call, Unknown

​
customerTaxId
string | null

The customers tax ID. If Customer Account ID exists in the system, will set this.

​
data
object

Custom data for a given vendor set within the commerce process.

​
discountedSubtotal
number<double>

Discounted Subtotal

​
dutyAmount
number<double> | null
​
dutyTotal
number<double>
​
email
string | null

Email address for checkout

​
externalId
string | null
​
feeTotal
number<double>
​
frequency
object
​
frequencyAuditInfo
object
​
fulfillmentInfo
object

Shipment information, which includes the shipping address, price, estimated delivery date, tracking information, method (for example, Ground, Overnight, or Pick-up), carrier (for example, USPS, UPS, FedEx), and current status (for example, Not Shipped, In Transit, Delayed, or Returned To Sender).

​
handlingAdjustment
object
​
handlingAmount
number<double> | null
​
handlingDiscounts
object[] | null
​
handlingSubTotal
number<double>
​
handlingTax
number<double> | null
​
handlingTaxTotal
number<double>
​
handlingTotal
number<double>
​
hasDraft
boolean | null

Does this subscription have a draft version.

​
id
string | null

Unique identifier.

​
invalidCoupons
object[] | null

A list of invalid coupons that were attempted on the Subscription

​
ipAddress
string | null

IP address of the user placing the order. (User or customer?)

​
isDraft
boolean | null

Is this subscription a draft version

​
isImport
boolean
​
isOrderReminderEmailSent
boolean

Has order reminder email sent.

​
isPartialDraft
boolean

Is this subscription draft is a partial draft.

​
isReactivationReminderEmailSent
boolean

Has reactivation reminder email sent.

​
isTaxExempt
boolean | null

Unique identifier of the customer account.

​
itemLevelAdjustmentsTotal
number<double>

The total value of all line item adjustments

​
itemLevelHandlingDiscountTotal
number<double>
​
itemLevelProductDiscountTotal
number<double>

The total value of item-level product discounts.

​
itemLevelShippingDiscountTotal
number<double>
​
itemTaxTotal
number<double>

Total tax on products.

​
itemTotal
number<double>

The total product cost, accounting for discounts and tax.

​
items
object[] | null

List of items in the Subscription.

​
lastContinuityOrderDateOnSubPaused
string<date-time> | null
​
lastOrderNowDate
string<date-time> | null

Indicate when "order now" and "partial order now" performed last time.

​
lineItemSubtotalWithOrderAdjustments
number<double> | null

Line Item Subtotals with Order Adjustments

​
locationCode
string | null

Identifies the location at which the order was placed if the order was placed externally.

​
nextOrderDate
string<date-time> | null
​
nextOrderDateAuditInfo
object
​
nextOrderDateOffsetCounter
integer<int32> | null

counter to keep track of nextOrderDate limit.

​
notes
object[] | null

Notes

​
number
integer<int32>

Subscription number.

​
orderDiscounts
object[] | null
​
orderLevelHandlingDiscountTotal
number<double>
​
orderLevelProductDiscountTotal
number<double>

The total value of order-level (group-level) product discounts.

​
orderLevelShippingDiscountTotal
number<double>
​
ordinal
integer<int32>
​
parentOrderId
string | null

The parent order id from which the subscription was created.

​
pauseDate
string<date-time> | null
​
payment
object

Payment transaction associated with this order. It is the entire payment interchange between the merchant who is forwarding the customer's payment information and the payment service who is authorizing and capturing payment. Payment can be either by credit card, check, or PayPal. (PayPal not currently supported.)

​
paymentErrorCode
string | null
​
previousFrequency
object
​
previousNextOrderDate
string<date-time> | null
​
priceListCode
string | null

Price-list code for the Subscription

​
processingErrorMessage
string | null

LastErrorMessage from subscription ProcessingInfo.

​
reactivationDate
string<date-time>

This property is being used for reactivation email templete

​
reasons
object[] | null
​
shippingAdjustment
object
​
shippingAmount
number<double>
​
shippingDiscounts
object[] | null
​
shippingSubTotal
number<double>
​
shippingTax
number<double> | null
​
shippingTaxTotal
number<double>
​
shippingTotal
number<double>
​
siteId
integer<int32>

Unique identifier of the Site.

​
skipCounter
integer<int32> | null

counter to keep track of skip limit

​
sourceDevice
string | null

Source device of the user placing the order. (User or customer?)

​
status
string | null
​
subTotal
number<double>

Subtotal before any coupon codes, taxes, fees, etc.

​
taxData
object

Storage for any additional/custom tax data.

​
tenantId
integer<int32>

Unique identifier of the Tenant.

​
total
number<double>

Final total

​
trial
object
​
userId
string | null
​
visitId
string | null

Identifies the Visit ID that was current when the order was placed or when the cart was last updated.

​
webSessionId
string | null

Identifies the web session used to place the order or last update the cart.