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

# Preview a Draft Invoice

> Preview a draft invoice as JSON, a PDF with a draft mark, or the invoice email.



## OpenAPI

````yaml get /billing/invoices/{invoice_id}/preview
openapi: 3.1.0
info:
  title: public
  description: ''
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: 1.122.7
servers:
  - url: https://test.dodopayments.com/
    description: Test Mode Server Host
  - url: https://live.dodopayments.com/
    description: Live Mode Server Host
security: []
tags:
  - name: Products
  - name: Payments
  - name: Subscriptions
  - name: Addons
  - name: Customers
  - name: Refunds
  - name: Disputes
  - name: Events
  - name: License Keys
  - name: Entitlements
  - name: Licenses
  - name: Discounts
  - name: Meters
  - name: Credit Entitlements
  - name: Credit Entitlement Balances
  - name: Outgoing Webhooks
  - name: Checkout
  - name: Webhook Events
  - name: Payment Connector Webhooks
  - name: Moderation
  - name: Invoices
  - name: Workload Identity
paths:
  /billing/invoices/{invoice_id}/preview:
    get:
      tags:
        - Invoices
      summary: Preview a draft invoice
      operationId: preview_invoice
      parameters:
        - name: invoice_id
          in: path
          description: Invoice ID
          required: true
          schema:
            type: string
        - name: format
          in: query
          required: false
          schema:
            type: string
            description: >-
              The preview body. `json` returns the invoice JSON. `pdf` returns
              the PDF with a draft mark.

              `email` returns the HTML of the invoice email. A preview saves no
              row.
            enum:
              - json
              - pdf
              - email
          style: form
      responses:
        '200':
          description: >-
            The preview in the format asked for: the PDF with a draft mark for
            `pdf`, the invoice JSON (an `InvoiceResponse`) for `json`, or the
            HTML of the invoice email for `email`. The SDKs return the raw
            response, so read it as bytes, JSON or text to match `format`.
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '400':
          description: The format parameter is not valid (InvalidQueryParams).
        '404':
          description: The invoice does not exist (NotFound).
        '422':
          description: The invoice is not a draft (InvoiceTransitionNotAllowed).
        '500':
          description: Something went wrong :(
      security:
        - API_KEY: []
      x-codeSamples:
        - lang: JavaScript
          source: >-
            import DodoPayments from 'dodopayments';


            const client = new DodoPayments({
              bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
            });


            const response = await
            client.invoices.previewExisting('invoice_id');


            console.log(response);


            const content = await response.blob();

            console.log(content);
        - lang: Python
          source: |-
            import os
            from dodopayments import DodoPayments

            client = DodoPayments(
                bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),  # This is the default and can be omitted
            )
            response = client.invoices.preview_existing(
                invoice_id="invoice_id",
            )
            print(response)
            content = response.read()
            print(content)
        - lang: Go
          source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/dodopayments/dodopayments-go\"\n\t\"github.com/dodopayments/dodopayments-go/option\"\n)\n\nfunc main() {\n\tclient := dodopayments.NewClient(\n\t\toption.WithBearerToken(\"My Bearer Token\"),\n\t)\n\tresponse, err := client.Invoices.PreviewExisting(\n\t\tcontext.TODO(),\n\t\t\"invoice_id\",\n\t\tdodopayments.InvoicePreviewExistingParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response)\n}\n"
        - lang: Java
          source: >-
            package com.dodopayments.api.example;


            import com.dodopayments.api.client.DodoPaymentsClient;

            import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;

            import com.dodopayments.api.core.http.HttpResponse;

            import
            com.dodopayments.api.models.invoices.InvoicePreviewExistingParams;


            public final class Main {
                private Main() {}

                public static void main(String[] args) {
                    DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

                    HttpResponse response = client.invoices().previewExisting("invoice_id");
                }
            }
        - lang: Kotlin
          source: >-
            package com.dodopayments.api.example


            import com.dodopayments.api.client.DodoPaymentsClient

            import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient

            import com.dodopayments.api.core.http.HttpResponse

            import
            com.dodopayments.api.models.invoices.InvoicePreviewExistingParams


            fun main() {
                val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()

                val response: HttpResponse = client.invoices().previewExisting("invoice_id")
            }
        - lang: Ruby
          source: |-
            require "dodopayments"

            dodo_payments = Dodopayments::Client.new(
              bearer_token: "My Bearer Token",
              environment: "test_mode" # defaults to "live_mode"
            )

            response = dodo_payments.invoices.preview_existing("invoice_id")

            puts(response)
        - lang: PHP
          source: |-
            <?php

            require_once dirname(__DIR__) . '/vendor/autoload.php';

            use Dodopayments\Client;
            use Dodopayments\Core\Exceptions\APIException;

            $client = new Client(
              bearerToken: getenv('DODO_PAYMENTS_API_KEY') ?: 'My Bearer Token',
              environment: 'test_mode',
            );

            try {
              $response = $client->invoices->previewExisting('invoice_id', format: 'json');

              var_dump($response);
            } catch (APIException $e) {
              echo $e->getMessage();
            }
        - lang: C#
          source: >-
            using System;

            using DodoPayments.Client;

            using DodoPayments.Client.Models.Invoices;


            DodoPaymentsClient client = new();


            InvoicePreviewExistingParams parameters = new() { InvoiceID =
            "invoice_id" };


            var response = await client.Invoices.PreviewExisting(parameters);


            Console.WriteLine(response);
        - lang: Rust
          source: |-
            use dodopayments::Client;

            #[tokio::main]
            async fn main() -> dodopayments::Result<()> {
                let client = Client::from_env()?;
                let invoice_id = "invoice_id";
                let result = client
                    .invoices()
                    .preview_existing()
                    .invoice_id(invoice_id)
                    .query(serde_json::json!({}))
                    .await?;
                println!("{result:?}");
                Ok(())
            }
components:
  securitySchemes:
    API_KEY:
      type: http
      scheme: bearer
      description: >-
        Send your API key as a bearer token: `Authorization: Bearer <api_key>`.
        A test mode key starts with `dodo_test_`, for example
        `dodo_test_AbCd1234EfGh5678.<secret>`. A live mode key starts with
        `dodo_live_`. Use a test mode key on `test.dodopayments.com` and a live
        mode key on `live.dodopayments.com`. Keys from before these tags have no
        tag and operate as before.

````

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