> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cope.com/llms.txt
> Use this file to discover all available pages before exploring further.

# payment.sale.succeeded

> A payment sale has succeeded.

# payment.sale.succeeded

> Generated from COPE public event contracts. Do not edit this page by hand.

Use this event when you need the payment-centric success fact for reconciliation, attribution, or downstream payment state transitions.

## Delivery Contract

| Field           | Value                                                                                |
| --------------- | ------------------------------------------------------------------------------------ |
| Encoding        | CloudEvents 1.0 structured JSON                                                      |
| Delivery        | At least once                                                                        |
| Idempotency     | Use the CloudEvents `source` + `id` tuple, or COPE `idempotency_key` when available. |
| Source          | `cope.payment`                                                                       |
| Subject pattern | `payment:<identifier>`                                                               |
| Category        | Payments                                                                             |
| Availability    | Available in the public webhook reference.                                           |
| Schema title    | payment.sale.succeeded v1 payload                                                    |
| Schema ID       | `https://schemas.cope.com/events/payment.sale.succeeded/v1`                          |

## Payload Fields

| Field                   | Required | Type     | Allowed Values            | Description                                                                                                                                                                                                               |                                                                                                                                                                                       |
| ----------------------- | -------- | -------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `additional_recipients` | no       | `array`  | -                         | Optional. Additional recipient email addresses configured in the vendor's notification settings. Each recipient receives an individually addressed copy of the notification email. Capped at 5 recipients.                |                                                                                                                                                                                       |
| `business`              | yes      | `object` | -                         | -                                                                                                                                                                                                                         |                                                                                                                                                                                       |
| `buyer`                 | yes      | `object` | -                         | -                                                                                                                                                                                                                         |                                                                                                                                                                                       |
| `currency`              | no       | `string` | -                         | -                                                                                                                                                                                                                         |                                                                                                                                                                                       |
| `event_type`            | yes      | `const`  | `payment.sale.succeeded`  | -                                                                                                                                                                                                                         |                                                                                                                                                                                       |
| `first_click_ref`       | no       | \`string | null\`                    | -                                                                                                                                                                                                                         | Raw, unvalidated affiliate reference captured from the inbound `?aff=` parameter. It is not a resolved or validated affiliate ID; COPE resolves and validates attribution downstream. |
| `invoice_number`        | no       | `string` | -                         | Sequential legal document number (§14 UStG) allocated atomically with this event — the invoice number on sale events and the credit-note number on refund events. Optional during rollout; may be absent on older events. |                                                                                                                                                                                       |
| `line_items`            | yes      | `array`  | -                         | -                                                                                                                                                                                                                         |                                                                                                                                                                                       |
| `occurred_at`           | yes      | `string` | -                         | -                                                                                                                                                                                                                         |                                                                                                                                                                                       |
| `order`                 | yes      | `object` | -                         | -                                                                                                                                                                                                                         |                                                                                                                                                                                       |
| `order_overview_url`    | no       | `string` | -                         | -                                                                                                                                                                                                                         |                                                                                                                                                                                       |
| `payment`               | no       | `object` | -                         | -                                                                                                                                                                                                                         |                                                                                                                                                                                       |
| `payment_method`        | yes      | \`object | null\`                    | -                                                                                                                                                                                                                         | -                                                                                                                                                                                     |
| `phone_offer_id`        | no       | \`string | null\`                    | -                                                                                                                                                                                                                         | Phone offer identifier associated with this sale, if any. Raw attribution signal only.                                                                                                |
| `promo`                 | yes      | \`object | null\`                    | -                                                                                                                                                                                                                         | -                                                                                                                                                                                     |
| `promo_code`            | no       | \`string | null\`                    | -                                                                                                                                                                                                                         | Promo code applied to this sale, if any. Raw attribution signal only.                                                                                                                 |
| `rail`                  | no       | `string` | -                         | -                                                                                                                                                                                                                         |                                                                                                                                                                                       |
| `schema_version`        | yes      | `const`  | `1.5`                     | -                                                                                                                                                                                                                         |                                                                                                                                                                                       |
| `seller_vat_info`       | no       | \`object | null\`                    | -                                                                                                                                                                                                                         | Seller identity used for invoicing when the creator is the VAT-liable party. Null when COPE is the VAT-liable party.                                                                  |
| `source_event_id`       | no       | `string` | -                         | -                                                                                                                                                                                                                         |                                                                                                                                                                                       |
| `source_event_type`     | no       | `const`  | `payment.sale.succeeded`  | -                                                                                                                                                                                                                         |                                                                                                                                                                                       |
| `totals`                | yes      | `object` | -                         | -                                                                                                                                                                                                                         |                                                                                                                                                                                       |
| `vat_mode`              | no       | `string` | `cope_vat`, `creator_vat` | Which party is liable for VAT on this sale: COPE (`cope_vat`) or the creator (`creator_vat`).                                                                                                                             |                                                                                                                                                                                       |
| `vat_responsibility`    | no       | `string` | `cope`, `creator`         | Which party remits VAT to the tax authority.                                                                                                                                                                              |                                                                                                                                                                                       |

## Example CloudEvent

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "data": {
    "business": {},
    "buyer": {},
    "event_type": "payment.sale.succeeded",
    "line_items": [
      {
        "amounts": {
          "gross_cents": 1000,
          "net_cents": 1000,
          "tax_cents": 1000,
          "tax_percentage": 19
        },
        "is_trial": true,
        "payment_number": 1000,
        "product": {},
        "quantity": 1000
      }
    ],
    "occurred_at": "2026-05-05T12:00:00.000Z",
    "order": {
      "created_at": "2026-05-05T12:00:00.000Z",
      "currency": "EUR",
      "source": "example_source"
    },
    "payment_method": {},
    "promo": {},
    "schema_version": "1.5",
    "totals": {
      "product": {
        "gross_cents": 1000,
        "net_cents": 1000,
        "tax_cents": 1000
      },
      "total": {
        "gross_cents": 1000,
        "net_cents": 1000,
        "tax_cents": 1000
      }
    }
  },
  "datacontenttype": "application/json",
  "dataschema": "https://schemas.cope.com/events/payment.sale.succeeded/v1",
  "id": "payment.sale.succeeded:example",
  "idempotency_key": "payment.sale.succeeded:example",
  "source": "cope.payment",
  "specversion": "1.0",
  "subject": "payment:example",
  "time": "2026-05-05T12:00:00.000Z",
  "type": "payment.sale.succeeded"
}
```

## Compatibility

Fields may be added within the same major version. Removing or changing the meaning of a documented field requires a new event version.