Invoice webhook request body resource.
Returns any 2xx status to indicate that the data received.
{- "invoiceId": "in_0YVF9605RKC62BP14NE2R7V2XT",
- "eventType": "invoice-abandoned",
- "_embedded": {
- "invoice": {
- "id": "in_0YVF9605RKC62BP14NE2R7V2XT",
- "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
- "invoiceNumber": 0,
- "subscriptionId": "ord_01GYJPRKHBD6ZYHH897QCJMBS4",
- "currency": "USD",
- "amount": 0,
- "amountDue": 0,
- "subtotalAmount": 0,
- "discountAmount": 0,
- "shipping": {
- "amount": 0,
- "calculator": "manual"
}, - "tax": {
- "amount": 0,
- "calculator": "string",
- "items": [
- {
- "amount": 0,
- "description": "string",
- "rate": 0,
- "stateAmount": 0.94,
- "countyAmount": 0.04,
- "cityAmount": 0,
- "specialDistrictAmount": 0.38,
- "stateRate": 0,
- "countyRate": 0,
- "cityRate": 0,
- "specialDistrictRate": 0,
- "jurisdictions": {
- "country": "US",
- "state": "CA",
- "county": "LOS ANGELES",
- "city": "LOS ANGELES"
}
}
]
}, - "organizationTaxIdNumber": {
- "type": "eu-vat",
- "value": "GB980780684"
}, - "customerTaxIdNumber": {
- "type": "eu-vat",
- "value": "GB980780684"
}, - "billingAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": "Rebilly",
- "address": "36 Craven St",
- "address2": "string",
- "city": "Austin",
- "region": "Texas",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "dob": "1980-04-01",
- "jobTitle": "CEO",
- "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "deliveryAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": "Rebilly",
- "address": "36 Craven St",
- "address2": "string",
- "city": "Austin",
- "region": "Texas",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "dob": "1980-04-01",
- "jobTitle": "CEO",
- "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "poNumber": "PO123456",
- "notes": "string",
- "items": [
- {
- "id": "ii_0YVFDEQS2KCFTBN9HXWJFY55GV",
- "type": "debit",
- "description": "string",
- "unitPrice": 0,
- "quantity": 0,
- "price": 0,
- "productId": "prod_0YV7DES3WPC5J8JD8QTVNZBZNZ",
- "planId": "plan_0YV7DENSVGDBW9S71XZNNYYQ0X",
- "subscriptionId": "ord_01GYJPRKHBD6ZYHH897QCJMBS4",
- "discountAmount": 0,
- "periodStartTime": "2019-08-24T14:15:22Z",
- "periodEndTime": "2019-08-24T14:15:22Z",
- "periodNumber": 0,
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "tax": {
- "amount": 0,
- "description": "string",
- "rate": 0,
- "stateAmount": 0.94,
- "countyAmount": 0.04,
- "cityAmount": 0,
- "specialDistrictAmount": 0.38,
- "stateRate": 0,
- "countyRate": 0,
- "cityRate": 0,
- "specialDistrictRate": 0,
- "jurisdictions": {
- "country": "US",
- "state": "CA",
- "county": "LOS ANGELES",
- "city": "LOS ANGELES"
}
}, - "_links": [
- {
- "href": "string",
- "rel": "self"
}
], - "_embedded": {
- "product": { },
- "plan": { }
}
}
], - "discounts": [
- {
- "couponId": "cpn_0YVCNKF81GD778N4YNVGDJK558",
- "redemptionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "amount": 0,
- "description": "string",
- "context": "items"
}
], - "autopayScheduledTime": "2019-08-24T14:15:22Z",
- "autopayRetryNumber": 0,
- "status": "draft",
- "delinquentCollectionPeriod": 0,
- "collectionPeriod": 0,
- "abandonedTime": "2019-08-24T14:15:22Z",
- "voidedTime": "2019-08-24T14:15:22Z",
- "paidTime": "2019-08-24T14:15:22Z",
- "dueTime": "2019-08-24T14:15:22Z",
- "issuedTime": "2019-08-24T14:15:22Z",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "paymentFormUrl": "string",
- "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
- "transactions": [
- {
- "id": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0",
- "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
- "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
- "type": "3ds-authentication",
- "status": "completed",
- "result": "abandoned",
- "amount": 0,
- "currency": "USD",
- "purchaseAmount": 0,
- "purchaseCurrency": "USD",
- "requestAmount": 0,
- "requestCurrency": "USD",
- "parentTransactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0",
- "childTransactions": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "invoiceIds": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "subscriptionIds": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "planIds": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "isRebill": true,
- "rebillNumber": 0,
- "billingAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": "Rebilly",
- "address": "36 Craven St",
- "address2": "string",
- "city": "Austin",
- "region": "Texas",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": null,
- "value": null,
- "primary": null
}
], - "emails": [
- {
- "label": null,
- "value": null,
- "primary": null
}
], - "dob": "1980-04-01",
- "jobTitle": "CEO",
- "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "has3ds": true,
- "3ds": {
- "server": "string",
- "version": "1.0.2",
- "enrolled": "yes",
- "authenticated": "yes",
- "liability": "protected",
- "flow": "frictionless",
- "isDowngraded": false
}, - "retryNumber": 0,
- "isRetry": true,
- "billingDescriptor": "string",
- "description": "string",
- "requestId": "string",
- "hasAmountAdjustment": true,
- "gatewayName": "A1Gateway",
- "customFields": {
- "foo": "bar"
}, - "processedTime": "2019-08-24T14:15:22Z",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "gatewayAccountId": "gw_acc_0YVCXMF26DDNKAERE5NW727S34",
- "gatewayTransactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0",
- "gateway": {
- "response": {
- "code": "string",
- "message": "string",
- "type": "string",
- "originalCode": "string",
- "originalMessage": "string"
}, - "avsResponse": {
- "code": "string",
- "message": "string",
- "originalCode": "string",
- "originalMessage": "string"
}, - "cvvResponse": {
- "code": "string",
- "message": "string",
- "originalCode": "string",
- "originalMessage": "string"
}
}, - "acquirerName": "Adyen",
- "method": "payment-card",
- "velocity": 0,
- "revision": 0,
- "referenceData": {
- "gatewayTransactionId": "GAT123"
}, - "bin": "string",
- "paymentInstrument": {
- "method": "payment-card",
- "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N"
}, - "hasDcc": true,
- "dcc": {
- "base": {
- "amount": 10,
- "currency": "USD"
}, - "quote": {
- "amount": 10,
- "currency": "USD"
}, - "usdMarkup": 10,
- "outcome": "rejected"
}, - "hasBumpOffer": true,
- "bumpOffer": {
- "order": {
- "amount": 10,
- "currency": "USD"
}, - "version": "string",
- "language": "US",
- "outcome": "presented",
- "presentedOffers": [
- {
- "offerId": null,
- "offerType": null,
- "bumpAmount": null,
- "bumpAmountInUsd": null,
- "customFields": null
}
], - "selectedOffer": {
- "offerId": "string",
- "offerType": "bonus",
- "bumpAmount": 10,
- "bumpAmountInUsd": 10,
- "customFields": {
- "foo": "bar"
}
}
}, - "riskScore": 0,
- "riskMetadata": {
- "ipAddress": "93.92.91.90",
- "fingerprint": "pIUt3xbgX3l9g3YDiLbx",
- "httpHeaders": {
- "Content-Type": "application/json",
- "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
}, - "browserData": {
- "colorDepth": 24,
- "isJavaEnabled": true,
- "language": "en-US",
- "screenWidth": 1920,
- "screenHeight": 1080,
- "timeZoneOffset": 300
}, - "extraData": {
- "kountFraudSessionId": "abcdefg12345abababab123456789012",
- "payPalMerchantSessionId": "dd65ratxc5qv15iph3vyoq7l6davuowa",
- "threatMetrixSessionId": "dd65ratxc5qv15iph3vyoq7l6davuowadd65ratxc5qv15iph3vyoq7l6davuowa"
}, - "isProxy": true,
- "isVpn": true,
- "isTor": true,
- "isHosting": true,
- "vpnServiceName": "string",
- "isp": "string",
- "country": "US",
- "region": "NY",
- "city": "New York",
- "latitude": 0,
- "longitude": 0,
- "postalCode": "string",
- "timeZone": "America/New_York",
- "accuracyRadius": 0,
- "distance": 0,
- "hasMismatchedBillingAddressCountry": true,
- "hasMismatchedBankCountry": true,
- "hasMismatchedTimeZone": true,
- "hasMismatchedHolderName": true,
- "hasFakeName": true,
- "isHighRiskCountry": true,
- "paymentInstrumentVelocity": 0,
- "declinedPaymentInstrumentVelocity": 0,
- "deviceVelocity": 0,
- "ipVelocity": 0,
- "emailVelocity": 0,
- "billingAddressVelocity": 0,
- "score": 0
}, - "isDisputed": true,
- "disputeTime": "2019-08-24T14:15:22Z",
- "disputeStatus": null,
- "isReconciled": true,
- "isProcessedOutside": true,
- "isMerchantInitiated": true,
- "hadDiscrepancy": true,
- "orderId": "string",
- "arn": "74836950144358910018150",
- "reportAmount": 0,
- "reportCurrency": "USD",
- "settlementTime": "2019-08-24T14:15:22Z",
- "discrepancyTime": "2019-08-24T14:15:22Z",
- "limits": {
- "amount": 275.35,
- "currency": "USD",
- "resetTime": "2019-08-24T14:15:22Z"
}, - "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8",
- "_links": [
- {
- "href": "string",
- "rel": "self"
}
], - "_embedded": {
- "parentTransaction": { },
- "childTransactions": [ ],
- "gatewayAccount": { },
- "customer": { },
- "leadSource": { },
- "website": { },
- "invoices": [ ],
- "organization": { },
- "paymentCard": { },
- "bankAccount": { }
}
}
], - "retryInstruction": {
- "attempts": [
- {
- "scheduleInstruction": {
- "method": "date-interval",
- "duration": 1,
- "unit": "second",
- "anchor": {
- "method": null,
- "day": null,
- "time": null
}
}, - "amountAdjustmentInstruction": {
- "method": "none"
}, - "tryBackupInstruments": false
}
], - "afterAttemptPolicies": [
- "change-subscription-renewal-time"
], - "afterRetryEndPolicies": [
- "abandon-invoice"
]
}, - "revision": 0,
- "type": "initial",
- "dueReminderTime": "2019-08-24T14:15:22Z",
- "dueReminderNumber": 0,
- "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8",
- "_links": [
- {
- "href": "string",
- "rel": "self"
}
], - "_embedded": {
- "customer": { },
- "website": { },
- "organization": { },
- "leadSource": { },
- "shippingRate": { }
}
}
}, - "_links": [
- {
- "href": "string",
- "rel": "invoice"
}
]
}