Business Platforms and marketplacesPlatforms Enterprise

Business Platforms and marketplaces Enterprise

Sections

Business Platforms and marketplaces Enterprise

Help

FAQs Account help Technical support API Status

APIs & SDKs

JavaScript SDK React SDK REST API Server SDKs Codes Webhook events iOS Android

On this page

Resources

GitHub repo

Postman repo

PayPal.com

llms.txt

Where to find us

Developer blog

Community

Help Center

Sign up for updates

Where to hear from us

X

YouTube

LinkedIn

Discord

Legal

Privacy Policy

Terms of Service

Developer Agreement

© 2026 PayPal. All rights reserved.

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Envelop

idstringRequired

Unique identifier for the webhook event.

create_timestring<DateTimeWithZone>Required

Time when the webhook event was created.

Formatdate-time

event_versionstringOptional

Version of the event schema.

summarystringOptional

Brief description of the event.

resource_versionstringOptional

Version of the resource schema.

linksobject<Link>[]Optional

HATEOAS links for the webhook event.

Link properties

3 properties

hrefstringRequired

URL for the action.

Formaturi

relstringRequired

Relation type of the link.

methodstringRequired

HTTP method to use with the URL.

resource_typeenum<ResourceType>Required

Type of resource that triggered the webhook.

Value in"subscription-alert" | "wallet" | "wallet-transaction" | "credit-note" | "invoice" | "subscription"

event_typeenum<EventType>Required

Type of event that occurred in webhooks.

Value in"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"

Back to top

On this page

No Headings