order.updated

Sent when an order is updated.

An order is updated when:

Its status changes, e.g. from pending to paid.
It's refunded, partially or fully.

Discord & Slack support: Full

type

string

required

Allowed value: "order.updated"

Examples:

"order.updated"

timestamp

string<date-time>

required

data

object

required

Show child attributes

{ "type": "order.updated", "timestamp": "2023-11-07T05:31:56Z", "data": { "id": "<string>", "created_at": "2023-11-07T05:31:56Z", "modified_at": "2023-11-07T05:31:56Z", "status": "paid", "paid": true, "subtotal_amount": 123, "discount_amount": 123, "net_amount": 123, "tax_amount": 123, "total_amount": 123, "from_balance_amount": 123, "refunded_amount": 123, "refunded_tax_amount": 123, "currency": "<string>", "billing_reason": "purchase", "billing_name": "<string>", "billing_address": { "line1": "<string>", "line2": "<string>", "postal_code": "<string>", "city": "<string>", "state": "<string>", "country": "US" }, "is_invoice_generated": true, "customer_id": "<string>", "product_id": "<string>", "discount_id": "<string>", "subscription_id": "<string>", "checkout_id": "<string>", "metadata": {}, "custom_field_data": {}, "customer": { "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2023-11-07T05:31:56Z", "modified_at": "2023-11-07T05:31:56Z", "metadata": {}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "name": "John Doe", "billing_address": { "line1": "<string>", "line2": "<string>", "postal_code": "<string>", "city": "<string>", "state": "<string>", "country": "US" }, "tax_id": [ "911144442", "us_ein" ], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2023-11-07T05:31:56Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404" }, "user_id": "<string>", "product": { "metadata": {}, "id": "<string>", "created_at": "2023-11-07T05:31:56Z", "modified_at": "2023-11-07T05:31:56Z", "trial_interval": "day", "trial_interval_count": 123, "name": "<string>", "description": "<string>", "recurring_interval": "day", "is_recurring": true, "is_archived": true, "organization_id": "<string>" }, "discount": { "duration": "once", "type": "fixed", "amount": 123, "currency": "<string>", "created_at": "2023-11-07T05:31:56Z", "modified_at": "2023-11-07T05:31:56Z", "id": "<string>", "metadata": {}, "name": "<string>", "code": "<string>", "starts_at": "2023-11-07T05:31:56Z", "ends_at": "2023-11-07T05:31:56Z", "max_redemptions": 123, "redemptions_count": 123, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737" }, "subscription": { "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "modified_at": "2023-11-07T05:31:56Z", "id": "<string>", "amount": 123, "currency": "<string>", "recurring_interval": "day", "status": "incomplete", "current_period_start": "2023-11-07T05:31:56Z", "current_period_end": "2023-11-07T05:31:56Z", "trial_start": "2023-11-07T05:31:56Z", "trial_end": "2023-11-07T05:31:56Z", "cancel_at_period_end": true, "canceled_at": "2023-11-07T05:31:56Z", "started_at": "2023-11-07T05:31:56Z", "ends_at": "2023-11-07T05:31:56Z", "ended_at": "2023-11-07T05:31:56Z", "customer_id": "<string>", "product_id": "<string>", "discount_id": "<string>", "checkout_id": "<string>", "customer_cancellation_reason": "customer_service", "customer_cancellation_comment": "<string>" }, "items": [ { "created_at": "2023-11-07T05:31:56Z", "modified_at": "2023-11-07T05:31:56Z", "id": "<string>", "label": "<string>", "amount": 123, "tax_amount": 123, "proration": true, "product_price_id": "<string>" } ] } }

General

Core API

Customer Portal API

Webhook Events

Integrations

order.updated