Invoices

Invoice payment overdue.

Webhook for an invoice payment overdue.

postWebhookusage-billing.invoice.payment.overdue

Headers

paypal-transmission-idstring

The unique ID of the transmission, from the paypal-transmission-id HTTP header.

paypal-transmission-timestring

The date and time when the message was transmitted, from the paypal-transmission-time HTTP header.

Payload

idstring required

Unique identifier for the webhook event.

create_timestring date-time required

Date and time in ISO 8601 format.

event_versionstring

Version of the event schema.

summarystring

Brief description of the event.

resource_versionstring

Version of the resource schema.

resource_type'subscription-alert' | 'wallet' | 'wallet-transaction' | 'credit-note' | 'invoice' | 'subscription' required

Type of resource that triggered the webhook.

event_type'USAGE-BILLING.SUBSCRIPTION-ALERT.TRIGGERED' | 'USAGE-BILLING.WALLET.CREATED' | 'USAGE-BILLING.WALLET.UPDATED' | 'USAGE-BILLING.WALLET.NET-BALANCE-DEPLETED' | 'USAGE-BILLING.WALLET.TERMINATED' | 'USAGE-BILLING.WALLET-TRANSACTION.CREATED' | 'USAGE-BILLING.WALLET-TRANSACTION.UPDATED' | 'USAGE-BILLING.CREDIT-NOTE.CREATED' | 'USAGE-BILLING.CREDIT-NOTE.REFUND.FAILED' | 'USAGE-BILLING.INVOICE.CREATED' | 'USAGE-BILLING.INVOICE.PAYMENT.OVERDUE' | 'USAGE-BILLING.INVOICE.PAYMENT.SUCCEEDED' | 'USAGE-BILLING.INVOICE.PAYMENT.FAILED' | 'USAGE-BILLING.SUBSCRIPTION.UPDATED' | 'USAGE-BILLING.SUBSCRIPTION.TERMINATED' | 'USAGE-BILLING.SUBSCRIPTION.TRIAL.ENDED' required

Type of event that occurred in webhooks.

Example payload

{
  "id": "8PT597110X687430LKGECATA",
  "create_time": "2023-10-01T12:00:00Z",
  "event_version": "1.0",
  "summary": "A new alert was triggered.",
  "resource_version": "1.0",
  "links": [
    {
      "href": "https://api-m.paypal.com/v1/notfications/webhooks-events/8PT597110X687430LKGECATA",
      "rel": "self",
      "method": "GET"
    }
  ],
  "resource": {
    "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "billing_entity_code": "acme_inc",
    "sequential_id": 3,
    "status": "FINALIZED",
    "payment_status": "PENDING",
    "amount": {
      "total_amount": {
        "value": 120.35,
        "currency_code": "USD"
      },
      "breakdown": {
        "fees": {
          "value": 120.35,
          "currency_code": "USD"
        },
        "credit_notes": {
          "value": 120.35,
          "currency_code": "USD"
        },
        "sub_total_excluding_taxes": {
          "value": 120.35,
          "currency_code": "USD"
        },
        "taxes": {
          "value": 120.35,
          "currency_code": "USD"
        },
        "sub_total_including_taxes": {
          "value": 120.35,
          "currency_code": "USD"
        },
        "prepaid_credit": {
          "value": 120.35,
          "currency_code": "USD"
        },
        "progressive_billing_credit": {
          "value": 120.35,
          "currency_code": "USD"
        }
      }
    },
    "fees": [
      {
        "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "total_amount": {
          "value": 120.35,
          "currency_code": "USD"
        },
        "name": "Basic Plan"
      }
    ],
    "due_date": "2023-10-01",
    "issued_date": "2023-10-01",
    "invoice_number": "INV-2023-001",
    "version_number": "INV-2023-001",
    "invoice_type": "SUBSCRIPTION",
    "customer": {
      "name": "John Doe",
      "external_id": "ext_cust_12345",
      "email": "abc@test.com",
      "billing_entity_code": "acme_inc",
      "address": {
        "line1": "123 Main St",
        "line2": "Apt 4B",
        "city": "New York",
        "state": "NY",
        "postal_code": "10001",
        "country": "US"
      },
      "phone": "+1-234-567-8900",
      "payment_method_token": "pm_visa_4242",
      "payment_method_type": "CARD",
      "taxes": [
        {
          "name": "TVA",
          "rate": "20.00",
          "description": "French standard VAT",
          "code": "standard_vat",
          "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "created_at": "2025-06-01T00:00:00Z"
        }
      ],
      "metadata": [
        {
          "key": "Purchase Order",
          "value": "123456789",
          "display_in_invoice": true
        }
      ]
    },
    "billing_period": [
      {
        "subscription_id": "sub_01H3YT8P7Q5R3S1T2U0V4W9X8",
        "external_subscription_id": "ext_id_23fw3",
        "plan_id": "plan_01H3YT8P7Q5R3S1T2U0V4W9X8",
        "payment_method_token": "pm_visa_4242",
        "payment_method_type": "CARD",
        "subscription_from_datetime": "2023-10-01T12:00:00Z",
        "subscription_to_datetime": "2023-10-01T12:00:00Z",
        "charges_from_datetime": "2023-10-01T12:00:00Z",
        "charges_to_datetime": "2023-10-01T12:00:00Z",
        "invoicing_reason": "subscription"
      }
    ],
    "created_at": "2023-01-01T00:00:00Z",
    "updated_at": "2023-01-01T00:00:00Z",
    "applied_taxes": [
      {
        "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "tax_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "tax_name": "TVA",
        "tax_code": "french_standard_vat",
        "tax_rate": 20,
        "tax_description": "French standard VAT",
        "amount": {
          "value": 120.35,
          "currency_code": "USD"
        },
        "created_at": "2023-10-01T12:00:00Z",
        "fees_amount": {
          "value": 120.35
        }
      }
    ]
  }
}

Response

Return a 204 status to indicate that the data was received successfully.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.