Preview an Invoice Request

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.preview({
  collection_method: 'auto_charge',
  currency: 'AED',
  customer_id: 'customer_id',
  items: [
    {
      description: 'description',
      kind: 'custom',
      tax_category: 'digital_products',
      unit_amount: 0,
    },
  ],
});

console.log(response);

const content = await response.blob();
console.log(content);

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(
    collection_method="auto_charge",
    currency="AED",
    customer_id="customer_id",
    items=[{
        "description": "description",
        "kind": "custom",
        "tax_category": "digital_products",
        "unit_amount": 0,
    }],
)
print(response)
content = response.read()
print(content)

package main

import (
	"context"
	"fmt"

	"github.com/dodopayments/dodopayments-go"
	"github.com/dodopayments/dodopayments-go/option"
)

func main() {
	client := dodopayments.NewClient(
		option.WithBearerToken("My Bearer Token"),
	)
	response, err := client.Invoices.Preview(context.TODO(), dodopayments.InvoicePreviewParams{
		CollectionMethod: dodopayments.F(dodopayments.CollectionMethodAutoCharge),
		Currency:         dodopayments.F(dodopayments.CurrencyAed),
		CustomerID:       dodopayments.F("customer_id"),
		Items: dodopayments.F([]dodopayments.InvoicePreviewParamsItemUnion{dodopayments.InvoicePreviewParamsItemsCustomItem{
			Description: dodopayments.F("description"),
			Kind:        dodopayments.F(dodopayments.InvoicePreviewParamsItemsCustomItemKindCustom),
			TaxCategory: dodopayments.F(dodopayments.TaxCategoryDigitalProducts),
			UnitAmount:  dodopayments.F(int64(0)),
		}}),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response)
}

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.CollectionMethod;
import com.dodopayments.api.models.invoices.InvoicePreviewParams;
import com.dodopayments.api.models.misc.Currency;
import com.dodopayments.api.models.misc.TaxCategory;

public final class Main {
    private Main() {}

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

        InvoicePreviewParams params = InvoicePreviewParams.builder()
            .collectionMethod(CollectionMethod.AUTO_CHARGE)
            .currency(Currency.AED)
            .customerId("customer_id")
            .addItem(InvoicePreviewParams.Item.CustomItem.builder()
                .description("description")
                .taxCategory(TaxCategory.DIGITAL_PRODUCTS)
                .unitAmount(0)
                .build())
            .build();
        HttpResponse response = client.invoices().preview(params);
    }
}

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.CollectionMethod
import com.dodopayments.api.models.invoices.InvoicePreviewParams
import com.dodopayments.api.models.misc.Currency
import com.dodopayments.api.models.misc.TaxCategory

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

    val params: InvoicePreviewParams = InvoicePreviewParams.builder()
        .collectionMethod(CollectionMethod.AUTO_CHARGE)
        .currency(Currency.AED)
        .customerId("customer_id")
        .addItem(InvoicePreviewParams.Item.CustomItem.builder()
            .description("description")
            .taxCategory(TaxCategory.DIGITAL_PRODUCTS)
            .unitAmount(0)
            .build())
        .build()
    val response: HttpResponse = client.invoices().preview(params)
}

require "dodopayments"

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

response = dodo_payments.invoices.preview(
  collection_method: :auto_charge,
  currency: :AED,
  customer_id: "customer_id",
  items: [{description: "description", kind: :custom, tax_category: :digital_products, unit_amount: 0}]
)

puts(response)

<?php

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

use Dodopayments\Client;
use Dodopayments\Core\Exceptions\APIException;
use Dodopayments\Invoices\CollectionMethod;
use Dodopayments\Misc\Currency;
use Dodopayments\Misc\TaxCategory;
use Dodopayments\Misc\CountryCode;

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

try {
  $response = $client->invoices->preview(
    collectionMethod: CollectionMethod::AUTO_CHARGE,
    currency: Currency::AED,
    customerID: 'customer_id',
    items: [
      [
        'description' => 'description',
        'kind' => 'custom',
        'taxCategory' => TaxCategory::DIGITAL_PRODUCTS,
        'unitAmount' => 0,
        'quantity' => 0,
      ],
    ],
    format: 'json',
    billingAddress: [
      'country' => CountryCode::AF,
      'city' => 'city',
      'state' => 'state',
      'street' => 'street',
      'zipcode' => 'zipcode',
    ],
    ccEmails: ['string'],
    customerEmail: 'customer_email',
    discountIDs: ['string'],
    dueAt: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
    dunning: ['remindersEnabled' => true, 'offsetsDays' => [0]],
    memo: 'memo',
    metadata: ['foo' => 'string'],
    paymentTerms: ['type' => 'due_on_receipt'],
    reviewRequired: true,
    taxID: 'tax_id',
  );

  var_dump($response);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.Invoices;
using DodoPayments.Client.Models.Misc;

DodoPaymentsClient client = new();

InvoicePreviewParams parameters = new()
{
    CollectionMethod = InvoiceCollectionMethod.AutoCharge,
    Currency = Currency.Aed,
    CustomerID = "customer_id",
    Items =
    [
        new InvoicePreviewParamsItemCustomItem()
        {
            Description = "description",
            TaxCategory = TaxCategory.DigitalProducts,
            UnitAmount = 0,
            Quantity = 0,
        },
    ],
};

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

Console.WriteLine(response);

use dodopayments::Client;

#[tokio::main]
async fn main() -> dodopayments::Result<()> {
    let client = Client::from_env()?;
    let result = client
        .invoices()
        .preview()
        .body(dodopayments::models::InvoicesPreviewParams {
                collection_method: Some(Box::new(dodopayments::models::CollectionMethod::AutoCharge)),
                currency: Some(Box::new(dodopayments::models::Currency::Aed)),
                customer_id: Some("customer_id".to_string()),
                items: Some(vec![serde_json::json!({"description":"description","kind":"custom","tax_category":"digital_products","unit_amount":0})]),
                ..Default::default()
            })
        .query(serde_json::json!({}))
        .await?;
    println!("{result:?}");
    Ok(())
}

curl --request POST \
  --url https://test.dodopayments.com/billing/invoices/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "<string>",
  "items": [
    {
      "description": "<string>",
      "kind": "custom",
      "unit_amount": 123,
      "quantity": 1
    }
  ],
  "billing_address": {
    "city": "<string>",
    "state": "<string>",
    "street": "<string>",
    "zipcode": "<string>"
  },
  "cc_emails": [
    "<string>"
  ],
  "customer_email": "<string>",
  "discount_ids": [
    "<string>"
  ],
  "due_at": "2023-11-07T05:31:56Z",
  "dunning": {
    "reminders_enabled": true,
    "offsets_days": [
      123
    ]
  },
  "memo": "<string>",
  "metadata": {},
  "payment_terms": {
    "type": "due_on_receipt"
  },
  "review_required": true,
  "tax_id": "<string>"
}
'

"<string>"