Create an order

post https://api.sandbox.cleeng.com/3.1/orders

To create an order, you use orders resource. Order resources 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.

You should add paymentOperation and subscriptionId parameters for recurring orders.

time	status	user agent
Retrieving recent requests…

Loading…

🚧
Providing both totalPrice and methodFee causes price calculation be based on those 2 parameters and ignore the offer price. This is useful when payment has already been made by an external service and the order (and subsequent payment) need to have the same price values as in the external service.

Body Params

paymentMethodId

int32

provided by Cleeng

customerId

int32

required

the identifier of Cleeng customer

offerId

string

required

the identifier for Cleeng offer

currency

string

required

customer currency (e.g. USD)

country

string

required

2-letter country code. It is the country code of the country where purchase is made.

couponCode

string

coupon code

taxRate

string

tax rate in float (e.g. '0.23')

billingAddress

object

customerIP

string

IP address of customer current location. Required conditionally when currency or country not supplied

paymentOperation

string

operation type, e.g. recurring-payment (required on pair with subscriptionId)

subscriptionId

string

the identifier of Cleeng subscription, e.g. 123123123 (required on pair with paymentOperation)

totalPrice

string

total price of the order (required on pair with methodFee)

methodFee

string

payment method fee (required on pair with totalPrice)

buyAsAGift

boolean

Whether an order refers to gift purchase

deliveryDetails

object

Headers

Content-Type

string

Defaults to application/json

X-Publisher-Token

string

required

Response

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.sandbox.cleeng.com/3.1/orders \
3
     --header 'Content-Type: application/json' \
4
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

🚧

200200