Skip to main content
WEBHOOK
contract.executed
{
  "acv": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "auto_charges": true,
  "auto_renews": true,
  "bundle_pricing_id": "<string>",
  "change_custom_date": "<unknown>",
  "change_proration_type": "<unknown>",
  "change_reset_billing_anchor": "<unknown>",
  "change_timing": "<unknown>",
  "company_id": "<string>",
  "completed_date": "<unknown>",
  "config_items": [
    {
      "hide_at_checkout": "<unknown>",
      "minimum_units": 123,
      "num_licenses": 123,
      "product_metric_pricing_id": "<unknown>",
      "product_pricing_id": "<unknown>",
      "quantity_config": {
        "allow_custom_quantity": true,
        "max_quantity": 123,
        "min_quantity": 123
      },
      "sort_order": "<unknown>",
      "upsell_product_metric_pricing_id": "<unknown>"
    }
  ],
  "contract_attachments": [
    {
      "attachment_type": "<unknown>",
      "created_at": "2023-11-07T05:31:56Z",
      "file_id": "<string>",
      "id": "<string>",
      "original_filename": "<string>",
      "uploaded_at": "2023-11-07T05:31:56Z"
    }
  ],
  "counter_signatories": [
    {
      "company_user": {
        "created_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "image_url": "<string>",
        "title": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "user": {
          "email": "<string>",
          "id": "<string>",
          "name": "<string>",
          "verified": true
        }
      },
      "declined": true,
      "email": "<string>",
      "id": "<string>",
      "position": "<unknown>",
      "signature_id": "<unknown>",
      "signed": true,
      "signed_date": "<unknown>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "custom_variables": {},
  "customer_id": "<unknown>",
  "discounts": [
    {
      "amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "cap": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "company_id": "<string>",
      "coupon_id": "<unknown>",
      "created_at": "2023-11-07T05:31:56Z",
      "customer_id": "<unknown>",
      "deleted_at": {},
      "expiration_date": "<unknown>",
      "id": "<string>",
      "import_created_at_ref": "<unknown>",
      "import_ref": "<unknown>",
      "imported_from": "<unknown>",
      "item_pricing_id": "<unknown>",
      "name": "<string>",
      "onetime_billable": {
        "aggregate": 123,
        "company_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "custom_price": {
          "amount": {
            "currency": "<string>",
            "value_in_cents": 123
          },
          "description": {},
          "product_id": "<string>"
        },
        "customer_id": "<unknown>",
        "deleted_at": {},
        "id": "<string>",
        "import_ref": "<unknown>",
        "imported_from": "<unknown>",
        "name": "<string>",
        "product_pricing_id": "<unknown>",
        "proposal_id": "<unknown>",
        "quantity_config": {
          "allow_custom_quantity": true,
          "max_quantity": 123,
          "min_quantity": 123
        },
        "sort_order": "<unknown>",
        "state": "<string>",
        "type": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "onetime_billable_id": "<unknown>",
      "percent": 123,
      "product_id": "<unknown>",
      "product_pricing_id": "<unknown>",
      "proposal_id": "<unknown>",
      "state": "<string>",
      "subscription_id": "<unknown>",
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "expiration_date": "<unknown>",
  "finalized_date": "<unknown>",
  "id": "<string>",
  "invoice_due_date_from_creation": "<unknown>",
  "invoice_event_grace_period": "<unknown>",
  "metadata": [
    1
  ],
  "minimum_spend": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "one_time_billables": [
    {
      "aggregate": 123,
      "company_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "custom_price": {
        "amount": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "description": {},
        "product_id": "<string>"
      },
      "customer_id": "<unknown>",
      "id": "<string>",
      "name": "<string>",
      "product_pricing": {
        "company_id": "<string>",
        "computed_entitlements": [
          {
            "entitlement_id": "<string>",
            "id": "<string>",
            "inherited_from_id": "<unknown>",
            "inherited_from_type": "<unknown>",
            "key": "<string>",
            "name": "<string>",
            "original_value": "<unknown>",
            "overridden": "<unknown>",
            "type": "<string>",
            "value": "<unknown>"
          }
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "currency": "<string>",
        "description": "<string>",
        "external_name": "<string>",
        "id": "<string>",
        "import_created_at_ref": "<unknown>",
        "import_ref": "<unknown>",
        "imported_from": "<unknown>",
        "metadata": [
          1
        ],
        "name": "<string>",
        "num_subs": 1,
        "override_entitlements": [
          {
            "entitlement_id": "<string>",
            "id": "<string>",
            "inherited_from_id": "<unknown>",
            "inherited_from_type": "<unknown>",
            "key": "<string>",
            "name": "<string>",
            "original_value": "<unknown>",
            "overridden": "<unknown>",
            "type": "<string>",
            "value": "<unknown>"
          }
        ],
        "product": {
          "company_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "entitlements": [
            {
              "entitlement_id": "<string>",
              "id": "<string>",
              "inherited_from_id": "<unknown>",
              "inherited_from_type": "<unknown>",
              "key": "<string>",
              "name": "<string>",
              "original_value": "<unknown>",
              "overridden": "<unknown>",
              "type": "<string>",
              "value": "<unknown>"
            }
          ],
          "external_name": "<string>",
          "id": "<string>",
          "image_url": "<unknown>",
          "import_created_at_ref": "<unknown>",
          "import_ref": "<unknown>",
          "imported_from": "<unknown>",
          "metadata": [
            1
          ],
          "name": "<string>",
          "product_pricings": "<array>",
          "state": "<string>",
          "tags": [
            "<string>"
          ],
          "updated_at": "2023-11-07T05:31:56Z"
        },
        "product_id": "<string>",
        "product_metric_pricings": [
          {
            "company_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "id": "<string>",
            "item": {
              "company_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "description": "<string>",
              "display_type": "<string>",
              "editable": true,
              "external_name": "<string>",
              "id": "<string>",
              "name": "<string>",
              "standard": true,
              "type": "<string>",
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "item_id": "<string>",
            "item_pricing": {
              "base_price": {
                "currency": "<string>",
                "value_in_cents": 123
              },
              "base_units": 123,
              "carry_over": true,
              "charge_type": "<string>",
              "company": {
                "address": {
                  "address_line_1": "<string>",
                  "address_line_2": "<string>",
                  "city": "<string>",
                  "country": "<string>",
                  "place_id": "<unknown>",
                  "state": "<string>",
                  "zip": "<string>"
                },
                "computed_entitlements": {},
                "created_at": "2023-11-07T05:31:56Z",
                "customer_id": "<unknown>",
                "demo": true,
                "email": "<string>",
                "id": "<string>",
                "is_dev": true,
                "legal_name": "<string>",
                "name": "<string>",
                "phone": "<string>",
                "preferred_currency": "<string>",
                "preferred_timezone": "<string>",
                "slug": "<string>",
                "updated_at": "2023-11-07T05:31:56Z"
              },
              "company_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "credit_price": {
                "amount": {
                  "currency": "<string>",
                  "value_in_cents": 123
                },
                "item_id": "<unknown>",
                "type": "<string>",
                "units": 123
              },
              "custom_price": {
                "max_price_per_unit": "<string>",
                "min_price_per_unit": "<string>",
                "preset_price_per_unit": "<string>",
                "price_per_unit": "<string>"
              },
              "description": "<string>",
              "display_type": "<string>",
              "editable": true,
              "external_name": "<string>",
              "fixed_price": {
                "price_per_unit": "<string>"
              },
              "frequency": "<string>",
              "gradient_price": [
                {
                  "end": 1,
                  "flat_price": "<string>",
                  "is_custom_tier": true,
                  "price_per_unit": "<string>",
                  "start": 1
                }
              ],
              "id": "<string>",
              "item": {
                "company_id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "description": "<string>",
                "display_type": "<string>",
                "editable": true,
                "external_name": "<string>",
                "id": "<string>",
                "name": "<string>",
                "standard": true,
                "type": "<string>",
                "updated_at": "2023-11-07T05:31:56Z"
              },
              "item_id": "<string>",
              "metadata": [
                1
              ],
              "minimum_spend": {
                "currency": "<string>",
                "value_in_cents": 123
              },
              "minimum_spend_schedule": {
                "allow_pulling_forward": true,
                "amount_per_period": "<unknown>",
                "minimum_spend_schedule_type": "<string>"
              },
              "name": "<string>",
              "num_subs": 1,
              "proration_type": "<string>",
              "recognition_schedule": {
                "amount_per_period": "<unknown>",
                "recognition_schedule_type": "<string>"
              },
              "scheduled_price": {
                "price_per_unit_per_period": [
                  "<string>"
                ]
              },
              "state": "<string>",
              "step_price": {
                "price_per_step": "<string>",
                "step_size": 1
              },
              "term_count": 123,
              "true_up_frequency": "<string>",
              "type": "<string>",
              "updated_at": "2023-11-07T05:31:56Z",
              "volume_price": [
                {
                  "flat_price": "<string>",
                  "is_custom_tier": true,
                  "price_per_unit": "<string>",
                  "total_units_end": 1,
                  "total_units_start": 1
                }
              ]
            },
            "item_pricing_id": "<string>",
            "metric": {
              "company_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "description": "<string>",
              "external_name": "<string>",
              "id": "<string>",
              "item_id": "<string>",
              "metering_rule": {
                "aggregator": "<string>",
                "group_keys": [
                  "<string>"
                ],
                "property": "<string>",
                "rule": "<unknown>"
              },
              "name": "<string>",
              "standard": true,
              "type": "<string>",
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "metric_id": "<string>",
            "product_id": "<string>",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        ],
        "state": "<string>",
        "tags": [
          "<string>"
        ],
        "type": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "upsell_product_pricing_id": "<unknown>"
      },
      "product_pricing_id": "<unknown>",
      "quantity_config": {
        "allow_custom_quantity": true,
        "max_quantity": 123,
        "min_quantity": 123
      },
      "sort_order": "<unknown>",
      "state": "<string>",
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "options": {
    "allow_promo_code": true,
    "collect_taxes": true,
    "completion_action": "<string>",
    "confirmation_message": "<string>",
    "redirect_url": "<string>",
    "requires_customer_address": true,
    "requires_customer_confirmation": true,
    "requires_customer_phone": true,
    "requires_email_verification": true,
    "save_card_on_checkout": true
  },
  "owner_id": "<unknown>",
  "parent_billed": true,
  "payment_provided_date": "<unknown>",
  "po_number": "<unknown>",
  "require_payment_method": true,
  "signatories": [
    {
      "declined": true,
      "email": "<string>",
      "name": "<string>",
      "position": "<unknown>",
      "signature_id": "<string>",
      "signature_link": "<string>",
      "signed": true,
      "signed_date": "<unknown>",
      "title": "<string>",
      "view_timestamps": [
        "2023-11-07T05:31:56Z"
      ]
    }
  ],
  "signed_date": "<unknown>",
  "signed_file_id": "<unknown>",
  "signed_offline": true,
  "start_date": "<unknown>",
  "start_type": "<string>",
  "status": "<string>",
  "tcv": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "template_variables": [
    "<string>"
  ],
  "term": {
    "count": 123,
    "frequency": "<string>"
  },
  "title": "<string>",
  "trial": true,
  "trial_term": {
    "count": 123,
    "frequency": "<string>"
  },
  "type": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

Body

application/json
acv
object

The amount which has value in cents and a currency

auto_charges
boolean
auto_renews
boolean
bundle_pricing_id
string
change_custom_date
null | string<date-time>
change_proration_type
null | string
change_reset_billing_anchor
null | boolean
change_timing
null | string
company_id
string
completed_date
null | string<date-time>
config_items
object[] | null
contract_attachments
object[] | null
counter_signatories
object[] | null
created_at
string<date-time>
custom_variables
object
customer_id
null | string
discounts
object[] | null
expiration_date
null | string<date-time>
finalized_date
null | string<date-time>
id
string
invoice_due_date_from_creation
null | integer
Required range: x >= 0
invoice_event_grace_period
null | integer
Required range: x >= 0
metadata
integer[] | null
Required range: x >= 0
minimum_spend
object

The amount which has value in cents and a currency

one_time_billables
object[] | null
options
object
owner_id
null | string
parent_billed
boolean
payment_provided_date
null | string<date-time>
po_number
null | string
require_payment_method
boolean
signatories
object[] | null
signed_date
null | string<date-time>
signed_file_id
null | string
signed_offline
boolean
start_date
null | string<date-time>
start_type
string
status
string
tcv
object

The amount which has value in cents and a currency

template_variables
string[] | null
term
object

The term which includes a frequency interval and a count for number of intervals

title
string
trial
boolean
trial_term
object

The term which includes a frequency interval and a count for number of intervals

type
string
updated_at
string<date-time>

Response

200

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