> ## Documentation Index > Fetch the complete documentation index at: https://docs.hubfy.io/llms.txt > Use this file to discover all available pages before exploring further. # Obter um pedido > Operação sobre pedidos da conta. Retorna o objeto completo identificado pelo ID, quando ele pertence à conta da chave. Requer `orders:read` ou `read`. Veja [campos, relacionamentos e eventos](https://docs.hubfy.io/api-reference/orders/object.md). ## OpenAPI ````yaml api/v1/openapi.yaml GET /v1/orders/{id} openapi: 3.1.0 info: title: Hubfy API version: 1.0.0 description: >- API pública da Hubfy para produtos, preços, arquivos, clientes, pedidos e links de pagamento. Autenticação por chave da conta. GET consulta; POST cria, atualiza ou executa ações; DELETE remove ou desativa. O ambiente usa dados reais, sem sandbox separado. Consulte os fundamentos, os objetos e os eventos em https://docs.hubfy.io/api-reference/introduction. servers: - url: https://api.hubfy.io security: - apiKeyAuth: [] tags: - name: Produtos description: Objeto Product. Campos e relacionamentos na visão geral. - name: Preços description: Objeto Price. Campos e relacionamentos na visão geral. - name: Arquivos description: Objeto Asset. Campos e relacionamentos na visão geral. - name: Clientes description: Objeto Customer. Campos e relacionamentos na visão geral. - name: Pedidos description: Objeto Order. Campos e relacionamentos na visão geral. - name: Links de pagamento description: Objeto PaymentLink. Campos e relacionamentos na visão geral. - name: Fundamentos da API description: Conexão e identificação da API. paths: /v1/orders/{id}: get: tags: - Pedidos summary: Obter um pedido description: >- Retorna o objeto completo quando ele pertence à conta da chave. Permissão: `orders:read` ou `read`. Consulte a [visão geral](/api-reference/orders/object) para campos e relacionamentos. operationId: getOrder parameters: - name: id in: path required: true schema: type: string pattern: ^ord_[a-z0-9]{16}$ description: ID público do pedido na conta. responses: '200': description: Operação concluída headers: X-Request-Id: description: Identifier of this HTTP request schema: type: string content: application/json: schema: $ref: '#/components/schemas/Order' example: id: ord_1234567890abcdef access_expires_at: null created_at: '2030-01-01T00:00:00.000Z' currency: BRL customer: cus_1234567890abcdef effective_order_at: '2030-01-01T00:00:00.000Z' metadata: {} object: order order_number: 1001 payment_method: credit_card price: prc_1234567890abcdef product: pro_1234567890abcdef status: approved subscription_status: null type: one_time unit_amount: 4990 updated_at: '2030-01-01T00:00:00.000Z' '400': $ref: '#/components/responses/ApiFailure' '401': $ref: '#/components/responses/ApiFailure' '403': $ref: '#/components/responses/ApiFailure' '404': $ref: '#/components/responses/ApiFailure' '409': $ref: '#/components/responses/ApiFailure' '429': $ref: '#/components/responses/ApiFailure' '500': $ref: '#/components/responses/ApiFailure' '502': $ref: '#/components/responses/ApiFailure' '503': $ref: '#/components/responses/ApiFailure' security: - apiKeyAuth: [] components: schemas: Order: type: object additionalProperties: false required: - id - access_expires_at - created_at - currency - customer - effective_order_at - metadata - object - order_number - payment_method - price - product - status - subscription_status - type - unit_amount - updated_at properties: id: type: string pattern: ^ord_[a-z0-9]{16}$ description: >- Identificador público estável. Use o valor retornado pela API nas consultas e relacionamentos; não derive IDs de nomes. access_expires_at: type: - string - 'null' format: date-time description: >- Fim da validade de acesso, em ISO 8601 com fuso. Editável. Null representa ausência de prazo; assinaturas approved ou completed exigem uma data. created_at: type: string format: date-time description: >- Data e hora da criação, em ISO 8601 com fuso horário. Somente leitura. currency: type: string description: Moeda do pedido, BRL ou USD. Somente leitura. customer: type: - string - 'null' pattern: ^cus_[a-z0-9]{16}$ description: ID do cliente vinculado; pode ser null. Somente leitura. effective_order_at: type: - string - 'null' format: date-time description: >- Data efetiva da compra em ISO 8601 com fuso. Pode ser null. Somente leitura. metadata: type: object additionalProperties: true description: >- Objeto JSON livre para referências da integração, limitado a 16 KB. Ao enviar, substitui todo o metadata anterior; use {} para limpar. Não aceita null. object: const: order type: string description: Tipo do objeto retornado. O valor é fixo para este recurso. order_number: type: integer description: >- Número do pedido para exibição. Para chamadas da API, use id. Somente leitura. payment_method: type: - string - 'null' description: >- Método de pagamento registrado, como credit_card ou pix. Pode ser null. Somente leitura. price: type: - string - 'null' pattern: ^prc_[a-z0-9]{16}$ description: ID do preço vinculado; pode ser null. Somente leitura. product: type: - string - 'null' pattern: ^pro_[a-z0-9]{16}$ description: ID do produto vinculado; pode ser null. Somente leitura. status: type: string description: >- Estado registrado: pending, approved, completed, refunded, cancelled, chargeback ou disputed. Somente leitura. subscription_status: type: - string - 'null' description: >- Situação da assinatura vinculada: trialing, active, past_due, paused, cancelled ou expired. Pode ser null. Somente leitura. type: type: string description: >- Tipo do pedido: one_time (compra única) ou subscription (assinatura). Somente leitura. unit_amount: type: integer description: >- Valor do pedido em centavos da moeda indicada em currency. Somente leitura. updated_at: type: string format: date-time description: >- Data e hora da última alteração, em ISO 8601 com fuso horário. Somente leitura. example: id: ord_1234567890abcdef access_expires_at: null created_at: '2030-01-01T00:00:00.000Z' currency: BRL customer: cus_1234567890abcdef effective_order_at: '2030-01-01T00:00:00.000Z' metadata: {} object: order order_number: 1001 payment_method: credit_card price: prc_1234567890abcdef product: pro_1234567890abcdef status: approved subscription_status: null type: one_time unit_amount: 4990 updated_at: '2030-01-01T00:00:00.000Z' ApiError: type: object additionalProperties: false required: - error properties: error: type: object additionalProperties: false required: - code - doc_url - message - param - type properties: code: type: string doc_url: type: - string - 'null' message: type: string param: type: - string - 'null' type: type: string enum: - invalid_request_error - authentication_error - permission_error - rate_limit_error - api_error example: error: code: invalid_parameter doc_url: null message: The request contains invalid parameters param: null type: invalid_request_error responses: ApiFailure: description: A operação não foi concluída headers: X-Request-Id: description: Identifier of this HTTP request schema: type: string content: application/json: schema: $ref: '#/components/schemas/ApiError' example: error: code: invalid_parameter doc_url: null message: The request contains invalid parameters param: null type: invalid_request_error securitySchemes: apiKeyAuth: type: http scheme: bearer bearerFormat: API key ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.