Model: PaymentPlanModel

1 min

Model Parameters

PaymentPlanModel
- addressIdstring
  Description
  Address ID.
- affiliateIdstring<uuid>
  Description
  Affiliate ID (GUID).
  Format
  uuid
- billingCurrencystring
  Description
  Billing currency.
- customerIdstring<uuid>
  Description
  Customer ID (GUID).
  Format
  uuid
- customerNamestring
  Description
  Customer name.
- handlingTotalnumber<double>
  Description
  Handling total.
  Format
  double
- instanceIdstring<uuid>
  Description
  Instance ID (GUID).
  Format
  uuid
- marketIdstring
  Description
  Market ID.
- namestringrequired
  Description
  Order name.
- orderAddressesOrderAddressModel[]
  Description
  List of addresses.
  - orderGroupAddressIdinteger<int32>
    Description
    Gets the order group address id.
    Format
    int32
  - namestring
    Description
    Gets or sets the name.
  - firstNamestring
    Description
    Gets or sets the first name.
  - lastNamestring
    Description
    Gets or sets last name.
  - organizationstring
    Description
    Gets or sets the organization.
  - line1string
    Description
    Gets or sets the line1.
  - line2string
    Description
    Gets or sets the line2.
  - citystring
    Description
    Gets or sets the city.
  - statestring
    Description
    Gets or sets the state.
  - countryCodestring
    Description
    Gets or sets the country code.
  - countryNamestring
    Description
    Gets or sets the name of the country.
  - postalCodestring
    Description
    Gets or sets the postal code.
  - regionCodestring
    Description
    Gets or sets the region code.
  - regionNamestring
    Description
    Gets or sets the name of the region.
  - daytimePhoneNumberstring
    Description
    Gets or sets the daytime phone number.
  - eveningPhoneNumberstring
    Description
    Gets or sets the evening phone number.
  - faxNumberstring
    Description
    Gets or sets the fax number.
  - emailstring
    Description
    Gets or sets the email.
  - propertiesPropertyItemModel[]
    Description
    Gets the list of key value pairs for dealing with custom properties.
    - keystring
      Description
      Key of the property.
    - valuestring
      Description
      Value of the property.
- orderFormsOrderFormModel[]
  Description
  List of order forms.
  - shipmentsShipmentModel[]
    Description
    Gets or sets the shipments.
    - discountsModelDiscountModel[]
      Description
      Gets the discounts.
      - discountIdinteger<int32>
        Description
        Gets or sets the discount id.
        Format
        int32
      - discountAmountnumber<double>
        Description
        Gets or sets the discount amount. Either fixed money value or percentage.
        Format
        double
      - discountCodestring
        Description
        Gets or sets the discount code. Also known as a coupon code.
      - discountNamestring
        Description
        Gets or sets the name of the discount.
      - displayMessagestring
        Description
        Gets or sets the display message.
      - discountValuenumber<double>
        Description
        Gets or sets the discount amount. The amount of discount that was applied. It will equal to DiscountAmount if it is a fixed monetary value. For the percentage based discount this value will be different.
        Format
        double
    - shipmentIdinteger<int32>
      Description
      Gets the shipment id.
      Format
      int32
    - shippingMethodIdstring<uuid>
      Description
      Gets or sets the shipping method id.
      Format
      uuid
    - shippingMethodNamestring
      Description
      Gets or sets the name of the shipping method.
    - shippingTaxnumber<double>
      Description
      Gets or sets the shipment tax.
      Format
      double
    - shippingAddressIdstring
      Description
      Gets or sets the shipping address name.
    - shipmentTrackingNumberstring
      Description
      Gets or sets the shipment tracking number.
    - shippingDiscountAmountnumber<double>
      Description
      Gets or sets the shipping discount amount.
      Format
      double
    - shippingSubTotalnumber<double>
      Description
      Gets or sets the shipping sub total.
      Format
      double
    - shippingTotalnumber<double>
      Description
      Gets or sets the total shipping cost, including shipping discounts (if any) and shipping tax.
      Format
      double
    - statusstring
      Description
      Gets or sets the status.
    - prevStatusstring
      Description
      Gets or sets the previous status.
    - pickListIdinteger<int32>
      Description
      Gets or sets the pick list id.
      Format
      int32
    - subTotalnumber<double>
      Description
      Gets or sets the sub total.
      Format
      double
    - warehouseCodestring
      Description
      Gets or sets the warehouse code.
    - lineItemsLineItemModel[]
      Description
      Gets or sets the collection of line items.
      - lineItemIdinteger<int32>
        Description
        Gets the identity of the line item.
        Format
        int32
      - codestring
        Description
        Gets the code of the variation content the line item represent. This property works as the connection between the line item and the variation content.
      - displayNamestring
        Description
        Gets or sets the display name.
      - placedPricenumber<double>
        Description
        Gets the price for one item that this line item represent. This property don't take any discounts in consideration.
        Format
        double
      - extendedPricenumber<double>
        Description
        Gets the extended price for the line item. Includes order-level discount amount (which is spread over all line items in the shipment) and the line item discount amount.
        Format
        double
      - discountedPricenumber<double>
        Description
        Gets the line item discounted price. Only calculates the price with the "line item discount amount," that is, the discount for a specific item.
        Format
        double
      - quantitynumber<double>
        Description
        Gets or sets the number of items this line item contains.
        Format
        double
      - returnQuantitynumber<double>
        Description
        Gets or sets the returned in stock quantity.
        Format
        double
      - inventoryTrackingStatusInventoryTrackingStatus
      - isInventoryAllocatedboolean
        Description
        Gets or sets a value indicating whether this instance has allocated inventory for the EPiServer.Commerce.Order.ILineItem.Quantity.
      - isGiftboolean
        Description
        Gets or sets a value indicating whether the line item is a gift item.
      - propertiesPropertyItemModel[]
        Description
        Gets the list of key value pairs for dealing with custom properties.
        keystring
        Description
        Key of the property.
        valuestring
        Description
        Value of the property.
    - propertiesPropertyItemModel[]
      Description
      Gets or sets the list of key value pairs for dealing with custom properties.
      - keystring
        Description
        Key of the property.
      - valuestring
        Description
        Value of the property.
  - lineItemsLineItemModel[]
    Description
    Gets or sets the line items.
    - lineItemIdinteger<int32>
      Description
      Gets the identity of the line item.
      Format
      int32
    - codestring
      Description
      Gets the code of the variation content the line item represent. This property works as the connection between the line item and the variation content.
    - displayNamestring
      Description
      Gets or sets the display name.
    - placedPricenumber<double>
      Description
      Gets the price for one item that this line item represent. This property don't take any discounts in consideration.
      Format
      double
    - extendedPricenumber<double>
      Description
      Gets the extended price for the line item. Includes order-level discount amount (which is spread over all line items in the shipment) and the line item discount amount.
      Format
      double
    - discountedPricenumber<double>
      Description
      Gets the line item discounted price. Only calculates the price with the "line item discount amount," that is, the discount for a specific item.
      Format
      double
    - quantitynumber<double>
      Description
      Gets or sets the number of items this line item contains.
      Format
      double
    - returnQuantitynumber<double>
      Description
      Gets or sets the returned in stock quantity.
      Format
      double
    - inventoryTrackingStatusInventoryTrackingStatus
    - isInventoryAllocatedboolean
      Description
      Gets or sets a value indicating whether this instance has allocated inventory for the EPiServer.Commerce.Order.ILineItem.Quantity.
    - isGiftboolean
      Description
      Gets or sets a value indicating whether the line item is a gift item.
    - propertiesPropertyItemModel[]
      Description
      Gets the list of key value pairs for dealing with custom properties.
      - keystring
        Description
        Key of the property.
      - valuestring
        Description
        Value of the property.
  - paymentsPaymentModel[]
    - amountnumber<double>
      Format
      double
    - authorizationCodestring
    - billingAddressIdstring
    - customerNamestring
    - implementationClassstring
    - paymentIdinteger<int32>
      Format
      int32
    - paymentMethodIdstring<uuid>
      Format
      uuid
    - paymentMethodNamestring
    - paymentTypeModelPaymentTypeModel
    - statusstring
    - transactionTypestring
    - validationCodestring
    - transactionIDstring
    - providerTransactionIDstring
    - propertiesPropertyItemModel[]
      Description
      Custom property item.
      - keystring
        Description
        Key of the property.
      - valuestring
        Description
        Value of the property.
  - discountsDiscountModel[]
    Description
    Gets or sets the discounts.
    - discountIdinteger<int32>
      Description
      Gets or sets the discount id.
      Format
      int32
    - discountAmountnumber<double>
      Description
      Gets or sets the discount amount. Either fixed money value or percentage.
      Format
      double
    - discountCodestring
      Description
      Gets or sets the discount code. Also known as a coupon code.
    - discountNamestring
      Description
      Gets or sets the name of the discount.
    - displayMessagestring
      Description
      Gets or sets the display message.
    - discountValuenumber<double>
      Description
      Gets or sets the discount amount. The amount of discount that was applied. It will equal to DiscountAmount if it is a fixed monetary value. For the percentage based discount this value will be different.
      Format
      double
  - returnCommentstring
    Description
    Gets or sets the rma comment.
  - returnTypestring
    Description
    Gets or sets the Return Type. For example can be "Refund", "Exchange" etc.
  - returnAuthCodestring
    Description
    Gets or sets the RMA auth code. Using for procedure RMA authentications.
  - orderFormIdinteger<int32>
    Description
    Gets the order form id.
    Format
    int32
  - namestring
    Description
    Gets or sets the name.
  - billingAddressIdstring
    Description
    Gets or sets the billing address id. The id is the name of the address in OrderAddress collection.
  - shippingTotalnumber<double>
    Description
    Gets or sets the shipping total, does not includes discounts that have been applied to each shipment.
    Format
    double
  - handlingTotalnumber<double>
    Description
    Gets or sets the handling total.
    Format
    double
  - taxTotalnumber<double>
    Description
    Gets or sets the tax total.
    Format
    double
  - discountAmountnumber<double>
    Description
    Gets or sets the discount amount. This amount includes shipping discounts as well.
    Format
    double
  - subTotalnumber<double>
    Description
    Gets or sets the sub total.
    Format
    double
  - totalnumber<double>
    Description
    Gets or sets the total.
    Format
    double
  - statusstring
    Description
    Gets or sets the status.
  - rmaNumberstring
    Description
    Gets or sets the RMA number.
  - authorizedPaymentTotalnumber<double>
    Description
    Gets or sets the authorized payment total.
    Format
    double
  - capturedPaymentTotalnumber<double>
    Description
    Gets or sets the captured payment total.
    Format
    double
  - propertiesPropertyItemModel[]
    Description
    Gets the list of key value pairs for dealing with custom properties.
    - keystring
      Description
      Key of the property.
    - valuestring
      Description
      Value of the property.
- orderGroupIdinteger<int32>
  Description
  Order group ID.
  Format
  int32
- orderNotesOrderNoteModel[]
  Description
  List of order notes.
  - orderNoteIdinteger<int32>
    Description
    Gets the order note ID.
    Format
    int32
  - createdstring<date-time>
    Description
    Gets Created date.
    Format
    date-time
  - customerIdstring<uuid>
    Description
    Gets or sets note customer ID.
    Format
    uuid
  - detailstring
    Description
    Gets or sets note details.
  - titlestring
    Description
    Gets or sets note title.
  - typestring
    Description
    Gets or sets note type.
  - lineItemIdinteger<int32>
    Description
    Gets or sets note related line item ID.
    Format
    int32
- ownerstring
  Description
  Owner name.
- ownerOrgstring
  Description
  Owner's organization name.
- providerIdstring
  Description
  Provider ID.
- shippingTotalnumber<double>
  Description
  Shipping total.
  Format
  double
- statusstring
  Description
  Status. Valid values:
  
  AwaitingExchange
  
  Cancelled
  
  Completed
  
  InProgress
  
  OnHold
  
  PartiallyShipped.
- subTotalnumber<double>
  Description
  Sub-total.
  Format
  double
- taxTotalnumber<double>
  Description
  Tax total.
  Format
  double
- totalnumber<double>
  Description
  Total.
  Format
  double
- modifiedstring<date-time>
  Description
  Modified date.
  Format
  date-time
- createdstring<date-time>
  Description
  Created date.
  Format
  date-time
- propertiesPropertyItemModel[]
  Description
  Gets the list of key value pairs for dealing with custom properties.
  - keystring
    Description
    Key of the property.
  - valuestring
    Description
    Value of the property.

Payment Plan is a type of order that will be a recurring order.