> ## 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 By Customer > List subscriptions for a customer belonging to the authenticated org ## OpenAPI ````yaml /openapi.yaml get /subscriptions/{customerID} 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/{customerID}: get: tags: - Subscriptions summary: List Subscriptions By Customer description: List subscriptions for a customer belonging to the authenticated org parameters: - description: Unique customer identifier (cus_... or raw UUID) in: path name: customerID required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/internal.PaginatedResponse-subscriptions_Subscription '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/internal.ErrorResponse' '404': description: Not Found 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_Subscription: properties: data: allOf: - $ref: >- #/components/schemas/internal.PaginatedItems-subscriptions_Subscription 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_Subscription: properties: items: description: Items in the current page. items: $ref: '#/components/schemas/subscriptions.Subscription' 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.Subscription: properties: chain_id: description: Blockchain chain ID for the subscription payments. type: string contract_subscription_id: description: On-chain or contract subscription identifier when applicable. type: string created_at: description: When the subscription was created (RFC3339). type: string customer_id: description: Unique identifier of the customer on the subscription. type: string id: description: Unique subscription identifier. type: string initial_payment_id: description: ID of the initial payment that started the subscription. type: string is_overdue: description: True when the subscription is overdue. type: boolean next_payment_at: description: When the next subscription payment is due (RFC3339). type: string payment_currency: description: Currency used for subscription charges. type: string plan: allOf: - $ref: '#/components/schemas/models.Plan' description: Plan associated with this subscription. plan_id: description: Unique identifier of the plan for this subscription. type: string started_at: description: When the subscription became active (RFC3339). type: string terminated_at: description: When the subscription ended (RFC3339), if terminated. type: string termination_txn_hash: description: On-chain transaction hash that terminated the subscription. type: string txn_hash: description: On-chain transaction hash that started the subscription. type: string updated_at: description: When the subscription was last updated (RFC3339). type: string 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 models.Plan: properties: available_quantity: description: >- Remaining purchasable quantity when supply is capped; omit 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: description: Arbitrary merchant-defined metadata. items: type: integer type: array name: description: Display name. type: string org_id: description: Organisation ID that owns this resource. type: string price: description: Price as a decimal string. type: string properties: description: Additional properties as a key-value map. items: type: integer type: array 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 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.BillingSource: enum: - Lago - BoomFi - Stripe - Chargebee - QuickBooks type: string x-enum-varnames: - BillingSourceLago - BillingSourceBoomFi - BillingSourceStripe - BillingSourceChargebee - BillingSourceQuickBooks docenums.PlanType: enum: - Unknown - OneTime - Recurring type: string x-enum-varnames: - PlanTypeUnknown - PlanTypeOneTime - PlanTypeRecurring securitySchemes: ApiKeyAuth: in: header name: X-API-KEY type: apiKey ````