Mark Invoice Uncollectible

curl --request POST \
  --url https://api.whop.com/api/v1/invoices/{id}/mark_uncollectible \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.whop.com/api/v1/invoices/{id}/mark_uncollectible"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.whop.com/api/v1/invoices/{id}/mark_uncollectible', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/invoices/{id}/mark_uncollectible",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/invoices/{id}/mark_uncollectible"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/invoices/{id}/mark_uncollectible")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "amount_due": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "billing_address": {
    "city": "Austin",
    "country": "US",
    "line1": "1114 Bouldin Ave",
    "line2": "Unit B",
    "name": "Dana Whitfield",
    "postal_code": "78704",
    "state": "TX"
  },
  "buyer_fee_amount": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "buyer_fee_percentage": 0,
  "checkout_link": "pay_xxxxxxxxxxxxxx.eyJfcmFpbHMiOnsiZGF0YSI6WzEsZmFsc2VdLCJwdXIiOiJSZWNlaXB0XG5jaGVja291dF9tb3VudFxuIn19--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "created_at": "2026-01-01T12:00:00.000Z",
  "customer_name": "Dana",
  "due_at": null,
  "email_address": "marcus@shinetime.example",
  "id": "pay_xxxxxxxxxxxxxx",
  "invoice_prefix": null,
  "line_items": [
    {
      "description": null,
      "discount_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "id": "li_xxxxxxxxxxxxxx",
      "label": "Ceramic Coating Package",
      "product_id": "prod_xxxxxxxxxxxxxx",
      "quantity": 1,
      "subtotal": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "tax_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "unit_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "variant_id": "plan_xxxxxxxxxxxxxx"
    }
  ],
  "mailing_address_id": null,
  "member_id": "mber_xxxxxxxxxxxxxx",
  "membership_id": "mem_xxxxxxxxxxxxxx",
  "memo": null,
  "metadata": {},
  "number": "#xxxxxxxx",
  "object": "invoice",
  "overdue": false,
  "paid_at": null,
  "payment_method_id": "payt_xxxxxxxxxxxxxx",
  "recipient_emails": [
    "marcus@shinetime.example"
  ],
  "scheduled_charge_at": null,
  "scheduled_collection_method": "charge_automatically",
  "scheduled_send_at": null,
  "status": "open",
  "subtotal": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "tax_amount": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "total": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "totals_status": "final",
  "updated_at": "2026-01-01T12:00:00.000Z"
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

POST

invoices

{id}

mark_uncollectible

Mark Invoice Uncollectible

curl --request POST \
  --url https://api.whop.com/api/v1/invoices/{id}/mark_uncollectible \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.whop.com/api/v1/invoices/{id}/mark_uncollectible"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.whop.com/api/v1/invoices/{id}/mark_uncollectible', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/invoices/{id}/mark_uncollectible",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/invoices/{id}/mark_uncollectible"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/invoices/{id}/mark_uncollectible")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "amount_due": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "billing_address": {
    "city": "Austin",
    "country": "US",
    "line1": "1114 Bouldin Ave",
    "line2": "Unit B",
    "name": "Dana Whitfield",
    "postal_code": "78704",
    "state": "TX"
  },
  "buyer_fee_amount": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "buyer_fee_percentage": 0,
  "checkout_link": "pay_xxxxxxxxxxxxxx.eyJfcmFpbHMiOnsiZGF0YSI6WzEsZmFsc2VdLCJwdXIiOiJSZWNlaXB0XG5jaGVja291dF9tb3VudFxuIn19--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "created_at": "2026-01-01T12:00:00.000Z",
  "customer_name": "Dana",
  "due_at": null,
  "email_address": "marcus@shinetime.example",
  "id": "pay_xxxxxxxxxxxxxx",
  "invoice_prefix": null,
  "line_items": [
    {
      "description": null,
      "discount_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "id": "li_xxxxxxxxxxxxxx",
      "label": "Ceramic Coating Package",
      "product_id": "prod_xxxxxxxxxxxxxx",
      "quantity": 1,
      "subtotal": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "tax_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "unit_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "variant_id": "plan_xxxxxxxxxxxxxx"
    }
  ],
  "mailing_address_id": null,
  "member_id": "mber_xxxxxxxxxxxxxx",
  "membership_id": "mem_xxxxxxxxxxxxxx",
  "memo": null,
  "metadata": {},
  "number": "#xxxxxxxx",
  "object": "invoice",
  "overdue": false,
  "paid_at": null,
  "payment_method_id": "payt_xxxxxxxxxxxxxx",
  "recipient_emails": [
    "marcus@shinetime.example"
  ],
  "scheduled_charge_at": null,
  "scheduled_collection_method": "charge_automatically",
  "scheduled_send_at": null,
  "status": "open",
  "subtotal": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "tax_amount": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "total": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "totals_status": "final",
  "updated_at": "2026-01-01T12:00:00.000Z"
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

Authorizations

Authorization

string

header

required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Idempotency-Key

string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255

Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date

string

Pins the request to a dated API version.

Example:

"2026-11-04-1"

Path Parameters

string

required

The invoice's pay_ ID.

Response

invoice updated

account_id

string

required

Example:

"biz_xxxxxxxxxxxxxx"

amount_due

object

required

Show child attributes

billing_address

object | null

required

Show child attributes

buyer_fee_amount

object

required

Show child attributes

buyer_fee_percentage

number

required

Example:

0

checkout_link

string | null

required

A signed link that opens this invoice in a checkout session so the buyer can pay it: pass it as link to POST /checkout_sessions. Present while the invoice is open; null in any other status, for an invoice billed to a business buyer or whose membership was canceled, and unless you have payment:charge, or invoice:create or invoice:update on an invoice with no payment_method_id.

Example:

"pay_xxxxxxxxxxxxxx.eyJfcmFpbHMiOnsiZGF0YSI6WzEsZmFsc2VdLCJwdXIiOiJSZWNlaXB0XG5jaGVja291dF9tb3VudFxuIn19--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

created_at

string

required

Example:

"2026-01-01T12:00:00.000Z"

customer_name

string | null

required

Example:

"Dana"

due_at

string | null

required

Example:

null

email_address

string | null

required

Example:

"marcus@shinetime.example"

string

required

Example:

"pay_xxxxxxxxxxxxxx"

invoice_prefix

string | null

required

Example:

null

line_items

object[]

required

Show child attributes

mailing_address_id

string | null

required

Example:

null

member_id

string | null

required

Example:

"mber_xxxxxxxxxxxxxx"

membership_id

string | null

required

The membership this invoice bills, prefixed mem_: the subscription a renewal invoice renews, or the one created when an invoice with a recurring item is issued. Null for one-off invoices, for a draft not yet issued, and without the member:basic:read permission.

Example:

"mem_xxxxxxxxxxxxxx"

memo

string | null

required

A note to the customer, shown on the invoice email, PDF, and checkout page with its line breaks kept. null when none is set.

Example:

null

metadata

object

required

Show child attributes

Example:

{}

number

string

required

Example:

"#xxxxxxxx"

object

enum<string>

required

Available options:

invoice

Example:

"invoice"

overdue

boolean

required

Example:

false

paid_at

string | null

required

Example:

null

payment_method_id

string | null

required

Example:

"payt_xxxxxxxxxxxxxx"

recipient_emails

string[]

required

Invoice email recipients, independent of the billed customer.

scheduled_charge_at

string | null

required

When the invoice's saved payment method will be charged, as an ISO 8601 timestamp: the charge_at it was sent or issued with, or due_at when an invoice with a payment_method_id is sent or issued before it is due without one. On a draft, the charge_at of its scheduled send. null otherwise, once the charge starts, and once the invoice is paid, void, or uncollectible.

Example:

null

scheduled_collection_method

enum<string> | null

required

The collection_method a draft's scheduled send applies when it fires. null when the draft has no scheduled send or it was scheduled without one, and once the invoice is issued.

Available options:

charge_automatically,

send_invoice,

null

Example:

"charge_automatically"

scheduled_send_at

string | null

required

Example:

null

status

enum<string>

required

Available options:

draft,

open,

authorized,

paid,

pending,

uncollectible,

unresolved,

void

Example:

"open"

subtotal

object

required

Show child attributes

tax_amount

object | null

required

Show child attributes

total

object

required

Show child attributes

totals_status

enum<string>

required

Available options:

estimated,

final

Example:

"final"

updated_at

string

required

Example:

"2026-01-01T12:00:00.000Z"

Introduction

Reference

Core Resources

Payments

Money

Commerce

Websites

Ads

Analytics

Communication

Partners

Workforce

Media

Developer

Mark Invoice Uncollectible

Authorizations

Headers

Path Parameters

Response