--- title: "Payloads - Examples" slug: "payloads-beispiele" updated: 2026-06-09T12:58:55Z published: 2026-06-09T12:58:55Z canonical: "help.frisbii.com/payloads-beispiele" --- > ## Documentation Index > Fetch the complete documentation index at: https://help.frisbii.com/llms.txt > Use this file to discover all available pages before exploring further. # Payloads - Examples The following callbacks are triggered by Frisbii Media: | Callback type | Entity type | Entity | Description | | --- | --- | --- | --- | | CREATION | APP_STORE_ORDER | AppStoreOrder | Create or update an existing order via an app store (Apple or Google) | | CHANGE | APP_STORE_SUBSCRIPTION | AppStoreSubscription | Sent when activating or deactivating the App Store subscription | | CREATION | APP_STORE_SUBSCRIPTION | AppStoreSubscription | Sent when creating an App Store subscription | | CHANGE | CUSTOMER | Customer | Sent when changing customer-related data - for example user name, password, e-mail, name, title, status or other data or token verification | | CREATION | CUSTOMER | Customer | Sent during customer creation or registration | | DELETION | CUSTOMER | - | Notifies of customer deletion | | CHANGE | CUSTOMER_OPT_IN | OptIns | Sent when creating or updating the customer opt-in | | PAYMENT_FAILED | FAILED_PAYMENT | FailedPaymentNotification | Sent in the event of a failed payment | | CHANGE | INVOICE | Invoice | Sent in the event of an invoice change - cancellation, correction, status change | | CREATION | INVOICE | Invoice | Sent during invoicing | | CREATION | INVOICE_CANCELLATION | Invoice | Sent in case of invoice cancellation | | CREATION | INVOICE_CORRECTION | Invoice | Sent with invoice correction | | CANCELLATION | MULTIUSER_SUBSCRIPTION | MultiuserSubscription | Sent when canceling a multi-user subscription | | CREATION | MULTIUSER_SUBSCRIPTION | MultiuserSubscription | Sent when creating a multi-user subscription | | UNDO_CANCELLATION | MULTIUSER_SUBSCRIPTION | MultiuserSubscription | Sent when withdrawing cancellation of a multi-user subscription | | CREATION | ORDER | Order | Sent with order | | CONDITIONS_FULFILLED | PURCHASED_ADDON | PurchasedAddon | Sent when ordering if there are purchased add-ons | | CANCELLATION | SUBSCRIPTION | Subscription | Sent when the subscription is canceled | | CHANGE | SUBSCRIPTION | Subscription | Sent when the subscription is changed | | CREATION | SUBSCRIPTION | Subscription | Sent when the subscription is created | | ENDED | SUBSCRIPTION | Subscription | Sent when the subscription ends | | UNDO_CANCELLATION | SUBSCRIPTION | Subscription | Sent on withdrawal of cancellation | | CREATION | CALLBACK_RENEWAL | ApiAccessTokenCallback | Sent when API access token is renewed | 💡 All schematics can be found in the attached document. > [!TIP] > **Note:** The following examples are intended to provide an exemplary impression of the data to be expected. However, the scope of the data may vary. Before going live, the callbacks should be checked on the stage system. ### General structure of a callback ```json {  "entityType": "CUSTOMER", -> the entity for which the callback was created (customer/invoice/subscription/etc.)  "callbackType": "CREATION", -> the corresponding callback type (create/modify/delete/etc.) "entityId": "29", - entityId corresponds to the customer ID/invoice ID/subscription ID/etc. depending on the entityType.)  "entityId": "29", -> entityId corresponds to the customer ID/invoice ID/subscription ID/etc. depending on the entityType  "entity": { -> the data of the entity according to the API documentation     xxxx } } ``` ### Create customer ```json {  "entityType": "CUSTOMER",  "callbackType": "CREATION",  "entityId": "29",  "entity": {    "ageVerificationPinEnabled": false,    "birthday": null,    "changedBy": "10001",    "changedByType": "MERCHANT",    "changedDate": "2024-08-27T11:49:41.389622Z",    "createdBy": "10001",    "createdByType": "MERCHANT",    "createdDate": "2024-08-27T11:49:41.389622Z",    "customerId": "29",    "email": "plenigo+callback@plenigo.com",    "externalSystemId": "",    "firstName": "Test",    "invoiceEmail": "",    "language": "de",    "lastName": "",    "miscellaneousData": {},    "mobileNumber": "",    "registrationDate": "2024-08-27T11:49:41.389622Z",    "registrationSource": "Supporter",    "salutation": "",    "ssoLoginProviders": null,    "status": "ACTIVATED",    "twoFactorEnabled": false,    "username": "Test"  } } ``` ### Create invoice ```json {  "entityType": "INVOICE",  "callbackType": "CREATION",  "entityId": "223",  "entity": {    "accumulatedPrice": 0.5,    "analogInvoice": false,    "cancellationInvoiceId": 0,    "changedDate": "2024-08-28T00:08:51.914437Z",    "currency": "EUR",    "customerEmail": "plenigo@plenigo.com",    "invoiceAddress": {      "businessAddress": false,      "city": "Kempten",      "country": "DE",      "firstName": "Test",      "lastName": "User",      "postbox": "48576525",      "postcode": "87435",      "salutation": "NONE",      "type": "INVOICE"    },    "invoiceCustomerId": "23",    "invoiceDate": "2024-08-28T00:08:51.868510Z",    "invoiceId": 223,    "items": [      {        "changedDate": "2024-08-28T00:08:51.916800Z",        "createdDate": "2024-08-28T00:08:51.916800Z",        "deliveryAddress": {          "businessAddress": false,          "country": "DE",          "salutation": "NONE",          "type": "DELIVERY"        },        "deliveryCustomerId": "23",        "discountPercentage": 0,        "periodEndDate": "2024-08-29T23:59:59.000000Z",        "periodStartDate": "2024-08-28T00:00:00.000000Z",        "plenigoOfferId": "O_D0SO735QL1AXZH7FTG",        "plenigoProductId": "P_DSQ20PV66PNWGK0LPV",        "plenigoStepId": "S_O38DOOQI9ZE6DESDWC",        "position": 1,        "price": 0.5,        "productId": "P_DSQ20PV66PNWGK0LPV",        "purchasedAddonId": 0,        "quantity": 1,        "subscriptionItemId": 1230101,        "tax": 7,        "taxCountry": "DE",        "taxType": "DIGITALNEWSPAPER",        "title": "Angebot A kurzes Abo-Intervall Leistungszeitraum 28.08.2024 - 29.08.2024"      }    ],    "orderId": 0,    "paymentChangedToBilling": false,    "paymentMethod": "BILLING",    "paymentMethodId": 0,    "precursorId": 0,    "status": "NOT_PAID",    "successorId": 0,    "type": "INVOICE"  } } ``` ### Change subscription ```json {  "entityType": "SUBSCRIPTION",  "callbackType": "CHANGE",  "entityId": "1230116",  "entity": {    "accessBlocked": false,    "accountingPeriod": 0,    "accountingPeriodTimeSpan": "NONE",    "activePartners": null,    "analogInvoice": false,    "cancellationDate": null,    "cancellationPeriod": 5,    "cancellationPeriodTimeSpan": "DAY",    "cancellationReasonUniqueId": "",    "cancellationType": "ISSUE_BASED_REGULAR",    "chainId": 1230116,    "changedBy": "PLENIGO",    "changedByType": "SYSTEM",    "changedDate": "2024-08-28T00:00:07.717485Z",    "chargeableDeliveries": 8,    "connectedOffer": false,    "connectedOfferInfo": null,    "createdBy": "8",    "createdByType": "CUSTOMER",    "createdDate": "2024-08-02T09:43:13.41412Z",    "currency": "EUR",    "customerCancellationBlocked": false,    "customerCancellationReasonId": 0,    "deliveries": 8,    "deliveryAddressId": 1230037,    "deliveryCustomerId": "8",    "deliveryPaused": null,    "durationPeriod": 0,    "durationPeriodTimeSpan": "NONE",    "endDate": null,    "externalBilling": false,    "externalSystemId": "",    "finishedDeliveries": 4,    "firstBookingDate": "2024-08-02T09:43:13.348227Z",    "invoiceAddressId": 1230038,    "invoiceCustomerId": "8",    "items": null,    "lastBookingDate": "2024-08-02T09:43:13.348227Z",    "managedBy": "PLENIGO",    "managedExternal": false,    "nextBookingDate": null,    "openDeliveries": 4,    "paused": null,    "paymentMethod": "CREDIT_CARD",    "paymentMethodDetails": {      "brand": "AMERICAN_EXPRESS"    },    "paymentMethodId": 1230005,    "paymentPaused": null,    "paymentTriesDone": 0,    "plenigoOfferId": "O_628IU8F9CB7I6EH5ZG",    "precursorId": 0,    "precursorReason": "",    "precursorReasonDetail": "",    "purchaseOrderIndicator": "",    "recurringDeliveries": false,    "referenceStartDate": "2024-08-02T00:00:00Z",    "startDate": "2024-08-02T09:43:13.348191Z",    "status": "ACTIVE",    "subscriptionId": 1230116,    "subscriptionType": "ISSUE_BASED",    "successorId": 0,    "successorReason": "",    "successorReasonDetail": "",    "suppressInvoiceSending": false,    "term": 0,    "termTimeSpan": "NONE"  } } ``` ### Delete customer ```json {  "entityType": "CUSTOMER",  "callbackType": "DELETION",  "entityId": "33",  "entity": null } ``` > [!CAUTION] > *entityId* is the customer number. *Entity* = processed data, here zero, as the data concerned has been deleted. ### Create in-app subscription ```json {  "entityType": "APP_STORE_SUBSCRIPTION",  "callbackType": "CREATION",  "version": "3.0",  "entityId": "1230306",  "entity": {    "accessRightUniqueId": "inappsub",    "appStoreSubscriptionId": 1230206,    "cancellationDate": "null",    "chainId": 1230206,    "changedBy": "2VYpOnyFbem8IWY9DyoVaLgOAuG",    "changedByType": "API",    "changedDate": 2023-12-29T15:02:05.353082Z",    "customerId": "29",    "endDate": "2023-12-29T15:06:32.364Z",    "externalSystemId: "subscription_1_app_2",    "startDate": "2023-12-29T15:01:34.393Z",    "status": "ACTIVE"   } } ``` --- ## Sales rule callback examples The following examples show the key fields that distinguish rule-driven subscription callbacks from regular user cancellations. ### Age-related rule: ENDED callback ```json {  "entityType": "SUBSCRIPTION",  "callbackType": "ENDED",  "entityId": "1230200",  "entity": {    "subscriptionId": 1230200,    "status": "INACTIVE",    "cancellationDate": null,    "endDate": "2025-03-15T00:00:00Z",    "successorReason": "AGE",    "successorReasonDetail": "",    "successorId": 1230201,    "precursorReason": "",    "precursorId": 0,    "plenigoOfferId": "O_UNDER25_OFFER",    "startDate": "2022-03-15T00:00:00Z",    "changedBy": "PLENIGO",    "changedByType": "SYSTEM",    "changedDate": "2025-03-15T00:00:01Z"  } } ``` > The `successorReason: "AGE"` and `successorId` pointing to the follow-up subscription are the key signals. > > No `cancellationDate` is set. ### Cross-selling (tag-based): CANCELLATION on auto-canceled dependent subscription ```json {  "entityType": "SUBSCRIPTION",  "callbackType": "CANCELLATION",  "entityId": "1230310",  "entity": {    "subscriptionId": 1230310,    "status": "ACTIVE",    "cancellationDate": "2025-06-01T10:00:00Z",    "endDate": "2025-07-01T00:00:00Z",    "successorReason": "",    "successorReasonDetail": "",    "successorId": 0,    "precursorReason": "",    "precursorId": 0,    "plenigoOfferId": "O_DISCOUNTED_OFFER",    "startDate": "2024-06-01T00:00:00Z",    "changedBy": "PLENIGO",    "changedByType": "SYSTEM",    "changedDate": "2025-06-01T10:00:01Z"  } } ``` > Note that this payload is **identical in shape to a user cancellation** — `cancellationDate` is set, `successorReason` is empty. > > The auto-cancel triggered by a cross-selling relation rule cannot be reliably distinguished from a manual cancel based on the payload alone. ### Up-/down-selling: CHANGE on old subscription (transition: NOW / END_OF_TERM / NEXT_BOOKING) ```json {  "entityType": "SUBSCRIPTION",  "callbackType": "CHANGE",  "entityId": "1231822",  "entity": {    "accessBlocked": false,    "accountingPeriod": 1,    "accountingPeriodTimeSpan": "DAY",    "activePartners": null,    "analogInvoice": false,    "cancellationDate": null,    "cancellationPeriod": 1,    "cancellationPeriodTimeSpan": "DAY",    "cancellationReasonUniqueId": "",    "cancellationType": "TIME_BASED",    "chainId": 1231822,    "changedBy": "66666668260",    "changedByType": "CUSTOMER",    "changedDate": "2026-06-03T07:41:50.242229Z",    "chargeableDeliveries": 0,    "connectedOffer": false,    "connectedOfferInfo": null,    "createdBy": "66666668260",    "createdByType": "CUSTOMER",    "createdDate": "2026-06-03T07:41:15.892031Z",    "currency": "EUR",    "customerCancellationBlocked": false,    "customerCancellationReasonId": 0,    "deliveries": 0,    "deliveryAddressId": 1230755,    "deliveryCustomerId": "66666668260",    "deliveryPaused": null,    "durationPeriod": 0,    "durationPeriodTimeSpan": "MONTH",    "endDate": "2026-06-05T00:00:00Z",    "externalBilling": false,    "externalSystemId": "",    "finishedDeliveries": 0,    "firstBookingDate": "2026-06-03T07:41:15.815532Z",    "invoiceAddressId": 0,    "invoiceCustomerId": "66666668260",    "items": [      {        "accessRightUniqueId": "time-misc",        "chainItemId": 1232077,        "changedBy": "66666668260",        "changedByType": "CUSTOMER",        "changedDate": "2026-06-03T07:41:50.247454Z",        "connectedOfferInfo": null,        "corporateAccountId": 0,        "costCenter": "",        "createdBy": "66666668260",        "createdByType": "CUSTOMER",        "createdDate": "2026-06-03T07:41:15.892031Z",        "creditCount": 0,        "creditWalletUniqueId": "",        "discountPercentage": 0,        "discountSettings": null,        "internalTitle": "Test",        "multiuserSettings": null,        "packageCancellationLocked": false,        "packageId": "",        "packageTitle": "",        "plenigoProductId": "P_NWM7KKEIW1970TR1NS",        "plenigoStepId": "S_O0AHMK0A2862NKMSB0",        "price": 1,        "priceIssueId": 100041,        "productContractId": 100080,        "productId": "P_NWM7KKEIW1970TR1NS",        "purchaseNumber": "",        "quantity": 1,        "status": "ACTIVE",        "subscriptionItemId": 1232077,        "taxType": "DIGITALPRODUCT",        "title": "Test"      }    ],    "lastBookingDate": "2026-06-03T07:41:15.815532Z",    "managedBy": "PLENIGO",    "managedExternal": false,    "multiuserSettings": null,    "nextBookingDate": "2026-06-04T00:00:00Z",    "openDeliveries": 0,    "paused": null,    "paymentMethod": "CREDIT_CARD",    "paymentMethodDetails": {      "brand": "VISA"    },    "paymentMethodId": 1230295,    "paymentPaused": null,    "paymentTriesDone": 0,    "plenigoOfferId": "O_MSNCU5I4FL4K08QXKJ",    "precursorId": 0,    "precursorReason": "",    "precursorReasonDetail": "",    "purchaseOrderIndicator": "",    "recurringDeliveries": false,    "referenceStartDate": "2026-06-03T00:00:00Z",    "startDate": "2026-06-03T07:41:15.815512Z",    "status": "ACTIVE",    "subscriptionId": 1231822,    "subscriptionType": "TIME_BASED",    "successorId": 1231823,    "successorReason": "CROSS_SELLING",    "successorReasonDetail": "END_OF_TERM",    "successorReasonMerchant": "",    "suppressInvoiceSending": false,    "term": 2,    "termTimeSpan": "DAY"  } } ``` > The `successorReason: "CROSS_SELLING"` and populated `successorId` identify this as a rule-driven offer change. `successorReasonDetail` reflects the configured transition option (`NOW`, `END_OF_TERM`, or `NEXT_BOOKING`). ### Up-/down-selling: CANCELLATION on old subscription (transition: LAST_BOOKING / NOW_WITH_INVOICING) ```json {  "entityType": "SUBSCRIPTION",  "callbackType": "CANCELLATION",  "entityId": "1231820",  "entity": {    "accessBlocked": false,    "accountingPeriod": 1,    "accountingPeriodTimeSpan": "DAY",    "activePartners": null,    "analogInvoice": false,    "cancellationDate": null,    "cancellationPeriod": 1,    "cancellationPeriodTimeSpan": "DAY",    "cancellationReasonUniqueId": "",    "cancellationType": "TIME_BASED",    "chainId": 1231820,    "changedBy": "PLENIGO",    "changedByType": "SYSTEM",    "changedDate": "2026-06-03T07:36:28.184834Z",    "chargeableDeliveries": 0,    "connectedOffer": false,    "connectedOfferInfo": null,    "createdBy": "66666668260",    "createdByType": "CUSTOMER",    "createdDate": "2026-06-03T07:35:53.851576Z",    "currency": "EUR",    "customerCancellationBlocked": false,    "customerCancellationReasonId": 0,    "deliveries": 0,    "deliveryAddressId": 1230755,    "deliveryCustomerId": "66666668260",    "deliveryPaused": null,    "durationPeriod": 0,    "durationPeriodTimeSpan": "MONTH",    "endDate": "2026-06-03T07:35:53.778014Z",    "externalBilling": false,    "externalSystemId": "",    "finishedDeliveries": 0,    "firstBookingDate": "2026-06-03T07:35:53.778031Z",    "invoiceAddressId": 0,    "invoiceCustomerId": "66666668260",    "items": [      {        "accessRightUniqueId": "time-misc",        "chainItemId": 1232074,        "changedBy": "66666668260",        "changedByType": "CUSTOMER",        "changedDate": "2026-06-03T07:36:28.192109Z",        "connectedOfferInfo": null,        "corporateAccountId": 0,        "costCenter": "",        "createdBy": "66666668260",        "createdByType": "CUSTOMER",        "createdDate": "2026-06-03T07:35:53.851576Z",        "creditCount": 0,        "creditWalletUniqueId": "",        "discountPercentage": 0,        "discountSettings": null,        "internalTitle": "Test",        "multiuserSettings": null,        "packageCancellationLocked": false,        "packageId": "",        "packageTitle": "",        "plenigoProductId": "P_VFQFK5I7XLL2OW03BA",        "plenigoStepId": "S_XP3FJQH32LX3WVWRHC",        "price": 1,        "priceIssueId": 100041,        "productContractId": 100080,        "productId": "P_VFQFK5I7XLL2OW03BA",        "purchaseNumber": "",        "quantity": 1,        "status": "ACTIVE",        "subscriptionItemId": 1232074,        "taxType": "DIGITALPRODUCT",        "title": "Test"      }    ],    "lastBookingDate": "2026-06-03T07:35:53.778031Z",    "managedBy": "PLENIGO",    "managedExternal": false,    "multiuserSettings": null,    "nextBookingDate": null,    "openDeliveries": 0,    "paused": null,    "paymentMethod": "CREDIT_CARD",    "paymentMethodDetails": {      "brand": "VISA"    },    "paymentMethodId": 1230295,    "paymentPaused": null,    "paymentTriesDone": 0,    "plenigoOfferId": "O_9MDKAABUM8FG7TT5KB",    "precursorId": 0,    "precursorReason": "",    "precursorReasonDetail": "",    "purchaseOrderIndicator": "",    "recurringDeliveries": false,    "referenceStartDate": "2026-06-03T00:00:00Z",    "startDate": "2026-06-03T07:35:53.778014Z",    "status": "ACTIVE",    "subscriptionId": 1231820,    "subscriptionType": "TIME_BASED",    "successorId": 1231821,    "successorReason": "CROSS_SELLING",    "successorReasonDetail": "LAST_BOOKING",    "successorReasonMerchant": "",    "suppressInvoiceSending": false,    "term": 2,    "termTimeSpan": "DAY"  } } ``` > For `LAST_BOOKING` and `NOW_WITH_INVOICING`, the callback type is `CANCELLATION` rather than `CHANGE`. > > The key distinguishing fields are `successorReason: "CROSS_SELLING"` and the populated `successorId` — these are never present on a plain user cancellation. --- ### Failed payment ```json {  "entityType": "FAILED_PAYMENT",  "callbackType": "PAYMENT_FAILED",  "entityId": "0",  "entity": {    "paymentRetry": 3,    "subscription": {      "accessBlocked": false,      "accountingPeriod": 1,      "accountingPeriodTimeSpan": "MONTH",      "activePartners": null,      "analogInvoice": false,      "cancellationDate": null,      "cancellationPeriod": 7,      "cancellationPeriodTimeSpan": "DAY",      "cancellationReasonUniqueId": "",      "cancellationType": "TIME_BASED",      "chainId": 1230391,      "changedBy": "10013",      "changedByType": "MERCHANT",      "changedDate": "2026-05-30T00:01:13.240032Z",      "chargeableDeliveries": 0,      "connectedOffer": false,      "connectedOfferInfo": null,      "createdBy": "10013",      "createdByType": "MERCHANT",      "createdDate": "2026-05-21T09:20:02.599792Z",      "currency": "EUR",      "customerCancellationBlocked": false,      "customerCancellationReasonId": 0,      "deliveries": 0,      "deliveryAddressId": 1230174,      "deliveryCustomerId": "97",      "deliveryPaused": null,      "durationPeriod": 0,      "durationPeriodTimeSpan": "MONTH",      "endDate": null,      "externalBilling": false,      "externalSystemId": "",      "finishedDeliveries": 0,      "firstBookingDate": "2026-05-21T09:20:02.395838Z",      "invoiceAddressId": 1230175,      "invoiceCustomerId": "97",      "items": [        {          "accessRightUniqueId": "Digi",          "chainItemId": 1230477,          "changedBy": "10013",          "changedByType": "MERCHANT",          "changedDate": "2026-05-21T09:20:02.599792Z",          "connectedOfferInfo": null,          "corporateAccountId": 0,          "costCenter": "",          "createdBy": "10013",          "createdByType": "MERCHANT",          "createdDate": "2026-05-21T09:20:02.599792Z",          "creditCount": 0,          "creditWalletUniqueId": "",          "discountPercentage": 0,          "discountSettings": null,          "internalTitle": "Monthly Subscription (Copy)",          "multiuserSettings": null,          "packageCancellationLocked": false,          "packageId": "",          "packageTitle": "",          "plenigoProductId": "P_A81TR7E86V3QTZ88NT",          "plenigoStepId": "S_P3PBYAXRG2ZKCIS02N",          "price": 17.99,          "priceIssueId": 100001,          "productContractId": 100001,          "productId": "P_A81TR7E86V3QTZ88NT",          "purchaseNumber": "",          "quantity": 1,          "status": "ACTIVE",          "subscriptionItemId": 1230477,          "taxType": "DIGITALNEWSPAPER",          "title": "Monthly Subscription"        }      ],      "lastBookingDate": "2026-05-21T09:20:02.395838Z",      "managedBy": "PLENIGO",      "managedExternal": false,      "multiuserSettings": null,      "nextBookingDate": "2026-06-01T00:00:00Z",      "openDeliveries": 0,      "paused": null,      "paymentMethod": "CREDIT_CARD",      "paymentMethodId": 1230037,      "paymentPaused": null,      "paymentTriesDone": 3,      "plenigoOfferId": "O_B6AN8XIDB96XXQDT7Y",      "precursorId": 0,      "precursorReason": "",      "precursorReasonDetail": "",      "purchaseOrderIndicator": "",      "recurringDeliveries": false,      "referenceStartDate": "2026-05-26T00:00:00Z",      "startDate": "2026-05-26T00:00:00Z",      "status": "ACTIVE",      "subscriptionId": 1230391,      "subscriptionType": "TIME_BASED",      "successorId": 0,      "successorReason": "",      "successorReasonDetail": "",      "successorReasonMerchant": "",      "suppressInvoiceSending": false,      "term": 1,      "termTimeSpan": "MONTH"    }  } } ``` ## Attachments - [Callback Schema.zip](https://cdn.document360.io/b84e1b5d-2ba6-4465-8c62-fb45a2f31314/Images/Documentation/Callback Schema.zip)