Skip to main content
WEBHOOK
invoice.paid
{
  "auto_charges": true,
  "billed_customer": {
    "email": "<string>",
    "exclude_from_metrics": true,
    "id": "<string>",
    "identifier": "<string>",
    "managed_externally": true,
    "metadata": [
      1
    ],
    "name": "<string>",
    "org_name": "<string>",
    "owner_id": null,
    "parent_customer_id": null,
    "status": "<string>",
    "title": "<string>"
  },
  "billed_customer_id": "<string>",
  "company_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "credit_details": {
    "aggregate_price": {
      "currency": "<string>",
      "value_in_cents": 123
    }
  },
  "currency": "<string>",
  "customer": {
    "email": "<string>",
    "exclude_from_metrics": true,
    "id": "<string>",
    "identifier": "<string>",
    "managed_externally": true,
    "metadata": [
      1
    ],
    "name": "<string>",
    "org_name": "<string>",
    "owner_id": null,
    "parent_customer_id": null,
    "status": "<string>",
    "title": "<string>"
  },
  "customer_id": "<string>",
  "discount_details": {
    "aggregate_price": {
      "currency": "<string>",
      "value_in_cents": 123
    }
  },
  "due": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "due_date": "2023-11-07T05:31:56Z",
  "hosted_link": null,
  "id": "<string>",
  "immediate": true,
  "import_created_at_ref": null,
  "import_ref": null,
  "imported_from": null,
  "invoice_date": "2023-11-07T05:31:56Z",
  "metadata": [
    1
  ],
  "name": "<string>",
  "notes": null,
  "number": "<string>",
  "paid": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "paid_date": null,
  "payment_processing_amount": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "pdf_link": null,
  "prorated_amount": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "status": "<string>",
  "sub_total": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "subscription_id": null,
  "tax_details": {
    "aggregate_price": {
      "currency": "<string>",
      "value_in_cents": 123
    }
  },
  "total": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "updated_at": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

Body

application/json
​
auto_charges
boolean

Whether the invoice is automatically charged to the payment method on file for the customer

​
billed_customer
object

The expanded billed customer for the invoice

​
billed_customer_id
string

The billed customer ID for the invoice. This matches the customer_id by default, but can be set to another parent customer ID

​
company_id
string

The company ID for the invoice

​
created_at
string<date-time>

The date the invoice was created

​
credit_details
object

The breakdown of credits applied on the invoice

​
currency
string

The currency of the invoice

​
customer
object

The expanded customer for the invoice

​
customer_id
string

The customer ID for the invoice

​
discount_details
object

The breakdown of discounts applied on the invoice

​
due
object

The total amount due on the invoice after any payments

​
due_date
string<date-time>

The date the invoice total is due

​
hosted_link
string | null

The hosted link for the invoice

​
id
string

The ID of the invoice

​
immediate
boolean

Whether the invoice is immediately charged or attached to the next invoice date

​
import_created_at_ref
string<date-time> | null

The date the invoice was created from the import source

​
import_ref
string | null

The import reference for the invoice

​
imported_from
string | null

Where the invoice was imported from

​
invoice_date
string<date-time>

The date for the invoice

​
metadata
integer[] | null

Any additional data as key-value pairs attached to the invoice

​
name
string

The name of the invoice

​
notes
string | null

Any notes attached to the invoice

​
number
string

The invoice number for the invoice

​
paid
object

The total amount paid against the invoice

​
paid_date
string<date-time> | null

The date the invoice was paid

​
payment_processing_amount
object

Any processing payments for the invoice

​
pdf_link
string | null

The PDF link for the invoice

​
prorated_amount
object

Any prorated amounts for the invoice

​
status
string

The status of the invoice such as PAID, DRAFT, VOID or PENDING

​
sub_total
object

The subtotal of the invoice which is prior to applying credits

​
subscription_id
string | null

The subscription ID for the invoice, if is not a one-time invoice

​
tax_details
object

The breakdown of tax charges on the invoice

​
total
object

The final total of the invoice after applying all credits, discounts and taxes

​
updated_at
string<date-time>

The last date the invoice was updated

​
uuid
string

The unique identifier for the invoice

Response

200

Return a 200 status to indicate that the data was received successfully

⌘I