Update invoice

Update a draft invoice’s details.

Required permissions:

• invoice:update
• member:email:read
• member:basic:read
• payment:basic:read

PATCH /invoices/{id}

JavaScript

JavaScript

import Whop from '@whop/sdk';

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

const invoice = await client.invoices.update('inv_xxxxxxxxxxxxxx');

console.log(invoice.id);

200

{
  "automatically_finalizes_at": "2023-12-01T05:00:00.401Z",
  "charge_buyer_fee": true,
  "collection_method": "send_invoice",
  "company": {
    "id": "biz_xxxxxxxxxxxxxx"
  },
  "created_at": "2023-12-01T05:00:00.401Z",
  "current_plan": {
    "currency": "usd",
    "description": "Monthly access to all premium analytics dashboards and data exports.",
    "formatted_price": "$10.00",
    "id": "plan_xxxxxxxxxxxxx"
  },
  "customer_name": "Jane Doe",
  "due_date": "2023-12-01T05:00:00.401Z",
  "email_address": "[e-mail]",
  "fetch_invoice_token": "eyJhbGciOiJIUzI1NiJ9...",
  "id": "inv_xxxxxxxxxxxxxx",
  "line_items": [
    {
      "label": "Platform subscription",
      "position": 42,
      "quantity": 6.9,
      "total": 6.9,
      "unit_price": 6.9
    }
  ],
  "mailing_address": {
    "city": "<string>",
    "country": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "name": "<string>",
    "phone": "<string>",
    "postal_code": "<string>",
    "state": "<string>"
  },
  "member": {
    "id": "<string>"
  },
  "number": "#0001",
  "pay_online_url": "<string>",
  "payment": {
    "id": "pay_xxxxxxxxxxxxxx"
  },
  "payment_processing": true,
  "product": {
    "id": "prod_xxxxxxxxxxxxx",
    "title": "Pickaxe Analytics"
  },
  "status": "draft",
  "subscription_billing_anchor_at": "2023-12-01T05:00:00.401Z",
  "updated_at": "2023-12-01T05:00:00.401Z",
  "user": {
    "email": "[e-mail]",
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  }
}

Authorizations

Authorization · string · header · required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example 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. For charge_automatically, triggers an automatic charge. For send_invoice, sends the invoice email at the specified time.

Example:

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

billing_address · object | null

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

Show child attributes

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.

Show child attributes

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 | null

Updated plan attributes.

Show child attributes

product_id · string | null

The unique identifier of an existing product to attach to this invoice. Only allowed while the invoice is still a draft.

Example:

"prod_xxxxxxxxxxxxx"

subscription_billing_anchor_at · string<date-time> | null

The date that defines when the subscription billing cycle should start.

Example:

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

Response

200

application/json

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.

automatically_finalizes_at · string<date-time> | null · required

The date and time when the invoice will be automatically finalized. For charge_automatically, triggers an automatic charge. For send_invoice, sends the invoice email at the specified time.

Example:

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

charge_buyer_fee · boolean · required

Whether the invoice includes a buyer processing fee on top of the plan price.

collection_method · enum<string> · required

The method used to collect payment for this invoice, such as automatic charging or manual payment.

Available options: send_invoice, charge_automatically

company · object · required

The company that issued this invoice.

Show child attributes

created_at · string<date-time> · required

The datetime the invoice was created.

Example:

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

current_plan · object · required

The plan that this invoice charges for.

Show child attributes

customer_name · string | null · required

The full name of the customer this invoice is addressed to. Null if no name is on file.

Example:

"Jane Doe"

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:

"[e-mail]"

fetch_invoice_token · string · required

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

Example:

"eyJhbGciOiJIUzI1NiJ9..."

id · string · required

The unique identifier for the invoice.

Example:

"inv_xxxxxxxxxxxxxx"

line_items · object[] · required

Optional line items that break down the invoice total into individual charges.

Show child attributes

mailing_address · object | null · required

The billing/mailing address associated with this invoice, if one was provided at creation time.

Show child attributes

member · object | null · required

The member that the invoice was created for. Null when the invoice is addressed to an email address with no member record behind it.

Show child attributes

number · string · required

The sequential invoice number for display purposes.

Example:

"#0001"

pay_online_url · string | null · required

The checkout URL where the customer can pay this invoice online, with their email address pre-filled and locked.

payment · object | null · required

The payment that settled this invoice. Null while the invoice is unpaid, when the invoice was marked paid manually, and on a subscription renewal invoice, where the settling payment cannot yet be identified.

Show child attributes

payment_processing · boolean · required

Whether a payment on this invoice is still clearing. True while a delayed payment method such as ACH or SEPA settles, during which the invoice stays open and is not marked past due.

product · object · required

The product that this invoice was generated for.

Show child attributes

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

subscription_billing_anchor_at · string<date-time> | null · required

The date that defines when the subscription billing cycle starts. When set on a renewal plan invoice, all future billing periods anchor to this date.

Example:

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

updated_at · string<date-time> · required

The datetime the invoice was last updated.

Example:

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

user · object | null · required

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

Show child attributes