Limio v1

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Please see below for methods

Authentication

API Key (APIGatewayAuthorizer)
- Parameter Name: Authorization, in: header.

Default

getIdentity

Code samples

# You can also use wget
curl -X GET /identities?id=jack%40limio.com \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('/identities?id=jack%40limio.com',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/identities?id=jack%40limio.com',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/identities", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/identities', params={
  'id': 'jack@limio.com'
}, headers = headers)

print(r.json())

GET /identities

Retrieves identity details

Parameters

Name	In	Type	Required	Description
id	query	string	true	none

Example responses

200 Response

[
  "/segments/regions/ASIA/JP/JP"
]

Responses

Status	Meaning	Description	Schema
200	OK	Found identity segments	IdentityResponse

updateIdentity

Code samples

# You can also use wget
curl -X PUT /identities \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const inputBody = '{
  "identity_id": "sam@limio.com",
  "segments": [
    "/segments/BusinessUnit/Regular"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/identities',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {
  "identity_id": "sam@limio.com",
  "segments": [
    "/segments/BusinessUnit/Regular"
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/identities',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/identities", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('/identities', headers = headers)

print(r.json())

PUT /identities

Update an identity or create new if it doesn't already exist

Body parameter

{
  "identity_id": "sam@limio.com",
  "segments": [
    "/segments/BusinessUnit/Regular"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	UpdateIdentityRequest	true	Update identity request

Example responses

200 Response

[
  "/segments/regions/ASIA/JP/JP"
]

Responses

Status	Meaning	Description	Schema
200	OK	The new identity details	IdentityResponse

getOrders

Code samples

# You can also use wget
curl -X GET /orders \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('/orders',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/orders',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/orders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/orders', headers = headers)

print(r.json())

GET /orders

Retrieves orders

Example responses

200 Response

[
  {
    "id": "93730d2e522b248afb2fee9725517d6e",
    "status": "submitted",
    "headers": {
      "key": "string"
    },
    "encrypted": "+AWnVsvIfHlhR2ewwE5tqRGKr6E42EYxgjE9UotMdeOAc46cp/2ZcnPulcTJHp3fdVYNOJAjewi6VJMmN1KgHYrbMbtek6w7mByyEziXJrNs7KEQiVgkCNIkjjaOCzOADJ6Pu+FtREh/6d33IDEnQx+Us7AoUZl6+PjM5FO4w0Jeu59ib1TQzmyPDyPz/Xw05VOOXUXY3FqDmeF/wI3zQvG54+77rE6MegCGK7ij0XCZ+aIaJcbsiutcbCL3P/D5BJwhVwIOCgUIaKCE1F/gSM4m62hQylnxIOx6hbQu1mYfWzKMmcgJh7hoZSW9VVjR1eaM0K+0SMDYPFXvA4/uyWYuN2aOcWmP9/SJ8rdOq337hJbRvdzDDlzPlMksRiGaa8y5kt2bXQIn9hxf7qOAClPYKQQX/137+ZHda6nOwE4Vvtehm27oZta+191sw0NkxsPHF9wR0DlHdaajO02S3LZtrLt1SvAK0ApEx/Q3YmfsRIZIC7eiefCrb4GsB3M3+m7ZTv9TAsc9Cml/jBvsGuNEsTZNZyuzu6R6N8lvmRuUXh3x8sh3OEwLWfrISyE4+YDTj5Xym+CnOu8TKO24gLYWi2wS57IbEnRCeDORJ4UligrN0WVqGmsYXByL4hsluHWW4HitEaG33g0uF4ur89QdJ41uO8hzEfglnJTAZiqHo4JnFmAWAtC15EpW9PMFSo2+Cg5WADpx29EULqxFt18gCyzHgqDWqTElyC9er1Wp4mtjT0V+1MbrmUp8VBZr8oPMHkjbTkghDQmJ/HVFNcdOhT3E42KA0cusD7PqKxNrUq4tRb3baZh/VJEKzrYqIUjFhYcA2BaPKj4xmDAtGVhn1/1zJv2D/He5FMTImt0RbxJ50aZbed6kvqdWMSs8Af1eGWdYlnOT+72xHdM2nP7wXH7fxlX+TxYEsIs8O0HEdllBjWCufFgCWGG72H30i1hZTmQy+XIudURYcBQgcwp3ftLw1Q0Y/DwzPf6PDDBFslVhOlvoUrLqBuhE1FPLtiKEadxBP0qj9Ja3ww1bnqStrjQkpuw6CL7zfkr8feeOO44j+jSrUjCPQDtovirvpXIT7JffHMjxZBmKQaKLecH8nK7UJX/217dJxxNpI9mHqbVbLWp30Vot4WLkYxYAT7e5dO2M6DzS/XaYL1CZVD8wx/hzkFY5KAft+nLwVax2+jzMOH0va6hH65NrC9cdXYduqfBnYuygbc7T7iA6DAyYc2SNcUDEgRD7LjRWTAWirHRbVEZHKjPHrKHoNBm7+Te9tO0Ry/cugCqDle/EzATHZqCOLyOvtJGH2gIXujtNwzYfZUu6xzSPWv5x04rBGf7rutcnhx5uRXGAhi96/nzAY1vaV/oAnz/rrK4kQvc3gAhwgflKNzysNXignJT3/eO6b1DTCUigncl96VxlLYcb4j3QbhE8lt9S60WfWnjO8WJ8Y3MHHqOfmFe/fk2mqrDcRjQw3sYNrW0FJiBKJcenophLWHgOAcA2UqAimHr/akxQtZFu0Fe3vksKM3lc5/xxSaK6rpVCd9Xr0uvumbwa2mihID7af3xiLVQAdD2ivYhAwDE3mJaTveUPavw7FzsG53rxyANBY1dXPwZiBdSRcqR80a/dfPdb+1C3xURAj+gkRR1DSD7lO/JVoM0UZzbI/bfMUNNSMna+g6JFtQiwOpe0xThpMsyURO4K5QyI62o9F1MdhxLRHq0rzXVbP+vrFq0wXdyGOFScc7B/nroepIuNh2vA/dHb5ahDXlG4G6hxSHJz/U5emoLcLm4nkKhCB0/dCQNJPu5TbCe/+V14ejCXoeYQzUb8enGlV00+xwvBsQoWgRGVbExW847LTUUbPty/ol5DsWIIJU/dRty7g6Gvk1mtWvYecBM1jSGbEUAswfYEc8xIDSaDyz9KQIR0oHD6SHBU5Y5qdegXuVAccSfD9VHDWX6Y8Qdb/GPH6Uc3sMEWdmb7pKaQi8NH2huxPnD6AcFmhNAqouQ8TOywr+cuN2VhVWuaMmWQZO18akWjv5Pm680a0h4xuhwBtSmeS5bQ4UcoZ1rAM2d67uiHF97YezlKAbwwiJFJjB92VQH3rQCNsDoYEODC3Po2GJYqYLxZa3RMX+vntmvXCGcuv/nMinia4VQI8baCujzWr48hb3eklXPVM84hw11V594c1afsojXa9hToDbWP0EfIgTC6NhCILdV+C68illLUCeRORaP/CeMrd5hNn68UHlNByZbPFI/tvtso0MjnhQ6UnSdiEPlwuZ3e0th2un/blrAI9dZn9DLqZhFDwOK2yASV5x1D7ba7WP1udXUpprKAikzUFdRuCBX6m8xVGRuaU5nI+XUhQx2P5d4UXkSr9M8w8QLoI0qMp16w2NQr2fynk20qvXDNT0ScOQi8z5rQ1xYJeQn/CWbtgEkrTmB+Ipd9c4fCehP2kjgoXjp8lyieftyIMmFTdWDMQBakA3oDQLRpQcbODM4ssSJy1PzZM1b48Dx/CHAR61jsvat0RHGDaO/qy+A5SSgaGI8joBsZC9nrsIbASngWUnizv/2fnfk8AqGSac5qu6ctswuQSg7X3ek9b8+jADt8UXlOIx1jRWNdp9qQtLw/UkjBG+sg57UWONXULvgAiwq7I/IrYy2qtwJzQFbm2A4gjDpMQuka2u4JUeYnPVKeyZU5PJqZudenW2YwuL6JRF2d47C3+qSIpgXr3UmmxR/xFh3CMH6+SfGMfkEwmx+421t7TYkzseXqImiYoEX53SOFNNoAnw=="
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	All found orders	OrdersResponse

sendOrder

Code samples

# You can also use wget
curl -X POST /order \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const inputBody = '{
  "stripeToken": {
    "id": "tok_1E5AF3ATj43ligNK3ShXcHmc",
    "object": "token",
    "card": {
      "id": "card_1E5AF3ATj43ligNKZBjxY5Es",
      "object": "card",
      "address_city": "London",
      "address_country": "UK",
      "address_line1": "7th Floor, Capital House",
      "address_line1_check": "string",
      "address_line2": "42 Weston Street",
      "address_zip": "SE1 3QD",
      "address_zip_check": "string",
      "brand": "Visa",
      "country": "UK",
      "cvc_check": "string",
      "dynamic_last4": "string",
      "exp_month": 4,
      "exp_year": 2022,
      "funding": "credit",
      "last4": "4242",
      "metadata": {},
      "name": "string",
      "tokenization_method": "string"
    },
    "client_ip": "87.242.167.174",
    "created": 1552667527,
    "livemode": true,
    "type": "card",
    "used": false
  },
  "customerDetails": {
    "firstName": "Joe",
    "lastName": "Bloggs",
    "email": "joe@bloggs.com",
    "phone": "02045354567",
    "address1": "7th Floor, Capital House",
    "address2": "42 Weston St",
    "city": "London",
    "county": "London",
    "postalCode": "SE1 3QD"
  },
  "orderItems": [
    {}
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/order',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {
  "stripeToken": {
    "id": "tok_1E5AF3ATj43ligNK3ShXcHmc",
    "object": "token",
    "card": {
      "id": "card_1E5AF3ATj43ligNKZBjxY5Es",
      "object": "card",
      "address_city": "London",
      "address_country": "UK",
      "address_line1": "7th Floor, Capital House",
      "address_line1_check": "string",
      "address_line2": "42 Weston Street",
      "address_zip": "SE1 3QD",
      "address_zip_check": "string",
      "brand": "Visa",
      "country": "UK",
      "cvc_check": "string",
      "dynamic_last4": "string",
      "exp_month": 4,
      "exp_year": 2022,
      "funding": "credit",
      "last4": "4242",
      "metadata": {},
      "name": "string",
      "tokenization_method": "string"
    },
    "client_ip": "87.242.167.174",
    "created": 1552667527,
    "livemode": true,
    "type": "card",
    "used": false
  },
  "customerDetails": {
    "firstName": "Joe",
    "lastName": "Bloggs",
    "email": "joe@bloggs.com",
    "phone": "02045354567",
    "address1": "7th Floor, Capital House",
    "address2": "42 Weston St",
    "city": "London",
    "county": "London",
    "postalCode": "SE1 3QD"
  },
  "orderItems": [
    {}
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/order',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/order", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/order', headers = headers)

print(r.json())

POST /order

Sends an order to be stored in db

Body parameter

{
  "stripeToken": {
    "id": "tok_1E5AF3ATj43ligNK3ShXcHmc",
    "object": "token",
    "card": {
      "id": "card_1E5AF3ATj43ligNKZBjxY5Es",
      "object": "card",
      "address_city": "London",
      "address_country": "UK",
      "address_line1": "7th Floor, Capital House",
      "address_line1_check": "string",
      "address_line2": "42 Weston Street",
      "address_zip": "SE1 3QD",
      "address_zip_check": "string",
      "brand": "Visa",
      "country": "UK",
      "cvc_check": "string",
      "dynamic_last4": "string",
      "exp_month": 4,
      "exp_year": 2022,
      "funding": "credit",
      "last4": "4242",
      "metadata": {},
      "name": "string",
      "tokenization_method": "string"
    },
    "client_ip": "87.242.167.174",
    "created": 1552667527,
    "livemode": true,
    "type": "card",
    "used": false
  },
  "customerDetails": {
    "firstName": "Joe",
    "lastName": "Bloggs",
    "email": "joe@bloggs.com",
    "phone": "02045354567",
    "address1": "7th Floor, Capital House",
    "address2": "42 Weston St",
    "city": "London",
    "county": "London",
    "postalCode": "SE1 3QD"
  },
  "orderItems": [
    {}
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	OrderRequest	true	Send order request

Example responses

200 Response

{
  "id": "93730d2e522b248afb2fee9725517d6e",
  "status": "submitted",
  "headers": {
    "key": "string"
  },
  "encrypted": "+AWnVsvIfHlhR2ewwE5tqRGKr6E42EYxgjE9UotMdeOAc46cp/2ZcnPulcTJHp3fdVYNOJAjewi6VJMmN1KgHYrbMbtek6w7mByyEziXJrNs7KEQiVgkCNIkjjaOCzOADJ6Pu+FtREh/6d33IDEnQx+Us7AoUZl6+PjM5FO4w0Jeu59ib1TQzmyPDyPz/Xw05VOOXUXY3FqDmeF/wI3zQvG54+77rE6MegCGK7ij0XCZ+aIaJcbsiutcbCL3P/D5BJwhVwIOCgUIaKCE1F/gSM4m62hQylnxIOx6hbQu1mYfWzKMmcgJh7hoZSW9VVjR1eaM0K+0SMDYPFXvA4/uyWYuN2aOcWmP9/SJ8rdOq337hJbRvdzDDlzPlMksRiGaa8y5kt2bXQIn9hxf7qOAClPYKQQX/137+ZHda6nOwE4Vvtehm27oZta+191sw0NkxsPHF9wR0DlHdaajO02S3LZtrLt1SvAK0ApEx/Q3YmfsRIZIC7eiefCrb4GsB3M3+m7ZTv9TAsc9Cml/jBvsGuNEsTZNZyuzu6R6N8lvmRuUXh3x8sh3OEwLWfrISyE4+YDTj5Xym+CnOu8TKO24gLYWi2wS57IbEnRCeDORJ4UligrN0WVqGmsYXByL4hsluHWW4HitEaG33g0uF4ur89QdJ41uO8hzEfglnJTAZiqHo4JnFmAWAtC15EpW9PMFSo2+Cg5WADpx29EULqxFt18gCyzHgqDWqTElyC9er1Wp4mtjT0V+1MbrmUp8VBZr8oPMHkjbTkghDQmJ/HVFNcdOhT3E42KA0cusD7PqKxNrUq4tRb3baZh/VJEKzrYqIUjFhYcA2BaPKj4xmDAtGVhn1/1zJv2D/He5FMTImt0RbxJ50aZbed6kvqdWMSs8Af1eGWdYlnOT+72xHdM2nP7wXH7fxlX+TxYEsIs8O0HEdllBjWCufFgCWGG72H30i1hZTmQy+XIudURYcBQgcwp3ftLw1Q0Y/DwzPf6PDDBFslVhOlvoUrLqBuhE1FPLtiKEadxBP0qj9Ja3ww1bnqStrjQkpuw6CL7zfkr8feeOO44j+jSrUjCPQDtovirvpXIT7JffHMjxZBmKQaKLecH8nK7UJX/217dJxxNpI9mHqbVbLWp30Vot4WLkYxYAT7e5dO2M6DzS/XaYL1CZVD8wx/hzkFY5KAft+nLwVax2+jzMOH0va6hH65NrC9cdXYduqfBnYuygbc7T7iA6DAyYc2SNcUDEgRD7LjRWTAWirHRbVEZHKjPHrKHoNBm7+Te9tO0Ry/cugCqDle/EzATHZqCOLyOvtJGH2gIXujtNwzYfZUu6xzSPWv5x04rBGf7rutcnhx5uRXGAhi96/nzAY1vaV/oAnz/rrK4kQvc3gAhwgflKNzysNXignJT3/eO6b1DTCUigncl96VxlLYcb4j3QbhE8lt9S60WfWnjO8WJ8Y3MHHqOfmFe/fk2mqrDcRjQw3sYNrW0FJiBKJcenophLWHgOAcA2UqAimHr/akxQtZFu0Fe3vksKM3lc5/xxSaK6rpVCd9Xr0uvumbwa2mihID7af3xiLVQAdD2ivYhAwDE3mJaTveUPavw7FzsG53rxyANBY1dXPwZiBdSRcqR80a/dfPdb+1C3xURAj+gkRR1DSD7lO/JVoM0UZzbI/bfMUNNSMna+g6JFtQiwOpe0xThpMsyURO4K5QyI62o9F1MdhxLRHq0rzXVbP+vrFq0wXdyGOFScc7B/nroepIuNh2vA/dHb5ahDXlG4G6hxSHJz/U5emoLcLm4nkKhCB0/dCQNJPu5TbCe/+V14ejCXoeYQzUb8enGlV00+xwvBsQoWgRGVbExW847LTUUbPty/ol5DsWIIJU/dRty7g6Gvk1mtWvYecBM1jSGbEUAswfYEc8xIDSaDyz9KQIR0oHD6SHBU5Y5qdegXuVAccSfD9VHDWX6Y8Qdb/GPH6Uc3sMEWdmb7pKaQi8NH2huxPnD6AcFmhNAqouQ8TOywr+cuN2VhVWuaMmWQZO18akWjv5Pm680a0h4xuhwBtSmeS5bQ4UcoZ1rAM2d67uiHF97YezlKAbwwiJFJjB92VQH3rQCNsDoYEODC3Po2GJYqYLxZa3RMX+vntmvXCGcuv/nMinia4VQI8baCujzWr48hb3eklXPVM84hw11V594c1afsojXa9hToDbWP0EfIgTC6NhCILdV+C68illLUCeRORaP/CeMrd5hNn68UHlNByZbPFI/tvtso0MjnhQ6UnSdiEPlwuZ3e0th2un/blrAI9dZn9DLqZhFDwOK2yASV5x1D7ba7WP1udXUpprKAikzUFdRuCBX6m8xVGRuaU5nI+XUhQx2P5d4UXkSr9M8w8QLoI0qMp16w2NQr2fynk20qvXDNT0ScOQi8z5rQ1xYJeQn/CWbtgEkrTmB+Ipd9c4fCehP2kjgoXjp8lyieftyIMmFTdWDMQBakA3oDQLRpQcbODM4ssSJy1PzZM1b48Dx/CHAR61jsvat0RHGDaO/qy+A5SSgaGI8joBsZC9nrsIbASngWUnizv/2fnfk8AqGSac5qu6ctswuQSg7X3ek9b8+jADt8UXlOIx1jRWNdp9qQtLw/UkjBG+sg57UWONXULvgAiwq7I/IrYy2qtwJzQFbm2A4gjDpMQuka2u4JUeYnPVKeyZU5PJqZudenW2YwuL6JRF2d47C3+qSIpgXr3UmmxR/xFh3CMH6+SfGMfkEwmx+421t7TYkzseXqImiYoEX53SOFNNoAnw=="
}

Responses

Status	Meaning	Description	Schema
200	OK	The new order details	OrderResponse

getObjects

Code samples

# You can also use wget
curl -X GET /objects/{service}/{path_type} \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/objects/{service}/{path_type}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/objects/{service}/{path_type}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/objects/{service}/{path_type}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/objects/{service}/{path_type}', headers = headers)

print(r.json())

GET /objects/{service}/{path_type}

Gets objects of provided path type from a provided service

Example responses

200 Response

{
  "items": [
    {
      "name": "Limio Subscription",
      "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
      "record_type": "subscription",
      "service": "limio",
      "mode": "production",
      "created": "2023-03-31T12:29:37.973Z",
      "data": {}
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Found objects	ObjectsResponse

getObject

Code samples

# You can also use wget
curl -X GET /objects/{service}/{path_type}/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/objects/{service}/{path_type}/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/objects/{service}/{path_type}/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/objects/{service}/{path_type}/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/objects/{service}/{path_type}/{id}', headers = headers)

print(r.json())

GET /objects/{service}/{path_type}/{id}

Gets a specific object of provided path type from a provided service using the object's ID

Example responses

200 Response

{
  "name": "Limio Subscription",
  "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
  "record_type": "subscription",
  "service": "limio",
  "mode": "production",
  "created": "2023-03-31T12:29:37.974Z",
  "data": {}
}

Responses

Status	Meaning	Description	Schema
200	OK	Found object	ObjectResponse

getObjectRelationships

Code samples

# You can also use wget
curl -X GET /objects/{service}/{path_type}/{id}/related/{record_type} \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/objects/{service}/{path_type}/{id}/related/{record_type}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/objects/{service}/{path_type}/{id}/related/{record_type}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/objects/{service}/{path_type}/{id}/related/{record_type}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/objects/{service}/{path_type}/{id}/related/{record_type}', headers = headers)

print(r.json())

GET /objects/{service}/{path_type}/{id}/related/{record_type}

Gets objects of a specific record type, related to a specific object of provided path type from a provided service using the object's ID

Example responses

200 Response

{
  "items": [
    {
      "name": "Limio Subscription",
      "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
      "relationship_id": "relationship_id",
      "record_type": "subscription",
      "service": "limio",
      "mode": "production",
      "created": "2023-03-31T12:29:37.975Z",
      "_relationship": {
        "reference": "217OU0391HEG",
        "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
        "related": "order-bcc1997b17b7824caf86b06451904fb8",
        "record_type": "rel",
        "service": "limio",
        "mode": "production",
        "created": "2023-03-31T12:29:37.975Z",
        "data": {
          "from": {
            "name": "Limio Subscription",
            "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
            "record_type": "subscription",
            "service": "limio",
            "data": {}
          },
          "to": {
            "name": "Limio Order",
            "id": "order-bcc1997b17b7824caf86b06451904fb8",
            "record_type": "order",
            "service": "limio",
            "data": {}
          },
          "metadata": {}
        }
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Found related objects	RelatedObjectsResponse

addObjectRelationship

Code samples

# You can also use wget
curl -X POST /objects/{service}/{path_type}/{id}/related/{record_type} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

const inputBody = '{}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/objects/{service}/{path_type}/{id}/related/{record_type}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/objects/{service}/{path_type}/{id}/related/{record_type}',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/objects/{service}/{path_type}/{id}/related/{record_type}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('/objects/{service}/{path_type}/{id}/related/{record_type}', headers = headers)

print(r.json())

POST /objects/{service}/{path_type}/{id}/related/{record_type}

Adds a related object of a specific record type to a specific object of provided path type from a provided service using the object's ID

Body parameter

{}

Parameters

Name	In	Type	Required	Description
body	body	RelatedObjectRequest	true	Send order request

Example responses

200 Response

{
  "name": "Limio Subscription",
  "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
  "relationship_id": "relationship_id",
  "record_type": "subscription",
  "service": "limio",
  "mode": "production",
  "created": "2023-03-31T12:29:37.976Z",
  "_relationship": {
    "reference": "217OU0391HEG",
    "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
    "related": "order-bcc1997b17b7824caf86b06451904fb8",
    "record_type": "rel",
    "service": "limio",
    "mode": "production",
    "created": "2023-03-31T12:29:37.976Z",
    "data": {
      "from": {
        "name": "Limio Subscription",
        "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
        "record_type": "subscription",
        "service": "limio",
        "data": {}
      },
      "to": {
        "name": "Limio Order",
        "id": "order-bcc1997b17b7824caf86b06451904fb8",
        "record_type": "order",
        "service": "limio",
        "data": {}
      },
      "metadata": {}
    }
  },
  "data": {}
}

Responses

Status	Meaning	Description	Schema
200	OK	Relationship added	RelatedObjectResponse

getObjectEvents

Code samples

# You can also use wget
curl -X GET /objects/{service}/{path_type}/{id}/events \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/objects/{service}/{path_type}/{id}/events',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/objects/{service}/{path_type}/{id}/events',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/objects/{service}/{path_type}/{id}/events", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/objects/{service}/{path_type}/{id}/events', headers = headers)

print(r.json())

GET /objects/{service}/{path_type}/{id}/events

Gets events associated with a specific object of provided path type from a provided service using the object's ID

Example responses

200 Response

{
  "items": [
    {
      "id": "event-2f2a17f37c22d0eb1d2e8ee0e021956b",
      "record_type": "event",
      "service": "limio",
      "mode": "production",
      "created": "2023-03-31T12:29:37.976Z",
      "data": {}
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Found object	EventsResponse

getObjectSubType

Code samples

# You can also use wget
curl -X GET /objects/{service}/{path_type}/{id}/objects/{subtype} \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/objects/{service}/{path_type}/{id}/objects/{subtype}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/objects/{service}/{path_type}/{id}/objects/{subtype}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/objects/{service}/{path_type}/{id}/objects/{subtype}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/objects/{service}/{path_type}/{id}/objects/{subtype}', headers = headers)

print(r.json())

GET /objects/{service}/{path_type}/{id}/objects/{subtype}

Gets children objects of a specific record type of a specific object of provided path type from a provided service using the object's ID

Example responses

200 Response

{
  "items": [
    {
      "name": "Limio Subscription",
      "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
      "related": "order-bcc1997b17b7824caf86b06451904fb8",
      "owner": "id-UshF1h62VLeKzukBmLGb59kU9c1Jn_hNewKngSrNXl8",
      "record_type": "subscription",
      "service": "limio",
      "mode": "production",
      "created": "2023-03-31T12:29:37.977Z",
      "data": {}
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Found child objects	SubObjectsResponse

Schemas

UpdateIdentityRequest

{
  "identity_id": "sam@limio.com",
  "segments": [
    "/segments/BusinessUnit/Regular"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
identity_id	string	true	none	Your unique identifier for a customer (we recommend hashing these to avoid sensitive data being stored by us)
segments	[string]	true	none	Segments to associate with new identity

IdentityResponse

[
  "/segments/regions/ASIA/JP/JP"
]

Segments associated with idenity

Properties

None

OrdersResponse

[
  {
    "id": "93730d2e522b248afb2fee9725517d6e",
    "status": "submitted",
    "headers": {
      "key": "string"
    },
    "encrypted": "+AWnVsvIfHlhR2ewwE5tqRGKr6E42EYxgjE9UotMdeOAc46cp/2ZcnPulcTJHp3fdVYNOJAjewi6VJMmN1KgHYrbMbtek6w7mByyEziXJrNs7KEQiVgkCNIkjjaOCzOADJ6Pu+FtREh/6d33IDEnQx+Us7AoUZl6+PjM5FO4w0Jeu59ib1TQzmyPDyPz/Xw05VOOXUXY3FqDmeF/wI3zQvG54+77rE6MegCGK7ij0XCZ+aIaJcbsiutcbCL3P/D5BJwhVwIOCgUIaKCE1F/gSM4m62hQylnxIOx6hbQu1mYfWzKMmcgJh7hoZSW9VVjR1eaM0K+0SMDYPFXvA4/uyWYuN2aOcWmP9/SJ8rdOq337hJbRvdzDDlzPlMksRiGaa8y5kt2bXQIn9hxf7qOAClPYKQQX/137+ZHda6nOwE4Vvtehm27oZta+191sw0NkxsPHF9wR0DlHdaajO02S3LZtrLt1SvAK0ApEx/Q3YmfsRIZIC7eiefCrb4GsB3M3+m7ZTv9TAsc9Cml/jBvsGuNEsTZNZyuzu6R6N8lvmRuUXh3x8sh3OEwLWfrISyE4+YDTj5Xym+CnOu8TKO24gLYWi2wS57IbEnRCeDORJ4UligrN0WVqGmsYXByL4hsluHWW4HitEaG33g0uF4ur89QdJ41uO8hzEfglnJTAZiqHo4JnFmAWAtC15EpW9PMFSo2+Cg5WADpx29EULqxFt18gCyzHgqDWqTElyC9er1Wp4mtjT0V+1MbrmUp8VBZr8oPMHkjbTkghDQmJ/HVFNcdOhT3E42KA0cusD7PqKxNrUq4tRb3baZh/VJEKzrYqIUjFhYcA2BaPKj4xmDAtGVhn1/1zJv2D/He5FMTImt0RbxJ50aZbed6kvqdWMSs8Af1eGWdYlnOT+72xHdM2nP7wXH7fxlX+TxYEsIs8O0HEdllBjWCufFgCWGG72H30i1hZTmQy+XIudURYcBQgcwp3ftLw1Q0Y/DwzPf6PDDBFslVhOlvoUrLqBuhE1FPLtiKEadxBP0qj9Ja3ww1bnqStrjQkpuw6CL7zfkr8feeOO44j+jSrUjCPQDtovirvpXIT7JffHMjxZBmKQaKLecH8nK7UJX/217dJxxNpI9mHqbVbLWp30Vot4WLkYxYAT7e5dO2M6DzS/XaYL1CZVD8wx/hzkFY5KAft+nLwVax2+jzMOH0va6hH65NrC9cdXYduqfBnYuygbc7T7iA6DAyYc2SNcUDEgRD7LjRWTAWirHRbVEZHKjPHrKHoNBm7+Te9tO0Ry/cugCqDle/EzATHZqCOLyOvtJGH2gIXujtNwzYfZUu6xzSPWv5x04rBGf7rutcnhx5uRXGAhi96/nzAY1vaV/oAnz/rrK4kQvc3gAhwgflKNzysNXignJT3/eO6b1DTCUigncl96VxlLYcb4j3QbhE8lt9S60WfWnjO8WJ8Y3MHHqOfmFe/fk2mqrDcRjQw3sYNrW0FJiBKJcenophLWHgOAcA2UqAimHr/akxQtZFu0Fe3vksKM3lc5/xxSaK6rpVCd9Xr0uvumbwa2mihID7af3xiLVQAdD2ivYhAwDE3mJaTveUPavw7FzsG53rxyANBY1dXPwZiBdSRcqR80a/dfPdb+1C3xURAj+gkRR1DSD7lO/JVoM0UZzbI/bfMUNNSMna+g6JFtQiwOpe0xThpMsyURO4K5QyI62o9F1MdhxLRHq0rzXVbP+vrFq0wXdyGOFScc7B/nroepIuNh2vA/dHb5ahDXlG4G6hxSHJz/U5emoLcLm4nkKhCB0/dCQNJPu5TbCe/+V14ejCXoeYQzUb8enGlV00+xwvBsQoWgRGVbExW847LTUUbPty/ol5DsWIIJU/dRty7g6Gvk1mtWvYecBM1jSGbEUAswfYEc8xIDSaDyz9KQIR0oHD6SHBU5Y5qdegXuVAccSfD9VHDWX6Y8Qdb/GPH6Uc3sMEWdmb7pKaQi8NH2huxPnD6AcFmhNAqouQ8TOywr+cuN2VhVWuaMmWQZO18akWjv5Pm680a0h4xuhwBtSmeS5bQ4UcoZ1rAM2d67uiHF97YezlKAbwwiJFJjB92VQH3rQCNsDoYEODC3Po2GJYqYLxZa3RMX+vntmvXCGcuv/nMinia4VQI8baCujzWr48hb3eklXPVM84hw11V594c1afsojXa9hToDbWP0EfIgTC6NhCILdV+C68illLUCeRORaP/CeMrd5hNn68UHlNByZbPFI/tvtso0MjnhQ6UnSdiEPlwuZ3e0th2un/blrAI9dZn9DLqZhFDwOK2yASV5x1D7ba7WP1udXUpprKAikzUFdRuCBX6m8xVGRuaU5nI+XUhQx2P5d4UXkSr9M8w8QLoI0qMp16w2NQr2fynk20qvXDNT0ScOQi8z5rQ1xYJeQn/CWbtgEkrTmB+Ipd9c4fCehP2kjgoXjp8lyieftyIMmFTdWDMQBakA3oDQLRpQcbODM4ssSJy1PzZM1b48Dx/CHAR61jsvat0RHGDaO/qy+A5SSgaGI8joBsZC9nrsIbASngWUnizv/2fnfk8AqGSac5qu6ctswuQSg7X3ek9b8+jADt8UXlOIx1jRWNdp9qQtLw/UkjBG+sg57UWONXULvgAiwq7I/IrYy2qtwJzQFbm2A4gjDpMQuka2u4JUeYnPVKeyZU5PJqZudenW2YwuL6JRF2d47C3+qSIpgXr3UmmxR/xFh3CMH6+SfGMfkEwmx+421t7TYkzseXqImiYoEX53SOFNNoAnw=="
  }
]

All orders

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	Order id
status	string	false	none	Status of order
headers	object	false	none	Order headers
» key	string	false	none	none
encrypted	string	false	none	Encrypted order

OrderRequest

{
  "stripeToken": {
    "id": "tok_1E5AF3ATj43ligNK3ShXcHmc",
    "object": "token",
    "card": {
      "id": "card_1E5AF3ATj43ligNKZBjxY5Es",
      "object": "card",
      "address_city": "London",
      "address_country": "UK",
      "address_line1": "7th Floor, Capital House",
      "address_line1_check": "string",
      "address_line2": "42 Weston Street",
      "address_zip": "SE1 3QD",
      "address_zip_check": "string",
      "brand": "Visa",
      "country": "UK",
      "cvc_check": "string",
      "dynamic_last4": "string",
      "exp_month": 4,
      "exp_year": 2022,
      "funding": "credit",
      "last4": "4242",
      "metadata": {},
      "name": "string",
      "tokenization_method": "string"
    },
    "client_ip": "87.242.167.174",
    "created": 1552667527,
    "livemode": true,
    "type": "card",
    "used": false
  },
  "customerDetails": {
    "firstName": "Joe",
    "lastName": "Bloggs",
    "email": "joe@bloggs.com",
    "phone": "02045354567",
    "address1": "7th Floor, Capital House",
    "address2": "42 Weston St",
    "city": "London",
    "county": "London",
    "postalCode": "SE1 3QD"
  },
  "orderItems": [
    {}
  ]
}

Properties

Name	Type	Required	Restrictions	Description
stripeToken	object	true	none	A stripe card token retrived from their api
» id	string	true	none	Token id
» object	string	true	none	Object type
» card	object	true	none	Card details
»» id	string	true	none	Card id
»» object	string	true	none	Object type
»» address_city	string	false	none	Address city
»» address_country	string	false	none	Address country
»» address_line1	string	false	none	Address line 1
»» address_line1_check	string	false	none	Outcome of address check
»» address_line2	string	false	none	Address line 1
»» address_zip	string	true	none	Zip code
»» address_zip_check	string	false	none	Outcome of zipcode check
»» brand	string	true	none	Card brand
»» country	string	true	none	Card country
»» cvc_check	string	false	none	Outcome of cvc check
»» dynamic_last4	string	false	none	none
»» exp_month	integer	true	none	Card expiry month
»» exp_year	integer	true	none	Card expiry year
»» funding	string	false	none	Funding type
»» last4	string	true	none	Card last 4 digits
»» metadata	object	false	none	none
»» name	string	false	none	none
»» tokenization_method	string	false	none	none
» client_ip	string	false	none	none
» created	integer	true	none	Time of token creation
» livemode	boolean	true	none	Live mode enabled
» type	string	true	none	Token type
» used	boolean	true	none	Token used
customerDetails	object	true	none	Details of customer
» firstName	string	true	none	Customer first name
» lastName	string	true	none	Customer last name
» email	string	true	none	Customer email
» phone	string	false	none	Customer phone number
» address1	string	false	none	Customer address line 1
» address2	string	false	none	Customer address line 2
» city	string	false	none	Customer city
» county	string	false	none	Customer county
» postalCode	string	true	none	Customer postal code
orderItems	[object]	true	none	Items selected for order

OrderResponse

{
  "id": "93730d2e522b248afb2fee9725517d6e",
  "status": "submitted",
  "headers": {
    "key": "string"
  },
  "encrypted": "+AWnVsvIfHlhR2ewwE5tqRGKr6E42EYxgjE9UotMdeOAc46cp/2ZcnPulcTJHp3fdVYNOJAjewi6VJMmN1KgHYrbMbtek6w7mByyEziXJrNs7KEQiVgkCNIkjjaOCzOADJ6Pu+FtREh/6d33IDEnQx+Us7AoUZl6+PjM5FO4w0Jeu59ib1TQzmyPDyPz/Xw05VOOXUXY3FqDmeF/wI3zQvG54+77rE6MegCGK7ij0XCZ+aIaJcbsiutcbCL3P/D5BJwhVwIOCgUIaKCE1F/gSM4m62hQylnxIOx6hbQu1mYfWzKMmcgJh7hoZSW9VVjR1eaM0K+0SMDYPFXvA4/uyWYuN2aOcWmP9/SJ8rdOq337hJbRvdzDDlzPlMksRiGaa8y5kt2bXQIn9hxf7qOAClPYKQQX/137+ZHda6nOwE4Vvtehm27oZta+191sw0NkxsPHF9wR0DlHdaajO02S3LZtrLt1SvAK0ApEx/Q3YmfsRIZIC7eiefCrb4GsB3M3+m7ZTv9TAsc9Cml/jBvsGuNEsTZNZyuzu6R6N8lvmRuUXh3x8sh3OEwLWfrISyE4+YDTj5Xym+CnOu8TKO24gLYWi2wS57IbEnRCeDORJ4UligrN0WVqGmsYXByL4hsluHWW4HitEaG33g0uF4ur89QdJ41uO8hzEfglnJTAZiqHo4JnFmAWAtC15EpW9PMFSo2+Cg5WADpx29EULqxFt18gCyzHgqDWqTElyC9er1Wp4mtjT0V+1MbrmUp8VBZr8oPMHkjbTkghDQmJ/HVFNcdOhT3E42KA0cusD7PqKxNrUq4tRb3baZh/VJEKzrYqIUjFhYcA2BaPKj4xmDAtGVhn1/1zJv2D/He5FMTImt0RbxJ50aZbed6kvqdWMSs8Af1eGWdYlnOT+72xHdM2nP7wXH7fxlX+TxYEsIs8O0HEdllBjWCufFgCWGG72H30i1hZTmQy+XIudURYcBQgcwp3ftLw1Q0Y/DwzPf6PDDBFslVhOlvoUrLqBuhE1FPLtiKEadxBP0qj9Ja3ww1bnqStrjQkpuw6CL7zfkr8feeOO44j+jSrUjCPQDtovirvpXIT7JffHMjxZBmKQaKLecH8nK7UJX/217dJxxNpI9mHqbVbLWp30Vot4WLkYxYAT7e5dO2M6DzS/XaYL1CZVD8wx/hzkFY5KAft+nLwVax2+jzMOH0va6hH65NrC9cdXYduqfBnYuygbc7T7iA6DAyYc2SNcUDEgRD7LjRWTAWirHRbVEZHKjPHrKHoNBm7+Te9tO0Ry/cugCqDle/EzATHZqCOLyOvtJGH2gIXujtNwzYfZUu6xzSPWv5x04rBGf7rutcnhx5uRXGAhi96/nzAY1vaV/oAnz/rrK4kQvc3gAhwgflKNzysNXignJT3/eO6b1DTCUigncl96VxlLYcb4j3QbhE8lt9S60WfWnjO8WJ8Y3MHHqOfmFe/fk2mqrDcRjQw3sYNrW0FJiBKJcenophLWHgOAcA2UqAimHr/akxQtZFu0Fe3vksKM3lc5/xxSaK6rpVCd9Xr0uvumbwa2mihID7af3xiLVQAdD2ivYhAwDE3mJaTveUPavw7FzsG53rxyANBY1dXPwZiBdSRcqR80a/dfPdb+1C3xURAj+gkRR1DSD7lO/JVoM0UZzbI/bfMUNNSMna+g6JFtQiwOpe0xThpMsyURO4K5QyI62o9F1MdhxLRHq0rzXVbP+vrFq0wXdyGOFScc7B/nroepIuNh2vA/dHb5ahDXlG4G6hxSHJz/U5emoLcLm4nkKhCB0/dCQNJPu5TbCe/+V14ejCXoeYQzUb8enGlV00+xwvBsQoWgRGVbExW847LTUUbPty/ol5DsWIIJU/dRty7g6Gvk1mtWvYecBM1jSGbEUAswfYEc8xIDSaDyz9KQIR0oHD6SHBU5Y5qdegXuVAccSfD9VHDWX6Y8Qdb/GPH6Uc3sMEWdmb7pKaQi8NH2huxPnD6AcFmhNAqouQ8TOywr+cuN2VhVWuaMmWQZO18akWjv5Pm680a0h4xuhwBtSmeS5bQ4UcoZ1rAM2d67uiHF97YezlKAbwwiJFJjB92VQH3rQCNsDoYEODC3Po2GJYqYLxZa3RMX+vntmvXCGcuv/nMinia4VQI8baCujzWr48hb3eklXPVM84hw11V594c1afsojXa9hToDbWP0EfIgTC6NhCILdV+C68illLUCeRORaP/CeMrd5hNn68UHlNByZbPFI/tvtso0MjnhQ6UnSdiEPlwuZ3e0th2un/blrAI9dZn9DLqZhFDwOK2yASV5x1D7ba7WP1udXUpprKAikzUFdRuCBX6m8xVGRuaU5nI+XUhQx2P5d4UXkSr9M8w8QLoI0qMp16w2NQr2fynk20qvXDNT0ScOQi8z5rQ1xYJeQn/CWbtgEkrTmB+Ipd9c4fCehP2kjgoXjp8lyieftyIMmFTdWDMQBakA3oDQLRpQcbODM4ssSJy1PzZM1b48Dx/CHAR61jsvat0RHGDaO/qy+A5SSgaGI8joBsZC9nrsIbASngWUnizv/2fnfk8AqGSac5qu6ctswuQSg7X3ek9b8+jADt8UXlOIx1jRWNdp9qQtLw/UkjBG+sg57UWONXULvgAiwq7I/IrYy2qtwJzQFbm2A4gjDpMQuka2u4JUeYnPVKeyZU5PJqZudenW2YwuL6JRF2d47C3+qSIpgXr3UmmxR/xFh3CMH6+SfGMfkEwmx+421t7TYkzseXqImiYoEX53SOFNNoAnw=="
}

Order details

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	Order id
status	string	false	none	Status of order
headers	object	false	none	Order headers
» key	string	false	none	none
encrypted	string	false	none	Encrypted order

ObjectResponse

{
  "name": "Limio Subscription",
  "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
  "record_type": "subscription",
  "service": "limio",
  "mode": "production",
  "created": "2023-03-31T12:29:37.980Z",
  "data": {}
}

Object

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	Object name
id	string	false	none	Object id
record_type	string	false	none	Object record type
service	string	false	none	Object service
mode	string	false	none	Mode in which the object was created
created	string	false	none	ISO date string on which the object was created
data	object	false	none	Additional object data

ObjectsResponse

{
  "items": [
    {
      "name": "Limio Subscription",
      "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
      "record_type": "subscription",
      "service": "limio",
      "mode": "production",
      "created": "2023-03-31T12:29:37.981Z",
      "data": {}
    }
  ]
}

Objects

Properties

Name	Type	Required	Restrictions	Description
items	[object]	false	none	Object array
» name	string	false	none	Object name
» id	string	false	none	Object id
» record_type	string	false	none	Object record type
» service	string	false	none	Object service
» mode	string	false	none	Mode in which the object was created
» created	string	false	none	ISO date string on which the object was created
» data	object	false	none	Additional object data

RelatedObjectRequest

{}

Related Object Request

Properties

None

RelatedObjectResponse

{
  "name": "Limio Subscription",
  "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
  "relationship_id": "relationship_id",
  "record_type": "subscription",
  "service": "limio",
  "mode": "production",
  "created": "2023-03-31T12:29:37.981Z",
  "_relationship": {
    "reference": "217OU0391HEG",
    "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
    "related": "order-bcc1997b17b7824caf86b06451904fb8",
    "record_type": "rel",
    "service": "limio",
    "mode": "production",
    "created": "2023-03-31T12:29:37.981Z",
    "data": {
      "from": {
        "name": "Limio Subscription",
        "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
        "record_type": "subscription",
        "service": "limio",
        "data": {}
      },
      "to": {
        "name": "Limio Order",
        "id": "order-bcc1997b17b7824caf86b06451904fb8",
        "record_type": "order",
        "service": "limio",
        "data": {}
      },
      "metadata": {}
    }
  },
  "data": {}
}

Related Object

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	Related Object name
id	string	false	none	Related Object id
relationship_id	string	false	none	Relationship id
record_type	string	false	none	Related Object record type
service	string	false	none	Related Object service
mode	string	false	none	Mode in which the related object was created
created	string	false	none	ISO date string on which the related object was created
_relationship	object	false	none	Relationship data
» reference	string	false	none	Relationship reference
» id	string	false	none	Object id
» related	string	false	none	The id of the object to which this relationship object is related
» record_type	string	false	none	Relationship record type
» service	string	false	none	Relationship service
» mode	string	false	none	Mode in which the relationship was created
» created	string	false	none	ISO date string on which the relationship was created
» data	object	false	none	Data of the two objects in the relationship
»» from	object	false	none	none
»»» name	string	false	none	Object name
»»» id	string	false	none	Object id
»»» record_type	string	false	none	Object record type
»»» service	string	false	none	Object service
»»» data	object	false	none	Additional object data
»» to	object	false	none	none
»»» name	string	false	none	Object name
»»» id	string	false	none	Object id
»»» record_type	string	false	none	Object record type
»»» service	string	false	none	Object service
»»» data	object	false	none	Additional object data
»» metadata	object	false	none	Additional relationship data
data	object	false	none	Additional date of the related object

RelatedObjectsResponse

{
  "items": [
    {
      "name": "Limio Subscription",
      "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
      "relationship_id": "relationship_id",
      "record_type": "subscription",
      "service": "limio",
      "mode": "production",
      "created": "2023-03-31T12:29:37.981Z",
      "_relationship": {
        "reference": "217OU0391HEG",
        "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
        "related": "order-bcc1997b17b7824caf86b06451904fb8",
        "record_type": "rel",
        "service": "limio",
        "mode": "production",
        "created": "2023-03-31T12:29:37.981Z",
        "data": {
          "from": {
            "name": "Limio Subscription",
            "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
            "record_type": "subscription",
            "service": "limio",
            "data": {}
          },
          "to": {
            "name": "Limio Order",
            "id": "order-bcc1997b17b7824caf86b06451904fb8",
            "record_type": "order",
            "service": "limio",
            "data": {}
          },
          "metadata": {}
        }
      }
    }
  ]
}

Related Objects

Properties

Name	Type	Required	Restrictions	Description
items	[object]	false	none	none
» name	string	false	none	Related Object name
» id	string	false	none	Related Object id
» relationship_id	string	false	none	Relationship id
» record_type	string	false	none	Related Object record type
» service	string	false	none	Related Object service
» mode	string	false	none	Mode in which the related object was created
» created	string	false	none	ISO date string on which the related object was created
» _relationship	object	false	none	Relationship data
»» reference	string	false	none	Relationship reference
»» id	string	false	none	Object id
»» related	string	false	none	The id of the object to which this relationship object is related
»» record_type	string	false	none	Relationship record type
»» service	string	false	none	Relationship service
»» mode	string	false	none	Mode in which the relationship was created
»» created	string	false	none	ISO date string on which the relationship was created
»» data	object	false	none	Data of the two objects in the relationship
»»» from	object	false	none	none
»»»» name	string	false	none	Object name
»»»» id	string	false	none	Object id
»»»» record_type	string	false	none	Object record type
»»»» service	string	false	none	Object service
»»»» data	object	false	none	Additional object data
»»» to	object	false	none	none
»»»» name	string	false	none	Object name
»»»» id	string	false	none	Object id
»»»» record_type	string	false	none	Object record type
»»»» service	string	false	none	Object service
»»»» data	object	false	none	Additional object data
»»» metadata	object	false	none	Additional relationship data

SubObjectsResponse

{
  "items": [
    {
      "name": "Limio Subscription",
      "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
      "related": "order-bcc1997b17b7824caf86b06451904fb8",
      "owner": "id-UshF1h62VLeKzukBmLGb59kU9c1Jn_hNewKngSrNXl8",
      "record_type": "subscription",
      "service": "limio",
      "mode": "production",
      "created": "2023-03-31T12:29:37.982Z",
      "data": {}
    }
  ]
}

Children Objects

Properties

Name	Type	Required	Restrictions	Description
items	[object]	false	none	Children Object array
» name	string	false	none	Child Object name
» id	string	false	none	Child Object id
» related	string	false	none	The id of the object to which this child object is related
» owner	string	false	none	The id of the parent object
» record_type	string	false	none	Child Object record type
» service	string	false	none	Child Object service
» mode	string	false	none	Mode in which the child object was created
» created	string	false	none	ISO date string on which the child object was created
» data	object	false	none	Additional data of the child object

EventsResponse

{
  "items": [
    {
      "id": "event-2f2a17f37c22d0eb1d2e8ee0e021956b",
      "record_type": "event",
      "service": "limio",
      "mode": "production",
      "created": "2023-03-31T12:29:37.983Z",
      "data": {}
    }
  ]
}

Events

Properties

Name	Type	Required	Restrictions	Description
items	[object]	false	none	Event array
» id	string	false	none	Event id
» record_type	string	false	none	Event record type
» service	string	false	none	Event service
» mode	string	false	none	Mode in which the event was created
» created	string	false	none	ISO date string on which the event was created
» data	object	false	none	Additional event data