Skip to main content
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 '
{
  "automatically_finalizes_at": "2023-12-01T05:00:00.401Z",
  "billing_address": {
    "city": "<string>",
    "country": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "name": "<string>",
    "phone": "<string>",
    "postal_code": "<string>",
    "state": "<string>",
    "tax_id_type": "ad_nrt",
    "tax_id_value": "<string>"
  },
  "charge_buyer_fee": true,
  "collection_method": "send_invoice",
  "customer_name": "<string>",
  "due_date": "2023-12-01T05:00:00.401Z",
  "email_address": "<string>",
  "line_items": [
    {
      "label": "<string>",
      "unit_price": 6.9,
      "quantity": 6.9
    }
  ],
  "mailing_address_id": "ma_xxxxxxxxxxxxxxx",
  "member_id": "mber_xxxxxxxxxxxxx",
  "payment_method_id": "pmt_xxxxxxxxxxxxxx",
  "plan": {
    "billing_period": 42,
    "custom_fields": [
      {
        "field_type": "<string>",
        "name": "<string>",
        "id": "<string>",
        "order": 42,
        "placeholder": "<string>",
        "required": true
      }
    ],
    "description": "<string>",
    "expiration_days": 42,
    "initial_price": 6.9,
    "internal_notes": "<string>",
    "legacy_payment_method_controls": true,
    "payment_method_configuration": {
      "disabled": [
        "acss_debit"
      ],
      "enabled": [
        "acss_debit"
      ],
      "include_platform_defaults": true
    },
    "plan_type": "renewal",
    "release_method": "buy_now",
    "renewal_price": 6.9,
    "stock": 42,
    "trial_period_days": 42,
    "unlimited_stock": true,
    "visibility": "visible"
  }
}
'
{
  "id": "inv_xxxxxxxxxxxxxx",
  "created_at": "2023-12-01T05:00:00.401Z",
  "status": "draft",
  "number": "#0001",
  "due_date": "2023-12-01T05:00:00.401Z",
  "email_address": "customer@example.com",
  "fetch_invoice_token": "eyJhbGciOiJIUzI1NiJ9...",
  "current_plan": {
    "id": "plan_xxxxxxxxxxxxx",
    "formatted_price": "$10.00",
    "currency": "usd"
  },
  "user": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  }
}

Authorizations

​
Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Path Parameters

​
id
string
required

The unique identifier of the invoice to update.

Example:

"inv_xxxxxxxxxxxxxx"

Body

application/json

Parameters for UpdateInvoice

​
automatically_finalizes_at
string<date-time> | null

The date and time when the invoice will be automatically finalized and charged.

Example:

"2023-12-01T05:00:00.401Z"

​
billing_address
object

Inline billing address to create or update a mailing address for this invoice.

​
charge_buyer_fee
boolean | null

Whether to charge the customer a buyer fee on this invoice.

​
collection_method
enum<string> | null

How the invoice should be collected.

Available options:
send_invoice,
charge_automatically
​
customer_name
string | null

The name of the customer.

​
due_date
string<date-time> | null

The date by which the invoice must be paid.

Example:

"2023-12-01T05:00:00.401Z"

​
email_address
string | null

The email address of the customer.

​
line_items
object[] | null

Line items that break down the invoice total.

​
mailing_address_id
string | null

The unique identifier of an existing mailing address to attach.

Example:

"ma_xxxxxxxxxxxxxxx"

​
member_id
string | null

The unique identifier of a member to assign as the customer.

Example:

"mber_xxxxxxxxxxxxx"

​
payment_method_id
string | null

The unique identifier of the payment method to charge.

Example:

"pmt_xxxxxxxxxxxxxx"

​
plan
object

Updated plan attributes.

Response

A successful response

An invoice represents an itemized bill sent by a company to a customer for a specific product and plan, tracking the amount owed, due date, and payment status.

​
id
string
required

The unique identifier for the invoice.

Example:

"inv_xxxxxxxxxxxxxx"

​
created_at
string<date-time>
required

The datetime the invoice was created.

Example:

"2023-12-01T05:00:00.401Z"

​
status
enum<string>
required

The current payment status of the invoice, such as draft, open, paid, or void.

Available options:
draft,
open,
paid,
past_due,
uncollectible,
void
​
number
string
required

The sequential invoice number for display purposes.

Example:

"#0001"

​
due_date
string<date-time> | null
required

The deadline by which payment is expected. Null if the invoice is collected automatically.

Example:

"2023-12-01T05:00:00.401Z"

​
email_address
string | null
required

The email address of the customer this invoice is addressed to. Null if no email is on file.

Example:

"customer@example.com"

​
fetch_invoice_token
string
required

A signed token that allows fetching invoice data publicly without authentication.

Example:

"eyJhbGciOiJIUzI1NiJ9..."

​
current_plan
object
required

The plan that this invoice charges for.

​
user
object
required

The user this invoice is addressed to. Null if the user account has been removed.