Create order

Use /orders endpoint to create an order.

Orders are used to handle customers' payments of previously defined offers. Orders expire after 24 hours unless the payment is captured. Payment method is required in order entity for payment but can be added in update order and fetch in /payment-methods.

AUTHORIZATION
Authorization with JWT is required.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Warning!

Customer country and currency or customerIP are required for correct price calculation because tax rate depends on the country. If none of these params are given, the price will be calculated for request IP address. If all of them are given, the given country is the most important.

Please note that when using Cleeng Merchant, customerIP should be available for the purpose of proper tax calculation in the US and Canada. It is recommended that customerIP is passed in the register, login and create order methods.

📘

Free Purchases

Please note that when a free trial period or 100% coupon is used for a given offer, the price is not taxable. Therefore, the price to be displayed is excluding tax.

After the free trial period ends or a 100% coupon is redeemed, the price for the following periods will include tax (if applicable).

Body Params
string
required

ID of Cleeng offer, e.g. A123123123_US

string
required

Customer identifier at Cleeng

string
required

2-letter customer country code (ISO 3166 country code - without 'UK'). It is the country code of the country where purchase is made.

string
required

Customer currency. To fetch customer's country and currency use /locales. A list of supported values can be found HERE

string
required

IP address of customer current location. Required conditionally when country and currency not given

int32

Identifier of selected payment method. Publisher payment methods Ids are provided by Cleeng

string

Coupon code applied for this order

boolean

Whether an order refers to gift purchase.

deliveryDetails
object
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json