Update Invoice

curl --request PATCH \
  --url https://api.whop.com/api/v1/invoices/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billing_address": {
    "city": "New York",
    "country": "US",
    "line1": "123 Main St",
    "postal_code": "10001",
    "line2": "<string>",
    "name": "<string>",
    "phone": "<string>",
    "state": "NY"
  },
  "buyer_fee_percentage": 2.5,
  "due_at": "2023-11-07T05:31:56Z",
  "items": [
    {
      "plan_id": "plan_xxxxxxxxxxxxxx"
    }
  ],
  "mailing_address_id": "<string>",
  "member_id": "mber_xxxxxxxxxxxxxx",
  "metadata": {
    "purchase_order": "PO-42"
  },
  "payment_method_id": "payt_xxxxxxxxxxxxxx",
  "recipient_emails": [
    "jsmith@example.com"
  ]
}
'

import requests

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

payload = {
    "billing_address": {
        "city": "New York",
        "country": "US",
        "line1": "123 Main St",
        "postal_code": "10001",
        "line2": "<string>",
        "name": "<string>",
        "phone": "<string>",
        "state": "NY"
    },
    "buyer_fee_percentage": 2.5,
    "due_at": "2023-11-07T05:31:56Z",
    "items": [{ "plan_id": "plan_xxxxxxxxxxxxxx" }],
    "mailing_address_id": "<string>",
    "member_id": "mber_xxxxxxxxxxxxxx",
    "metadata": { "purchase_order": "PO-42" },
    "payment_method_id": "payt_xxxxxxxxxxxxxx",
    "recipient_emails": ["jsmith@example.com"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    billing_address: {
      city: 'New York',
      country: 'US',
      line1: '123 Main St',
      postal_code: '10001',
      line2: '<string>',
      name: '<string>',
      phone: '<string>',
      state: 'NY'
    },
    buyer_fee_percentage: 2.5,
    due_at: '2023-11-07T05:31:56Z',
    items: [{plan_id: 'plan_xxxxxxxxxxxxxx'}],
    mailing_address_id: '<string>',
    member_id: 'mber_xxxxxxxxxxxxxx',
    metadata: {purchase_order: 'PO-42'},
    payment_method_id: 'payt_xxxxxxxxxxxxxx',
    recipient_emails: ['jsmith@example.com']
  })
};

fetch('https://api.whop.com/api/v1/invoices/{id}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'billing_address' => [
        'city' => 'New York',
        'country' => 'US',
        'line1' => '123 Main St',
        'postal_code' => '10001',
        'line2' => '<string>',
        'name' => '<string>',
        'phone' => '<string>',
        'state' => 'NY'
    ],
    'buyer_fee_percentage' => 2.5,
    'due_at' => '2023-11-07T05:31:56Z',
    'items' => [
        [
                'plan_id' => 'plan_xxxxxxxxxxxxxx'
        ]
    ],
    'mailing_address_id' => '<string>',
    'member_id' => 'mber_xxxxxxxxxxxxxx',
    'metadata' => [
        'purchase_order' => 'PO-42'
    ],
    'payment_method_id' => 'payt_xxxxxxxxxxxxxx',
    'recipient_emails' => [
        'jsmith@example.com'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"billing_address\": {\n    \"city\": \"New York\",\n    \"country\": \"US\",\n    \"line1\": \"123 Main St\",\n    \"postal_code\": \"10001\",\n    \"line2\": \"<string>\",\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"state\": \"NY\"\n  },\n  \"buyer_fee_percentage\": 2.5,\n  \"due_at\": \"2023-11-07T05:31:56Z\",\n  \"items\": [\n    {\n      \"plan_id\": \"plan_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"mailing_address_id\": \"<string>\",\n  \"member_id\": \"mber_xxxxxxxxxxxxxx\",\n  \"metadata\": {\n    \"purchase_order\": \"PO-42\"\n  },\n  \"payment_method_id\": \"payt_xxxxxxxxxxxxxx\",\n  \"recipient_emails\": [\n    \"jsmith@example.com\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.whop.com/api/v1/invoices/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"billing_address\": {\n    \"city\": \"New York\",\n    \"country\": \"US\",\n    \"line1\": \"123 Main St\",\n    \"postal_code\": \"10001\",\n    \"line2\": \"<string>\",\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"state\": \"NY\"\n  },\n  \"buyer_fee_percentage\": 2.5,\n  \"due_at\": \"2023-11-07T05:31:56Z\",\n  \"items\": [\n    {\n      \"plan_id\": \"plan_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"mailing_address_id\": \"<string>\",\n  \"member_id\": \"mber_xxxxxxxxxxxxxx\",\n  \"metadata\": {\n    \"purchase_order\": \"PO-42\"\n  },\n  \"payment_method_id\": \"payt_xxxxxxxxxxxxxx\",\n  \"recipient_emails\": [\n    \"jsmith@example.com\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"billing_address\": {\n    \"city\": \"New York\",\n    \"country\": \"US\",\n    \"line1\": \"123 Main St\",\n    \"postal_code\": \"10001\",\n    \"line2\": \"<string>\",\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"state\": \"NY\"\n  },\n  \"buyer_fee_percentage\": 2.5,\n  \"due_at\": \"2023-11-07T05:31:56Z\",\n  \"items\": [\n    {\n      \"plan_id\": \"plan_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"mailing_address_id\": \"<string>\",\n  \"member_id\": \"mber_xxxxxxxxxxxxxx\",\n  \"metadata\": {\n    \"purchase_order\": \"PO-42\"\n  },\n  \"payment_method_id\": \"payt_xxxxxxxxxxxxxx\",\n  \"recipient_emails\": [\n    \"jsmith@example.com\"\n  ]\n}"

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,
  "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": [
    {
      "discount_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "id": "li_xxxxxxxxxxxxxx",
      "label": "Ceramic Coating Package",
      "plan_id": "plan_xxxxxxxxxxxxxx",
      "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
      }
    }
  ],
  "mailing_address_id": null,
  "member_id": "mber_xxxxxxxxxxxxxx",
  "metadata": {},
  "number": "#xxxxxxxx",
  "object": "invoice",
  "overdue": false,
  "paid_at": null,
  "payment_method_id": null,
  "recipient_emails": [
    "marcus@shinetime.example"
  ],
  "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>"
  }
}

PATCH

invoices

{id}

Update Invoice

curl --request PATCH \
  --url https://api.whop.com/api/v1/invoices/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billing_address": {
    "city": "New York",
    "country": "US",
    "line1": "123 Main St",
    "postal_code": "10001",
    "line2": "<string>",
    "name": "<string>",
    "phone": "<string>",
    "state": "NY"
  },
  "buyer_fee_percentage": 2.5,
  "due_at": "2023-11-07T05:31:56Z",
  "items": [
    {
      "plan_id": "plan_xxxxxxxxxxxxxx"
    }
  ],
  "mailing_address_id": "<string>",
  "member_id": "mber_xxxxxxxxxxxxxx",
  "metadata": {
    "purchase_order": "PO-42"
  },
  "payment_method_id": "payt_xxxxxxxxxxxxxx",
  "recipient_emails": [
    "jsmith@example.com"
  ]
}
'

import requests

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

payload = {
    "billing_address": {
        "city": "New York",
        "country": "US",
        "line1": "123 Main St",
        "postal_code": "10001",
        "line2": "<string>",
        "name": "<string>",
        "phone": "<string>",
        "state": "NY"
    },
    "buyer_fee_percentage": 2.5,
    "due_at": "2023-11-07T05:31:56Z",
    "items": [{ "plan_id": "plan_xxxxxxxxxxxxxx" }],
    "mailing_address_id": "<string>",
    "member_id": "mber_xxxxxxxxxxxxxx",
    "metadata": { "purchase_order": "PO-42" },
    "payment_method_id": "payt_xxxxxxxxxxxxxx",
    "recipient_emails": ["jsmith@example.com"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    billing_address: {
      city: 'New York',
      country: 'US',
      line1: '123 Main St',
      postal_code: '10001',
      line2: '<string>',
      name: '<string>',
      phone: '<string>',
      state: 'NY'
    },
    buyer_fee_percentage: 2.5,
    due_at: '2023-11-07T05:31:56Z',
    items: [{plan_id: 'plan_xxxxxxxxxxxxxx'}],
    mailing_address_id: '<string>',
    member_id: 'mber_xxxxxxxxxxxxxx',
    metadata: {purchase_order: 'PO-42'},
    payment_method_id: 'payt_xxxxxxxxxxxxxx',
    recipient_emails: ['jsmith@example.com']
  })
};

fetch('https://api.whop.com/api/v1/invoices/{id}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'billing_address' => [
        'city' => 'New York',
        'country' => 'US',
        'line1' => '123 Main St',
        'postal_code' => '10001',
        'line2' => '<string>',
        'name' => '<string>',
        'phone' => '<string>',
        'state' => 'NY'
    ],
    'buyer_fee_percentage' => 2.5,
    'due_at' => '2023-11-07T05:31:56Z',
    'items' => [
        [
                'plan_id' => 'plan_xxxxxxxxxxxxxx'
        ]
    ],
    'mailing_address_id' => '<string>',
    'member_id' => 'mber_xxxxxxxxxxxxxx',
    'metadata' => [
        'purchase_order' => 'PO-42'
    ],
    'payment_method_id' => 'payt_xxxxxxxxxxxxxx',
    'recipient_emails' => [
        'jsmith@example.com'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"billing_address\": {\n    \"city\": \"New York\",\n    \"country\": \"US\",\n    \"line1\": \"123 Main St\",\n    \"postal_code\": \"10001\",\n    \"line2\": \"<string>\",\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"state\": \"NY\"\n  },\n  \"buyer_fee_percentage\": 2.5,\n  \"due_at\": \"2023-11-07T05:31:56Z\",\n  \"items\": [\n    {\n      \"plan_id\": \"plan_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"mailing_address_id\": \"<string>\",\n  \"member_id\": \"mber_xxxxxxxxxxxxxx\",\n  \"metadata\": {\n    \"purchase_order\": \"PO-42\"\n  },\n  \"payment_method_id\": \"payt_xxxxxxxxxxxxxx\",\n  \"recipient_emails\": [\n    \"jsmith@example.com\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.whop.com/api/v1/invoices/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"billing_address\": {\n    \"city\": \"New York\",\n    \"country\": \"US\",\n    \"line1\": \"123 Main St\",\n    \"postal_code\": \"10001\",\n    \"line2\": \"<string>\",\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"state\": \"NY\"\n  },\n  \"buyer_fee_percentage\": 2.5,\n  \"due_at\": \"2023-11-07T05:31:56Z\",\n  \"items\": [\n    {\n      \"plan_id\": \"plan_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"mailing_address_id\": \"<string>\",\n  \"member_id\": \"mber_xxxxxxxxxxxxxx\",\n  \"metadata\": {\n    \"purchase_order\": \"PO-42\"\n  },\n  \"payment_method_id\": \"payt_xxxxxxxxxxxxxx\",\n  \"recipient_emails\": [\n    \"jsmith@example.com\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"billing_address\": {\n    \"city\": \"New York\",\n    \"country\": \"US\",\n    \"line1\": \"123 Main St\",\n    \"postal_code\": \"10001\",\n    \"line2\": \"<string>\",\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"state\": \"NY\"\n  },\n  \"buyer_fee_percentage\": 2.5,\n  \"due_at\": \"2023-11-07T05:31:56Z\",\n  \"items\": [\n    {\n      \"plan_id\": \"plan_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"mailing_address_id\": \"<string>\",\n  \"member_id\": \"mber_xxxxxxxxxxxxxx\",\n  \"metadata\": {\n    \"purchase_order\": \"PO-42\"\n  },\n  \"payment_method_id\": \"payt_xxxxxxxxxxxxxx\",\n  \"recipient_emails\": [\n    \"jsmith@example.com\"\n  ]\n}"

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,
  "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": [
    {
      "discount_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "id": "li_xxxxxxxxxxxxxx",
      "label": "Ceramic Coating Package",
      "plan_id": "plan_xxxxxxxxxxxxxx",
      "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
      }
    }
  ],
  "mailing_address_id": null,
  "member_id": "mber_xxxxxxxxxxxxxx",
  "metadata": {},
  "number": "#xxxxxxxx",
  "object": "invoice",
  "overdue": false,
  "paid_at": null,
  "payment_method_id": null,
  "recipient_emails": [
    "marcus@shinetime.example"
  ],
  "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>"
  }
}

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

Api-Version-Date

string

Pins the request to a dated API version.

Example:

"2026-10-24"

Path Parameters

string

required

The invoice's pay_ ID.

Body

application/json

billing_address

object | null

Create a billing address linked to this member.

Show child attributes

buyer_fee_percentage

number

The buyer's adjustable fee in percentage points, with at most two decimal places.

Required range: 0 <= x <= 100

Example:

2.5

due_at

string<date-time> | null

When payment is due, as an ISO 8601 timestamp.

items

object[]

The one-time variants being invoiced, all in the same currency. Each variant may appear once; use quantity for multiple units. Product and price come from each variant. Multiple items require unlimited stock and compatible payment, tax, and access settings.

Required array length: 1 - 50 elements

Option 1
Option 2

Show child attributes

Example:

{ "plan_id": "plan_xxxxxxxxxxxxxx" }

mailing_address_id

string | null

An address associated with the member. Mutually exclusive with billing_address.

member_id

string | null

The billed customer, a member of the account. Changing email recipients does not change this buyer.

Example:

"mber_xxxxxxxxxxxxxx"

metadata

object

Up to 50 caller-owned string key/value pairs.

Show child attributes

Example:

{ "purchase_order": "PO-42" }

payment_method_id

string | null

A saved payment method belonging to the member. Issuing the invoice charges it.

Example:

"payt_xxxxxxxxxxxxxx"

recipient_emails

string<email>[]

Email addresses saved for invoice delivery, independent of the billed customer. Saving them sends no email. Defaults to the customer email when omitted on create. Can be updated on draft, open, or uncollectible invoices.

Maximum array length: 50

Response

draft 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

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"

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:

null

recipient_emails

string[]

required

Invoice email recipients, independent of the billed customer.

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

Update Invoice

Authorizations

Headers

Path Parameters

Body

Response