Order API

You can send preview and send orders into Limio to trigger Limio's Order Orchestration framework.

See below for full documentation: Limio Order REST API Documentation

Submit Order

Submit an order directly to Limio. This will apply the changes immediately and can be used to update a subscription, change the offer, or update customer details.

post

/order

Authorizations

Body

one of

Create a new subscription

Create a new billing or delivery address on a subscription.

Change the offer that is attached to a subscription.

Update a subscription with new offers, add-ons or other changes.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://your-environment.prod.limio.com/api/order' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "external_id": "text",
    "initiated_source": "text",
    "source": "text",
    "process_immediately": true,
    "billingDetails": {
      "firstName": "text",
      "lastName": "text",
      "email": "text",
      "phone": "text",
      "company": "text",
      "address1": "text",
      "address2": "text",
      "city": "text",
      "state": "text",
      "postalCode": "text",
      "country": "text"
    },
    "deliveryDetails": {
      "firstName": "text",
      "lastName": "text",
      "email": "text",
      "phone": "text",
      "company": "text",
      "address1": "text",
      "address2": "text",
      "city": "text",
      "state": "text",
      "postalCode": "text",
      "country": "text"
    },
    "customerDetails": {
      "firstName": "text",
      "lastName": "text",
      "phone": "text",
      "email": "text"
    },
    "tracking": {
      "purchaseCountryCode": "GB",
      "accountId": "0017x00000Q9O9qAAF",
      "contactId": "0037x00000F58M9AAJ",
      "userId": "0057x0000088Oh3AAE",
      "offers": [
        "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew"
      ]
    },
    "orderDate": "2020-01-01T00:00:00Z",
    "checkoutId": "basket-22e3d318-92e2-4909-b59c-1265623bc3f6",
    "country": "GB",
    "order_type": "new",
    "payment": {
      "type": "zuora",
      "zuora": {
        "refId": "2c92c0f96e4e3b7f016e5f3b3b7b0b3d",
        "paymentGateway": "CreditCard_UK"
      }
    },
    "orderItems": [
      {
        "offer": {
          "id": "8a512ee55befaea0f7fa962cea9982d0e84f0098",
          "version": "4dd34671f26fdbbf240560b78f7f2f54654cde72"
        },
        "quantity": 1
      }
    ]
  }'

200

401

404

502

200

{
  "id": "text",
  "order_reference": "text",
  "status": "text",
  "external_id": "text",
  "subscriptionReference": "text",
  "owner": "text"
}

OK

Preview Order

Preview an order in Limio to see the changes that will be applied. This can be used to show the user what will happen before they confirm the order, including changes to future charges, the effective date of the change, and any other details.

post

/order/preview

Authorizations

Body

one of

Change the offer that is attached to a subscription.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://your-environment.prod.limio.com/api/order/preview' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "external_id": "text",
    "initiated_source": "text",
    "source": "text",
    "process_immediately": true,
    "offer": {
      "id": "8a512ee55befaea0f7fa962cea9982d0e84f0098",
      "version": "4dd34671f26fdbbf240560b78f7f2f54654cde72"
    },
    "effectiveDate": "2025-02-28T07:31:05.744Z",
    "order_type": "change_offer",
    "forSubscription": {
      "name": "text"
    }
  }'

200

401

404

502

200

{
  "schedule": [
    {
      "date": "2020-05-01",
      "schedule_date": "2020-05-01",
      "type": "Schedule",
      "description": "Schedule",
      "amount": "19.99",
      "taxAmount": 0,
      "amountWithoutTax": "19.99",
      "currency": "GBP",
      "quantity": 1,
      "reference": "S-000000000",
      "unit_amount": "19.99",
      "lineItems": [
        {
          "amountWithoutTax": 19.99,
          "processingType": "Charge",
          "taxAmount": "0.00",
          "chargeDescription": "Charge",
          "chargeName": "Charge",
          "productName": "Product",
          "quantity": 1
        }
      ]
    }
  ],
  "preview": {
    "success": true,
    "orderNumber": "67JKSCLQESR0",
    "orderId": "8ad0887e850fc589018512981a1b4acb",
    "accountNumber": "A-000000000",
    "status": "active",
    "paymentNumber": "P-000000000",
    "paymentId": "8ad0887e850fc589018512981a1b4acb",
    "paidAmount": "19.99",
    "subscriptions": [
      {
        "status": "active",
        "subscriptionId": "8ad0887e850fc589018512981a1b4acb",
        "subscriptionNumber": "S-000000000"
      }
    ],
    "previewResult": {
      "invoices": [
        {
          "amount": 19.99,
          "amountWithoutTax": 19.99,
          "targetDate": "2020-05-01",
          "taxAmount": 0,
          "invoiceItems": {
            "amountWithoutTax": 19.99,
            "chargeDescription": "Monthly subscription",
            "chargeName": "Charge",
            "chargeNumber": "C-000000000",
            "processingType": "Charge",
            "productName": "Product",
            "productRatePlanChargeId": "2c98901f6706718c016706b91c6e001f",
            "serviceEndDate": "2020-05-01",
            "serviceStartDate": "2020-05-01",
            "subscriptionNumber": "S-000000000",
            "taxAmount": 0,
            "unitPrice": 19.99,
            "additionalInfo": {
              "quantity": 1,
              "unitOfMeasure": "Each"
            }
          }
        }
      ],
      "creditMemos": [
        {
          "amount": 19.99,
          "amountWithoutTax": 19.99,
          "targetDate": "2020-05-01",
          "taxAmount": 0,
          "creditMemoItems": [
            {
              "amountWithoutTax": 19.99,
              "chargeDescription": "Monthly subscription",
              "chargeName": "Charge",
              "chargeNumber": "C-000000000",
              "processingType": "Charge",
              "productName": "Product",
              "productRatePlanChargeId": "2c98901f6706718c016706b91c6e001f",
              "serviceEndDate": "2020-05-01",
              "serviceStartDate": "2020-05-01",
              "subscriptionNumber": "S-000000000",
              "taxAmount": 0,
              "unitPrice": 19.99,
              "additionalInfo": {
                "quantity": 1,
                "unitOfMeasure": "Each"
              }
            }
          ]
        }
      ]
    }
  }
}

OK