Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Orders::Invoice

Update External Invoice

Update a specific invoice in the current workspace. Currently, only invoices of external orders can be updated. So, you can't update invoices of other payment processors, like Payments AI and Stripe.

put/orders/invoices/{id}

Path parameters

idstring required

Request body

Example request

{
  "orders_invoice": {
    "orders_invoice": {
      "status": "paid",
      "paid_at": "2025-01-10T00:00:00.000Z",
      "line_items_attributes": [
        {
          "id": 682,
          "amount": "99.00",
          "quantity": 2
        }
      ]
    }
  }
}

Response

OK

idinteger

Invoice ID

public_idstring

Invoice public ID

order_idinteger

Order ID

statusstring

The billing status reflects the status of the invoice's payment. Billing status can be one of the following for Payments AI orders: draft, paid, unpaid, partially-refunded, refunded, voided, disputed, past-due.

External invoice statuses of external one-time orders can be one of the following: unpaid, paid, voided and refunded, disputed, past-due. A change in status will update the billing_status of the parent order. If the status of a one-time order is changed to paid, the order's service_status will also be flipped to completed.

due_amountstring nullable

Due Amount

total_amountstring nullable

Total Amt

subtotal_amountstring nullable

Subtotal Amount

tax_amountstring nullable

Tax Amount

shipping_amountstring nullable

Invoiced shipping amount. Cannot be negative.

discount_amountstring nullable

Discount Amount

currencystring nullable

Currency

issued_atstring date-time nullable

The date the invoice was issued.

due_atstring date-time nullable

The date the invoice is due.

paid_atstring date-time nullable

The date the invoice was paid.

invoice_type'initial' | 'renewal' | 'interim' | 'cancellation' | 'one_time' | 'refund' | 'charge' | 'one_time_sale' nullable

Invoice Type

invoice_numberstring

The number of the invoice. Usually, this is a sequential number in a certain format to be used for bookkeeping purposes.

fulfillment_statusstring nullable

The fulfillment status of the invoice. This can be one of:

  • not_applicable - the invoice is not eligible for fulfillment
  • unfulfilled - the entire invoice needs to be fulfilled
  • partial - some items have been fulfilled, but some are pending or restocked
  • complete - all items are fulfilled
created_atstring date-time nullable

Added

updated_atstring date-time nullable

Updated

external_idstring

External ID

payment_processorstring nullable

The payment processor of the invoice's order. Currently, it can be one of payments_ai and external.

eligible_for_fulfillmentboolean nullable

Invoice has been paid so is eligible for fulfillment (does not indicate if the invoice has any fulfillable items)

Example response

{
  "id": 838,
  "public_id": "WNrMnJ",
  "order_id": 22642,
  "status": "paid",
  "due_amount": "13.00",
  "total_amount": "13.00",
  "subtotal_amount": "3.00",
  "tax_amount": "0.00",
  "shipping_amount": "10.00",
  "discount_amount": "0.00",
  "currency": "USD",
  "issued_at": "2023-10-01T12:43:55.000Z",
  "due_at": "2023-10-15T00:00:00.000Z",
  "paid_at": "2025-10-10T08:04:02.000Z",
  "invoice_type": "one_time_sale",
  "invoice_number": "3",
  "fulfillment_status": "not_applicable",
  "created_at": "2026-01-10T20:16:16.536Z",
  "updated_at": "2026-01-10T20:16:16.536Z",
  "external_id": "tffv2w34qv",
  "payment_processor": "external",
  "eligible_for_fulfillment": true,
  "line_items": [
    {
      "id": 682,
      "public_id": "RegpVj",
      "invoice_id": 838,
      "external_id": null,
      "payment_type": null,
      "description": null,
      "quantity": 1,
      "fulfillment_status": "unfulfilled",
      "external_product_id": null,
      "discount_amount": "0.0",
      "state_tax_amount": "0.0",
      "county_tax_amount": "0.0",
      "city_tax_amount": "0.0",
      "district_tax_amount": "0.0",
      "state_tax_rate": "0.0",
      "county_tax_rate": "0.0",
      "city_tax_rate": "0.0",
      "district_tax_rate": "0.0",
      "country_tax_jurisdiction": null,
      "state_tax_jurisdiction": null,
      "county_tax_jurisdiction": null,
      "city_tax_jurisdiction": null,
      "period_start_at": null,
      "period_end_at": null,
      "period_number": null,
      "created_at": "2026-01-10T20:16:16.538Z",
      "updated_at": "2026-01-10T20:16:16.538Z",
      "amount": "3.00",
      "products_price": {
        "id": 22229,
        "public_id": "YqEWxY",
        "amount": "198.00",
        "currency": "usd",
        "duration": null,
        "interval": null,
        "interval_count": null
      },
      "products_variant": {
        "id": 22228,
        "public_id": "JdknyN",
        "product_id": 6512,
        "name": "Seinfeld In Your Pocket - Comedy Joke Machine (Black Premium)",
        "description": null,
        "sku": "SIYP-BLACK-PREMIUM-001",
        "fulfillment_required": false
      }
    }
  ],
  "order": {
    "id": 22642,
    "public_id": "JmRRyN",
    "order_number": "#2146",
    "total_amount": "396.00",
    "origination_channel_id": 11,
    "origination_channel_type": "Platform::Application",
    "notes": "For Fulfillment",
    "live_mode": true,
    "in_trial": false,
    "billing_status": "paid",
    "service_status": "completed",
    "order_type": "one-time-order",
    "next_charge_at": null,
    "trial_end_at": null,
    "tag_ids": [],
    "activated_at": null,
    "canceled_at": null,
    "canceled_by": null,
    "cancel_reason": null,
    "cancel_description": null,
    "churned_at": null,
    "shipping_address_first_name": "Caroll",
    "shipping_address_last_name": "Kirlin",
    "shipping_address_organization_name": "Testing, Inc.",
    "shipping_address_phone_number": "+19053871234",
    "shipping_address_street_one": "3443 W Bavaria St",
    "shipping_address_street_two": "",
    "shipping_address_city": "Eagle",
    "shipping_address_region": "ID",
    "shipping_address_country": "US",
    "shipping_address_postal_code": "83616",
    "billing_address_street_one": "3443 W Bavaria St",
    "billing_address_street_two": "",
    "billing_address_city": "Eagle",
    "billing_address_region": "ID",
    "billing_address_country": "US",
    "billing_address_postal_code": "83616",
    "recurring_invoices_paid_count": 1,
    "origination_channel_name": "Default API Client",
    "origination_channel_public_id": "vNWWMb",
    "contact": {
      "$ref": "#/components/schemas/ContactBaseAttributes/example"
    },
    "affiliate": null,
    "referral_code": null,
    "order_page": null
  },
  "visits": {
    "last_visit": {
      "uuid": "7a3f9c11-2d45-4e23-88d2-1bef9acd44fa",
      "utm_source": null,
      "utm_medium": null,
      "utm_campaign": null,
      "utm_term": null,
      "utm_content": null,
      "ip": "192.168.1.1",
      "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36",
      "referrer": "https://www.clickfunnels.com/products",
      "referring_domain": "clickfunnels.com",
      "landing_page": "https://example.com/checkout",
      "browser": "Chrome",
      "os": "Mac OS X",
      "device_type": "desktop",
      "started_at": "2026-01-10T20:10:15.234Z",
      "created_at": "2026-01-10T20:10:15.234Z",
      "updated_at": "2026-01-10T20:10:15.234Z"
    },
    "last_visit_with_utm": {
      "uuid": "9f2e8a22-1b65-4414-95f3-5caf0bbd11da",
      "utm_source": "google",
      "utm_medium": "cpc",
      "utm_campaign": "spring_sale",
      "utm_term": "running shoes",
      "utm_content": "ad_variant_a",
      "ip": "192.168.1.1",
      "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36",
      "referrer": "https://www.google.com/search?q=example",
      "referring_domain": "google.com",
      "landing_page": "https://example.com/products/shoes",
      "browser": "Chrome",
      "os": "Mac OS X",
      "device_type": "desktop",
      "started_at": "2026-01-09T14:23:45.123Z",
      "created_at": "2026-01-09T14:23:45.123Z",
      "updated_at": "2026-01-09T14:23:45.123Z"
    }
  }
}