Skip to main content

CreditNoteCreatedEventPayload

creditAmountinteger<int64>required
creditNoteIdstringrequired
currencystringrequired
customerIdstringrequired
lineItems object[]required
  • Array [
    • amountinteger<int64>required
    descriptionstringrequired
    externalLineItemIdstringnullable
    idstringrequired
    quantityinteger<int32>required
    typestringrequired
    unitAmountinteger<int64>required
  • ]
    • numberstringnullable
    organizationIdstringrequired
    outOfBandAmountinteger<int64>required
    paymentIdstringrequired
    reasonstringnullable
    refundAmountinteger<int64>required
    refundedTipAmountinteger<int64>nullable
    statusstringrequired
    totalinteger<int64>required
    CreditNoteCreatedEventPayload
    {
      "creditAmount": 0,
      "creditNoteId": "string",
      "currency": "string",
      "customerId": "string",
      "lineItems": [
        {
          "amount": 0,
          "description": "string",
          "externalLineItemId": "string",
          "id": "string",
          "quantity": 0,
          "type": "string",
          "unitAmount": 0
        }
      ],
      "number": "string",
      "organizationId": "string",
      "outOfBandAmount": 0,
      "paymentId": "string",
      "reason": "string",
      "refundAmount": 0,
      "refundedTipAmount": 0,
      "status": "string",
      "total": 0
    }