> ## 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. # List Subscriptions > Search and filter Subscriptions with pagination. Results are sorted by creation date (newest first) by default. ## OpenAPI ````yaml /api-reference/api-docs.yaml get /v0/subscriptions/list 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/list: get: tags: - subscriptions summary: List Subscriptions description: |- Search and filter Subscriptions with pagination. Results are sorted by creation date (newest first) by default. operationId: GetV0SubscriptionsList parameters: - name: status in: query required: false description: |- Filter Subscriptions by their status: - active: Currently active Subscription - past_due: Payment failed but will retry - canceled: Subscription has been canceled - incomplete: Initial payment failed - incomplete_expired: Initial payment failed and expired - trialing: In trial period - unpaid: Payment failed and won't retry schema: $ref: '#/components/schemas/GetV0SubscriptionsListParameterStatus' - name: userId in: query required: false description: Filter Subscriptions by User ID schema: $ref: '#/components/schemas/GetV0SubscriptionsListParameterUserId' - name: cursor in: query required: false description: Pagination cursor for fetching next page schema: $ref: '#/components/schemas/GetV0SubscriptionsListParameterCursor' - name: take in: query required: false description: 'Number of Subscriptions per page (default: 10, max: 100)' schema: $ref: '#/components/schemas/GetV0SubscriptionsListParameterTake' responses: '200': description: GET /v0/subscriptions/list Positive response content: application/json: schema: $ref: '#/components/schemas/GetV0SubscriptionsListPositiveResponse' '400': description: GET /v0/subscriptions/list Negative response content: application/json: schema: $ref: '#/components/schemas/GetV0SubscriptionsListNegativeResponse' examples: example1: value: status: error error: message: Sample error message security: - APIKEY_1: [] components: schemas: GetV0SubscriptionsListParameterStatus: type: string enum: - all - active - canceled - incomplete - incomplete_expired - past_due - trialing - paused - unpaid description: |- Filter Subscriptions by their status: - active: Currently active Subscription - past_due: Payment failed but will retry - canceled: Subscription has been canceled - incomplete: Initial payment failed - incomplete_expired: Initial payment failed and expired - trialing: In trial period - unpaid: Payment failed and won't retry GetV0SubscriptionsListParameterUserId: type: string format: uuid description: Filter Subscriptions by User ID GetV0SubscriptionsListParameterCursor: type: string description: Pagination cursor for fetching next page GetV0SubscriptionsListParameterTake: type: integer format: int64 minimum: 1 maximum: 100 default: 10 description: 'Number of Subscriptions per page (default: 10, max: 100)' GetV0SubscriptionsListPositiveResponse: type: object properties: status: type: string const: success data: type: object properties: subscriptions: type: array items: 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 count: type: - number - 'null' format: double minimum: -1.7976931348623157e+308 maximum: 1.7976931348623157e+308 cursor: type: - string - 'null' hasMore: type: boolean default: false required: - subscriptions - count - cursor required: - status - data GetV0SubscriptionsListNegativeResponse: 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 ````