--- title: Searches payment plans. slug: commerce-connect-15/service-api/av9D-searches-payment-plans docTags: createdAt: 2026-10-09T17:33:29.599Z --- { "id": "e4-8sRv4pt6CPks9rX9cm", "type": "api-oas-v2", "data": { "method": "GET", "url": "/episerverapi/commerce/paymentplans/search/{start}/{maxCount}", "servers": [], "name": "Searches payment plans.", "description": "", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "start", "type": "integer", "description": "Start record index.", "format": "int32" }, { "kind": "required", "name": "maxCount", "type": "integer", "description": "Max number of records to return.", "format": "int32" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "text/plain", "application/json", "text/json" ], "default": "text/plain" } ], "queryParameters": [ { "kind": "optional", "name": "OrderShipmentStatus", "type": "string", "description": "

Order shipment status to filter.\r\nValid values:

\n" }, { "kind": "optional", "name": "ShippingMethodId", "type": "string", "description": "

Shipping method ID (GUID) to filter.

", "format": "uuid" }, { "kind": "optional", "name": "ModifiedFrom", "type": "string", "description": "Modified from date to filter.", "format": "date-time" }, { "kind": "optional", "name": "Status", "type": "array", "description": "

List of statuses to filter.\r\nValid values:

\n
    \n
  • AwaitingExchange
    • \n
  • Cancelled
    • \n
  • Completed
    • \n
  • InProgress
    • \n
  • OnHold
    • \n
  • PartiallyShipped
    • \n
", "schema": [], "itemType": "string", "customType": "string[]" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Return the payment plans.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "Payment Plan is a type of order that will be a recurring order.", "customType": "PaymentPlanModel[]", "schema": [ { "name": "addressId", "kind": "optional", "type": "string", "nullable": true, "description": "Address ID." }, { "name": "affiliateId", "kind": "optional", "type": "string", "description": "

Affiliate ID (GUID).

", "format": "uuid" }, { "name": "billingCurrency", "kind": "optional", "type": "string", "nullable": true, "description": "Billing currency." }, { "name": "customerId", "kind": "optional", "type": "string", "description": "

Customer ID (GUID).

", "format": "uuid" }, { "name": "customerName", "kind": "optional", "type": "string", "nullable": true, "description": "Customer name." }, { "name": "handlingTotal", "kind": "optional", "type": "number", "description": "Handling total.", "format": "double" }, { "name": "instanceId", "kind": "optional", "type": "string", "description": "

Instance ID (GUID).

", "format": "uuid" }, { "name": "marketId", "kind": "optional", "type": "string", "nullable": true, "description": "Market ID." }, { "name": "name", "kind": "required", "type": "string", "description": "Order name." }, { "name": "orderAddresses", "kind": "optional", "type": "array", "nullable": true, "description": "List of addresses.", "modelRef": "#/components/schemas/OrderAddressModel", "customType": "OrderAddressModel[]", "schema": [ { "name": "orderGroupAddressId", "kind": "optional", "type": "integer", "description": "Gets the order group address id.", "format": "int32" }, { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name." }, { "name": "firstName", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the first name." }, { "name": "lastName", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets last name." }, { "name": "organization", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the organization." }, { "name": "line1", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the line1." }, { "name": "line2", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the line2." }, { "name": "city", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the city." }, { "name": "state", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the state." }, { "name": "countryCode", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the country code." }, { "name": "countryName", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name of the country." }, { "name": "postalCode", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the postal code." }, { "name": "regionCode", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the region code." }, { "name": "regionName", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name of the region." }, { "name": "daytimePhoneNumber", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the daytime phone number." }, { "name": "eveningPhoneNumber", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the evening phone number." }, { "name": "faxNumber", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the fax number." }, { "name": "email", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the email." }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets the list of key value pairs for dealing with custom properties.", "modelRef": "#/components/schemas/PropertyItemModel", "customType": "PropertyItemModel[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "nullable": true, "description": "Key of the property." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Value of the property." } ] } ] }, { "name": "orderForms", "kind": "optional", "type": "array", "nullable": true, "description": "List of order forms.", "modelRef": "#/components/schemas/OrderFormModel", "customType": "OrderFormModel[]", "schema": [ { "name": "shipments", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the shipments.", "modelRef": "#/components/schemas/ShipmentModel", "customType": "ShipmentModel[]", "schema": [ { "name": "discountsModel", "kind": "optional", "type": "array", "nullable": true, "description": "Gets the discounts.", "modelRef": "#/components/schemas/DiscountModel", "customType": "DiscountModel[]", "schema": [ { "name": "discountId", "kind": "optional", "type": "integer", "description": "Gets or sets the discount id.", "format": "int32" }, { "name": "discountAmount", "kind": "optional", "type": "number", "description": "Gets or sets the discount amount. Either fixed money value or percentage.", "format": "double" }, { "name": "discountCode", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the discount code. Also known as a coupon code." }, { "name": "discountName", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name of the discount." }, { "name": "displayMessage", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the display message." }, { "name": "discountValue", "kind": "optional", "type": "number", "description": "Gets or sets the discount amount. The amount of discount that was applied. It will equal to DiscountAmount\r\nif it is a fixed monetary value. For the percentage based discount this value will be different.", "format": "double" } ] }, { "name": "shipmentId", "kind": "optional", "type": "integer", "description": "Gets the shipment id.", "format": "int32" }, { "name": "shippingMethodId", "kind": "optional", "type": "string", "description": "Gets or sets the shipping method id.", "format": "uuid" }, { "name": "shippingMethodName", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name of the shipping method." }, { "name": "shippingTax", "kind": "optional", "type": "number", "description": "Gets or sets the shipment tax.", "format": "double" }, { "name": "shippingAddressId", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the shipping address name." }, { "name": "shipmentTrackingNumber", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the shipment tracking number." }, { "name": "shippingDiscountAmount", "kind": "optional", "type": "number", "description": "Gets or sets the shipping discount amount.", "format": "double" }, { "name": "shippingSubTotal", "kind": "optional", "type": "number", "description": "Gets or sets the shipping sub total.", "format": "double" }, { "name": "shippingTotal", "kind": "optional", "type": "number", "description": "

Gets or sets the total shipping cost, including shipping discounts (if any) and shipping tax.

", "format": "double" }, { "name": "status", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the status." }, { "name": "prevStatus", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the previous status." }, { "name": "pickListId", "kind": "optional", "type": "integer", "nullable": true, "description": "Gets or sets the pick list id.", "format": "int32" }, { "name": "subTotal", "kind": "optional", "type": "number", "description": "Gets or sets the sub total.", "format": "double" }, { "name": "warehouseCode", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the warehouse code." }, { "name": "lineItems", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the collection of line items.", "modelRef": "#/components/schemas/LineItemModel", "customType": "LineItemModel[]", "schema": [ { "name": "lineItemId", "kind": "optional", "type": "integer", "description": "Gets the identity of the line item.", "format": "int32" }, { "name": "code", "kind": "optional", "type": "string", "nullable": true, "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." }, { "name": "displayName", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the display name." }, { "name": "placedPrice", "kind": "optional", "type": "number", "description": "Gets the price for one item that this line item represent. This property don't take any discounts in consideration.", "format": "double" }, { "name": "extendedPrice", "kind": "optional", "type": "number", "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" }, { "name": "discountedPrice", "kind": "optional", "type": "number", "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" }, { "name": "quantity", "kind": "optional", "type": "number", "description": "Gets or sets the number of items this line item contains.", "format": "double" }, { "name": "returnQuantity", "kind": "optional", "type": "number", "description": "Gets or sets the returned in stock quantity.", "format": "double" }, { "name": "inventoryTrackingStatus", "kind": "optional", "type": "integer", "description": "", "modelRef": "#/components/schemas/InventoryTrackingStatus", "customType": "InventoryTrackingStatus", "schema": [] }, { "name": "isInventoryAllocated", "kind": "optional", "type": "boolean", "description": "Gets or sets a value indicating whether this instance has allocated inventory for the EPiServer.Commerce.Order.ILineItem.Quantity." }, { "name": "isGift", "kind": "optional", "type": "boolean", "description": "Gets or sets a value indicating whether the line item is a gift item." }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets the list of key value pairs for dealing with custom properties.", "modelRef": "#/components/schemas/PropertyItemModel", "customType": "PropertyItemModel[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "nullable": true, "description": "Key of the property." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Value of the property." } ] } ] }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the list of key value pairs for dealing with custom properties.", "modelRef": "#/components/schemas/PropertyItemModel", "customType": "PropertyItemModel[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "nullable": true, "description": "Key of the property." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Value of the property." } ] } ] }, { "name": "lineItems", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the line items.", "modelRef": "#/components/schemas/LineItemModel", "customType": "LineItemModel[]", "schema": [ { "name": "lineItemId", "kind": "optional", "type": "integer", "description": "Gets the identity of the line item.", "format": "int32" }, { "name": "code", "kind": "optional", "type": "string", "nullable": true, "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." }, { "name": "displayName", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the display name." }, { "name": "placedPrice", "kind": "optional", "type": "number", "description": "Gets the price for one item that this line item represent. This property don't take any discounts in consideration.", "format": "double" }, { "name": "extendedPrice", "kind": "optional", "type": "number", "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" }, { "name": "discountedPrice", "kind": "optional", "type": "number", "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" }, { "name": "quantity", "kind": "optional", "type": "number", "description": "Gets or sets the number of items this line item contains.", "format": "double" }, { "name": "returnQuantity", "kind": "optional", "type": "number", "description": "Gets or sets the returned in stock quantity.", "format": "double" }, { "name": "inventoryTrackingStatus", "kind": "optional", "type": "integer", "description": "", "modelRef": "#/components/schemas/InventoryTrackingStatus", "customType": "InventoryTrackingStatus", "schema": [] }, { "name": "isInventoryAllocated", "kind": "optional", "type": "boolean", "description": "Gets or sets a value indicating whether this instance has allocated inventory for the EPiServer.Commerce.Order.ILineItem.Quantity." }, { "name": "isGift", "kind": "optional", "type": "boolean", "description": "Gets or sets a value indicating whether the line item is a gift item." }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets the list of key value pairs for dealing with custom properties.", "modelRef": "#/components/schemas/PropertyItemModel", "customType": "PropertyItemModel[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "nullable": true, "description": "Key of the property." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Value of the property." } ] } ] }, { "name": "payments", "kind": "optional", "type": "array", "nullable": true, "description": "", "modelRef": "#/components/schemas/PaymentModel", "customType": "PaymentModel[]", "schema": [ { "name": "amount", "kind": "optional", "type": "number", "description": "", "format": "double" }, { "name": "authorizationCode", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "billingAddressId", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "customerName", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "implementationClass", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "paymentId", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "paymentMethodId", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "paymentMethodName", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "paymentTypeModel", "kind": "optional", "type": "integer", "description": "", "modelRef": "#/components/schemas/PaymentTypeModel", "customType": "PaymentTypeModel", "schema": [] }, { "name": "status", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "transactionType", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "validationCode", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "transactionID", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "providerTransactionID", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Custom property item.", "modelRef": "#/components/schemas/PropertyItemModel", "customType": "PropertyItemModel[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "nullable": true, "description": "Key of the property." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Value of the property." } ] } ] }, { "name": "discounts", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the discounts.", "modelRef": "#/components/schemas/DiscountModel", "customType": "DiscountModel[]", "schema": [ { "name": "discountId", "kind": "optional", "type": "integer", "description": "Gets or sets the discount id.", "format": "int32" }, { "name": "discountAmount", "kind": "optional", "type": "number", "description": "Gets or sets the discount amount. Either fixed money value or percentage.", "format": "double" }, { "name": "discountCode", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the discount code. Also known as a coupon code." }, { "name": "discountName", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name of the discount." }, { "name": "displayMessage", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the display message." }, { "name": "discountValue", "kind": "optional", "type": "number", "description": "Gets or sets the discount amount. The amount of discount that was applied. It will equal to DiscountAmount\r\nif it is a fixed monetary value. For the percentage based discount this value will be different.", "format": "double" } ] }, { "name": "returnComment", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the rma comment." }, { "name": "returnType", "kind": "optional", "type": "string", "nullable": true, "description": "

Gets or sets the Return Type. For example can be \"Refund\", \"Exchange\" etc.

" }, { "name": "returnAuthCode", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the RMA auth code. Using for procedure RMA authentications." }, { "name": "orderFormId", "kind": "optional", "type": "integer", "description": "Gets the order form id.", "format": "int32" }, { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name." }, { "name": "billingAddressId", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the billing address id. The id is the name of the address in OrderAddress collection." }, { "name": "shippingTotal", "kind": "optional", "type": "number", "description": "

Gets or sets the shipping total, does not includes discounts that have been applied to each shipment.

", "format": "double" }, { "name": "handlingTotal", "kind": "optional", "type": "number", "description": "Gets or sets the handling total.", "format": "double" }, { "name": "taxTotal", "kind": "optional", "type": "number", "description": "Gets or sets the tax total.", "format": "double" }, { "name": "discountAmount", "kind": "optional", "type": "number", "description": "Gets or sets the discount amount. This amount includes shipping discounts as well.", "format": "double" }, { "name": "subTotal", "kind": "optional", "type": "number", "description": "Gets or sets the sub total.", "format": "double" }, { "name": "total", "kind": "optional", "type": "number", "description": "Gets or sets the total.", "format": "double" }, { "name": "status", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the status." }, { "name": "rmaNumber", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the RMA number." }, { "name": "authorizedPaymentTotal", "kind": "optional", "type": "number", "description": "Gets or sets the authorized payment total.", "format": "double" }, { "name": "capturedPaymentTotal", "kind": "optional", "type": "number", "description": "Gets or sets the captured payment total.", "format": "double" }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets the list of key value pairs for dealing with custom properties.", "modelRef": "#/components/schemas/PropertyItemModel", "customType": "PropertyItemModel[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "nullable": true, "description": "Key of the property." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Value of the property." } ] } ] }, { "name": "orderGroupId", "kind": "optional", "type": "integer", "description": "Order group ID.", "format": "int32" }, { "name": "orderNotes", "kind": "optional", "type": "array", "nullable": true, "description": "List of order notes.", "modelRef": "#/components/schemas/OrderNoteModel", "customType": "OrderNoteModel[]", "schema": [ { "name": "orderNoteId", "kind": "optional", "type": "integer", "nullable": true, "description": "Gets the order note ID.", "format": "int32" }, { "name": "created", "kind": "optional", "type": "string", "description": "Gets Created date.", "format": "date-time" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "Gets or sets note customer ID.", "format": "uuid" }, { "name": "detail", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets note details." }, { "name": "title", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets note title." }, { "name": "type", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets note type." }, { "name": "lineItemId", "kind": "optional", "type": "integer", "nullable": true, "description": "Gets or sets note related line item ID.", "format": "int32" } ] }, { "name": "owner", "kind": "optional", "type": "string", "nullable": true, "description": "Owner name." }, { "name": "ownerOrg", "kind": "optional", "type": "string", "nullable": true, "description": "Owner's organization name." }, { "name": "providerId", "kind": "optional", "type": "string", "nullable": true, "description": "Provider ID." }, { "name": "shippingTotal", "kind": "optional", "type": "number", "description": "Shipping total.", "format": "double" }, { "name": "status", "kind": "optional", "type": "string", "nullable": true, "description": "

Status.\r\nValid values:

\n
    \n
  • AwaitingExchange
    • \n
  • Cancelled
    • \n
  • Completed
    • \n
  • InProgress
    • \n
  • OnHold
    • \n
  • PartiallyShipped.
    • \n
" }, { "name": "subTotal", "kind": "optional", "type": "number", "description": "

Sub-total.

", "format": "double" }, { "name": "taxTotal", "kind": "optional", "type": "number", "description": "Tax total.", "format": "double" }, { "name": "total", "kind": "optional", "type": "number", "description": "Total.", "format": "double" }, { "name": "modified", "kind": "optional", "type": "string", "description": "Modified date.", "format": "date-time" }, { "name": "created", "kind": "optional", "type": "string", "description": "Created date.", "format": "date-time" }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets the list of key value pairs for dealing with custom properties.", "modelRef": "#/components/schemas/PropertyItemModel", "customType": "PropertyItemModel[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "nullable": true, "description": "Key of the property." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Value of the property." } ] } ], "modelRef": "#/components/schemas/PaymentPlanModel", "isExpanded": true } ] }, { "statusCode": "401", "description": "If user does not have enough permission for this request.", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "_HM3EQPjDqxL5CvXMudFZ", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url /episerverapi/commerce/paymentplans/search/{start}/{maxCount} \\\n --header 'accept: text/plain'" }, { "id": "1RQGM0Dh5hhEeGGf6R5-x", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"text/plain\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"/episerverapi/commerce/paymentplans/search/{start}/{maxCount}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "z2aAjNgp1fcVKtUGDoHYP", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/episerverapi/commerce/paymentplans/search/{start}/{maxCount}\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"text/plain\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n" }, { "id": "DxEZQIvKRb2zfplcm8xsI", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"/episerverapi/commerce/paymentplans/search/{start}/{maxCount}\"\n\npayload = {}\nheaders = {\n 'accept': 'text/plain',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "_HM3EQPjDqxL5CvXMudFZ" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Return the payment plans.\n[\n {\n \"addressId\": \"\",\n \"affiliateId\": \"\",\n \"billingCurrency\": \"\",\n \"customerId\": \"\",\n \"customerName\": \"\",\n \"handlingTotal\": \"\",\n \"instanceId\": \"\",\n \"marketId\": \"\",\n \"name\": \"\",\n \"orderAddresses\": [\n {\n \"orderGroupAddressId\": \"\",\n \"name\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"organization\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"countryCode\": \"\",\n \"countryName\": \"\",\n \"postalCode\": \"\",\n \"regionCode\": \"\",\n \"regionName\": \"\",\n \"daytimePhoneNumber\": \"\",\n \"eveningPhoneNumber\": \"\",\n \"faxNumber\": \"\",\n \"email\": \"\",\n \"properties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"orderForms\": [\n {\n \"shipments\": [\n {\n \"discountsModel\": [\n {\n \"discountId\": \"\",\n \"discountAmount\": \"\",\n \"discountCode\": \"\",\n \"discountName\": \"\",\n \"displayMessage\": \"\",\n \"discountValue\": \"\"\n }\n ],\n \"shipmentId\": \"\",\n \"shippingMethodId\": \"\",\n \"shippingMethodName\": \"\",\n \"shippingTax\": \"\",\n \"shippingAddressId\": \"\",\n \"shipmentTrackingNumber\": \"\",\n \"shippingDiscountAmount\": \"\",\n \"shippingSubTotal\": \"\",\n \"shippingTotal\": \"\",\n \"status\": \"\",\n \"prevStatus\": \"\",\n \"pickListId\": \"\",\n \"subTotal\": \"\",\n \"warehouseCode\": \"\",\n \"lineItems\": [\n {\n \"lineItemId\": \"\",\n \"code\": \"\",\n \"displayName\": \"\",\n \"placedPrice\": \"\",\n \"extendedPrice\": \"\",\n \"discountedPrice\": \"\",\n \"quantity\": \"\",\n \"returnQuantity\": \"\",\n \"inventoryTrackingStatus\": 0,\n \"isInventoryAllocated\": false,\n \"isGift\": false,\n \"properties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"properties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"lineItems\": [\n {\n \"lineItemId\": \"\",\n \"code\": \"\",\n \"displayName\": \"\",\n \"placedPrice\": \"\",\n \"extendedPrice\": \"\",\n \"discountedPrice\": \"\",\n \"quantity\": \"\",\n \"returnQuantity\": \"\",\n \"inventoryTrackingStatus\": 0,\n \"isInventoryAllocated\": false,\n \"isGift\": false,\n \"properties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"payments\": [\n {\n \"amount\": \"\",\n \"authorizationCode\": \"\",\n \"billingAddressId\": \"\",\n \"customerName\": \"\",\n \"implementationClass\": \"\",\n \"paymentId\": \"\",\n \"paymentMethodId\": \"\",\n \"paymentMethodName\": \"\",\n \"paymentTypeModel\": 0,\n \"status\": \"\",\n \"transactionType\": \"\",\n \"validationCode\": \"\",\n \"transactionID\": \"\",\n \"providerTransactionID\": \"\",\n \"properties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"discounts\": [\n {\n \"discountId\": \"\",\n \"discountAmount\": \"\",\n \"discountCode\": \"\",\n \"discountName\": \"\",\n \"displayMessage\": \"\",\n \"discountValue\": \"\"\n }\n ],\n \"returnComment\": \"\",\n \"returnType\": \"\",\n \"returnAuthCode\": \"\",\n \"orderFormId\": \"\",\n \"name\": \"\",\n \"billingAddressId\": \"\",\n \"shippingTotal\": \"\",\n \"handlingTotal\": \"\",\n \"taxTotal\": \"\",\n \"discountAmount\": \"\",\n \"subTotal\": \"\",\n \"total\": \"\",\n \"status\": \"\",\n \"rmaNumber\": \"\",\n \"authorizedPaymentTotal\": \"\",\n \"capturedPaymentTotal\": \"\",\n \"properties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"orderGroupId\": \"\",\n \"orderNotes\": [\n {\n \"orderNoteId\": \"\",\n \"created\": \"\",\n \"customerId\": \"\",\n \"detail\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"lineItemId\": \"\"\n }\n ],\n \"owner\": \"\",\n \"ownerOrg\": \"\",\n \"providerId\": \"\",\n \"shippingTotal\": \"\",\n \"status\": \"\",\n \"subTotal\": \"\",\n \"taxTotal\": \"\",\n \"total\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"properties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n]" }, { "id": "response-1-401", "language": "401", "code": "// If user does not have enough permission for this request.\n" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }