> ## Documentation Index > Fetch the complete documentation index at: https://docs.clinkbill.com/llms.txt > Use this file to discover all available pages before exploring further. # 查询订单列表 > List orders under your current merchant account. You can filter orders by subscription ID or customer ID. ## OpenAPI ````yaml GET /order openapi: 3.1.0 info: title: Clink API description: >- Official API documentation for Clink's payment processing platform. This API enables merchants to create and manage payment sessions, handle subscriptions, and process transactions. version: 1.0.0 servers: - url: https://uat-api.clinkbill.com/api/ security: - ApiKeyAuth: [] paths: /order: get: summary: List Orders description: >- List orders under your current merchant account. You can filter orders by subscription ID or customer ID. operationId: listOrders parameters: - $ref: '#/components/parameters/TimestampHeader' - name: subscriptionId in: query description: Subscription ID used to filter recurring orders required: false schema: type: string - name: customerId in: query description: Customer ID used to filter orders required: false schema: type: string - name: pageNum in: query description: Current page number. Defaults to 1. required: false schema: type: integer format: int32 default: 1 - name: pageSize in: query description: >- Number of records per page. Defaults to 20. The maximum is 50; larger values are capped at 50. required: false schema: type: integer format: int32 default: 20 maximum: 50 responses: '200': description: Orders retrieved successfully content: application/json: schema: $ref: '#/components/schemas/TableDataInfoOrderApiVo' '*/*': schema: $ref: '#/components/schemas/TableDataInfoOrderApiVo' '401': description: Unauthorized content: '*/*': schema: type: string components: parameters: TimestampHeader: name: X-Timestamp in: header required: true description: >- Current timestamp in milliseconds since Unix epoch (required for request signing) schema: type: string example: '1783513683000' schemas: TableDataInfoOrderApiVo: type: object properties: total: type: integer description: Total number of records format: int64 rows: type: array description: List of data items: $ref: '#/components/schemas/OrderApiVo' code: type: integer description: Response status code, 200 when success format: int32 example: 200 msg: type: string example: success description: Brief description of what happened, 'success' when happy case description: Table Paging Data Object OrderApiVo: type: object properties: orderId: type: string description: Unique identifier of the order type: type: string enum: - recurring - onetime description: >- Order type. `recurring` is a subscription order and `onetime` is a one-time payment order. merchantReferenceId: type: string description: Merchant's internal reference ID for the order invoiceId: type: string description: Associated invoice identifier customerId: type: string description: Customer identifier associated with the order customerEmail: type: string description: Customer email address associated with the order createTime: type: integer example: 1754819711382 description: Unix timestamp when the order was created format: int64 productId: type: string description: Product identifier for the ordered item priceId: type: string description: Price configuration identifier used for the order priceDataList: type: array description: List of pricing details for items in the order items: $ref: '#/components/schemas/PriceData' refType: PriceData paymentMethod: $ref: '#/components/schemas/PaymentMethodApiVo' description: Payment method details used for the order paymentExecutionDetails: type: array description: Payment execution details for platform-managed payment attempts items: $ref: '#/components/schemas/PaymentExecutionDetailApiVo' refType: PaymentExecutionDetailApiVo amountSubtotal: type: number example: 9.99 description: Order subtotal before taxes and adjustments amountTotal: type: number example: 9.99 description: Final order amount including all adjustments paymentCurrency: type: string example: USD description: Currency used for payment processing originalCurrency: type: string example: USD description: Original currency of the order status: type: string enum: - success - failed - requires_action - pending - partial_refunded - refunded description: Current status of the order paymentTime: type: integer example: 1754819711382 description: >- Unix timestamp when the order payment reached a final success or failed state format: int64 sessionId: type: string description: Unique identifier for the checkout session metadata: type: object additionalProperties: type: string description: Set of key-value pairs that you can attach to an object riskLevel: type: string description: Risk level detected for the order PriceData: required: - name - unitAmount type: object properties: name: type: string description: Display name of the product shown to customers during checkout quantity: minimum: 1 type: integer description: Number of units to be purchased (minimum 1) format: int32 unitAmount: minimum: 0 exclusiveMinimum: true type: number description: Price per unit in the specified currency (must be greater than 0) currency: type: string description: Three-letter ISO currency code for the price (e.g., USD, EUR, GBP) imageUrl: type: string description: URL of the product image to display during checkout PaymentMethodApiVo: type: object properties: paymentMethodType: type: string example: CARD description: Type of payment method used (e.g., CARD) paymentInstrumentId: type: string description: Unique identifier of the specific payment instrument cardScheme: type: string example: Visa description: Card brand or scheme, such as Visa or Mastercard cardLastFour: type: string example: '4242' description: Last four digits of the card issuerRegion: type: string example: US description: Card issuing country or region issuerBank: type: string example: Chase Bank description: Card issuing bank wallet: type: object description: Wallet account information for wallet-based payment methods properties: accountTag: type: string example: s*****@personal.example.com description: Bound wallet account tag or reference PaymentExecutionDetailApiVo: type: object properties: channelCode: type: string description: Payment channel code channelTransactionId: type: string description: Transaction identifier returned by the payment channel originalFailureCode: type: string description: Original failure code returned by the payment channel originalFailureMessage: type: string description: Original failure message returned by the payment channel securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-KEY description: >- Your secret API key obtained from the Clink dashboard (Developers section) ````