> ## Documentation Index > Fetch the complete documentation index at: https://docs.zbx.boomfi.xyz/llms.txt > Use this file to discover all available pages before exploring further. # List Subscriptions > List subscriptions with optional status and customer filters ## OpenAPI ````yaml /openapi.yaml get /subscriptions openapi: 3.1.0 info: contact: email: support@boomfi.xyz name: API Support description: >- The BoomFi Merchants API provides a set of endpoints for merchants to manage their accounts, transactions, and more. Hosts differ per brand/environment; use the brand-specific base URL from the docs. title: ZBX Merchants API version: '1.0' servers: - url: https://mapi.zbx.boomfi.xyz/v1 description: Production security: [] tags: - description: Payment links name: Paylinks - description: Billing plans name: Plans - description: Subscriptions name: Subscriptions - description: Customer records name: Customers - description: Invoices name: Invoices - description: Payments name: Payments - description: Organisation events name: Events - description: Organisation profile and display settings name: Organisation - description: Webhook and request-signing secrets name: Secrets - description: Settlement accounts name: Accounts - name: Bank Address Book - description: Managed virtual accounts, balances, pay-in, and payout name: Virtual Accounts - description: Partner-managed accounts, virtual accounts, pay-in, and payout name: Partners - description: Partner virtual account automations and run history name: Partner Automations - description: Partner maintain-balance automations name: Partner Balance Monitoring - description: Tradeable currencies, instruments, and swap targets name: Instruments - description: RFQ quotes name: Quotes - description: RFQ orders and one-click trades name: Orders - description: Executed trades name: Trades paths: /subscriptions: get: tags: - Subscriptions summary: List Subscriptions description: List subscriptions with optional status and customer filters parameters: - description: Filter by customer display ID (cus_...). example: cus_01HXYZ in: query name: customer_id schema: type: string - description: Page size. Defaults to 100. Minimum 1, maximum 100. example: 20 in: query name: limit schema: type: integer minimum: 1 maximum: 100 - description: Page number (1-based). Defaults to 1. example: 1 in: query name: page schema: type: integer minimum: 1 - description: >- Inclusive lower bound on created_at (RFC3339). When set, results are sorted by created_at. example: '2024-01-01T00:00:00.000Z' in: query name: since schema: type: string format: date-time - description: >- Sort direction for the primary list key (created_at when since/until are set, otherwise id). Defaults to desc. example: desc in: query name: sort schema: type: string enum: - asc - desc - description: Filter by subscription status. example: Active in: query name: status schema: type: string enum: - Unknown - Pending - Future - InTrial - Active - Paused - Expired - Canceled - description: >- Inclusive upper bound on created_at (RFC3339). When set, results are sorted by created_at. example: '2024-12-31T23:59:59.000Z' in: query name: until schema: type: string format: date-time responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/internal.PaginatedResponse-subscriptions_SubscriptionResponse '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/internal.ErrorResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/internal.ErrorResponse' security: - ApiKeyAuth: [] components: schemas: internal.PaginatedResponse-subscriptions_SubscriptionResponse: properties: data: allOf: - $ref: >- #/components/schemas/internal.PaginatedItems-subscriptions_SubscriptionResponse description: Paginated payload. error: description: True when the request failed. type: boolean type: object internal.ErrorResponse: properties: error: allOf: - $ref: '#/components/schemas/internal.ErrorStruct' description: Error details including HTTP-style code and message. type: object internal.PaginatedItems-subscriptions_SubscriptionResponse: properties: items: description: Items in the current page. items: $ref: '#/components/schemas/subscriptions.SubscriptionResponse' type: array last_update: description: >- Timestamp of the most recently updated item in the result set, when available. example: '2021-01-01T00:00:00.000Z' type: string next: description: Next page number to request, when more results exist. example: 10 type: integer total: description: Total number of matching items across all pages. example: 10 type: integer type: object internal.ErrorStruct: properties: code: description: |- Error code Example: 400 example: 400 type: integer errors: description: List of errors items: $ref: '#/components/schemas/internal.SingleError' type: array message: description: |- Error message Example: Insufficient quantity example: Insufficient quantity type: string type: object subscriptions.SubscriptionResponse: properties: cancel_at_period_end: description: >- If true, the subscription cancels at the end of the current billing period. type: boolean created_at: description: When the resource was created (RFC3339). type: string currency: description: Currency symbol (for example USDC or USD). type: string customer: allOf: - $ref: '#/components/schemas/customers.CustomerResponse' description: Customer associated with this resource. customer_id: description: Unique identifier of the customer linked to this resource. type: string id: description: Unique resource identifier. type: string is_overdue: description: True when the subscription or invoice is overdue. type: boolean items: description: List of items in the request or response. items: $ref: '#/components/schemas/subscriptions.SubscriptionItem' type: array metadata: additionalProperties: {} description: Arbitrary merchant-defined metadata. type: object org_id: description: Organisation ID that owns this resource. type: string payment_method: allOf: - $ref: '#/components/schemas/docenums.PaymentMethod' description: Payment method used for this deposit or settlement. properties: additionalProperties: {} description: Additional properties as a key-value map. type: object reference: description: Merchant-defined reference string. type: string source: allOf: - $ref: '#/components/schemas/docenums.BillingSource' description: Origin system or integration that created this resource. start_at: description: When the subscription or schedule starts (RFC3339). type: string status: allOf: - $ref: '#/components/schemas/docenums.SubscriptionStatus' description: Status of this resource. updated_at: description: When the resource was last updated (RFC3339). type: string v1: description: Legacy v1 payload fields, when present. type: object internal.SingleError: properties: domain: description: |- Domain Example: orders example: orders type: string reason: description: |- Error Reason Example: InsufficientQuantity example: InsufficientQuantity type: string type: object customers.CustomerResponse: properties: created_at: description: When the resource was created (RFC3339). type: string deleted_at: description: When the resource was soft-deleted (RFC3339), if applicable. type: string email: description: Email address. type: string id: description: Unique resource identifier. type: string metadata: additionalProperties: {} description: Arbitrary key-value metadata. type: object name: description: Display name. type: string org_id: description: Organisation ID that owns this resource. type: string phone: description: Phone number. type: string properties: additionalProperties: {} description: Internal properties (for example social handles). type: object reference: description: Merchant-defined reference string. type: string updated_at: description: When the resource was last updated (RFC3339). type: string wallet_address: description: Blockchain wallet address. type: string type: object subscriptions.SubscriptionItem: properties: created_at: description: When the resource was created (RFC3339). type: string id: description: Unique resource identifier. type: string plan: allOf: - $ref: '#/components/schemas/plan.PlanResponse' description: Plan associated with this resource. plan_id: description: Unique identifier of the plan linked to this resource. type: string properties: additionalProperties: {} description: Additional properties as a key-value map. type: object subscription_id: description: Unique identifier of the subscription this item belongs to. type: string updated_at: description: When the resource was last updated (RFC3339). type: string v1: description: Legacy v1 payload fields, when present. type: object docenums.PaymentMethod: enum: - Unknown - MerchantContract - ProxyWallet - Unblock - Payout - Card - GooglePay - ApplePay - Paypal - DirectDebit - Ramp - RampCryptoSettlement - Refund - Deposit type: string x-enum-varnames: - PaymentMethodUnknown - PaymentMethodMerchantContract - PaymentMethodProxyWallet - PaymentMethodUnblock - PaymentMethodPayout - PaymentMethodCard - PaymentMethodGooglePay - PaymentMethodApplePay - PaymentMethodPaypal - PaymentMethodDirectDebit - PaymentMethodRamp - PaymentMethodRampCryptoSettlement - PaymentMethodRefund - PaymentMethodDeposit docenums.BillingSource: enum: - Lago - BoomFi - Stripe - Chargebee - QuickBooks type: string x-enum-varnames: - BillingSourceLago - BillingSourceBoomFi - BillingSourceStripe - BillingSourceChargebee - BillingSourceQuickBooks docenums.SubscriptionStatus: enum: - Unknown - Pending - Future - InTrial - Active - Paused - Expired - Canceled type: string x-enum-varnames: - SubscriptionStatusUnknown - SubscriptionStatusPending - SubscriptionStatusFuture - SubscriptionStatusInTrial - SubscriptionStatusActive - SubscriptionStatusPaused - SubscriptionStatusExpired - SubscriptionStatusCanceled plan.PlanResponse: properties: available_quantity: description: >- Remaining purchasable quantity when the plan has a capped supply; omitted when unlimited. type: integer billing_scheme: allOf: - $ref: '#/components/schemas/docenums.BillingScheme' description: Pricing scheme (FlatFee, PerUnit, Graduated, Volume). created_at: description: When the resource was created (RFC3339). type: string created_by: description: User or system that created the resource. type: string currency: description: Currency symbol (for example USDC or USD). type: string deleted_at: description: When the resource was soft-deleted (RFC3339), if applicable. type: string enabled: description: Whether this resource is enabled. type: boolean expires_at: description: Expiration time (RFC3339). type: string id: description: Unique resource identifier. type: string metadata: additionalProperties: {} description: Arbitrary key-value metadata attached to the plan. type: object name: description: Display name. type: string org_id: description: Organisation ID that owns this resource. type: string payment_link: allOf: - $ref: '#/components/schemas/plan.PaymentLinkResponse' description: Checkout payment link associated with this plan, when one exists. price: description: Price as a decimal string. type: string properties: additionalProperties: {} description: Internal plan properties (feature flags and display settings). type: object recurring_interval: allOf: - $ref: '#/components/schemas/docenums.RecurringInterval' description: >- Billing interval unit for recurring plans (Minute, Hour, Day, Week, Month, Year). recurring_interval_count: description: Number of interval units between billings. type: integer recurring_usage_type: allOf: - $ref: '#/components/schemas/docenums.RecurringUsageType' description: Usage metering type for recurring plans (Licensed or Metered). reference: description: Merchant-defined reference string. type: string source: allOf: - $ref: '#/components/schemas/docenums.BillingSource' description: Origin system or integration that created this resource. trial_period: description: Trial period before the first charge (for example duration string). type: string type: allOf: - $ref: '#/components/schemas/docenums.PlanType' description: Resource or value type. updated_at: description: When the resource was last updated (RFC3339). type: string type: object docenums.BillingScheme: enum: - FlatFee - PerUnit - Graduated - Volume type: string x-enum-varnames: - BillingSchemeFlatFee - BillingSchemePerUnit - BillingSchemeGraduated - BillingSchemeVolume plan.PaymentLinkResponse: properties: created_at: description: When the resource was created (RFC3339). type: string created_by: description: User or system that created the resource. type: string customer_ident_collection: description: Whether customer identity details are collected at checkout. type: boolean deleted_at: description: When the resource was soft-deleted (RFC3339), if applicable. type: string enabled: description: Whether this resource is enabled. type: boolean id: description: Unique resource identifier. type: string invoice_id: description: Unique identifier of the invoice linked to this resource. type: string metadata: additionalProperties: {} description: Arbitrary key-value metadata attached to the payment link. type: object plan_id: description: Unique identifier of the plan linked to this resource. type: string properties: additionalProperties: {} description: Internal payment link properties. type: object shipping_address_collection: description: Whether a shipping address is collected at checkout. type: boolean source: allOf: - $ref: '#/components/schemas/docenums.BillingSource' description: Origin system or integration that created this resource. tax_ident_collection: description: Whether a tax identifier is collected at checkout. type: boolean updated_at: description: When the resource was last updated (RFC3339). type: string updated_by: description: User or system that last updated the resource. type: string type: object docenums.RecurringInterval: enum: - Unknown - Minute - Hour - Day - Week - Month - Year type: string x-enum-varnames: - RecurringIntervalUnknown - RecurringIntervalMinute - RecurringIntervalHour - RecurringIntervalDay - RecurringIntervalWeek - RecurringIntervalMonth - RecurringIntervalYear docenums.RecurringUsageType: enum: - Unknown - Licensed - Metered type: string x-enum-varnames: - RecurringUsageTypeUnknown - RecurringUsageTypeLicensed - RecurringUsageTypeMetered docenums.PlanType: enum: - Unknown - OneTime - Recurring type: string x-enum-varnames: - PlanTypeUnknown - PlanTypeOneTime - PlanTypeRecurring securitySchemes: ApiKeyAuth: in: header name: X-API-KEY type: apiKey ````