> ## Documentation Index > Fetch the complete documentation index at: https://docs.fungies.io/llms.txt > Use this file to discover all available pages before exploring further. # Get Subscription > Retrieve detailed information about a specific Subscription. ## OpenAPI ````yaml /api-reference/api-docs.yaml get /v0/subscriptions/{subscriptionIdOrNumber} openapi: 3.1.0 info: title: Fungies API v0 version: 0.3.5 servers: - url: https://api.fungies.io security: [] tags: - name: discounts description: Discounts related endpoints - name: keys description: Offer product keys related endpoints - name: orders description: Orders related endpoints - name: payments description: Payments related endpoints - name: offers description: Offers related endpoints - name: products description: Products related endpoints - name: subscriptions description: Subscriptions related endpoints - name: users description: Users related endpoints - name: variants description: Product variants related endpoints - name: plans description: Product plans related endpoints - name: elements description: Elements related endpoints paths: /v0/subscriptions/{subscriptionIdOrNumber}: get: tags: - subscriptions summary: Get Subscription description: Retrieve detailed information about a specific Subscription. operationId: GetV0SubscriptionsSubscriptionIdOrNumber parameters: - name: subscriptionIdOrNumber in: path required: true description: Subscription ID or order number schema: $ref: >- #/components/schemas/GetV0SubscriptionsSubscriptionIdOrNumberParameterSubscriptionIdOrNumber responses: '200': description: GET /v0/subscriptions/:subscriptionIdOrNumber Positive response content: application/json: schema: $ref: >- #/components/schemas/GetV0SubscriptionsSubscriptionIdOrNumberPositiveResponse '400': description: GET /v0/subscriptions/:subscriptionIdOrNumber Negative response content: application/json: schema: $ref: >- #/components/schemas/GetV0SubscriptionsSubscriptionIdOrNumberNegativeResponse examples: example1: value: status: error error: message: Sample error message security: - APIKEY_1: [] components: schemas: GetV0SubscriptionsSubscriptionIdOrNumberParameterSubscriptionIdOrNumber: type: string description: Subscription ID or order number GetV0SubscriptionsSubscriptionIdOrNumberPositiveResponse: type: object properties: status: type: string const: success data: type: object properties: subscription: type: object properties: object: type: string enum: - subscription default: subscription description: >- Object type identifier. Always 'subscription' for subscription objects. id: type: string pattern: ^#?([0-9A-Za-z]{12,32}|[0-9]+)(-[0-9]+)?$ description: Subscription identifier (based on initial order number). status: type: string enum: - all - active - canceled - incomplete - incomplete_expired - past_due - trialing - paused - unpaid description: |- Subscription status from payment provider: - active: Subscription is active and billing - past_due: Payment failed, retry in progress - canceled: Subscription has been cancelled - unpaid: Payment failed after all retries - incomplete: Initial payment pending - incomplete_expired: Initial payment expired - trialing: In trial period - paused: Subscription is paused createdAt: type: - integer - 'null' format: int64 minimum: 0 maximum: 9007199254740991 currentIntervalEnd: type: - integer - 'null' format: int64 minimum: 0 maximum: 9007199254740991 currentIntervalStart: type: - integer - 'null' format: int64 minimum: 0 maximum: 9007199254740991 cancelAtIntervalEnd: type: boolean default: false canceledAt: type: - integer - 'null' format: int64 minimum: 0 maximum: 9007199254740991 default: null userId: type: - string - 'null' format: uuid default: null user: type: - object - 'null' properties: object: type: string enum: - user default: user description: Object type identifier. Always 'user' for user objects. id: type: string format: uuid description: Unique identifier (UUID) for this user. username: type: - string - 'null' default: null description: Username of the user, if set. required: - id default: null orderId: type: string format: uuid orderNumber: type: string pattern: ^#?([0-9A-Za-z]{12,32}|[0-9]+)(-[0-9]+)?$ order: type: object properties: object: type: string enum: - order default: order description: >- Object type identifier. Always 'order' for order objects. id: type: string format: uuid description: Unique identifier (UUID) for this order. number: type: string pattern: ^#?([0-9A-Za-z]{12,32}|[0-9]+)(-[0-9]+)?$ description: Human-readable order number. status: type: string enum: - PENDING - PAID - FAILED - UNPAID - CANCELLED - REFUNDED - PARTIALLY_REFUNDED - EXPIRED description: Current order status. required: - id - number - status lastPaymentId: type: - string - 'null' format: uuid default: null lastPaymentNumber: type: - string - 'null' pattern: ^#?([0-9A-Za-z]{12,32}|[0-9]+)(-[0-9]+)?$ default: null lastPayment: type: - object - 'null' properties: object: type: string enum: - payment default: payment description: >- Object type identifier. Always 'payment' for payment objects. id: type: string format: uuid description: Unique identifier (UUID) for this payment. type: type: string enum: - one_time - subscription_initial - subscription_update - subscription_interval - subscription_extra - claim_free description: |- Type of payment: - one_time: Single purchase - subscription_initial: First subscription payment - subscription_update: Subscription modification payment - subscription_interval: Recurring subscription payment - subscription_extra: Additional subscription charge - claim_free: Free product claim number: type: string pattern: ^#?([0-9A-Za-z]{12,32}|[0-9]+)(-[0-9]+)?$ description: >- Human-readable payment number (e.g., #ABC123DEF456). Used for reference in invoices and support. status: type: string enum: - PENDING - PAID - FAILED - UNPAID - CANCELLED - REFUNDED - PARTIALLY_REFUNDED - EXPIRED description: |- Current payment status: - PENDING: Being processed - PAID: Completed successfully - FAILED: Payment failed - UNPAID: Not yet attempted - CANCELLED: Was cancelled - REFUNDED: Fully refunded - PARTIALLY_REFUNDED: Partially refunded - EXPIRED: Expired before completion required: - id - type - number - status default: null required: - id - status - createdAt - currentIntervalEnd - currentIntervalStart - orderId - orderNumber - order lastPayment: type: object properties: object: type: string enum: - payment default: payment description: >- Object type identifier. Always 'payment' for payment objects. id: type: string format: uuid description: Unique identifier (UUID) for this payment. type: type: string enum: - one_time - subscription_initial - subscription_update - subscription_interval - subscription_extra - claim_free description: |- Type of payment: - one_time: Single purchase - subscription_initial: First subscription payment - subscription_update: Subscription modification payment - subscription_interval: Recurring subscription payment - subscription_extra: Additional subscription charge - claim_free: Free product claim number: type: string pattern: ^#?([0-9A-Za-z]{12,32}|[0-9]+)(-[0-9]+)?$ description: >- Human-readable payment number (e.g., #ABC123DEF456). Used for reference in invoices and support. status: type: string enum: - PENDING - PAID - FAILED - UNPAID - CANCELLED - REFUNDED - PARTIALLY_REFUNDED - EXPIRED description: |- Current payment status: - PENDING: Being processed - PAID: Completed successfully - FAILED: Payment failed - UNPAID: Not yet attempted - CANCELLED: Was cancelled - REFUNDED: Fully refunded - PARTIALLY_REFUNDED: Partially refunded - EXPIRED: Expired before completion value: type: - integer - 'null' format: int64 minimum: -9007199254740991 maximum: 9007199254740991 default: 0 description: >- Payment amount in smallest currency unit (e.g., cents for USD). Includes tax but excludes fees. tax: type: - integer - 'null' format: int64 minimum: -9007199254740991 maximum: 9007199254740991 default: 0 description: >- Tax amount in smallest currency unit. Included in the total value. fee: type: - integer - 'null' format: int64 minimum: -9007199254740991 maximum: 9007199254740991 default: 0 description: >- Processing fee in smallest currency unit. This is deducted from your payout. currency: type: - string - 'null' enum: - 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 default: null description: ISO 4217 currency code (e.g., USD, EUR, GBP). currencyDecimals: type: - integer - 'null' format: int64 minimum: -9007199254740991 maximum: 9007199254740991 default: null description: >- Number of decimal places for this currency (e.g., 2 for USD, 0 for JPY). createdAt: type: - integer - 'null' format: int64 minimum: 0 maximum: 9007199254740991 description: Unix timestamp (milliseconds) when the payment was created. userId: type: - string - 'null' format: uuid default: null description: >- UUID of the user who made this payment, if associated with a user account. user: type: - object - 'null' properties: object: type: string enum: - user default: user description: Object type identifier. Always 'user' for user objects. id: type: string format: uuid description: Unique identifier (UUID) for this user. username: type: - string - 'null' default: null description: Username of the user, if set. required: - id default: null description: Short user object with basic information about the payer. orderId: type: - string - 'null' format: uuid default: null description: >- UUID of the initial order, for subscription payments this links to the first order. orderNumber: type: - string - 'null' pattern: ^#?([0-9A-Za-z]{12,32}|[0-9]+)(-[0-9]+)?$ default: null description: Human-readable order number of the initial order. order: type: - object - 'null' properties: object: type: string enum: - order default: order description: >- Object type identifier. Always 'order' for order objects. id: type: string format: uuid description: Unique identifier (UUID) for this order. number: type: string pattern: ^#?([0-9A-Za-z]{12,32}|[0-9]+)(-[0-9]+)?$ description: Human-readable order number. status: type: string enum: - PENDING - PAID - FAILED - UNPAID - CANCELLED - REFUNDED - PARTIALLY_REFUNDED - EXPIRED description: Current order status. required: - id - number - status default: null description: >- Short order object with basic information about the associated order. subscriptionId: type: - string - 'null' pattern: ^#?([0-9A-Za-z]{12,32}|[0-9]+)(-[0-9]+)?$ default: null description: >- Subscription identifier if this is a subscription-related payment. subscription: type: - object - 'null' properties: object: type: string enum: - subscription default: subscription description: >- Object type identifier. Always 'subscription' for subscription objects. id: type: string pattern: ^#?([0-9A-Za-z]{12,32}|[0-9]+)(-[0-9]+)?$ description: Subscription identifier (based on initial order number). status: type: string enum: - all - active - canceled - incomplete - incomplete_expired - past_due - trialing - paused - unpaid description: |- Subscription status from payment provider: - active: Subscription is active and billing - past_due: Payment failed, retry in progress - canceled: Subscription has been cancelled - unpaid: Payment failed after all retries - incomplete: Initial payment pending - incomplete_expired: Initial payment expired - trialing: In trial period - paused: Subscription is paused required: - id - status default: null description: Short subscription object with status and ID. discount: type: - object - 'null' properties: object: type: string enum: - discount default: discount description: >- Object type identifier. Always 'discount' for discount objects. id: type: string format: uuid description: Unique identifier (UUID) for this discount. type: type: string enum: - code - sale description: >- Discount type: 'code' for coupon codes, 'sale' for automatic discounts. name: type: - string - 'null' default: null description: Display name of the discount. amount: type: number format: double minimum: -1.7976931348623157e+308 maximum: 1.7976931348623157e+308 description: >- Discount amount (fixed value in currency units or percentage value). amountType: type: string enum: - fixed - percentage description: >- Whether amount is 'fixed' (currency value) or 'percentage'. discountCode: type: - string - 'null' default: null description: The coupon code if this is a code-type discount. required: - id - type - amount - amountType default: null description: >- Applied discount details if a discount code or sale was used. invoiceNumber: type: - string - 'null' default: null description: >- Invoice number for completed payments. Only available for PAID, REFUNDED, or PARTIALLY_REFUNDED statuses. invoiceUrl: type: - string - 'null' default: null description: >- URL to download the invoice PDF. Only available for completed payments with generated invoices. charges: type: - array - 'null' items: type: object properties: object: type: string enum: - charge default: charge description: >- Object type identifier. Always 'charge' for charge objects. id: type: string format: uuid description: Unique identifier (UUID) for this charge. status: type: - string - 'null' enum: - succeeded - pending - failed default: null description: |- Charge status: - succeeded: Payment was successful - pending: Payment is being processed - failed: Payment attempt failed createdAt: type: - number - 'null' format: double minimum: -1.7976931348623157e+308 maximum: 1.7976931348623157e+308 default: null description: >- Unix timestamp (milliseconds) when the charge was created. ipAddress: type: - string - 'null' default: null description: >- IP address of the customer at time of charge, if available. paymentMethod: type: - object - 'null' properties: type: type: string description: >- Payment method type (e.g., card, paypal, bank_transfer, klarna, affirm). brand: type: - string - 'null' enum: - visa - mastercard - amex - discover - diners - jcb - unionpay default: null description: >- Card brand if payment method is a card (visa, mastercard, amex, discover, diners, jcb, unionpay). last4: type: - string - 'null' default: null description: Last 4 digits of the card or account number. card: type: object properties: brand: type: - string - 'null' enum: - visa - mastercard - amex - discover - diners - jcb - unionpay default: null last4: type: - string - 'null' default: null country: type: - string - 'null' network: type: - string - 'null' wallet: type: - object - 'null' properties: type: type: string enum: - amex_express_checkout - apple_pay - google_pay - link - masterpass - samsung_pay - visa_checkout description: >- The type of digital wallet used for the payment. Possible values: - amex_express_checkout: Amex Express Checkout - apple_pay: Apple Pay - google_pay: Google Pay - link: Stripe Link - masterpass: Masterpass - samsung_pay: Samsung Pay - visa_checkout: Visa Checkout dynamicLast4: type: - string - 'null' default: null description: >- The last four digits of the device account number. For Apple Pay, this is the last four digits of the Device Account Number. May differ from the physical card's last4. required: - type default: null description: >- Digital wallet details, if the card payment was made via a wallet (e.g., Apple Pay, Google Pay). Null when no wallet was used. description: >- Card-specific payment details. Present when the payment method type is 'card'. required: - type default: null description: Payment method details used for this charge. reason: type: - string - 'null' default: null description: >- Machine-readable failure reason code if the charge failed. sellerMessage: type: - string - 'null' default: null description: >- Human-readable message explaining the charge outcome, useful for failed charges. required: - id default: null description: >- Array of charge attempts for this payment. Each charge represents a payment attempt with status and payment method details. required: - id - type - number - status - createdAt items: type: array items: type: object properties: object: type: string enum: - item default: item quantity: type: integer format: int64 minimum: 0 maximum: 9007199254740991 default: 0 value: type: - integer - 'null' format: int64 minimum: 0 maximum: 9007199254740991 default: 0 currency: type: string enum: - 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 name: type: string variant: type: - object - 'null' properties: object: type: string enum: - variant default: variant id: type: string format: uuid internalId: type: - string - 'null' default: null required: - id default: null plan: type: - object - 'null' properties: object: type: string enum: - variant default: variant id: type: string format: uuid internalId: type: - string - 'null' default: null required: - id default: null product: type: object properties: object: type: string enum: - product default: product id: type: string format: uuid type: type: string enum: - DigitalDownload - Game - GiftCard - SoftwareKey - VirtualCurrency - VirtualItem - Subscription - OneTimePayment internalId: type: - string - 'null' default: null required: - id - type offer: type: object properties: object: type: string enum: - offer default: offer id: type: string format: uuid internalId: type: - string - 'null' default: null required: - id id: type: string format: uuid customFields: type: - object - 'null' additionalProperties: type: string default: null required: - currency - name - product - offer - id user: type: object properties: object: type: string enum: - user default: user description: Object type identifier. Always 'user' for user objects. id: type: string format: uuid description: Unique identifier (UUID) for this user. username: type: - string - 'null' default: null description: Username of the user, if set. email: type: - string - 'null' format: email default: null details: type: - object - 'null' properties: firstName: type: - string - 'null' default: null lastName: type: - string - 'null' default: null dialCode: type: - string - 'null' default: null phoneNumber: type: - string - 'null' default: null taxId: type: - string - 'null' enum: - al_tin_albania - ad_nrt_andorra - ao_tin_angola - ar_cuit_argentina - am_tin_armenia - aw_tin_aruba - au_abn_australia - au_arn_australia - eu_vat_austria - az_tin_azerbaijan - bs_tin_bahamas - bh_vat_bahrain - bd_bin_bangladesh - bb_tin_barbados - by_tin_belarus - eu_vat_belgium - bj_ifu_benin - bo_tin_bolivia - ba_tin_bosnia_and_herzegovina - br_cnpj_brazil - br_cpf_brazil - bg_uic_bulgaria - eu_vat_bulgaria - bf_ifu_burkina_faso - kh_tin_cambodia - cm_niu_cameroon - ca_bn_canada - ca_gst_hst_canada - ca_pst_bc_canada - ca_pst_mb_canada - ca_pst_sk_canada - ca_qst_canada - cv_nif_cape_verde - cl_tin_chile - cn_tin_china - co_nit_colombia - cd_nif_congo_kinshasa - cr_tin_costa_rica - eu_vat_croatia - hr_oib_croatia - eu_vat_cyprus - eu_vat_czech_republic - eu_vat_denmark - do_rcn_dominican_republic - ec_ruc_ecuador - eg_tin_egypt - sv_nit_el_salvador - eu_vat_estonia - et_tin_ethiopia - eu_oss_vat_eu - eu_vat_finland - eu_vat_france - ge_vat_georgia - de_stn_germany - eu_vat_germany - eu_vat_greece - gn_nif_guinea - hk_br_hong_kong - eu_vat_hungary - hu_tin_hungary - is_vat_iceland - in_gst_india - id_npwp_indonesia - eu_vat_ireland - il_vat_israel - eu_vat_italy - jp_cn_japan - jp_rn_japan - jp_trn_japan - kz_bin_kazakhstan - ke_pin_kenya - kg_tin_kyrgyzstan - la_tin_laos - eu_vat_latvia - li_uid_liechtenstein - li_vat_liechtenstein - eu_vat_lithuania - eu_vat_luxembourg - my_frp_malaysia - my_itn_malaysia - my_sst_malaysia - eu_vat_malta - mr_nif_mauritania - mx_rfc_mexico - md_vat_moldova - me_pib_montenegro - ma_vat_morocco - np_pan_nepal - eu_vat_netherlands - nz_gst_new_zealand - ng_tin_nigeria - mk_vat_macedonia - no_vat_norway - no_voec_norway - om_vat_oman - pe_ruc_peru - ph_tin_philippines - eu_vat_poland - pl_nip_poland - eu_vat_portugal - eu_vat_romania - ro_tin_romania - ru_inn_russia - ru_kpp_russia - sa_vat_saudi_arabia - sn_ninea_senegal - rs_pib_serbia - sg_gst_singapore - sg_uen_singapore - eu_vat_slovakia - eu_vat_slovenia - si_tin_slovenia - za_vat_south_africa - kr_brn_south_korea - es_cif_spain - eu_vat_spain - lk_vat_sri_lanka - sr_fin_suriname - eu_vat_sweden - ch_uid_switzerland - ch_vat_switzerland - tw_vat_taiwan - tj_tin_tajikistan - tz_vat_tanzania - th_vat_thailand - tr_tin_turkey - ug_tin_uganda - ua_vat_ukraine - ae_trn_united_arab_emirates - eu_vat_united_kingdom - gb_vat_united_kingdom - us_ein_united_states - uy_ruc_uruguay - uz_tin_uzbekistan - uz_vat_uzbekistan - ve_rif_venezuela - vn_tin_vietnam - zm_tin_zambia - zw_tin_zimbabwe default: null taxNumber: type: - string - 'null' default: null type: type: - string - 'null' enum: - individual - company default: null address: type: - string - 'null' default: null addressLine2: type: - string - 'null' default: null city: type: - string - 'null' default: null postalCode: type: - string - 'null' default: null companyName: type: - string - 'null' default: null countryCode: type: - string - 'null' enum: - 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 default: null state: type: - string - 'null' default: null default: null internalId: type: - string - 'null' default: null required: - id required: - subscription - lastPayment - items - user required: - status - data GetV0SubscriptionsSubscriptionIdOrNumberNegativeResponse: type: object properties: status: type: string const: error error: type: object properties: message: type: string required: - message required: - status - error securitySchemes: APIKEY_1: type: apiKey in: header name: x-fngs-public-key ````