order.paid

Sent when an order is paid.

When you receive this event, the order is fully processed and payment has been received.

Discord & Slack support: Full

type

string

required

Allowed value: "order.paid"

Example:

"order.paid"

data

object

required

data.created_at

string

required

Creation timestamp of the object.

data.modified_at

string | null

required

Last modification timestamp of the object.

data.id

string

required

The ID of the object.

data.metadata

object

required

data.status

enum<string>

required

Available options:

pending,

paid,

refunded,

partially_refunded

Example:

"paid"

data.paid

boolean

required

Whether the order has been paid for.

Example:

true

data.subtotal_amount

integer

required

Amount in cents, before discounts and taxes.

data.discount_amount

integer

required

Discount amount in cents.

data.net_amount

integer

required

Amount in cents, after discounts but before taxes.

data.amount

integer

required

deprecated

Amount in cents, after discounts but before taxes.

data.tax_amount

integer

required

Sales tax amount in cents.

data.total_amount

integer

required

Amount in cents, after discounts and taxes.

data.refunded_amount

integer

required

Amount refunded in cents.

data.refunded_tax_amount

integer

required

Sales tax refunded in cents.

data.currency

string

required

data.billing_reason

enum<string>

required

Available options:

purchase,

subscription_create,

subscription_cycle,

subscription_update

data.billing_address

object | null

required

data.customer_id

string

required

data.product_id

string

required

data.product_price_id

string

required

deprecated

data.discount_id

string | null

required

data.subscription_id

string | null

required

data.checkout_id

string | null

required

data.customer

object

required

data.customer.id

string

required

The ID of the customer.

Example:

"992fae2a-2a17-4b7a-8d9e-e287cf90131b"

data.customer.created_at

string

required

Creation timestamp of the object.

data.customer.modified_at

string | null

required

Last modification timestamp of the object.

data.customer.metadata

object

required

data.customer.external_id

string | null

required

The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated.

Example:

"usr_1337"

data.customer.email

string

required

The email address of the customer. This must be unique within the organization.

Example:

"customer@example.com"

data.customer.email_verified

boolean

required

Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address.

Example:

true

data.customer.name

string | null

required

The name of the customer.

Example:

"John Doe"

data.customer.billing_address

object | null

required

data.customer.tax_id

any[] | null

required

Example:

["911144442", "us_ein"]

data.customer.organization_id

string

required

The ID of the organization owning the customer.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

data.customer.deleted_at

string | null

required

Timestamp for when the customer was soft deleted.

data.customer.avatar_url

string

required

Example:

"https://www.gravatar.com/avatar/xxx?d=blank"

data.user_id

string

required

deprecated

data.user

object

required

deprecated

data.product

object

required

data.product_price

object

required

deprecated

A recurring price for a product, i.e. a subscription.

Deprecated: The recurring interval should be set on the product itself.

data.discount

object | null

required

data.subscription

object | null

required

data.subscription.metadata

object

required

data.subscription.created_at

string

required

Creation timestamp of the object.

data.subscription.modified_at

string | null

required

Last modification timestamp of the object.

data.subscription.id

string

required

The ID of the object.

data.subscription.amount

integer

required

The amount of the subscription.

data.subscription.currency

string

required

The currency of the subscription.

data.subscription.recurring_interval

enum<string>

required

The interval at which the subscription recurs.

Available options:

month,

year

data.subscription.status

enum<string>

required

The status of the subscription.

Available options:

incomplete,

incomplete_expired,

trialing,

active,

past_due,

canceled,

unpaid

data.subscription.current_period_start

string

required

The start timestamp of the current billing period.

data.subscription.current_period_end

string | null

required

The end timestamp of the current billing period.

data.subscription.cancel_at_period_end

boolean

required

Whether the subscription will be canceled at the end of the current period.

data.subscription.canceled_at

string | null

required

The timestamp when the subscription was canceled. The subscription might still be active if cancel_at_period_end is true.

data.subscription.started_at

string | null

required

The timestamp when the subscription started.

data.subscription.ends_at

string | null

required

The timestamp when the subscription will end.

data.subscription.ended_at

string | null

required

The timestamp when the subscription ended.

data.subscription.customer_id

string

required

The ID of the subscribed customer.

data.subscription.product_id

string

required

The ID of the subscribed product.

data.subscription.discount_id

string | null

required

The ID of the applied discount, if any.

data.subscription.checkout_id

string | null

required

data.subscription.customer_cancellation_reason

enum<string> | null

required

Available options:

customer_service,

low_quality,

missing_features,

switched_service,

too_complex,

too_expensive,

unused,

other

data.subscription.customer_cancellation_comment

string | null

required

data.subscription.price_id

string

required

deprecated

data.subscription.user_id

string

required

deprecated

data.items

object[]

required

Line items composing the order.

An order line item.

data.custom_field_data

object

Key-value object storing custom field values.

Was this page helpful?

order.created

order.updated

{
  "type": "order.paid",
  "data": {
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "metadata": {},
    "custom_field_data": {},
    "status": "paid",
    "paid": true,
    "subtotal_amount": 123,
    "discount_amount": 123,
    "net_amount": 123,
    "amount": 123,
    "tax_amount": 123,
    "total_amount": 123,
    "refunded_amount": 123,
    "refunded_tax_amount": 123,
    "currency": "<string>",
    "billing_reason": "purchase",
    "billing_address": {
      "line1": "<string>",
      "line2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "US"
    },
    "customer_id": "<string>",
    "product_id": "<string>",
    "product_price_id": "<string>",
    "discount_id": "<string>",
    "subscription_id": "<string>",
    "checkout_id": "<string>",
    "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=blank"
    },
    "user_id": "<string>",
    "user": {
      "id": "<string>",
      "email": "<string>",
      "public_name": "<string>",
      "avatar_url": "<string>",
      "github_username": "<string>"
    },
    "product": {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "recurring_interval": "month",
      "is_recurring": true,
      "is_archived": true,
      "organization_id": "<string>"
    },
    "product_price": {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "amount_type": "<string>",
      "is_archived": true,
      "product_id": "<string>",
      "type": "<string>",
      "recurring_interval": "month",
      "price_currency": "<string>",
      "price_amount": 123,
      "legacy": true
    },
    "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": "month",
      "status": "incomplete",
      "current_period_start": "2023-11-07T05:31:56Z",
      "current_period_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>",
      "price_id": "<string>",
      "user_id": "<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>"
      }
    ]
  }
}

Core API

Customer Portal API

Webhook Events

OAuth 2.0 API