Balance transaction settledWebhook

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Invoice webhook request body resource.

recognitionId
string

ID of the recognized revenue.

invoiceId
string

ID of the invoice.

itemId
string

ID of the invoice item.

amount
number <double>

Amount recognized.

currency
string (CurrencyCode) = 3 characters

Currency code in ISO 4217 format.

eventType
string

Webhook event type.

Value: "invoice-revenue-recognized"
object

Available embedded objects that are requested by the expand query parameter.

object (Invoice)
currency
required
string = 3 characters

Currency code in ISO 4217 format.

websiteId
required
string (WebsiteId) <= 50 characters

Unique website identifier string. A website is where an organization obtains a customer through a subscription. For more information, see Obtain an organization ID and website ID.

customerId
required
string <= 50 characters

Customer resource ID. Defaults to UUID v4.

id
string <= 50 characters

ID of the invoice.

invoiceNumber
integer

Auto-incrementing number based on the sequence of invoices for any particular customer.

subscriptionId
string <= 50 characters

ID of the related subscription order, if available. This field is null if there are no related subscription orders.

amount
number <double>

Amount of the invoice.

amountDue
number <double>

Amount that is due on the invoice.

subtotalAmount
number <double>

Subtotal amount of the invoice.

discountAmount
number <double>

Discount amount that is applied to the invoice.

object (Shipping)

Shipping settings.

object (InvoiceTax)

Invoice taxes.

object

Billing address of the invoice.

object

Delivery address of the invoice.

poNumber
string or null

Purchase order number that is displayed on the invoice.

notes
string

Notes for the customer that are displayed on the invoice.

Array of objects (InvoiceItem)

Invoice items array.

Array of objects

Discounts applied.

autopayScheduledTime
string <date-time>

Date and time when an automatic payment (autopay) is scheduled.

autopayRetryNumber
integer >= 0
Default: 0

Number of times that an automatic payment (autopay) has been attempted on an invoice.

status
string

Status of the invoice.

Enum: "draft" "unpaid" "paid" "partially-paid" "past-due" "abandoned" "voided" "partially-refunded" "refunded" "disputed"
delinquentCollectionPeriod
integer

Length of time, in days, between when the invoice is due and when the invoice is paid.

collectionPeriod
integer

Length of time, in days, between when the invoice is issued and when the invoice is paid.

abandonedTime
string <date-time>

Date and time when the invoice is abandoned.

voidedTime
string <date-time>

Date and time when the invoice is voided.

paidTime
string <date-time>

Date and time when the invoice is paid.

dueTime
string <date-time>

Date and time when the invoice is due for payment.

issuedTime
string <date-time>

Date and time when the invoice is issued.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

paymentFormUrl
string <url>

URL where the customer is redirected to pay the invoice using one of the methods which are available to the customer. This is an alternative to creating a new transaction with empty methods.

Array of objects (Transaction)

Invoice transactions array.

object

Invoice payment retry instruction. This object specifies how to proceed if a payment related to the invoice fails.

revision
integer

Number of times the invoice data has been modified.

Use the revision number when analyzing webhook data to determine if a change should take precedence over the current representation.

type
string

Type of invoice.

Enum: "initial" "renewal" "interim" "cancellation" "one-time" "refund" "charge" "one-time-sale"
dueReminderTime
string or null <date-time>

Date and time when a past due reminder event is triggered.

dueReminderNumber
integer or null

Number of past due reminder events that have been triggered.

Array of Self (object) or CustomerLink (object) or WebsiteLink (object) or OrganizationLink (object) or LeadSourceLink (object) or TransactionAllocationsLink (object) or RecalculateInvoiceLink (object) or SubscriptionLink (object) non-empty

Related resource links.

Array of CustomerEmbed (object) or WebsiteEmbed (object) or OrganizationEmbed (object) or LeadSourceEmbed (object) or ShippingRateEmbed (object) non-empty

Embedded objects that are requested by the expand query parameter.

Array of InvoiceLink (object) non-empty

Related resource links.

Array (non-empty)
Any of:
rel
required
string

Type of link.

Value: "invoice"
href
required
string

Link URL.

Responses
2xx

Returns any 2xx status to indicate that the data received.

Request samples
application/json
{
  • "recognitionId": "string",
  • "invoiceId": "string",
  • "itemId": "string",
  • "amount": 0,
  • "currency": "USD",
  • "eventType": "invoice-revenue-recognized",
  • "_embedded": {
    },
  • "_links": [
    ]
}