List orders

Authorizations

x-fngs-public-key

string

header

required

Query Parameters

orderDirection

enum<string>

GET /v0/orders/list Parameter

Available options:

ASC,

DESC

skip

number<double> | null

GET /v0/orders/list Parameter

Required range: 0 <= x <= 1.7976931348623157e+308

take

number<double> | null

GET /v0/orders/list Parameter

Required range: 0 <= x <= 1.7976931348623157e+308

archived

GET /v0/orders/list Parameter

withArchived

GET /v0/orders/list Parameter

returnCount

GET /v0/orders/list Parameter

term

string

GET /v0/orders/list Parameter

ids

string<uuid>[]

GET /v0/orders/list Parameter

number

string

GET /v0/orders/list Parameter

userId

string<uuid>

GET /v0/orders/list Parameter

subscriptionId

string

GET /v0/orders/list Parameter

statuses

enum<string>[]

GET /v0/orders/list Parameter

Available options:

PENDING,

PAID,

FAILED,

UNPAID,

CANCELLED,

REFUNDED,

PARTIALLY_REFUNDED,

EXPIRED

types

enum<string>[]

GET /v0/orders/list Parameter

Available options:

one_time,

subscription_initial,

subscription_update,

subscription_interval,

subscription_extra,

claim_free

valueFrom

number<double> | null

GET /v0/orders/list Parameter

Required range: -1.7976931348623157e+308 <= x <= 1.7976931348623157e+308

valueTo

number<double> | null

GET /v0/orders/list Parameter

Required range: -1.7976931348623157e+308 <= x <= 1.7976931348623157e+308

currency

enum<string>

GET /v0/orders/list Parameter

Available options:

AFN,

ALL,

DZD,

AOA,

ARS,

AMD,

AWG,

AUD,

AZN,

BSD,

BDT,

BBD,

BZD,

BMD,

BOB,

BAM,

BWP,

BRL,

BHD,

GBP,

BND,

BGN,

BIF,

BYN,

KHR,

CAD,

CVE,

KYD,

KWD,

XAF,

XPF,

CLP,

CNY,

COP,

KMF,

CDF,

CRC,

HRK,

CZK,

DKK,

DJF,

DOP,

XCD,

EGP,

ETB,

EUR,

FKP,

FJD,

GMD,

GEL,

GIP,

GTQ,

GNF,

GYD,

HTG,

HNL,

HKD,

HUF,

ISK,

INR,

IDR,

ILS,

JMD,

JPY,

JOD,

KZT,

KES,

KGS,

LAK,

LBP,

LSL,

LRD,

MOP,

MKD,

MGA,

MWK,

MYR,

MVR,

MRO,

MUR,

MXN,

MDL,

MNT,

MAD,

MZN,

MMK,

NAD,

NPR,

ANG,

TWD,

NZD,

NIO,

NGN,

NOK,

OMR,

PKR,

PAB,

PGK,

PYG,

PEN,

PHP,

PLN,

QAR,

RON,

RUB,

RWF,

SHP,

SVC,

WST,

STD,

SAR,

RSD,

SCR,

SLL,

SGD,

SBD,

SOS,

ZAR,

KRW,

LKR,

SRD,

SZL,

SEK,

CHF,

TJS,

TZS,

THB,

TND,

TOP,

TTD,

TRY,

UGX,

UAH,

AED,

UYU,

USD,

UZS,

VUV,

VEF,

VND,

XOF,

YER,

ZMW,

SLE,

XCG,

SSP,

VES,

MRU,

STN,

VED

country

enum<string>

GET /v0/orders/list Parameter

Available options:

AF,

AX,

AL,

DZ,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BA,

BW,

BV,

BR,

IO,

VG,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

BQ,

KY,

CF,

TD,

CL,

CN,

CO,

KM,

CG,

CD,

CK,

CR,

CI,

HR,

CW,

CY,

CZ,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

SZ,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HN,

HK,

HU,

IS,

IN,

ID,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

XK,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MG,

MW,

MY,

MV,

ML,

MT,

MQ,

MR,

MU,

YT,

MX,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

MK,

NO,

OM,

PK,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RE,

RO,

RU,

RW,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

GS,

KR,

SS,

ES,

LK,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

SD,

SR,

SJ,

SE,

CH,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UY,

UZ,

VU,

VA,

VE,

VN,

WF,

EH,

YE,

ZM,

ZW

createdFrom

integer<int64> | null

GET /v0/orders/list Parameter

Required range: 0 <= x <= 9007199254740991

createdTo

integer<int64> | null

GET /v0/orders/list Parameter

Required range: 0 <= x <= 9007199254740991

orderBy

enum<string>

GET /v0/orders/list Parameter

Available options:

createdAt,

orderNumber,

value

Response

GET /v0/orders/list Positive response

status

string

required

Allowed value: "success"

data

object

required

Show child attributes

data.orders

object[]

required

Show child attributes

data.orders.id

string<uuid>

required

data.orders.number

string

required

data.orders.status

enum<string>

required

Available options:

PENDING,

PAID,

FAILED,

UNPAID,

CANCELLED,

REFUNDED,

PARTIALLY_REFUNDED,

EXPIRED

data.orders.createdAt

integer<int64> | null

required

Required range: 0 <= x <= 9007199254740991

data.orders.orderNumber

string

required

data.orders.object

enum<string>

default:order

Available options:

order

data.orders.value

integer<int64> | null

default:0

Required range: -9007199254740991 <= x <= 9007199254740991

data.orders.tax

integer<int64> | null

default:0

Required range: -9007199254740991 <= x <= 9007199254740991

data.orders.fee

integer<int64> | null

default:0

Required range: -9007199254740991 <= x <= 9007199254740991

data.orders.totalItems

integer<int64> | null

default:0

Required range: 0 <= x <= 9007199254740991

data.orders.country

string | null

data.orders.currency

enum<string> | null

Available options:

AFN,

ALL,

DZD,

AOA,

ARS,

AMD,

AWG,

AUD,

AZN,

BSD,

BDT,

BBD,

BZD,

BMD,

BOB,

BAM,

BWP,

BRL,

BHD,

GBP,

BND,

BGN,

BIF,

BYN,

KHR,

CAD,

CVE,

KYD,

KWD,

XAF,

XPF,

CLP,

CNY,

COP,

KMF,

CDF,

CRC,

HRK,

CZK,

DKK,

DJF,

DOP,

XCD,

EGP,

ETB,

EUR,

FKP,

FJD,

GMD,

GEL,

GIP,

GTQ,

GNF,

GYD,

HTG,

HNL,

HKD,

HUF,

ISK,

INR,

IDR,

ILS,

JMD,

JPY,

JOD,

KZT,

KES,

KGS,

LAK,

LBP,

LSL,

LRD,

MOP,

MKD,

MGA,

MWK,

MYR,

MVR,

MRO,

MUR,

MXN,

MDL,

MNT,

MAD,

MZN,

MMK,

NAD,

NPR,

ANG,

TWD,

NZD,

NIO,

NGN,

NOK,

OMR,

PKR,

PAB,

PGK,

PYG,

PEN,

PHP,

PLN,

QAR,

RON,

RUB,

RWF,

SHP,

SVC,

WST,

STD,

SAR,

RSD,

SCR,

SLL,

SGD,

SBD,

SOS,

ZAR,

KRW,

LKR,

SRD,

SZL,

SEK,

CHF,

TJS,

TZS,

THB,

TND,

TOP,

TTD,

TRY,

UGX,

UAH,

AED,

UYU,

USD,

UZS,

VUV,

VEF,

VND,

XOF,

YER,

ZMW,

SLE,

XCG,

SSP,

VES,

MRU,

STN,

VED

data.orders.currencyDecimals

integer<int64> | null

Required range: -9007199254740991 <= x <= 9007199254740991

data.orders.userId

string<uuid> | null

data.orders.user

object

Show child attributes

data.orders.user.id

string<uuid>

required

data.orders.user.object

enum<string>

default:user

Available options:

user

data.orders.user.username

string | null

data.orders.lastPaymentId

string<uuid> | null

data.orders.lastPaymentNumber

string | null

data.orders.lastPayment

object

Show child attributes

data.orders.lastPayment.id

string<uuid>

required

data.orders.lastPayment.type

enum<string>

required

Available options:

one_time,

subscription_initial,

subscription_update,

subscription_interval,

subscription_extra,

claim_free

data.orders.lastPayment.number

string

required

data.orders.lastPayment.status

enum<string>

required

Available options:

PENDING,

PAID,

FAILED,

UNPAID,

CANCELLED,

REFUNDED,

PARTIALLY_REFUNDED,

EXPIRED

data.orders.lastPayment.object

enum<string>

default:payment

Available options:

payment

data.orders.subscriptionId

string | null

data.orders.subscription

object

Show child attributes

data.orders.subscription.id

string

required

data.orders.subscription.status

enum<string>

required

Available options:

all,

active,

canceled,

incomplete,

incomplete_expired,

past_due,

trialing,

paused,

unpaid

data.orders.subscription.object

enum<string>

default:subscription

Available options:

subscription

data.count

number<double> | null

required

Required range: -1.7976931348623157e+308 <= x <= 1.7976931348623157e+308

API v0 Documentation

discounts

offers

orders

payments

products

subscriptions

users

elements

Authorizations

Query Parameters

Response