Send Orders

APIs related to sending Limio Orders

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.

SecuritybearerAuth

Request

Request Body schema: application/json
required

One of:

Create a new subscription

external_id

string

external order reference

initiated_source

string

initiated source of the order. "shop" and "salesforce" used by limio.

source

string

source of the order. "shop" and "salesforce" used by limio.

process_immediately

boolean

if true the order is processed synchronously

order_type

required

string

Value: "new"

required

Array of objects

Array

	object (OfferPayload) Details of a published Limio Offer
quantity	number

object (OrderDiscount)

Order Discount

name

string

The name of the order discount

object

	object
	object

object (ProductDetails)

baseTemplate	string
	Array of objects (Entitlement)
path	string
created	string <date-time>
modified	string <date-time>
	object (ProductAttributes)
record_type	string
lastSynced	string <date-time>
synced	boolean
syncedFrom	string

object

discountType	string The type of the discount
durationLength	number The period of time the discount is applied
durationType	string The type of period of time the discount is applied
percentageDiscount	number The percentage of the discount
amountDiscount	number The amount of the discount
currency	string The currency of the discount
	object

required

object (Address)

Address

firstName	string
lastName	string
email	string
workEmail	string
phone	string
workPhone	string
otherPhone	string
company	string
address1	string
address2	string
city	string
state	string
postalCode	string
country	string

object (Address)

Address

firstName	string
lastName	string
email	string
workEmail	string
phone	string
workPhone	string
otherPhone	string
company	string
address1	string
address2	string
city	string
state	string
postalCode	string
country	string

required

object (CustomerDetails)

firstName	string
lastName	string
phone	string
email	string

object (Tracking)

offers	Array of strings
purchaseCountryCode	string
accountId	string
contactId	string
userId	string

required

ZuoraPayment (object)

Payment

One of:

Zuora Payment Method

type

string

Value: "zuora"

object

refId	string The Zuora ID of the payment method to use for the payment
paymentGateway	string The Zuora payment gateway to use for processing the payment

orderDate

string <date-time>

the date on which the subscription should start

checkoutId

required

string

the limio session checkout id for this order

country

required

string

the country code of the customer's purchase location

Responses

200

401

Unauthorized

404

Not found

502

Bad Gateway

post/order

Request samples

Payload
curl
JavaScript
Python

application/json

{"external_id": "string",
"initiated_source": "string",
"source": "string",
"process_immediately": true,
"order_type": "new",
"orderItems": [{"offer": {"id": "8a512ee55befaea0f7fa962cea9982d0e84f0098",
"version": "4dd34671f26fdbbf240560b78f7f2f54654cde72"
},
"quantity": 1
}
],
"orderDiscount": {"name": "TEST123",
"productDetails": {"ratePlan": {"path": "30% Off Monthly"
},
"product": {"path": "/products/Discounts"
}
},
"product": {"baseTemplate": "/config/templates/products/default",
"entitlements": [{"$ref": "/entitlements/Digital"
}
],
"path": "/products/Digital",
"created": "2023-12-11T13:44:43+00:00",
"modified": "2024-01-15T13:56:18+00:00",
"attributes": {"display_name__limio": "Digital",
"has_delivery__limio": false,
"product_code__limio": "LI.DIGITAL"
},
"record_type": "product",
"lastSynced": "2024-03-12T16:00:35.232Z",
"synced": true,
"syncedFrom": "2c92c0f9778c090d0177aa4f357d043b"
},
"discountOverrides": {"discountType": "DiscountPercentage",
"durationLength": 1,
"durationType": "Months",
"percentageDiscount": 10,
"amountDiscount": 10,
"currency": "USD",
"orderItemsWithSpecifiedDiscount": {"discountedOffers": [ ]
}
}
},
"billingDetails": {"firstName": "string",
"lastName": "string",
"email": "string",
"workEmail": "string",
"phone": "string",
"workPhone": "string",
"otherPhone": "string",
"company": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string"
},
"deliveryDetails": {"firstName": "string",
"lastName": "string",
"email": "string",
"workEmail": "string",
"phone": "string",
"workPhone": "string",
"otherPhone": "string",
"company": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string"
},
"customerDetails": {"firstName": "string",
"lastName": "string",
"phone": "string",
"email": "string"
},
"tracking": {"offers": ["/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew"
],
"purchaseCountryCode": "GB",
"accountId": "0017x00000Q9O9qAAF",
"contactId": "0037x00000F58M9AAJ",
"userId": "0057x0000088Oh3AAE"
},
"payment": {"type": "zuora",
"zuora": {"refId": "2c92c0f96e4e3b7f016e5f3b3b7b0b3d",
"paymentGateway": "CreditCard_UK"
}
},
"orderDate": "2020-01-01T00:00:00Z",
"checkoutId": "basket-22e3d318-92e2-4909-b59c-1265623bc3f6",
"country": "GB"
}

Response samples

application/json

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

Submit Order as Admin

Submit an order using management credentials. Admin users can optionally include a partner organisation to attribute the order to and run partner-specific eligibility checks and associate the order, and all its related objects with the partner organisation.

SecuritybearerAuth

Request

Request Body schema: application/json
required

object

Submit the order on behalf of a specific partner organisation.

required

string

Partner organisation id

external_id

string

external order reference

initiated_source

string

initiated source of the order. "shop" and "salesforce" used by limio.

source

string

source of the order. "shop" and "salesforce" used by limio.

process_immediately

boolean

if true the order is processed synchronously

order_type

required

string

Value: "new"

required

Array of objects

Array

	object (OfferPayload) Details of a published Limio Offer
quantity	number

object (OrderDiscount)

Order Discount

name

string

The name of the order discount

object

	object
	object

object (ProductDetails)

baseTemplate	string
	Array of objects (Entitlement)
path	string
created	string <date-time>
modified	string <date-time>
	object (ProductAttributes)
record_type	string
lastSynced	string <date-time>
synced	boolean
syncedFrom	string

object

discountType	string The type of the discount
durationLength	number The period of time the discount is applied
durationType	string The type of period of time the discount is applied
percentageDiscount	number The percentage of the discount
amountDiscount	number The amount of the discount
currency	string The currency of the discount
	object

required

object (Address)

Address

firstName	string
lastName	string
email	string
workEmail	string
phone	string
workPhone	string
otherPhone	string
company	string
address1	string
address2	string
city	string
state	string
postalCode	string
country	string

object (Address)

Address

firstName	string
lastName	string
email	string
workEmail	string
phone	string
workPhone	string
otherPhone	string
company	string
address1	string
address2	string
city	string
state	string
postalCode	string
country	string

required

object (CustomerDetails)

firstName	string
lastName	string
phone	string
email	string

object (Tracking)

offers	Array of strings
purchaseCountryCode	string
accountId	string
contactId	string
userId	string

required

ZuoraPayment (object)

Payment

One of:

Zuora Payment Method

type

string

Value: "zuora"

object

refId	string The Zuora ID of the payment method to use for the payment
paymentGateway	string The Zuora payment gateway to use for processing the payment

orderDate

string <date-time>

the date on which the subscription should start

checkoutId

required

string

the limio session checkout id for this order

country

required

string

the country code of the customer's purchase location

Responses

200

400

Invalid partner organisation or malformed order payload.

401

Unauthorized

404

Not found

502

Bad Gateway

post/admin/order

Request samples

Payload
curl
JavaScript
Python

application/json

{"forPartner": {"id": "partner_org-123"
},
"external_id": "string",
"initiated_source": "string",
"source": "string",
"process_immediately": true,
"order_type": "new",
"orderItems": [{"offer": {"id": "8a512ee55befaea0f7fa962cea9982d0e84f0098",
"version": "4dd34671f26fdbbf240560b78f7f2f54654cde72"
},
"quantity": 1
}
],
"orderDiscount": {"name": "TEST123",
"productDetails": {"ratePlan": {"path": "30% Off Monthly"
},
"product": {"path": "/products/Discounts"
}
},
"product": {"baseTemplate": "/config/templates/products/default",
"entitlements": [{"$ref": "/entitlements/Digital"
}
],
"path": "/products/Digital",
"created": "2023-12-11T13:44:43+00:00",
"modified": "2024-01-15T13:56:18+00:00",
"attributes": {"display_name__limio": "Digital",
"has_delivery__limio": false,
"product_code__limio": "LI.DIGITAL"
},
"record_type": "product",
"lastSynced": "2024-03-12T16:00:35.232Z",
"synced": true,
"syncedFrom": "2c92c0f9778c090d0177aa4f357d043b"
},
"discountOverrides": {"discountType": "DiscountPercentage",
"durationLength": 1,
"durationType": "Months",
"percentageDiscount": 10,
"amountDiscount": 10,
"currency": "USD",
"orderItemsWithSpecifiedDiscount": {"discountedOffers": [ ]
}
}
},
"billingDetails": {"firstName": "string",
"lastName": "string",
"email": "string",
"workEmail": "string",
"phone": "string",
"workPhone": "string",
"otherPhone": "string",
"company": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string"
},
"deliveryDetails": {"firstName": "string",
"lastName": "string",
"email": "string",
"workEmail": "string",
"phone": "string",
"workPhone": "string",
"otherPhone": "string",
"company": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string"
},
"customerDetails": {"firstName": "string",
"lastName": "string",
"phone": "string",
"email": "string"
},
"tracking": {"offers": ["/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew"
],
"purchaseCountryCode": "GB",
"accountId": "0017x00000Q9O9qAAF",
"contactId": "0037x00000F58M9AAJ",
"userId": "0057x0000088Oh3AAE"
},
"payment": {"type": "zuora",
"zuora": {"refId": "2c92c0f96e4e3b7f016e5f3b3b7b0b3d",
"paymentGateway": "CreditCard_UK"
}
},
"orderDate": "2020-01-01T00:00:00Z",
"checkoutId": "basket-22e3d318-92e2-4909-b59c-1265623bc3f6",
"country": "GB"
}

Response samples

application/json

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

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.

SecuritybearerAuth

Request

Request Body schema: application/json
required

One of:

Preview a new subscription order to see pricing, tax calculation, and schedule before submitting.

Tax Address Requirements:

The tax address is determined by deliveryDetails if products have delivery, otherwise billingDetails
country - Always required
state - Required for US and CA
postalCode - Required for US and CA

If address requirements aren't met, a default address for the region will be used based on the order currency.

order_type

required

string

Value: "new"

required

Array of objects

Array of offers to include in the subscription

Array

required	object (OfferPayload) Details of a published Limio Offer
quantity required	number
type	string
startDate	string <date-time> Optional start date for future-dated subscriptions

required

object

Address

firstName	string
lastName	string
email	string
workEmail	string
phone	string
workPhone	string
otherPhone	string
company	string
address1	string
address2	string
city	string
state	string Required for US and CA
postalCode	string Required for US and CA
country required	string

object

Address

firstName	string
lastName	string
email	string
workEmail	string
phone	string
workPhone	string
otherPhone	string
company	string
address1	string
address2	string
city	string
state	string Required for US and CA
postalCode	string Required for US and CA
country	string

object (OrderDiscount)

Order Discount

name

string

The name of the order discount

object

	object
	object

object (ProductDetails)

baseTemplate	string
	Array of objects (Entitlement)
path	string
created	string <date-time>
modified	string <date-time>
	object (ProductAttributes)
record_type	string
lastSynced	string <date-time>
synced	boolean
syncedFrom	string

object

discountType	string The type of the discount
durationLength	number The period of time the discount is applied
durationType	string The type of period of time the discount is applied
percentageDiscount	number The percentage of the discount
amountDiscount	number The amount of the discount
currency	string The currency of the discount
	object

orderDate

string <date-time>

The date on which the subscription should start. Defaults to current date if not provided.

country

string

The country code of the customer's purchase location

Responses

200

401

Unauthorized

404

Not found

502

Bad Gateway

post/order/preview

Request samples

Payload
curl
JavaScript
Python

application/json

{"order_type": "new",
"orderItems": [{"offer": {"id": "8a512ee55befaea0f7fa962cea9982d0e84f0098",
"version": "4dd34671f26fdbbf240560b78f7f2f54654cde72"
},
"quantity": 1,
"type": "offer",
"startDate": "2019-08-24T14:15:22Z"
}
],
"billingDetails": {"firstName": "string",
"lastName": "string",
"email": "string",
"workEmail": "string",
"phone": "string",
"workPhone": "string",
"otherPhone": "string",
"company": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "NY",
"postalCode": "10001",
"country": "GB"
},
"deliveryDetails": {"firstName": "string",
"lastName": "string",
"email": "string",
"workEmail": "string",
"phone": "string",
"workPhone": "string",
"otherPhone": "string",
"company": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string"
},
"orderDiscount": {"name": "TEST123",
"productDetails": {"ratePlan": {"path": "30% Off Monthly"
},
"product": {"path": "/products/Discounts"
}
},
"product": {"baseTemplate": "/config/templates/products/default",
"entitlements": [{"$ref": "/entitlements/Digital"
}
],
"path": "/products/Digital",
"created": "2023-12-11T13:44:43+00:00",
"modified": "2024-01-15T13:56:18+00:00",
"attributes": {"display_name__limio": "Digital",
"has_delivery__limio": false,
"product_code__limio": "LI.DIGITAL"
},
"record_type": "product",
"lastSynced": "2024-03-12T16:00:35.232Z",
"synced": true,
"syncedFrom": "2c92c0f9778c090d0177aa4f357d043b"
},
"discountOverrides": {"discountType": "DiscountPercentage",
"durationLength": 1,
"durationType": "Months",
"percentageDiscount": 10,
"amountDiscount": 10,
"currency": "USD",
"orderItemsWithSpecifiedDiscount": {"discountedOffers": [ ]
}
}
},
"orderDate": "2025-01-05T00:00:00Z",
"country": "GB"
}

Response samples

application/json

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

➔ Next to Subscription

Send Orders

Submit Order

Request Body schema: application/jsonrequired

Submit Order as Admin

Request Body schema: application/jsonrequired

Preview Order

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required