Mark an Invoice Uncollectable

import DodoPayments from 'dodopayments';

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

const invoice = await client.invoices.markUncollectable('invoice_id', { 'If-Match': 'If-Match' });

console.log(invoice.amount_paid);

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
)
invoice = client.invoices.mark_uncollectable(
    invoice_id="invoice_id",
    if_match="If-Match",
)
print(invoice.amount_paid)

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"),
	)
	invoice, err := client.Invoices.MarkUncollectable(
		context.TODO(),
		"invoice_id",
		dodopayments.InvoiceMarkUncollectableParams{
			IfMatch: dodopayments.F("If-Match"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", invoice.AmountPaid)
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.invoices.Invoice;
import com.dodopayments.api.models.invoices.InvoiceMarkUncollectableParams;

public final class Main {
    private Main() {}

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

        InvoiceMarkUncollectableParams params = InvoiceMarkUncollectableParams.builder()
            .invoiceId("invoice_id")
            .ifMatch("If-Match")
            .build();
        Invoice invoice = client.invoices().markUncollectable(params);
    }
}

package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.invoices.Invoice
import com.dodopayments.api.models.invoices.InvoiceMarkUncollectableParams

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

    val params: InvoiceMarkUncollectableParams = InvoiceMarkUncollectableParams.builder()
        .invoiceId("invoice_id")
        .ifMatch("If-Match")
        .build()
    val invoice: Invoice = client.invoices().markUncollectable(params)
}

require "dodopayments"

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

invoice = dodo_payments.invoices.mark_uncollectable("invoice_id", if_match: "If-Match")

puts(invoice)

<?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 {
  $invoice = $client->invoices->markUncollectable(
    'invoice_id', ifMatch: 'If-Match'
  );

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

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

DodoPaymentsClient client = new();

InvoiceMarkUncollectableParams parameters = new()
{
    InvoiceID = "invoice_id",
    IfMatch = "If-Match",
};

var invoice = await client.Invoices.MarkUncollectable(parameters);

Console.WriteLine(invoice);

use dodopayments::Client;

#[tokio::main]
async fn main() -> dodopayments::Result<()> {
    let client = Client::from_env()?;
    let invoice_id = "invoice_id";
    let result = client
        .invoices()
        .mark_uncollectable()
        .invoice_id(invoice_id)
        .await?;
    println!("{result:?}");
    Ok(())
}

curl --request POST \
  --url https://test.dodopayments.com/billing/invoices/{invoice_id}/mark-uncollectable \
  --header 'Authorization: Bearer <token>' \
  --header 'If-Match: <if-match>'

{
  "allowed_actions": [
    "edit"
  ],
  "amount_due": 123,
  "amount_paid": 123,
  "amount_refunded": 123,
  "billing_mode": "normal",
  "business_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "credits": 123,
  "currency": "AED",
  "customer": {
    "billing_address": {
      "city": "<string>",
      "country": "AF",
      "state": "<string>",
      "street": "<string>",
      "zipcode": "<string>"
    },
    "cc_emails": [
      "<string>"
    ],
    "customer_id": "<string>",
    "email": "<string>",
    "tax_id": "<string>"
  },
  "discount_ids": [
    "<string>"
  ],
  "editable_fields": [
    "customer"
  ],
  "frequency": {
    "type": "one_time"
  },
  "invoice_id": "<string>",
  "metadata": {},
  "refund_ids": [
    "<string>"
  ],
  "retry_count": 123,
  "row_version": 123,
  "status": "open",
  "subscription_ids": [
    "<string>"
  ],
  "tags": [
    "refunded"
  ],
  "tax": 123,
  "total_amount": 123,
  "collection_method": "auto_charge",
  "due_at": "2023-11-07T05:31:56Z",
  "dunning_state": "not_started",
  "finalized_at": "2023-11-07T05:31:56Z",
  "hosted_url": "<string>",
  "lines": [
    {
      "amount": 123,
      "kind": "subscription",
      "quantity": 123,
      "tax": 123,
      "tax_inclusive": true,
      "unit_amount": 123,
      "addon_id": "<string>",
      "description": "<string>",
      "name": "<string>",
      "period_end": "2023-11-07T05:31:56Z",
      "period_start": "2023-11-07T05:31:56Z",
      "product_id": "<string>",
      "subscription_id": "<string>",
      "tax_rate": 123
    }
  ],
  "memo": "<string>",
  "next_reminder_at": "2023-11-07T05:31:56Z",
  "next_retry_at": "2023-11-07T05:31:56Z",
  "payment_terms_days": 123,
  "payments": [
    {
      "amount": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "payment_id": "<string>",
      "retry_attempt": 123,
      "status": "succeeded"
    }
  ],
  "pdf_url": "<string>",
  "reminder_settings": {
    "kind": "snapshot",
    "offsets_minutes": [
      123
    ],
    "paused": true,
    "reminders_enabled": true
  },
  "review_deadline": "2023-11-07T05:31:56Z",
  "sent_at": "2023-11-07T05:31:56Z"
}