Download OpenAPI specification:Download
Our REST API is a core building block of the LeaseCloud Platform. You can use it to create, retrieve and update orders from your sales or e-commerce platform. How to integrate LeaseCloud into your own product is completely up to you.
This API enables you to integrate Permånad services into your e-commerce or sales platform. With this API you can:
This API enforces a rate limit of 100 requests per 5 minutes per IP.
The API utilizes a secure bearer token authentication for access.
LeaseCloud supports ordering in Sweden, Denmark, Norway and Finland. You need a separate API key for each market that can be obtained from the LeaseCloud Dev team. We offer a Sandbox development environment for testing.
| price | integer The total price of the product or service in cents |
{- "price": 0
}{- "data": {
- "monthlyAmounts": [
- {
- "months": 0,
- "monthlyAmount": 0
}
]
}
}{- "data": {
- "partner": {
- "id": 0,
- "orgNumber": "string",
- "name": "string",
- "website": "string",
- "country": "string",
- "email": "string",
- "termsOfPayment": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "tariffs": [
- {
- "tariff": null,
- "months": 0
}
]
}
}| partnerId | string The partner's identifier |
| internalOrderId | string The partner's internal order identifier |
| months required | number The number of months for which the order applies |
| invoiceInterval | string Enum: "MONTHLY" "QUARTERLY" The invoicing interval |
| ownInsurance required | boolean Whether the customer has their own insurance |
| company required | string The company name |
| orgNumber required | string The company's organization number |
| nin required | string The orderer's national identification number in the format YYYYMMDD(-)XXXX, used to check for blacklisted customers and board members |
| authorizedSignatory | string The authorized signatory's email address (optional) |
| firstName required | string The customer's first name |
| lastName required | string The customer's last name |
| email required | string The customer's email address, also used to check for blacklisted customers |
| phone required | string The customer's phone number, also used to check for blacklisted customers |
| billingAddress required | string The billing address |
| billingAddress2 | string Additional billing address line (optional) |
| billingCity required | string The billing city |
| billingPostalCode required | string The billing postal code |
| billingCountry required | string The billing country (ISO 2-letter code) |
| shippingFirstName | string The shipping first name (optional) |
| shippingLastName | string The shipping last name (optional) |
| shippingAddress | string The shipping address (optional) |
| shippingAddress2 | string Additional shipping address line (optional) |
| shippingCity | string The shipping city (optional) |
| shippingPostalCode | string The shipping postal code (optional) |
| shippingAmount | number The shipping amount in cents (optional) |
| shippingVAT | number The shipping VAT in cents (optional) |
| customerIp | string The customer's IP address (optional). Used to check for blacklisted customers |
required | Array of objects Array of order items |
| statusTrigger | enum Enum: "READY_TO_SHIP" "ACTIVE" "CANCELLED" "DECLINED" The status trigger for the order (optional, only for testing) |
{- "partnerId": "string",
- "internalOrderId": "string",
- "months": 0,
- "invoiceInterval": "MONTHLY",
- "ownInsurance": true,
- "company": "string",
- "orgNumber": "string",
- "nin": "string",
- "authorizedSignatory": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "phone": "string",
- "billingAddress": "string",
- "billingAddress2": "string",
- "billingCity": "string",
- "billingPostalCode": "string",
- "billingCountry": "string",
- "shippingFirstName": "string",
- "shippingLastName": "string",
- "shippingAddress": "string",
- "shippingAddress2": "string",
- "shippingCity": "string",
- "shippingPostalCode": "string",
- "shippingAmount": 0,
- "shippingVAT": 0,
- "customerIp": "string",
- "items": [
- {
- "name": "string",
- "attributes": "string",
- "sku": "string",
- "productId": "string",
- "unitAmount": 0,
- "quantity": 0,
- "discountAmount": 0
}
], - "statusTrigger": "READY_TO_SHIP"
}{- "data": {
- "id": "string",
- "monthlyAmount": 0,
- "notice": "string"
}
}Fetch paginated partner orders.
| page | integer >= 1 Default: 1 The page number |
| limit | integer [ 1 .. 100 ] Default: 50 The number of items per page |
{- "data": {
- "orders": [
- {
- "id": "string",
- "buyOut": {
- "amount": 0
}, - "partnerOrderId": "string",
- "insuranceYearlyCost": 0,
- "insuranceMonthlyCost": 0,
- "totalAmount": 0,
- "activeStatus": "PENDING",
- "terminatedAt": "2019-08-24T14:15:22Z",
- "terminated": true
}
], - "pagination": {
- "currentPage": 0,
- "totalPages": 0,
- "totalItems": 0,
- "limit": 0,
- "prev": "string",
- "next": "string"
}
}
}| publicId required | string The order's public identifier |
{- "data": {
- "order": {
- "id": "string",
- "buyOut": {
- "amount": 0
}, - "partnerOrderId": "string",
- "insuranceYearlyCost": 0,
- "insuranceMonthlyCost": 0,
- "totalAmount": 0,
- "activeStatus": "PENDING",
- "terminatedAt": "2019-08-24T14:15:22Z",
- "terminated": true
}
}
}| publicId required | string |
| internalOrderId | string The partner's internal order identifier |
{- "internalOrderId": "string"
}{- "data": {
- "message": "string"
}
}