---
title: "Invoice created"
method: POST
path: "invoice.created"
tags: ["Invoices"]
---

# Invoice created

`POST invoice.created` (webhook)

Triggered when an invoice is created

## Headers

- `webhook-id` string, required
- `webhook-timestamp` string, required
- `webhook-signature` string, required

## Payload

- object
  - `id` string, required: Unique identifier for this webhook event
  - `object` 'event', required
  - `type` 'invoice.created', required: The event type
  - `created_at` string, date-time, required: ISO 8601 timestamp of when the event was created
  - `api_version` string, required: API version used to generate the payload
  - `data` object, required: `object` is the resource exactly as its API endpoint returns it, with `customer` expanded.
    - `object` Invoice, required
      - `id` string, required
      - `object` string, required
      - `status` 'open' | 'paid' | 'past_due' | 'void', required
      - `number` string, required
      - `description` string, nullable, required
      - `customer_name` string, nullable, required
      - `email_address` string, nullable, required
      - `collection_method` 'send_invoice' | 'charge_automatically', required
      - `due_at` string, date-time, required
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
      - `checkout_url` string, nullable, required
      - `amount` number, nullable, required
      - `currency` string, nullable, required
      - `paid_at` string, nullable, required
      - `customer` union: ID by default, full object when expanded
        - string
        - Customer
          - `id` string, required
          - `object` string, required
          - `email` string, required
          - `name` string, nullable, required
          - `first_name` string, nullable, required
          - `last_name` string, nullable, required
          - `phone_number` string, nullable, required
          - `customer_type` 'paid' | 'free' | 'lead', required
          - `notes` string, nullable, required
          - `confirmed_at` string, date-time, nullable, required
          - `created_at` string, date-time, required
          - `updated_at` string, date-time, required
          - `deleted_at` string, date-time, nullable, required
          - `purge_at` string, nullable, required
          - `anonymized` boolean, required
          - `metadata` object, required
          - `orders_count` integer, required
          - `total_spend` number, required
          - `tags` unknown[], required
            - unknown
      - `price_variant` union, required: ID by default, full object when expanded
        - string
        - PriceVariant
          - `id` string, required
          - `object` string, required
          - `name` string, required
          - `amount` integer, nullable, required
          - `amount_type` 'free' | 'fixed' | 'custom', required
          - `billing_type` 'subscription' | 'one_time' | 'payment_plan', required
          - `recurring_interval` 'day' | 'week' | 'month' | 'year' | 'null', nullable, required
          - `interval_count` integer, required
          - `installment_count` integer, nullable, required
          - `setup_fee_amount` integer, nullable, required
          - `trial_period_days` integer, nullable, required
          - `revoke_after_days` integer, nullable, required
          - `quantity_available` integer, nullable, required
          - `archived` boolean, nullable, required
          - `position` integer, required
          - `hidden` boolean, nullable, required
          - `created_at` string, date-time, required
          - `updated_at` string, date-time, required
          - `currency` string, nullable, required
          - `discounted_from_amount` integer, nullable, required
          - `minimum_amount` integer, nullable, required
          - `maximum_amount` integer, nullable, required
          - `preset_amount` integer, nullable, required
          - `waitlist` boolean, required
          - `benefits` string[]
          - `purchase_url` string, required
          - `product` string, required
      - `order` union: ID by default, full object when expanded
        - string
        - Order
          - `id` string, required
          - `object` string, required
          - `status` 'succeeded' | 'pending' | 'failed' | 'refunded' | 'partially_refunded' | 'disputed', required
          - `livemode` boolean, required
          - `created_at` string, date-time, required
          - `updated_at` string, date-time, required
          - `metadata` object, nullable, required
          - `amount` integer, required: Amount charged after discounts, in the smallest currency unit (79 = $0.79).
          - `currency` string, required
          - `amount_refunded` integer, required: Amount refunded so far, in the smallest currency unit.
          - `customer` union, required: ID by default, full object when expanded
            - string
            - Customer
              - …
          - `line_items` OrderItem[]
            - `id` string, required
            - `object` string, required
            - `quantity` integer, required
            - `order` union: ID by default, full object when expanded
              - …
            - `price_variant` union, required: ID by default, full object when expanded
              - …
            - `product` union, required: ID by default, full object when expanded
              - …
          - `checkout` string, required
          - `billing_address` Address, required
            - `name` string, nullable, required
            - `line1` string, nullable, required
            - `line2` string, nullable, required
            - `city` string, nullable, required
            - `state` string, nullable, required
            - `postal_code` string, nullable, required
            - `country` string, nullable, required
          - `shipping_address` Address, required
            - `name` string, nullable, required
            - `line1` string, nullable, required
            - `line2` string, nullable, required
            - `city` string, nullable, required
            - `state` string, nullable, required
            - `postal_code` string, nullable, required
            - `country` string, nullable, required
          - `charge` string, nullable, required

## Acknowledgement `200`

Return any 2xx status within 5 seconds to acknowledge receipt.

---

[API](https://skmtc.dev/crevio/apis/crevio-api-v1.md) · [All operations](https://skmtc.dev/crevio/apis/crevio-api-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/crevio/apis/crevio-api-v1/revisions/2219f18ad651?raw)