order.created

Sent when a new order is created.

A new order is created when:

A customer purchases a one-time product. In this case, billing_reason is set to purchase.
A customer starts a subscription. In this case, billing_reason is set to subscription_create.
A subscription is renewed. In this case, billing_reason is set to subscription_cycle.
A subscription is upgraded or downgraded with an immediate proration invoice. In this case, billing_reason is set to subscription_update.

[!WARNING] The order might not be paid yet, so the status field might be pending.

Discord & Slack support: Full

{ "type": "<string>", "timestamp": "2023-11-07T05:31:56Z", "data": { "id": "<string>", "created_at": "2023-11-07T05:31:56Z", "modified_at": "2023-11-07T05:31:56Z", "status": "pending", "paid": true, "subtotal_amount": 123, "discount_amount": 123, "net_amount": 123, "tax_amount": 123, "total_amount": 123, "applied_balance_amount": 123, "due_amount": 123, "refunded_amount": 123, "refunded_tax_amount": 123, "currency": "<string>", "billing_reason": "purchase", "billing_name": "<string>", "billing_address": { "country": "AD", "line1": "<string>", "line2": "<string>", "postal_code": "<string>", "city": "<string>", "state": "<string>" }, "invoice_number": "<string>", "is_invoice_generated": true, "customer_id": "<string>", "product_id": "<string>", "discount_id": "<string>", "subscription_id": "<string>", "checkout_id": "<string>", "metadata": {}, "platform_fee_amount": 123, "platform_fee_currency": "usd", "customer": { "id": "<string>", "created_at": "2023-11-07T05:31:56Z", "modified_at": "2023-11-07T05:31:56Z", "metadata": {}, "email_verified": true, "type": "individual", "name": "John Doe", "billing_address": { "country": "AD", "line1": "<string>", "line2": "<string>", "postal_code": "<string>", "city": "<string>", "state": "<string>" }, "tax_id": { "[0]": "<string>" }, "organization_id": "<string>", "deleted_at": "2023-11-07T05:31:56Z", "avatar_url": "<string>", "external_id": "usr_1337", "email": "customer@example.com", "locale": "<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>", "visibility": "draft", "recurring_interval": "day", "recurring_interval_count": 123, "is_recurring": true, "is_archived": true, "organization_id": "<string>" }, "discount": { "duration": "once", "type": "fixed", "amount": 123, "currency": "<string>", "amounts": {}, "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": "<string>" }, "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", "recurring_interval_count": 123, "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>", "seats": 123 }, "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>" } ], "description": "<string>", "seats": 123, "custom_field_data": {} } }

General

Core API

Customer Portal API

Webhook Events

Integrations