subscriptions
Get Subscription
subscriptions
Get Subscription
Retrieve detailed information about a specific Subscription.
GET
/
v0
/
subscriptions
/
{subscriptionIdOrNumber}
curl --request GET \
--url https://api.fungies.io/v0/subscriptions/{subscriptionIdOrNumber} \
--header 'x-fngs-public-key: <api-key>'{
"status": "<string>",
"data": {
"subscription": {
"object": "subscription",
"id": "<string>",
"status": "all",
"createdAt": 4503599627370495,
"currentIntervalEnd": 4503599627370495,
"currentIntervalStart": 4503599627370495,
"cancelAtIntervalEnd": false,
"canceledAt": null,
"userId": null,
"user": null,
"orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orderNumber": "<string>",
"order": {
"object": "order",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": "<string>",
"status": "PENDING"
},
"lastPaymentId": null,
"lastPaymentNumber": null,
"lastPayment": null
},
"lastPayment": {
"object": "payment",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "one_time",
"number": "<string>",
"status": "PENDING",
"value": 0,
"tax": 0,
"fee": 0,
"currency": null,
"currencyDecimals": null,
"createdAt": 4503599627370495,
"userId": null,
"user": null,
"orderId": null,
"orderNumber": null,
"order": null,
"subscriptionId": null,
"subscription": null,
"invoiceNumber": null,
"invoiceUrl": null
},
"items": [
{
"object": "item",
"quantity": 0,
"value": 0,
"currency": "AFN",
"name": "<string>",
"variant": null,
"plan": null,
"product": {
"object": "product",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "DigitalDownload",
"internalId": null
},
"offer": {
"object": "offer",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"internalId": null
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customFields": null
}
],
"user": {
"object": "user",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"username": null,
"email": null,
"details": null,
"internalId": null
}
}
}Authorizations
Path Parameters
Subscription ID or order number
Response
200
application/json
GET /v0/subscriptions/:subscriptionIdOrNumber Positive response
Allowed value:
"success"Available options:
all, active, canceled, incomplete, incomplete_expired, past_due, trialing, paused, unpaid Required range:
0 <= x <= 9007199254740991Required range:
0 <= x <= 9007199254740991Required range:
0 <= x <= 9007199254740991Available options:
PENDING, PAID, FAILED, UNPAID, CANCELLED, REFUNDED, PARTIALLY_REFUNDED, EXPIRED Available options:
order Available options:
subscription Required range:
0 <= x <= 9007199254740991Available options:
one_time, subscription_initial, subscription_update, subscription_interval, subscription_extra, claim_free Available options:
PENDING, PAID, FAILED, UNPAID, CANCELLED, REFUNDED, PARTIALLY_REFUNDED, EXPIRED Available options:
payment Available options:
one_time, subscription_initial, subscription_update, subscription_interval, subscription_extra, claim_free Available options:
PENDING, PAID, FAILED, UNPAID, CANCELLED, REFUNDED, PARTIALLY_REFUNDED, EXPIRED Required range:
0 <= x <= 9007199254740991Available options:
payment Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Available 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 Required range:
-9007199254740991 <= x <= 9007199254740991Available options:
PENDING, PAID, FAILED, UNPAID, CANCELLED, REFUNDED, PARTIALLY_REFUNDED, EXPIRED Available options:
order Available options:
all, active, canceled, incomplete, incomplete_expired, past_due, trialing, paused, unpaid Available options:
subscription 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 Available options:
DigitalDownload, Game, GiftCard, SoftwareKey, VirtualCurrency, VirtualItem, Subscription, OneTimePayment Available options:
product Available options:
item Required range:
0 <= x <= 9007199254740991Required range:
0 <= x <= 9007199254740991Available options:
user Available options:
individual, company 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 curl --request GET \
--url https://api.fungies.io/v0/subscriptions/{subscriptionIdOrNumber} \
--header 'x-fngs-public-key: <api-key>'{
"status": "<string>",
"data": {
"subscription": {
"object": "subscription",
"id": "<string>",
"status": "all",
"createdAt": 4503599627370495,
"currentIntervalEnd": 4503599627370495,
"currentIntervalStart": 4503599627370495,
"cancelAtIntervalEnd": false,
"canceledAt": null,
"userId": null,
"user": null,
"orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orderNumber": "<string>",
"order": {
"object": "order",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": "<string>",
"status": "PENDING"
},
"lastPaymentId": null,
"lastPaymentNumber": null,
"lastPayment": null
},
"lastPayment": {
"object": "payment",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "one_time",
"number": "<string>",
"status": "PENDING",
"value": 0,
"tax": 0,
"fee": 0,
"currency": null,
"currencyDecimals": null,
"createdAt": 4503599627370495,
"userId": null,
"user": null,
"orderId": null,
"orderNumber": null,
"order": null,
"subscriptionId": null,
"subscription": null,
"invoiceNumber": null,
"invoiceUrl": null
},
"items": [
{
"object": "item",
"quantity": 0,
"value": 0,
"currency": "AFN",
"name": "<string>",
"variant": null,
"plan": null,
"product": {
"object": "product",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "DigitalDownload",
"internalId": null
},
"offer": {
"object": "offer",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"internalId": null
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customFields": null
}
],
"user": {
"object": "user",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"username": null,
"email": null,
"details": null,
"internalId": null
}
}
}