Sign in
Webhook Events

invoice.communication.triggered

Fired when an invoice communication (e.g. email notification) is triggered. Doc-only for parsing.

post/webhook-events/invoice.communication.triggered

Response

Webhook payload

event_type'subscription.created' | 'subscription.draft.created' | 'subscription.activated' | 'subscription.updated' | 'subscription.paused' | 'subscription.cancelled' | 'subscription.resumed' | 'subscription.plan_changed' | 'subscription.phase.created' | 'subscription.phase.updated' | 'subscription.phase.deleted' | 'feature.created' | 'feature.updated' | 'feature.deleted' | 'feature.wallet_balance.alert' | 'entitlement.created' | 'entitlement.updated' | 'entitlement.deleted' | 'wallet.created' | 'wallet.updated' | 'wallet.terminated' | 'wallet.transaction.created' | 'wallet.transaction.updated' | 'payment.created' | 'payment.updated' | 'payment.failed' | 'payment.success' | 'payment.pending' | 'customer.created' | 'customer.updated' | 'customer.deleted' | 'invoice.update.finalized' | 'invoice.update.payment' | 'invoice.update.voided' | 'invoice.update' | 'invoice.payment.overdue' | 'wallet.credit_balance.dropped' | 'wallet.credit_balance.recovered' | 'wallet.ongoing_balance.dropped' | 'wallet.ongoing_balance.recovered' | 'wallet.ongoing_balance.updated' | 'subscription.spend.threshold_reached' | 'subscription.spend.threshold_recovered' | 'subscription.line_item_spend.threshold_reached' | 'subscription.line_item_spend.threshold_recovered' | 'subscription.group_spend.threshold_reached' | 'subscription.group_spend.threshold_recovered' | 'entitlement.grant.exhausted' | 'subscription.renewal.due' | 'invoice.communication.triggered' | 'credit_note.created' | 'credit_note.updated' | 'checkout.session.initiated' | 'checkout.session.completed' | 'checkout.session.failed' | 'checkout.session.expired' | 'event.rejected'

Changes

Changed in 28 of the 108 revisions of this API.318548

  • 562f13cf61dd3See the full diff
    • ○

      added the optional property invoice/customer/environment_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property invoice/environment_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property invoice/subscription/customer/environment_id to the response with the 200 status

      response-optional-property-added

  • 29f14678f58f103See the full diff
    • ●

      removed the optional property invoice/adjustment_amount from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/billing_period from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/billing_sequence from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/coupon_applications from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/created_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/created_by from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/customer/contact from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/customer/created_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/customer/created_by from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/customer/environment_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/customer/integrations from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/customer/status from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/customer/tenant_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/customer/updated_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/customer/updated_by from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/description from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/environment_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/idempotency_key from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/issue_date from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/last_computed_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/adjusted_entitlement_quantity from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/commitment_info from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/created_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/created_by from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/currency from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/customer_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/entity_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/entity_type from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/environment_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/invoice_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/invoice_level_discount from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/line_item_discount from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/metadata from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/meter_display_name from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/meter_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/prepaid_credits_applied from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/price_type from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/price_unit from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/price_unit_amount from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/price_unit_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/status from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/subscription_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/subscription_line_item_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/tenant_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/updated_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/updated_by from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/usage_analytics from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/line_items/items/usage_breakdown from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/overpaid_amount from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/recalculated_invoice_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/refunded_amount from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/status from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/active_pause_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/auto_invoice_threshold from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/billing_anchor from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/billing_cycle from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/collection_method from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/commitment_amount from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/commitment_duration from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/coupon_associations from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/created_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/created_by from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/credit_grants from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/customer/contact from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/customer/created_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/customer/created_by from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/customer/environment_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/customer/integrations from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/customer/status from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/customer/tenant_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/customer/updated_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/customer/updated_by from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/enable_true_up from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/entitlements from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/environment_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/gateway_payment_method_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/invoicing_customer_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/latest_invoice from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/line_items from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/overage_factor from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/pauses from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/payment_behavior from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/payment_terms from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/phases from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/plan from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/proration_behavior from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/status from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/synced_price_sequence from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/tenant_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/timezone from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/updated_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/updated_by from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription/version from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/subscription_customer_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/taxes from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/tenant_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/total_discount from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/total_prepaid_credits_applied from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/total_tax from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/updated_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/updated_by from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice/version from the response with the 200 status

      response-optional-property-removed

    • ●

      added the new subscription.plan_changed enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 50b7421a969013See the full diff
    • ●

      added the new entitlement.grant.exhausted enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property invoice/subscription/coupon_associations/items/subscription_line_item/meter to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property invoice/subscription/entitlements to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property invoice/subscription/line_items/items/meter to the response with the 200 status

      response-optional-property-added

  • f8ecf435d25d145See the full diff
    • ●

      added the new ADDON enum value to the invoice/subscription/coupon_associations/items/subscription_line_item/price/plan/credit_grants/items/scope response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ADDON enum value to the invoice/subscription/credit_grants/items/scope response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ADDON enum value to the invoice/subscription/plan/credit_grants/items/scope response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new event.rejected enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new invoice_line_item enum value to the invoice/customer/integrations/items/entity_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new invoice_line_item enum value to the invoice/subscription/customer/integrations/items/entity_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new subscription.group_spend.threshold_reached enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new subscription.group_spend.threshold_recovered enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new subscription.line_item_spend.threshold_reached enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new subscription.line_item_spend.threshold_recovered enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new subscription.spend.threshold_reached enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new subscription.spend.threshold_recovered enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new wallet.ongoing_balance.updated enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new wallet.transaction.updated enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property invoice/customer/contact to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property invoice/subscription/coupon_associations/items/subscription_line_item/price/plan/credit_grants/items/addon_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property invoice/subscription/credit_grants/items/addon_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property invoice/subscription/customer/contact to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property invoice/subscription/plan/credit_grants/items/addon_id to the response with the 200 status

      response-optional-property-added

  • 646d6658479b3See the full diff
    • ○

      the billing_period_count response's property default value 1 was removed for the status 200

      response-property-default-value-removed

    • ○

      the billing_period_count response's property default value 1 was removed for the status 200

      response-property-default-value-removed

    • ○

      the billing_period_count response's property default value 1 was removed for the status 200

      response-property-default-value-removed

  • 7d57386313c712See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ○

      added the optional property event_type to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property invoice to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4b1a811c417912See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • ●

      removed the optional property event_type from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice from the response with the 200 status

      response-optional-property-removed

    This revision also has 121 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7857ddc6e44d23See the full diff
    • ●

      removed the optional property invoice/subscription/customer_timezone from the response with the 200 status

      response-optional-property-removed

    • ●

      added the new checkout.session.expired enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property invoice/customer/timezone to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property invoice/subscription/customer/timezone to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property invoice/subscription/timezone to the response with the 200 status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 0b54d0a8a98f4See the full diff
    • ●

      added the new VOIDED enum value to the invoice/payment_status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new checkout.session.completed enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new checkout.session.failed enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new checkout.session.initiated enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 774ba8074d081See the full diff
    • ○

      added the optional property invoice/subscription/coupon_associations/items/subscription_line_item to the response with the 200 status

      response-optional-property-added