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 | JSON: id, type, version, source, created_at, occurred_at, data |
| Delivery | At least once |
| Idempotency | Deduplicate on the envelope’s id: it is covered by the signature, and every retry and replay of this event repeats it. The X-Cope-Event-Id header carries the same value but is not signed. |
| Source | cope.payment |
| Category | Payments |
| Availability | Available in the public webhook reference. |
| Schema title | payment.sale.succeeded webhook body |
| Schema ID | https://schemas.cope.com/webhooks/payment.sale.succeeded/v1 |
Payload Fields
| Field | Required | Type | Allowed Values | Description |
|---|---|---|---|---|
attribution | yes | `object | null` | - |
business | no | object | - | - |
buyer | yes | object | - | The buyer as the checkout captured them. email is null when the checkout did not ask for one. |
currency | no | string | - | - |
event_type | yes | const | payment.sale.succeeded | - |
first_click_ref | no | `string | null` | - |
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 | - | One entry per line the payment covers. |
mor_posture | no | string | - | - |
occurred_at | yes | string | - | - |
order | no | object | - | The order this payment is for. order.metadata is the metadata attached to the cart. Use it to group the payment with your own records, but identify the order by order.id: on a cart created with your publishable key or from a checkout link, the buyer can set or change the metadata before paying, so it is not proof of which order is yours. On a cart created from an offer or with a secret API key the metadata is locked. |
payment | no | object | - | - |
payment_chunk | no | object | - | The payment chunk this event concerns. Carries object (what it is) and id (which one); id is the public identifier a merchant addresses it by. |
payment_method | yes | `object | null` | - |
phone_offer_id | no | `string | null` | - |
promo | yes | `object | null` | - |
promo_code | no | `string | null` | - |
rail | no | string | - | - |
schema_version | yes | const | 1.5 | - |
seller_vat_info | no | `object | null` | - |
subscription_renewal | no | boolean | - | Optional. true when this payment is a recurring charge: a subscription renewal, the first charge once a trial ends, or a later instalment, whether collected against a card processor’s invoice or charged to the buyer’s PayPal by COPE’s renewal schedule. Absent on the first purchase and on an instalment payoff, and on events sent before this field shipped, so treat absent and false alike. On a subscription renewal the amount charged, tax included, is the subscription’s recurring amount: the same at every renewal, including on a subscription sold at a net price, until a price or plan change replaces it. The tax is calculated again from that amount at each renewal, so the net and tax figures can differ slightly from the purchase’s while the total stays the same. An instalment keeps the net and tax split agreed at purchase. |
supply_classification | no | string | - | Whether this sale is an electronically supplied service (“ess”) or not (“non_ess”), decided by cart from the products on the payment: non_ess only when EVERY line is. It determines which document the buyer is owed — COPE is deemed supplier for an ESS sale and issues an invoice; for a non-ESS sale it is a payment agent and issues a payment confirmation. Absent means a producer that predates the field; consumers fall back to the invoice rather than silently downgrading a document. Deliberately not an enum so a new classification cannot reject events against an older schema. |
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 delivery
{
"created_at": "2026-05-05T12:00:00.000Z",
"data": {
"attribution": {
"fbclid": "IwAR3pX7kQ9mZ2vL8sT1",
"gclid": "Cj0KCQjw8e2xBhD3ARIsAA",
"msclkid": "4f7a9c2e1b3d4e6f8a0b1c2d3e4f5a6b",
"ttclid": "E.C.P.Cn8kQ2vX7mL",
"utm_campaign": "spring_sale",
"utm_content": "hero_banner",
"utm_medium": "email",
"utm_source": "newsletter",
"utm_term": "watercolour"
},
"business": {
"id": "biz_g7-Jq2PxT_4mRvNa",
"name": "Northwind Studio",
"object": "business"
},
"buyer": {
"billing_address": {
"city": "Musterstadt",
"country": "DE",
"line1": "Musterstraße 1",
"line2": "2nd floor",
"postal_code": "12345",
"region": "Musterland"
},
"company_name": "Mustermann Analytics GmbH",
"email": "erika.mustermann@example.com",
"first_name": "Erika",
"full_name": "Erika Mustermann",
"last_name": "Mustermann",
"locale": "de",
"phone": "+1 202 555 0143",
"private_person": false,
"shipping_address": {
"city": "Musterstadt",
"country": "DE",
"line1": "Musterstraße 1",
"line2": "2nd floor",
"postal_code": "12345",
"region": "Musterland"
},
"tax_id": "DE000000000"
},
"currency": "EUR",
"event_type": "payment.sale.succeeded",
"first_click_ref": "partner-anna",
"invoice_number": "INV-2026-000042",
"line_items": [
{
"amounts": {
"gross_cents": 4900,
"net_cents": 4118,
"tax_cents": 782,
"tax_percentage": 19
},
"base_net_amount_cents": 4118,
"commission_notional_vat_bps": 1900,
"currency": "EUR",
"discount": {
"applied_cents": 1000,
"original_gross_cents": 5900
},
"is_trial": false,
"payment_number": 1,
"payment_plan": {
"id": "plan_Yr8K2vPd",
"object": "payment_plan"
},
"plan": {
"charge_shipping_once": false,
"display_name": "Monthly membership",
"first_payment_gross_cents": 4900,
"interval": "month",
"interval_count": 1,
"next_payment_gross_cents": 4900,
"payments_count": null,
"plan_type": "subscription",
"shipping_depend_on_quantity": false,
"shipping_price_cents": 500
},
"platform_fee_amount_cents": 490,
"product": {
"id": "prod_Hq2W8xLm",
"object": "product",
"refund_period_days": 14
},
"promo_applies": true,
"quantity": 1,
"shipping": {
"gross_cents": 500,
"net_cents": 420,
"tax_cents": 80,
"tax_percentage": 19
},
"subscription": {
"id": "ps_Gm3Tq8ZrW1bN",
"object": "subscription"
},
"tax_breakdown": [
{
"jurisdiction": "DE",
"jurisdiction_type": "Country",
"rate": 0.19,
"tax_amount": 7.82,
"tax_name": "VAT"
}
]
}
],
"mor_posture": "mor",
"occurred_at": "2026-05-12T16:30:12Z",
"order": {
"created_at": "2026-05-12T16:28:04Z",
"currency": "EUR",
"id": "ord_V7kP2mQx9RtL",
"metadata": {},
"object": "order",
"source": "checkout"
},
"payment": {
"id": "py_4nHs8QwZ2pLk",
"object": "payment"
},
"payment_chunk": {
"id": "pc_Tz6Rb1Vc9KdQ",
"object": "payment_chunk"
},
"payment_method": {
"brand": "visa",
"last4": "4242",
"type": "card"
},
"phone_offer_id": "spring-call-01",
"promo": {
"amount_discounted_cents": 1000,
"code": "SPRING10",
"currency": "EUR"
},
"promo_code": "SPRING10",
"rail": "stripe",
"schema_version": "1.5",
"seller_vat_info": {
"address": "Beispielweg 7, 54321 Beispielstadt, Germany",
"email": "billing@northwind-studio.example.com",
"name": "Northwind Studio GmbH",
"phone": "+1 202 555 0178",
"tax_id": "DE000000001"
},
"subscription_renewal": false,
"supply_classification": "ess",
"totals": {
"product": {
"gross_cents": 4900,
"net_cents": 4118,
"tax_cents": 782
},
"provider_result": "positive",
"shipping": {
"gross_cents": 500,
"net_cents": 420,
"tax_cents": 80
},
"tax_treatment": "standard",
"total": {
"gross_cents": 5400,
"net_cents": 4538,
"tax_cents": 862
}
},
"vat_mode": "cope_vat",
"vat_responsibility": "cope"
},
"id": "8d2f6c1a-4e7b-4a39-b5d0-2c9e1f7a3b64",
"occurred_at": "2026-05-05T11:59:58.500Z",
"source": "cope.payment",
"type": "payment.sale.succeeded",
"version": "v1"
}