> ## Documentation Index
> Fetch the complete documentation index at: https://docs.proxylane.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Order ISP IPs

> Charges the USD balance at the catalog price with volume and term discounts. The order starts as `preparing`. Poll `GET /isp/orders/{id}` until it is `active` and `connections` are filled, usually within minutes. Promo codes are not accepted.



## OpenAPI

````yaml /resellers/openapi.json post /isp/orders
openapi: 3.1.0
info:
  title: ProxyLane Reseller API
  version: 1.0.0
  description: Residential traffic, sub-accounts, proxy generation and static ISP IPs.
servers:
  - url: https://proxylane.dev/api/v1
security:
  - bearer: []
paths:
  /isp/orders:
    post:
      summary: Order ISP IPs
      description: >-
        Charges the USD balance at the catalog price with volume and term
        discounts. The order starts as `preparing`. Poll `GET /isp/orders/{id}`
        until it is `active` and `connections` are filled, usually within
        minutes. Promo codes are not accepted.
      operationId: createIspOrder
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - product
                - quantity
                - days
                - use_case
              properties:
                product:
                  type: string
                  maxLength: 100
                  description: '`id` from `GET /isp/products`'
                quantity:
                  type: integer
                  minimum: 1
                  maximum: 256
                  description: >-
                    Within the product's `min_quantity` and `max_quantity`. 256
                    for a subnet
                days:
                  type: integer
                  enum:
                    - 30
                    - 60
                    - 90
                    - 360
                  description: One of the product's `terms_days`
                use_case:
                  type: string
                  enum:
                    - Account management
                    - E-commerce and marketplaces
                    - Ads and marketing
                    - Web data and monitoring
                    - Other
                use_case_note:
                  type: string
                  maxLength: 500
                  description: Required when `use_case` is `Other`
            example:
              product: isp_us_retail
              quantity: 2
              days: 30
              use_case: Account management
      responses:
        '201':
          description: Ordered
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      order:
                        $ref: '#/components/schemas/IspOrder'
                      charged_cents:
                        type: integer
                        description: Charged from the USD balance
                      balance_cents:
                        type: integer
                        description: Available USD balance after the charge
              example:
                data:
                  order:
                    id: 9b2f6c1e-4a0e-4b36-8a8e-5d2f6c1e7b90
                    product: isp_us_retail
                    name: AI accounts, United States
                    country_code: US
                    status: preparing
                    quantity: 2
                    issued_quantity: 0
                    price_cents: 780
                    ends_at: null
                    days_left: null
                    renewable: false
                    auto_renew: false
                    connections: []
                  charged_cents: 780
                  balance_cents: 4220
        '400':
          $ref: '#/components/responses/Error'
        '402':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '409':
          $ref: '#/components/responses/Error'
        '422':
          $ref: '#/components/responses/Error'
        '503':
          $ref: '#/components/responses/Error'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: true
      schema:
        type: string
        minLength: 8
        maxLength: 100
      description: >-
        A new random value per action. A retry with the same key returns the
        first result
  schemas:
    IspOrder:
      type: object
      properties:
        id:
          type: string
          format: uuid
        product:
          type:
            - string
            - 'null'
          description: Product ID
        name:
          type: string
          example: AI accounts, United States
        country_code:
          type:
            - string
            - 'null'
        status:
          type: string
          enum:
            - preparing
            - active
            - soon
            - expired
          description: >-
            `preparing` while IPs are issued or renewed, `soon` ends within 3
            days
        quantity:
          type: integer
          description: IPs ordered
        issued_quantity:
          type: integer
          description: IPs already issued
        price_cents:
          type: integer
          description: What the first purchase cost
        ends_at:
          type:
            - string
            - 'null'
          format: date-time
          description: '`null` until IPs are issued'
        days_left:
          type:
            - integer
            - 'null'
        renewable:
          type: boolean
          description: '`true` when `POST /isp/orders/{id}/renew` is possible now'
        auto_renew:
          type: boolean
        connections:
          type: array
          items:
            $ref: '#/components/schemas/IspConnection'
          description: Empty while the order is preparing
    IspConnection:
      type: object
      properties:
        ip:
          type: string
          example: 203.0.113.1
        protocol:
          type: string
          enum:
            - http
            - socks5
        host:
          type: string
        port:
          type: integer
        username:
          type: string
        password:
          type: string
        url:
          type: string
          description: Ready connection string
          example: http://user:pass@203.0.113.1:61234
    Error:
      type: object
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              example: insufficient_pool_traffic
            message:
              type: string
            available_bytes:
              type: integer
            required_cents:
              type: integer
            fields:
              type: object
            balance_cents:
              type: integer
              description: Available USD balance in cents, on ISP `insufficient_balance`
  responses:
    Error:
      description: Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: A reseller key from the panel, starting with plr_

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.