Get order details

curl --request GET \
  --url https://api.fungies.io/v0/orders/{orderIdOrNumber} \
  --header 'x-fngs-public-key: <api-key>'

{
  "status": "<string>",
  "data": {
    "order": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "number": "<string>",
      "status": "PENDING",
      "createdAt": 4503599627370495,
      "orderNumber": "<string>",
      "object": "order",
      "value": 0,
      "tax": 0,
      "fee": 0,
      "totalItems": 0,
      "country": null,
      "currency": null,
      "currencyDecimals": null,
      "userId": null,
      "user": null,
      "lastPaymentId": null,
      "lastPaymentNumber": null,
      "lastPayment": null,
      "subscriptionId": null,
      "subscription": null
    },
    "subscription": {
      "id": "<string>",
      "status": "all",
      "createdAt": 4503599627370495,
      "currentIntervalEnd": 4503599627370495,
      "currentIntervalStart": 4503599627370495,
      "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "orderNumber": "<string>",
      "order": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "number": "<string>",
        "status": "PENDING",
        "object": "order"
      },
      "object": "subscription",
      "cancelAtIntervalEnd": false,
      "canceledAt": null,
      "userId": null,
      "user": null,
      "lastPaymentId": null,
      "lastPaymentNumber": null,
      "lastPayment": null
    }
  }
}

GET

orders

{orderIdOrNumber}

Get order details

curl --request GET \
  --url https://api.fungies.io/v0/orders/{orderIdOrNumber} \
  --header 'x-fngs-public-key: <api-key>'

{
  "status": "<string>",
  "data": {
    "order": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "number": "<string>",
      "status": "PENDING",
      "createdAt": 4503599627370495,
      "orderNumber": "<string>",
      "object": "order",
      "value": 0,
      "tax": 0,
      "fee": 0,
      "totalItems": 0,
      "country": null,
      "currency": null,
      "currencyDecimals": null,
      "userId": null,
      "user": null,
      "lastPaymentId": null,
      "lastPaymentNumber": null,
      "lastPayment": null,
      "subscriptionId": null,
      "subscription": null
    },
    "subscription": {
      "id": "<string>",
      "status": "all",
      "createdAt": 4503599627370495,
      "currentIntervalEnd": 4503599627370495,
      "currentIntervalStart": 4503599627370495,
      "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "orderNumber": "<string>",
      "order": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "number": "<string>",
        "status": "PENDING",
        "object": "order"
      },
      "object": "subscription",
      "cancelAtIntervalEnd": false,
      "canceledAt": null,
      "userId": null,
      "user": null,
      "lastPaymentId": null,
      "lastPaymentNumber": null,
      "lastPayment": null
    }
  }
}

Authorizations

x-fngs-public-key

string

header

required

Path Parameters

orderIdOrNumber

required

GET /v0/orders/:orderIdOrNumber Parameter

Response

GET /v0/orders/:orderIdOrNumber Positive response

status

string

required

Allowed value: "success"

data

object

required

Show child attributes

data.order

object

required

Show child attributes

data.order.id

string<uuid>

required

data.order.number

string

required

data.order.status

enum<string>

required

Available options:

PENDING,

PAID,

FAILED,

UNPAID,

CANCELLED,

REFUNDED,

PARTIALLY_REFUNDED,

EXPIRED

data.order.createdAt

integer<int64> | null

required

Required range: 0 <= x <= 9007199254740991

data.order.orderNumber

string

required

data.order.object

enum<string>

default:order

Available options:

order

data.order.value

integer<int64> | null

default:0

Required range: -9007199254740991 <= x <= 9007199254740991

data.order.tax

integer<int64> | null

default:0

Required range: -9007199254740991 <= x <= 9007199254740991

data.order.fee

integer<int64> | null

default:0

Required range: -9007199254740991 <= x <= 9007199254740991

data.order.totalItems

integer<int64> | null

default:0

Required range: 0 <= x <= 9007199254740991

data.order.country

string | null

data.order.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.order.currencyDecimals

integer<int64> | null

Required range: -9007199254740991 <= x <= 9007199254740991

data.order.userId

string<uuid> | null

data.order.user

object

Show child attributes

data.order.user.id

string<uuid>

required

data.order.user.object

enum<string>

default:user

Available options:

user

data.order.user.username

string | null

data.order.lastPaymentId

string<uuid> | null

data.order.lastPaymentNumber

string | null

data.order.lastPayment

object

Show child attributes

data.order.lastPayment.id

string<uuid>

required

data.order.lastPayment.type

enum<string>

required

Available options:

one_time,

subscription_initial,

subscription_update,

subscription_interval,

subscription_extra,

claim_free

data.order.lastPayment.number

string

required

data.order.lastPayment.status

enum<string>

required

Available options:

PENDING,

PAID,

FAILED,

UNPAID,

CANCELLED,

REFUNDED,

PARTIALLY_REFUNDED,

EXPIRED

data.order.lastPayment.object

enum<string>

default:payment

Available options:

payment

data.order.subscriptionId

string | null

data.order.subscription

object

Show child attributes

data.order.subscription.id

string

required

data.order.subscription.status

enum<string>

required

Available options:

all,

active,

canceled,

incomplete,

incomplete_expired,

past_due,

trialing,

paused,

unpaid

data.order.subscription.object

enum<string>

default:subscription

Available options:

subscription

data.subscription

object

required

Show child attributes

data.subscription.id

string

required

data.subscription.status

enum<string>

required

Available options:

all,

active,

canceled,

incomplete,

incomplete_expired,

past_due,

trialing,

paused,

unpaid

data.subscription.createdAt

integer<int64> | null

required

Required range: 0 <= x <= 9007199254740991

data.subscription.currentIntervalEnd

integer<int64> | null

required

Required range: 0 <= x <= 9007199254740991

data.subscription.currentIntervalStart

integer<int64> | null

required

Required range: 0 <= x <= 9007199254740991

data.subscription.orderId

string<uuid>

required

data.subscription.orderNumber

string

required

data.subscription.order

object

required

Show child attributes

data.subscription.order.id

string<uuid>

required

data.subscription.order.number

string

required

data.subscription.order.status

enum<string>

required

Available options:

PENDING,

PAID,

FAILED,

UNPAID,

CANCELLED,

REFUNDED,

PARTIALLY_REFUNDED,

EXPIRED

data.subscription.order.object

enum<string>

default:order

Available options:

order

data.subscription.object

enum<string>

default:subscription

Available options:

subscription

data.subscription.cancelAtIntervalEnd

boolean

default:false

data.subscription.canceledAt

integer<int64> | null

Required range: 0 <= x <= 9007199254740991

data.subscription.userId

string<uuid> | null

data.subscription.user

object

Show child attributes

data.subscription.user.id

string<uuid>

required

data.subscription.user.object

enum<string>

default:user

Available options:

user

data.subscription.user.username

string | null

data.subscription.lastPaymentId

string<uuid> | null

data.subscription.lastPaymentNumber

string | null

data.subscription.lastPayment

object

Show child attributes

data.subscription.lastPayment.id

string<uuid>

required

data.subscription.lastPayment.type

enum<string>

required

Available options:

one_time,

subscription_initial,

subscription_update,

subscription_interval,

subscription_extra,

claim_free

data.subscription.lastPayment.number

string

required

data.subscription.lastPayment.status

enum<string>

required

Available options:

PENDING,

PAID,

FAILED,

UNPAID,

CANCELLED,

REFUNDED,

PARTIALLY_REFUNDED,

EXPIRED

data.subscription.lastPayment.object

enum<string>

default:payment

Available options:

payment

List orders Update order

⌘I

API v0 Documentation

discounts

offers

orders

payments

products

subscriptions

users

elements

Get order details

Authorizations

Path Parameters

Response