> ## Documentation Index > Fetch the complete documentation index at: https://docs.nomos.energy/llms.txt > Use this file to discover all available pages before exploring further. # List subscriptions > Retrieve all subscriptions ## OpenAPI ````yaml /openapi/openapi.batman.json get /subscriptions openapi: 3.0.0 info: title: Nomos API version: 2025-12-16.batman servers: - url: http://localhost description: test security: [] tags: - name: Plans - name: Leads - name: Subscriptions - name: Customers - name: Usage - name: Prices - name: Invoices - name: Market Partners - name: Events - name: Authentication paths: /subscriptions: get: tags: - Subscriptions summary: List subscriptions description: Retrieve all subscriptions parameters: - schema: type: string nullable: true required: false name: cursor in: query - schema: type: number minimum: 1 maximum: 100 default: 10 required: false name: limit in: query - schema: nullable: true description: >- **Filterable fields:** - `status` (enum): pending, active, ended - `customer` (string) - `plan` (string) - `created_at` (date) - `updated_at` (date) See [Filtering Documentation](https://docs.nomos.energy/guides/filtering) for supported operators and syntax. example: value required: false description: >- **Filterable fields:** - `status` (enum): pending, active, ended - `customer` (string) - `plan` (string) - `created_at` (date) - `updated_at` (date) See [Filtering Documentation](https://docs.nomos.energy/guides/filtering) for supported operators and syntax. name: filter[field][operator] in: query responses: '200': description: Retrieve all subscriptions content: application/json: schema: type: object properties: object: type: string enum: - list items: type: array items: type: object properties: object: type: string enum: - subscription description: Type of the object, always 'subscription' id: type: string description: Unique identifier for the subscription example: sub_ plan: type: string description: ID of the plan example: pln_ customer: type: string description: ID of the customer example: cus_ address: type: string description: ID of the address example: adr_ meter: type: string description: ID of the meter example: mtr_ payment_method: type: string description: ID of the payment method example: pm_ supplier: type: string nullable: true description: ID of the previous supplier example: mp_ number: type: string nullable: true description: Human-readable identifier for the subscription example: 4X44EMKX status: type: string enum: - pending - active - ended description: Status of the subscription example: active direction: type: string enum: - consumption - feed_in description: >- Whether the subscription covers electricity consumption or feed-in. Feed-in subscriptions are only available from the 2026-05-27.curie API version onwards. example: consumption estimated_usage: type: number description: >- Estimated yearly usage in kWh, provided by the customer in the checkout. created_at: anyOf: - type: string - type: string format: date-time description: Timestamp when the subscription was created example: '2024-03-14T12:00:00Z' updated_at: anyOf: - type: string - type: string format: date-time description: Timestamp when the subscription was updated example: '2024-03-14T12:00:00Z' start_at: anyOf: - type: string - type: string format: date-time - nullable: true description: Timestamp when delivery was started / will start example: '2024-03-14T12:00:00Z' terminated_at: anyOf: - type: string - type: string format: date-time - nullable: true description: Timestamp when delivery was terminated example: '2024-03-14T12:00:00Z' end_at: anyOf: - type: string - type: string format: date-time - nullable: true description: Timestamp when the subscription was ended / will end example: '2024-03-14T12:00:00Z' metadata: type: object nullable: true additionalProperties: nullable: true description: >- Metadata of the subscription. Store any type of information, custom to your needs. E.g. the `user_id` of your in-house user. Restricted to 10KB. example: utm_source: google utm_campaign: campaign_name user_id: '1234567890' required: - object - id - plan - customer - address - meter - payment_method - status - direction - estimated_usage - created_at - updated_at next_page: type: string nullable: true has_more: type: boolean default: false required: - object - items '400': description: >- The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). content: application/json: schema: $ref: '#/components/schemas/ErrBadRequest' '401': description: The client must authenticate itself to get the requested response. content: application/json: schema: $ref: '#/components/schemas/ErrUnauthorized' '402': description: A higher pricing plan is required to access the resource. content: application/json: schema: $ref: '#/components/schemas/ErrPaymentRequired' '403': description: >- The client does not have the necessary permissions to access the resource. content: application/json: schema: $ref: '#/components/schemas/ErrForbidden' '404': description: The server can't find the requested resource. content: application/json: schema: $ref: '#/components/schemas/ErrNotFound' '405': description: The request method is not allowed. content: application/json: schema: $ref: '#/components/schemas/ErrMethodNotAllowed' '409': description: >- The request could not be completed due to a conflict mainly due to unique constraints. content: application/json: schema: $ref: '#/components/schemas/ErrConflict' '422': description: >- The request was well-formed but was unable to be followed due to semantic errors. content: application/json: schema: $ref: '#/components/schemas/ErrUnprocessableEntity' '429': description: The client has sent too many requests. content: application/json: schema: $ref: '#/components/schemas/ErrTooManyRequests' '500': description: >- The server has encountered a situation it doesn't know how to handle. content: application/json: schema: $ref: '#/components/schemas/ErrInternalServerError' security: - Bearer: [] components: schemas: ErrBadRequest: type: object properties: code: type: string enum: - BAD_REQUEST description: The error code related to the status code. example: BAD_REQUEST message: type: string description: A human readable message describing the issue. example: 'invalid_type in ''end'': Required' requestId: type: string description: The request id to be used for debugging and error reporting. example: 37a04f8f-e791-491c-81e1-86cd304649bb docs: type: string description: The docs related to the error code. example: https://docs.nomos.energy/api-references/errors/BAD_REQUEST required: - code - message - requestId - docs ErrUnauthorized: type: object properties: code: type: string enum: - UNAUTHORIZED description: The error code related to the status code. example: UNAUTHORIZED message: type: string description: A human readable message describing the issue. example: Invalid or malformed token requestId: type: string description: The request id to be used for debugging and error reporting. example: 37a04f8f-e791-491c-81e1-86cd304649bb docs: type: string description: The docs related to the error code. example: https://docs.nomos.energy/api-references/errors/UNAUTHORIZED required: - code - message - requestId - docs ErrPaymentRequired: type: object properties: code: type: string enum: - PAYMENT_REQUIRED description: The error code related to the status code. example: PAYMENT_REQUIRED message: type: string description: A human readable message describing the issue. example: Payment required requestId: type: string description: The request id to be used for debugging and error reporting. example: 37a04f8f-e791-491c-81e1-86cd304649bb docs: type: string description: The docs related to the error code. example: https://docs.nomos.energy/api-references/errors/PAYMENT_REQUIRED required: - code - message - requestId - docs ErrForbidden: type: object properties: code: type: string enum: - FORBIDDEN description: The error code related to the status code. example: FORBIDDEN message: type: string description: A human readable message describing the issue. example: You are not allowed to access this resource requestId: type: string description: The request id to be used for debugging and error reporting. example: 37a04f8f-e791-491c-81e1-86cd304649bb docs: type: string description: The docs related to the error code. example: https://docs.nomos.energy/api-references/errors/FORBIDDEN required: - code - message - requestId - docs ErrNotFound: type: object properties: code: type: string enum: - NOT_FOUND description: The error code related to the status code. example: NOT_FOUND message: type: string description: A human readable message describing the issue. example: Resource not found requestId: type: string description: The request id to be used for debugging and error reporting. example: 37a04f8f-e791-491c-81e1-86cd304649bb docs: type: string description: The docs related to the error code. example: https://docs.nomos.energy/api-references/errors/NOT_FOUND required: - code - message - requestId - docs ErrMethodNotAllowed: type: object properties: code: type: string enum: - METHOD_NOT_ALLOWED description: The error code related to the status code. example: METHOD_NOT_ALLOWED message: type: string description: A human readable message describing the issue. example: Method not allowed requestId: type: string description: The request id to be used for debugging and error reporting. example: 37a04f8f-e791-491c-81e1-86cd304649bb docs: type: string description: The docs related to the error code. example: https://docs.nomos.energy/api-references/errors/METHOD_NOT_ALLOWED required: - code - message - requestId - docs ErrConflict: type: object properties: code: type: string enum: - CONFLICT description: The error code related to the status code. example: CONFLICT message: type: string description: A human readable message describing the issue. example: Resource already exists requestId: type: string description: The request id to be used for debugging and error reporting. example: 37a04f8f-e791-491c-81e1-86cd304649bb docs: type: string description: The docs related to the error code. example: https://docs.nomos.energy/api-references/errors/CONFLICT required: - code - message - requestId - docs ErrUnprocessableEntity: type: object properties: code: type: string enum: - UNPROCESSABLE_ENTITY description: The error code related to the status code. example: UNPROCESSABLE_ENTITY message: type: string description: A human readable message describing the issue. example: >- invalid_enum_value in 'status': Invalid enum value. Expected 'pending' | 'active' | 'ended' requestId: type: string description: The request id to be used for debugging and error reporting. example: 37a04f8f-e791-491c-81e1-86cd304649bb docs: type: string description: The docs related to the error code. example: https://docs.nomos.energy/api-references/errors/UNPROCESSABLE_ENTITY required: - code - message - requestId - docs ErrTooManyRequests: type: object properties: code: type: string enum: - TOO_MANY_REQUESTS description: The error code related to the status code. example: TOO_MANY_REQUESTS message: type: string description: A human readable message describing the issue. example: Wait 30 seconds before retrying. requestId: type: string description: The request id to be used for debugging and error reporting. example: 37a04f8f-e791-491c-81e1-86cd304649bb docs: type: string description: The docs related to the error code. example: https://docs.nomos.energy/api-references/errors/TOO_MANY_REQUESTS required: - code - message - requestId - docs ErrInternalServerError: type: object properties: code: type: string enum: - INTERNAL_SERVER_ERROR description: The error code related to the status code. example: INTERNAL_SERVER_ERROR message: type: string description: A human readable message describing the issue. example: Internal Server Error requestId: type: string description: The request id to be used for debugging and error reporting. example: 37a04f8f-e791-491c-81e1-86cd304649bb docs: type: string description: The docs related to the error code. example: >- https://docs.nomos.energy/api-references/errors/INTERNAL_SERVER_ERROR required: - code - message - requestId - docs securitySchemes: Bearer: type: http scheme: bearer bearerFormat: JWT ````