Skip to main content
POST
Create a checkout session

Authorizations

Authorization
string
header
required

API key starting with sk_live_ or sk_test_

Body

application/json
items
object[]
amount
integer

Fixed amount (alternative to items)

Required range: 1 <= x <= 100000000
currency
enum<string>

ISO currency code

Available options:
CVE,
AOA
customerId
string
returnUrl
string
completionUrl
string
expiresInMinutes
integer
Required range: 5 <= x <= 1440
metadata
object | null

Arbitrary key-value metadata (max 50 keys)

Response

200 - application/json

Checkout session created

id
string
Example:

"cs_abc123"

url
string
Example:

"https://pay.plexospay.com/cs_abc123"

amount
string
Example:

"30000"

currency
enum<string>

ISO currency code

Available options:
CVE,
AOA
status
enum<string>
Available options:
OPEN,
COMPLETED,
EXPIRED
returnUrl
string | null
completionUrl
string | null
customerId
string | null
paymentIntentId
string | null
items
object[]
metadata
object | null

Arbitrary key-value metadata (max 50 keys)

expiresAt
string<date-time>
createdAt
string<date-time>
updatedAt
string<date-time>