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

# List Document Mailing Services

> The carrier services available for a document **you supply**: we print the PDF, attach a label and hand it to USPS or FedEx. No wallet is debited — only the mailing fee is billed, on your monthly invoice.

Rating needs the destination, so `zip` is required. `fee` is what you will be billed; `carrier_cost` and `markup_fee` are what it is made of. Send the document as `document` when you create it.



## OpenAPI

````yaml GET /v1/platform/payments/document-mailing/methods
openapi: 3.1.0
info:
  title: Finogate Platform API v1
  version: 0.1.0
servers:
  - url: https://api-sandbox.finogates.com
    description: Sandbox
  - url: https://api.finogates.com
    description: Production
security: []
tags:
  - name: auth
  - name: users
  - name: payees
  - name: verification
  - name: bank accounts
  - name: card processing
  - name: digital-assets
  - name: international
  - name: fees
  - name: onboarding
  - name: pending-applications
  - name: wallets
  - name: payments
  - name: document mailing
  - name: merchant onboarding
  - name: catalog
  - name: webhooks
  - name: screening
  - name: Platform - File Scanning
  - name: phone-numbers
  - name: sms
  - name: calls
  - name: listings
  - name: Card Transfers
  - name: embed-tokens
paths:
  /v1/platform/payments/document-mailing/methods:
    get:
      tags:
        - document mailing
      summary: List Document Mailing Services
      description: >-
        The carrier services available for a document **you supply**: we print
        the PDF, attach a label and hand it to USPS or FedEx. No wallet is
        debited — only the mailing fee is billed, on your monthly invoice.


        Rating needs the destination, so `zip` is required. `fee` is what you
        will be billed; `carrier_cost` and `markup_fee` are what it is made of.
        Send the document as `document` when you create it.
      operationId: >-
        list_document_shipping_methods_v1_platform_payments_document_mailing_methods_get
      parameters:
        - name: zip
          in: query
          required: true
          schema:
            type: string
            maxLength: 20
            description: Recipient ZIP code — services are rated against it.
            title: Zip
          description: Recipient ZIP code — services are rated against it.
        - name: country
          in: query
          required: false
          schema:
            type: string
            maxLength: 2
            description: Recipient country.
            default: US
            title: Country
          description: Recipient country.
        - name: pages
          in: query
          required: false
          schema:
            type: integer
            maximum: 50
            minimum: 0
            description: >-
              Total attachment pages you plan to send. Rates the heavier
              envelope so the quote matches what you will be billed. An estimate
              — the rate at create time is authoritative. Capped at the same
              50-page limit create enforces.
            default: 0
            title: Pages
          description: >-
            Total attachment pages you plan to send. Rates the heavier envelope
            so the quote matches what you will be billed. An estimate — the rate
            at create time is authoritative. Capped at the same 50-page limit
            create enforces.
        - name: document_pages
          in: query
          required: false
          schema:
            type: integer
            maximum: 50
            minimum: 1
            description: >-
              Pages in the document itself. Every shipment has one, so this
              defaults to 1. Billed per page just like attachments — an estimate
              for the quote, not a create-time limit.
            default: 1
            title: Document Pages
          description: >-
            Pages in the document itself. Every shipment has one, so this
            defaults to 1. Billed per page just like attachments — an estimate
            for the quote, not a create-time limit.
      responses:
        '200':
          description: The mailing services offered to you, priced for this destination.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/CommonResponse_list_DocumentShippingMethodQuote__
              example:
                status_code: 200
                data:
                  - key: usps_ground_advantage
                    label: USPS Ground Advantage
                    fee: 6.95
                    fee_percentage: 0
                    carrier_cost: 5.2
                    markup_fee: 1.75
                    estimated_days: 2-5
                    requires_document: true
                    attachment_fee_per_page: 0.25
                    attachment_fee: 0.75
                  - key: usps_priority
                    label: USPS Priority Mail
                    fee: 11.4
                    fee_percentage: 0
                    carrier_cost: 9.15
                    markup_fee: 2.25
                    estimated_days: 1-3
                    requires_document: true
                    attachment_fee_per_page: 0.25
                    attachment_fee: 0.75
                query_generated_time: 1712847600000
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - _AuthenticatedBearer: []
components:
  schemas:
    CommonResponse_list_DocumentShippingMethodQuote__:
      properties:
        status_code:
          type: integer
          title: Status Code
          description: HTTP status code for the response.
        data:
          items:
            $ref: '#/components/schemas/DocumentShippingMethodQuote'
          type: array
          title: Data
          description: Payload or error details.
        query_generated_time:
          type: integer
          title: Query Generated Time
          description: >-
            UTC timestamp (milliseconds since epoch) when response was
            generated.
      type: object
      required:
        - status_code
        - data
        - query_generated_time
      title: CommonResponse[list[DocumentShippingMethodQuote]]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DocumentShippingMethodQuote:
      properties:
        key:
          type: string
          title: Key
          description: Carrier service key — send this as `mail_type` on create.
          examples:
            - usps_ground_advantage
        label:
          type: string
          title: Label
          description: Display name for this service.
          examples:
            - USPS Ground Advantage
        fee:
          type: number
          title: Fee
          description: What you will be billed for this document, in major currency units.
          examples:
            - 8.45
        fee_percentage:
          type: number
          title: Fee Percentage
          description: Percentage-based surcharge applied on top of `fee`, if any.
          default: 0
          examples:
            - 0
        carrier_cost:
          type: number
          title: Carrier Cost
          description: The carrier's own rate, before markup.
          examples:
            - 6.2
        markup_fee:
          type: number
          title: Markup Fee
          description: Finogate's markup on top of `carrier_cost`.
          examples:
            - 2.25
        estimated_days:
          anyOf:
            - type: string
            - type: 'null'
          title: Estimated Days
          description: Carrier's estimated transit time in days, as a range (e.g. `1-3`).
          examples:
            - 1-3
        requires_document:
          type: boolean
          title: Requires Document
          description: Whether this service requires the document PDF at create time.
          default: true
        attachment_fee_per_page:
          type: number
          title: Attachment Fee Per Page
          description: >-
            Per-page rate for extra attachments. Do not multiply by page count
            to get a total — see `attachment_fee`.
          examples:
            - 0.25
        attachment_fee:
          type: number
          title: Attachment Fee
          description: The real total attachment fee for the page count you requested.
          examples:
            - 0.75
      type: object
      required:
        - key
        - label
        - fee
        - carrier_cost
        - markup_fee
        - attachment_fee_per_page
        - attachment_fee
      title: DocumentShippingMethodQuote
      description: |-
        One in-house mailing service, priced against a specific destination.

        What ``GET /document-mailing/methods`` returns per item — distinct from
        :class:`DocumentShippingMethodItem`, which is the admin enable/disable
        config shape and carries no pricing.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    _AuthenticatedBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /v1/platform/auth/token

````