Invoice dunning schedule step executed (standard payload)

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "type": "invoice.dunning_schedule_step_executed",
  "invoice": {
    "metadata": {},
    "voided_at": "2023-11-07T05:31:56Z",
    "paid_at": "2023-11-07T05:31:56Z",
    "issued_at": "2023-11-07T05:31:56Z",
    "scheduled_issue_at": "2023-11-07T05:31:56Z",
    "auto_collection": {
      "next_attempt_at": "2023-11-07T05:31:56Z",
      "previously_attempted_at": "2023-11-07T05:31:56Z",
      "enabled": true,
      "num_attempts": 123
    },
    "issue_failed_at": "2023-11-07T05:31:56Z",
    "sync_failed_at": "2023-11-07T05:31:56Z",
    "payment_failed_at": "2023-11-07T05:31:56Z",
    "payment_started_at": "2023-11-07T05:31:56Z",
    "amount_due": "8.00",
    "created_at": "2022-05-01T07:01:31+00:00",
    "currency": "USD",
    "customer": {
      "id": "<string>",
      "external_customer_id": "<string>"
    },
    "due_date": "2022-05-30T07:00:00+00:00",
    "service_period_start": "2022-05-01T07:00:00+00:00",
    "service_period_end": "2022-06-01T07:00:00+00:00",
    "id": "<string>",
    "invoice_pdf": "https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb",
    "invoice_number": "JYEFHK-00001",
    "subscription": {
      "id": "VDGsT23osdLb84KD"
    },
    "total": "8.00",
    "customer_balance_transactions": [
      {
        "id": "cgZa3SXcsPTVyC4Y",
        "created_at": "2022-05-01T07:01:31+00:00",
        "starting_balance": "33.00",
        "ending_balance": "22.00",
        "amount": "11.00",
        "description": "An optional description",
        "invoice": {
          "id": "gXcsPTVyC4YZa3Sc"
        },
        "credit_note": {
          "id": "<string>"
        }
      }
    ],
    "shipping_address": {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    },
    "billing_address": {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    },
    "hosted_invoice_url": "<string>",
    "will_auto_issue": true,
    "eligible_to_issue_at": "2023-11-07T05:31:56Z",
    "customer_tax_id": {
      "value": "<string>"
    },
    "memo": "<string>",
    "credit_notes": [
      {
        "id": "<string>",
        "credit_note_number": "<string>",
        "reason": "<string>",
        "total": "<string>",
        "voided_at": "2022-05-01T07:01:31+00:00",
        "type": "<string>",
        "memo": "<string>"
      }
    ],
    "payment_received_at": "2023-11-07T05:31:56Z",
    "payment_attempts": [
      {
        "id": "<string>",
        "payment_provider_id": "<string>",
        "amount": "<string>",
        "succeeded": true,
        "created_at": "2023-11-07T05:31:56Z",
        "receipt_pdf": "https://assets.withorb.com/receipt/rUHdhmg45vY45DX/qEAeuYePaphGMdFb"
      }
    ],
    "invoice_date": "2022-05-01T07:00:00+00:00"
  },
  "properties": {
    "dunning_step": {
      "step_number": 123,
      "timestamp": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "execution_time": "2023-11-07T05:31:56Z",
      "manually_triggered_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "actions": [
        "<string>"
      ]
    }
  }
}

WEBHOOK

invoice.dunning_schedule_step_executed.standard

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "type": "invoice.dunning_schedule_step_executed",
  "invoice": {
    "metadata": {},
    "voided_at": "2023-11-07T05:31:56Z",
    "paid_at": "2023-11-07T05:31:56Z",
    "issued_at": "2023-11-07T05:31:56Z",
    "scheduled_issue_at": "2023-11-07T05:31:56Z",
    "auto_collection": {
      "next_attempt_at": "2023-11-07T05:31:56Z",
      "previously_attempted_at": "2023-11-07T05:31:56Z",
      "enabled": true,
      "num_attempts": 123
    },
    "issue_failed_at": "2023-11-07T05:31:56Z",
    "sync_failed_at": "2023-11-07T05:31:56Z",
    "payment_failed_at": "2023-11-07T05:31:56Z",
    "payment_started_at": "2023-11-07T05:31:56Z",
    "amount_due": "8.00",
    "created_at": "2022-05-01T07:01:31+00:00",
    "currency": "USD",
    "customer": {
      "id": "<string>",
      "external_customer_id": "<string>"
    },
    "due_date": "2022-05-30T07:00:00+00:00",
    "service_period_start": "2022-05-01T07:00:00+00:00",
    "service_period_end": "2022-06-01T07:00:00+00:00",
    "id": "<string>",
    "invoice_pdf": "https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb",
    "invoice_number": "JYEFHK-00001",
    "subscription": {
      "id": "VDGsT23osdLb84KD"
    },
    "total": "8.00",
    "customer_balance_transactions": [
      {
        "id": "cgZa3SXcsPTVyC4Y",
        "created_at": "2022-05-01T07:01:31+00:00",
        "starting_balance": "33.00",
        "ending_balance": "22.00",
        "amount": "11.00",
        "description": "An optional description",
        "invoice": {
          "id": "gXcsPTVyC4YZa3Sc"
        },
        "credit_note": {
          "id": "<string>"
        }
      }
    ],
    "shipping_address": {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    },
    "billing_address": {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    },
    "hosted_invoice_url": "<string>",
    "will_auto_issue": true,
    "eligible_to_issue_at": "2023-11-07T05:31:56Z",
    "customer_tax_id": {
      "value": "<string>"
    },
    "memo": "<string>",
    "credit_notes": [
      {
        "id": "<string>",
        "credit_note_number": "<string>",
        "reason": "<string>",
        "total": "<string>",
        "voided_at": "2022-05-01T07:01:31+00:00",
        "type": "<string>",
        "memo": "<string>"
      }
    ],
    "payment_received_at": "2023-11-07T05:31:56Z",
    "payment_attempts": [
      {
        "id": "<string>",
        "payment_provider_id": "<string>",
        "amount": "<string>",
        "succeeded": true,
        "created_at": "2023-11-07T05:31:56Z",
        "receipt_pdf": "https://assets.withorb.com/receipt/rUHdhmg45vY45DX/qEAeuYePaphGMdFb"
      }
    ],
    "invoice_date": "2022-05-01T07:00:00+00:00"
  },
  "properties": {
    "dunning_step": {
      "step_number": 123,
      "timestamp": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "execution_time": "2023-11-07T05:31:56Z",
      "manually_triggered_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "actions": [
        "<string>"
      ]
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Orb-Signature

string

required

v1= followed by the hex HMAC-SHA256 of v1:{X-Orb-Timestamp}:{raw request body}, keyed by the endpoint's webhook secret. The header may carry several space-separated signatures during a secret rotation; a receiver accepts the delivery when any v1 signature matches. Compare in constant time, and sign the bytes as received rather than a re-serialized body.

X-Orb-Timestamp

string<date-time>

required

When the delivery was signed, ISO 8601 to milliseconds. It is part of the signed message, so a receiver must reject timestamps outside its tolerance to stop replays.

Body

application/json

Issued when a dunning schedule step is executed.

string

required

The ID of this webhook event.

created_at

string<date-time>

required

The time at which this event was created, to the second.

type

enum<string>

required

The event this payload describes.

Available options:

invoice.dunning_schedule_step_executed

payload_style

enum<string>

required

The serialization style this payload was rendered in, as configured on the endpoint.

Available options:

expanded,

standard

invoice

InvoiceSummary · object

required

An invoice without its line items, subtotal, discounts, minimums or maximums. Fetch the invoice for those.

Show child attributes

properties

InvoiceDunningStepExecutedWebhookEventProperties · object

required

Show child attributes

Response

2XX

Any 2xx acknowledges receipt.

API documentation

Webhooks

Alert

Coupon

Credit

Credit note

Customer

Dimensional Price Group

Event

Invoice

Item

LicenseType

License

Metric

Availability

Plan

Price

Subscription Change

Subscription

Price interval

Webhook endpoint

Invoice dunning schedule step executed (standard payload)

Authorizations

Headers

Body

Response