Skip to main content
WEBHOOK
checkout.created
{
  "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",
    "client_secret": "<string>",
    "url": "<string>",
    "expires_at": "2023-11-07T05:31:56Z",
    "success_url": "<string>",
    "return_url": "<string>",
    "embed_origin": "<string>",
    "amount": 123,
    "discount_amount": 123,
    "net_amount": 123,
    "tax_amount": 123,
    "total_amount": 123,
    "currency": "<string>",
    "allow_trial": true,
    "active_trial_interval_count": 123,
    "trial_end": "2023-11-07T05:31:56Z",
    "organization_id": "<string>",
    "product_id": "<string>",
    "product_price_id": "<string>",
    "discount_id": "<string>",
    "allow_discount_codes": true,
    "require_billing_address": true,
    "is_discount_applicable": true,
    "is_free_product_price": true,
    "is_payment_required": true,
    "is_payment_setup_required": true,
    "is_payment_form_required": true,
    "customer_id": "<string>",
    "is_business_customer": true,
    "customer_name": "<string>",
    "customer_email": "<string>",
    "customer_ip_address": "<string>",
    "customer_billing_name": "<string>",
    "customer_billing_address": {
      "line1": "<string>",
      "line2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "state": "<string>"
    },
    "customer_tax_id": "<string>",
    "payment_processor_metadata": {},
    "billing_address_fields": {},
    "trial_interval_count": 123,
    "metadata": {},
    "external_customer_id": "<string>",
    "customer_external_id": "<string>",
    "products": [
      {
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "trial_interval_count": 123,
        "name": "<string>",
        "description": "<string>",
        "recurring_interval_count": 123,
        "is_recurring": true,
        "is_archived": true,
        "organization_id": "<string>",
        "prices": [
          {
            "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>",
            "price_amount": 123
          }
        ],
        "benefits": [
          {
            "id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "modified_at": "2023-11-07T05:31:56Z",
            "description": "<string>",
            "selectable": true,
            "deletable": true,
            "organization_id": "<string>"
          }
        ],
        "medias": [
          {
            "id": "<string>",
            "organization_id": "<string>",
            "name": "<string>",
            "path": "<string>",
            "mime_type": "<string>",
            "size": 123,
            "storage_version": "<string>",
            "checksum_etag": "<string>",
            "checksum_sha256_base64": "<string>",
            "checksum_sha256_hex": "<string>",
            "last_modified_at": "2023-11-07T05:31:56Z",
            "version": "<string>",
            "service": "<string>",
            "is_uploaded": true,
            "created_at": "2023-11-07T05:31:56Z"
          }
        ],
        "product_type": "digital"
      }
    ],
    "product": {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "trial_interval_count": 123,
      "name": "<string>",
      "description": "<string>",
      "recurring_interval_count": 123,
      "is_recurring": true,
      "is_archived": true,
      "organization_id": "<string>",
      "prices": [
        {
          "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>",
          "price_amount": 123
        }
      ],
      "benefits": [
        {
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "selectable": true,
          "deletable": true,
          "organization_id": "<string>"
        }
      ],
      "medias": [
        {
          "id": "<string>",
          "organization_id": "<string>",
          "name": "<string>",
          "path": "<string>",
          "mime_type": "<string>",
          "size": 123,
          "storage_version": "<string>",
          "checksum_etag": "<string>",
          "checksum_sha256_base64": "<string>",
          "checksum_sha256_hex": "<string>",
          "last_modified_at": "2023-11-07T05:31:56Z",
          "version": "<string>",
          "service": "<string>",
          "is_uploaded": true,
          "created_at": "2023-11-07T05:31:56Z"
        }
      ],
      "product_type": "digital"
    },
    "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>",
      "price_amount": 123
    },
    "prices": {},
    "discount": {
      "amount": 123,
      "currency": "<string>",
      "id": "<string>",
      "name": "<string>",
      "code": "<string>"
    },
    "subscription_id": "<string>",
    "attached_custom_fields": [
      {
        "custom_field_id": "<string>",
        "custom_field": {
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "metadata": {},
          "type": "<string>",
          "slug": "<string>",
          "name": "<string>",
          "organization_id": "<string>",
          "properties": {
            "form_label": "<string>",
            "form_help_text": "<string>",
            "form_placeholder": "<string>",
            "textarea": true,
            "min_length": 1073741823,
            "max_length": 1073741823
          }
        },
        "order": 123,
        "required": true
      }
    ],
    "customer_metadata": {},
    "custom_field_data": {},
    "locale": "<string>",
    "seats": 123,
    "price_per_seat": 123
  }
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.spairehq.com/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json

Sent when a new checkout is created.

Discord & Slack support: Basic

​
type
string
required
Allowed value: "checkout.created"
Example:

"checkout.created"

​
timestamp
string<date-time>
required
​
data
Checkout · object
required

Checkout session data retrieved using an access token.

Response

Successful Response