LedgerBee Public API
numbernumbernumber · requirednumber · requirednumber · required
string · maxLength: 255string · requiredstring[] · requiredstring · maxLength: 512string · requiredstring · requiredstring[] · requiredstring · enum · requiredstring · requiredstring · requiredstring · requiredstring | null
string · requiredstring · requiredstring · requiredstring[] · requiredstring · enum · requiredstring · requiredstring · requiredstring | null
string · requiredstring · maxLength: 255stringstring[]string · enumstring | null · maxLength: 512string · requiredstring · requiredstring[] · requiredstring · enum · requiredstring · requiredstring · requiredstring | null
string · requiredstring · maxLength: 255
string · requiredstring · maxLength: 255string · requiredstring · requiredstring[] · requiredstring · enum · requiredstring · requiredstring · requiredstring · requiredstring | null
string · requiredstring · maxLength: 255string · enum · requiredboolean · requirednumber · requirednumber | nullstring | null
Webhook Endpoints
Register HTTPS endpoints to receive signed event notifications. Each delivery is signed following the Standard Webhooks specification — verify the webhook-id, webhook-timestamp, and webhook-signature headers against the endpoint secret (returned once on create / roll-secret) using one of the spec’s drop-in verification libraries instead of implementing the HMAC-SHA256 check yourself.
List webhook endpoints
GET
https://api.ledgerbee.com/api
/v1/webhook-endpoints
x-api-key (header)
or
OAuth 2.0
Returns the company’s webhook endpoints, newest first.
Required Scope
webhook-endpoints-read
query Parameters
pagePage number (1-based).
Example: 1
Default: 1
limitPage size (max 100).
Example: 25
Default: 25
List webhook endpoints › Responses
Paginated list of webhook endpoints.
WebhookEndpoint[] · required
totalTotal number of endpoints matching the query.
Example: 3
pageCurrent page (1-based).
Example: 1
pageSizePage size.
Example: 25
Create a webhook endpoint
POST
https://api.ledgerbee.com/api
/v1/webhook-endpoints
x-api-key (header)
or
OAuth 2.0
Registers a new endpoint. url must be a public HTTPS URL. The response includes the signing secret exactly once — store it securely.
Required Scope
webhook-endpoints-write
Headers
x-api-idempotency-keyOptional idempotency key for safely retrying mutating requests.
Create a webhook endpoint › Request Body
urlThe HTTPS URL events are delivered to. Must be a public https URL (loopback/private/link-local hosts are rejected).
Example: https://example.com/webhooks/ledgerbee
enabledEventsThe events to subscribe to. Must contain at least one known event type.
Available events:
subscription.assigned— Fired when a subscription is assigned to a customer (may be future-dated / upcoming).subscription.started— Fired when a subscription becomes active — grant entitlement/access on this event, not on assigned.subscription.updated— Fired when a config property changes without a structural transition (e.g. name, payment method, billing direction).subscription.transitioned— Fired on a structural change: plan replace, product edit, billing cadence change, phase change, or realign.subscription.paused— Fired when a subscription is paused.subscription.resumed— Fired when a subscription resumes from a pause.subscription.trial_ended— Fired when a subscription trial ends. The payload outcome says whether billing begins (ACTIVE) or the subscription was held for a missing payment card (PAUSED).subscription.cancellation_scheduled— Fired when a future cancellation is scheduled for a subscription (still active until then).subscription.cancellation_cleared— Fired when a previously scheduled cancellation is cleared.subscription.churned— Fired when a subscription is cancelled/finalized — revoke entitlement on this event.subscription.billed— Fired once per subscription that billed onto an invoice — one per child on a parent-paid consolidated invoice, one per member on a billing-group invoice. amount is always the whole document total; deduplicate on invoiceId, attribute on billingGroupId, never sum amount across events.subscription.payment_succeeded— Fired when a card charge for the subscription clears — the success pair of the charge_failed error signal. On a billing-group card charge one event fires per member, each carrying the full charged amount and the shared billingGroupId.subscription.error— Fired when a delivery/processing problem occurs for a subscription (e.g. undeliverable recipient).billing.invoice_sent— Fired when an invoice document is sent to the customer.billing.credit_note_sent— Fired when a credit note document is sent to the customer.customer.created— Fired when a customer is created (payload flags whether it was a portal self-signup).card.added— Fired when a card is successfully saved for a customer (provider-opaque).card.removed— Fired when a saved card is removed in-app or cancelled at the provider.card.updated— Fired when a saved card’s details change (network auto-update or refresh).card.expiring— Fired when a saved card is approaching expiry.card.expired— Fired when a saved card is observed to have expired.card.default_changed— Fired when the customer’s default card changes (explicit or auto-default).card.backup_changed— Fired when the customer’s designated backup card is set, replaced, or cleared.card.add_failed— Fired when a card-save attempt fails (decline or authentication failure).quote.sent— Fired when a quote is sent to the customer.quote.converted— Fired when a quote is converted into an order confirmation or an invoice.order_confirmation.sent— Fired when an order confirmation is sent to the customer.order_confirmation.converted— Fired when an order confirmation is converted into an invoice.checkout.card_ready— Fired when the buyer's card lands on a checkout session's card window — confirm may proceed. The card-status poll remains authoritative.checkout.card_failed— Fired when a checkout card window closes without a card (the provider window expired mid-capture) — open a fresh window to retry.checkout.session_expired— Fired when a checkout session expires unconsumed — the abandoned-checkout signal.project.created— Fired when a project is created (payload carries the owned dimension id for correlation with the dimensions API).project.updated— Fired when a project's fields are updated (payload lists the changed field names). Also fires on un-archive.project.archived— Fired when a project is archived (its dimension is deactivated; postings history is preserved).
Enum values:
subscription.assigned
subscription.started
subscription.updated
subscription.transitioned
subscription.paused
subscription.resumed
subscription.trial_ended
subscription.cancellation_scheduled
Example: ["subscription.assigned"]
descriptionOptional human-facing description.
Example: Production billing sync
Create a webhook endpoint › Responses
Endpoint created. Includes the one-time signing secret.
idUnique identifier of the webhook endpoint.
Example: 0192f3a1-...
urlThe HTTPS URL events are delivered to.
Example: https://example.com/webhooks/ledgerbee
enabledEventsThe events this endpoint is subscribed to. An event is delivered to every enabled endpoint subscribed to its type.
Available events:
subscription.assigned— Fired when a subscription is assigned to a customer (may be future-dated / upcoming).subscription.started— Fired when a subscription becomes active — grant entitlement/access on this event, not on assigned.subscription.updated— Fired when a config property changes without a structural transition (e.g. name, payment method, billing direction).subscription.transitioned— Fired on a structural change: plan replace, product edit, billing cadence change, phase change, or realign.subscription.paused— Fired when a subscription is paused.subscription.resumed— Fired when a subscription resumes from a pause.subscription.trial_ended— Fired when a subscription trial ends. The payload outcome says whether billing begins (ACTIVE) or the subscription was held for a missing payment card (PAUSED).subscription.cancellation_scheduled— Fired when a future cancellation is scheduled for a subscription (still active until then).subscription.cancellation_cleared— Fired when a previously scheduled cancellation is cleared.subscription.churned— Fired when a subscription is cancelled/finalized — revoke entitlement on this event.subscription.billed— Fired once per subscription that billed onto an invoice — one per child on a parent-paid consolidated invoice, one per member on a billing-group invoice. amount is always the whole document total; deduplicate on invoiceId, attribute on billingGroupId, never sum amount across events.subscription.payment_succeeded— Fired when a card charge for the subscription clears — the success pair of the charge_failed error signal. On a billing-group card charge one event fires per member, each carrying the full charged amount and the shared billingGroupId.subscription.error— Fired when a delivery/processing problem occurs for a subscription (e.g. undeliverable recipient).billing.invoice_sent— Fired when an invoice document is sent to the customer.billing.credit_note_sent— Fired when a credit note document is sent to the customer.customer.created— Fired when a customer is created (payload flags whether it was a portal self-signup).card.added— Fired when a card is successfully saved for a customer (provider-opaque).card.removed— Fired when a saved card is removed in-app or cancelled at the provider.card.updated— Fired when a saved card’s details change (network auto-update or refresh).card.expiring— Fired when a saved card is approaching expiry.card.expired— Fired when a saved card is observed to have expired.card.default_changed— Fired when the customer’s default card changes (explicit or auto-default).card.backup_changed— Fired when the customer’s designated backup card is set, replaced, or cleared.card.add_failed— Fired when a card-save attempt fails (decline or authentication failure).quote.sent— Fired when a quote is sent to the customer.quote.converted— Fired when a quote is converted into an order confirmation or an invoice.order_confirmation.sent— Fired when an order confirmation is sent to the customer.order_confirmation.converted— Fired when an order confirmation is converted into an invoice.checkout.card_ready— Fired when the buyer's card lands on a checkout session's card window — confirm may proceed. The card-status poll remains authoritative.checkout.card_failed— Fired when a checkout card window closes without a card (the provider window expired mid-capture) — open a fresh window to retry.checkout.session_expired— Fired when a checkout session expires unconsumed — the abandoned-checkout signal.project.created— Fired when a project is created (payload carries the owned dimension id for correlation with the dimensions API).project.updated— Fired when a project's fields are updated (payload lists the changed field names). Also fires on un-archive.project.archived— Fired when a project is archived (its dimension is deactivated; postings history is preserved).
Enum values:
subscription.assigned
subscription.started
subscription.updated
subscription.transitioned
subscription.paused
subscription.resumed
subscription.trial_ended
subscription.cancellation_scheduled
Example: ["subscription.assigned"]
statusDelivery status. disabled endpoints are retained but receive no events.
Enum values:
enabled
disabled
Example: enabled
createdAtISO 8601 creation timestamp.
Example: 2026-05-29T10:00:00.000Z
updatedAtISO 8601 last-update timestamp.
Example: 2026-05-29T10:00:00.000Z
secretThe signing secret (shown only on create and roll-secret). Used to verify the webhook-signature header.
Example: whsec_...
descriptionOptional human-facing description of what this endpoint is used for.
Example: Production billing sync
Retrieve a webhook endpoint
GET
https://api.ledgerbee.com/api
/v1/webhook-endpoints/{id}
x-api-key (header)
or
OAuth 2.0
Retrieves a single webhook endpoint configuration by its id. Returns 404
with code WEBHOOK_ENDPOINT_NOT_FOUND when the endpoint does not exist in
your company.
Required Scope
webhook-endpoints-read
path Parameters
idThe webhook endpoint id.
Retrieve a webhook endpoint › Responses
The webhook endpoint.
idUnique identifier of the webhook endpoint.
Example: 0192f3a1-...
urlThe HTTPS URL events are delivered to.
Example: https://example.com/webhooks/ledgerbee
enabledEventsThe events this endpoint is subscribed to. An event is delivered to every enabled endpoint subscribed to its type.
Available events:
subscription.assigned— Fired when a subscription is assigned to a customer (may be future-dated / upcoming).subscription.started— Fired when a subscription becomes active — grant entitlement/access on this event, not on assigned.subscription.updated— Fired when a config property changes without a structural transition (e.g. name, payment method, billing direction).subscription.transitioned— Fired on a structural change: plan replace, product edit, billing cadence change, phase change, or realign.subscription.paused— Fired when a subscription is paused.subscription.resumed— Fired when a subscription resumes from a pause.subscription.trial_ended— Fired when a subscription trial ends. The payload outcome says whether billing begins (ACTIVE) or the subscription was held for a missing payment card (PAUSED).subscription.cancellation_scheduled— Fired when a future cancellation is scheduled for a subscription (still active until then).subscription.cancellation_cleared— Fired when a previously scheduled cancellation is cleared.subscription.churned— Fired when a subscription is cancelled/finalized — revoke entitlement on this event.subscription.billed— Fired once per subscription that billed onto an invoice — one per child on a parent-paid consolidated invoice, one per member on a billing-group invoice. amount is always the whole document total; deduplicate on invoiceId, attribute on billingGroupId, never sum amount across events.subscription.payment_succeeded— Fired when a card charge for the subscription clears — the success pair of the charge_failed error signal. On a billing-group card charge one event fires per member, each carrying the full charged amount and the shared billingGroupId.subscription.error— Fired when a delivery/processing problem occurs for a subscription (e.g. undeliverable recipient).billing.invoice_sent— Fired when an invoice document is sent to the customer.billing.credit_note_sent— Fired when a credit note document is sent to the customer.customer.created— Fired when a customer is created (payload flags whether it was a portal self-signup).card.added— Fired when a card is successfully saved for a customer (provider-opaque).card.removed— Fired when a saved card is removed in-app or cancelled at the provider.card.updated— Fired when a saved card’s details change (network auto-update or refresh).card.expiring— Fired when a saved card is approaching expiry.card.expired— Fired when a saved card is observed to have expired.card.default_changed— Fired when the customer’s default card changes (explicit or auto-default).card.backup_changed— Fired when the customer’s designated backup card is set, replaced, or cleared.card.add_failed— Fired when a card-save attempt fails (decline or authentication failure).quote.sent— Fired when a quote is sent to the customer.quote.converted— Fired when a quote is converted into an order confirmation or an invoice.order_confirmation.sent— Fired when an order confirmation is sent to the customer.order_confirmation.converted— Fired when an order confirmation is converted into an invoice.checkout.card_ready— Fired when the buyer's card lands on a checkout session's card window — confirm may proceed. The card-status poll remains authoritative.checkout.card_failed— Fired when a checkout card window closes without a card (the provider window expired mid-capture) — open a fresh window to retry.checkout.session_expired— Fired when a checkout session expires unconsumed — the abandoned-checkout signal.project.created— Fired when a project is created (payload carries the owned dimension id for correlation with the dimensions API).project.updated— Fired when a project's fields are updated (payload lists the changed field names). Also fires on un-archive.project.archived— Fired when a project is archived (its dimension is deactivated; postings history is preserved).
Enum values:
subscription.assigned
subscription.started
subscription.updated
subscription.transitioned
subscription.paused
subscription.resumed
subscription.trial_ended
subscription.cancellation_scheduled
Example: ["subscription.assigned"]
statusDelivery status. disabled endpoints are retained but receive no events.
Enum values:
enabled
disabled
Example: enabled
createdAtISO 8601 creation timestamp.
Example: 2026-05-29T10:00:00.000Z
updatedAtISO 8601 last-update timestamp.
Example: 2026-05-29T10:00:00.000Z
descriptionOptional human-facing description of what this endpoint is used for.
Example: Production billing sync
Update a webhook endpoint
PUT
https://api.ledgerbee.com/api
/v1/webhook-endpoints/{id}
x-api-key (header)
or
OAuth 2.0
All fields optional. enabledEvents replaces the full subscription set. Send description: null to clear it.
Required Scope
webhook-endpoints-write
path Parameters
idThe webhook endpoint id.
Headers
x-api-idempotency-keyOptional idempotency key for safely retrying mutating requests.
Update a webhook endpoint › Request Body
urlNew HTTPS delivery URL.
Example: https://example.com/webhooks/v2
enabledEventsReplace the full set of subscribed events.
Available events:
subscription.assigned— Fired when a subscription is assigned to a customer (may be future-dated / upcoming).subscription.started— Fired when a subscription becomes active — grant entitlement/access on this event, not on assigned.subscription.updated— Fired when a config property changes without a structural transition (e.g. name, payment method, billing direction).subscription.transitioned— Fired on a structural change: plan replace, product edit, billing cadence change, phase change, or realign.subscription.paused— Fired when a subscription is paused.subscription.resumed— Fired when a subscription resumes from a pause.subscription.trial_ended— Fired when a subscription trial ends. The payload outcome says whether billing begins (ACTIVE) or the subscription was held for a missing payment card (PAUSED).subscription.cancellation_scheduled— Fired when a future cancellation is scheduled for a subscription (still active until then).subscription.cancellation_cleared— Fired when a previously scheduled cancellation is cleared.subscription.churned— Fired when a subscription is cancelled/finalized — revoke entitlement on this event.subscription.billed— Fired once per subscription that billed onto an invoice — one per child on a parent-paid consolidated invoice, one per member on a billing-group invoice. amount is always the whole document total; deduplicate on invoiceId, attribute on billingGroupId, never sum amount across events.subscription.payment_succeeded— Fired when a card charge for the subscription clears — the success pair of the charge_failed error signal. On a billing-group card charge one event fires per member, each carrying the full charged amount and the shared billingGroupId.subscription.error— Fired when a delivery/processing problem occurs for a subscription (e.g. undeliverable recipient).billing.invoice_sent— Fired when an invoice document is sent to the customer.billing.credit_note_sent— Fired when a credit note document is sent to the customer.customer.created— Fired when a customer is created (payload flags whether it was a portal self-signup).card.added— Fired when a card is successfully saved for a customer (provider-opaque).card.removed— Fired when a saved card is removed in-app or cancelled at the provider.card.updated— Fired when a saved card’s details change (network auto-update or refresh).card.expiring— Fired when a saved card is approaching expiry.card.expired— Fired when a saved card is observed to have expired.card.default_changed— Fired when the customer’s default card changes (explicit or auto-default).card.backup_changed— Fired when the customer’s designated backup card is set, replaced, or cleared.card.add_failed— Fired when a card-save attempt fails (decline or authentication failure).quote.sent— Fired when a quote is sent to the customer.quote.converted— Fired when a quote is converted into an order confirmation or an invoice.order_confirmation.sent— Fired when an order confirmation is sent to the customer.order_confirmation.converted— Fired when an order confirmation is converted into an invoice.checkout.card_ready— Fired when the buyer's card lands on a checkout session's card window — confirm may proceed. The card-status poll remains authoritative.checkout.card_failed— Fired when a checkout card window closes without a card (the provider window expired mid-capture) — open a fresh window to retry.checkout.session_expired— Fired when a checkout session expires unconsumed — the abandoned-checkout signal.project.created— Fired when a project is created (payload carries the owned dimension id for correlation with the dimensions API).project.updated— Fired when a project's fields are updated (payload lists the changed field names). Also fires on un-archive.project.archived— Fired when a project is archived (its dimension is deactivated; postings history is preserved).
Enum values:
subscription.assigned
subscription.started
subscription.updated
subscription.transitioned
subscription.paused
subscription.resumed
subscription.trial_ended
subscription.cancellation_scheduled
Example: ["subscription.assigned"]
statusEnable or disable delivery without deleting the endpoint.
Enum values:
enabled
disabled
descriptionUpdate the description. Send null to clear it.
Example: Updated description
Update a webhook endpoint › Responses
The updated webhook endpoint.
idUnique identifier of the webhook endpoint.
Example: 0192f3a1-...
urlThe HTTPS URL events are delivered to.
Example: https://example.com/webhooks/ledgerbee
enabledEventsThe events this endpoint is subscribed to. An event is delivered to every enabled endpoint subscribed to its type.
Available events:
subscription.assigned— Fired when a subscription is assigned to a customer (may be future-dated / upcoming).subscription.started— Fired when a subscription becomes active — grant entitlement/access on this event, not on assigned.subscription.updated— Fired when a config property changes without a structural transition (e.g. name, payment method, billing direction).subscription.transitioned— Fired on a structural change: plan replace, product edit, billing cadence change, phase change, or realign.subscription.paused— Fired when a subscription is paused.subscription.resumed— Fired when a subscription resumes from a pause.subscription.trial_ended— Fired when a subscription trial ends. The payload outcome says whether billing begins (ACTIVE) or the subscription was held for a missing payment card (PAUSED).subscription.cancellation_scheduled— Fired when a future cancellation is scheduled for a subscription (still active until then).subscription.cancellation_cleared— Fired when a previously scheduled cancellation is cleared.subscription.churned— Fired when a subscription is cancelled/finalized — revoke entitlement on this event.subscription.billed— Fired once per subscription that billed onto an invoice — one per child on a parent-paid consolidated invoice, one per member on a billing-group invoice. amount is always the whole document total; deduplicate on invoiceId, attribute on billingGroupId, never sum amount across events.subscription.payment_succeeded— Fired when a card charge for the subscription clears — the success pair of the charge_failed error signal. On a billing-group card charge one event fires per member, each carrying the full charged amount and the shared billingGroupId.subscription.error— Fired when a delivery/processing problem occurs for a subscription (e.g. undeliverable recipient).billing.invoice_sent— Fired when an invoice document is sent to the customer.billing.credit_note_sent— Fired when a credit note document is sent to the customer.customer.created— Fired when a customer is created (payload flags whether it was a portal self-signup).card.added— Fired when a card is successfully saved for a customer (provider-opaque).card.removed— Fired when a saved card is removed in-app or cancelled at the provider.card.updated— Fired when a saved card’s details change (network auto-update or refresh).card.expiring— Fired when a saved card is approaching expiry.card.expired— Fired when a saved card is observed to have expired.card.default_changed— Fired when the customer’s default card changes (explicit or auto-default).card.backup_changed— Fired when the customer’s designated backup card is set, replaced, or cleared.card.add_failed— Fired when a card-save attempt fails (decline or authentication failure).quote.sent— Fired when a quote is sent to the customer.quote.converted— Fired when a quote is converted into an order confirmation or an invoice.order_confirmation.sent— Fired when an order confirmation is sent to the customer.order_confirmation.converted— Fired when an order confirmation is converted into an invoice.checkout.card_ready— Fired when the buyer's card lands on a checkout session's card window — confirm may proceed. The card-status poll remains authoritative.checkout.card_failed— Fired when a checkout card window closes without a card (the provider window expired mid-capture) — open a fresh window to retry.checkout.session_expired— Fired when a checkout session expires unconsumed — the abandoned-checkout signal.project.created— Fired when a project is created (payload carries the owned dimension id for correlation with the dimensions API).project.updated— Fired when a project's fields are updated (payload lists the changed field names). Also fires on un-archive.project.archived— Fired when a project is archived (its dimension is deactivated; postings history is preserved).
Enum values:
subscription.assigned
subscription.started
subscription.updated
subscription.transitioned
subscription.paused
subscription.resumed
subscription.trial_ended
subscription.cancellation_scheduled
Example: ["subscription.assigned"]
statusDelivery status. disabled endpoints are retained but receive no events.
Enum values:
enabled
disabled
Example: enabled
createdAtISO 8601 creation timestamp.
Example: 2026-05-29T10:00:00.000Z
updatedAtISO 8601 last-update timestamp.
Example: 2026-05-29T10:00:00.000Z
descriptionOptional human-facing description of what this endpoint is used for.
Example: Production billing sync
Delete a webhook endpoint
DELETE
https://api.ledgerbee.com/api
/v1/webhook-endpoints/{id}
x-api-key (header)
or
OAuth 2.0
Permanently removes the endpoint and its delivery log.
Required Scope
webhook-endpoints-write
path Parameters
idThe webhook endpoint id.
Headers
x-api-idempotency-keyOptional idempotency key for safely retrying mutating requests.
Delete a webhook endpoint › Responses
Endpoint deleted.
No data returned
Roll the signing secret
POST
https://api.ledgerbee.com/api
/v1/webhook-endpoints/{id}/roll-secret
x-api-key (header)
or
OAuth 2.0
Generates a new signing secret for the endpoint, returned once. The endpoint id is unchanged. The previous secret stops verifying immediately.
Required Scope
webhook-endpoints-write
path Parameters
idThe webhook endpoint id.
Headers
x-api-idempotency-keyOptional idempotency key for safely retrying mutating requests.
Roll the signing secret › Responses
The endpoint with its new one-time signing secret.
idUnique identifier of the webhook endpoint.
Example: 0192f3a1-...
urlThe HTTPS URL events are delivered to.
Example: https://example.com/webhooks/ledgerbee
enabledEventsThe events this endpoint is subscribed to. An event is delivered to every enabled endpoint subscribed to its type.
Available events:
subscription.assigned— Fired when a subscription is assigned to a customer (may be future-dated / upcoming).subscription.started— Fired when a subscription becomes active — grant entitlement/access on this event, not on assigned.subscription.updated— Fired when a config property changes without a structural transition (e.g. name, payment method, billing direction).subscription.transitioned— Fired on a structural change: plan replace, product edit, billing cadence change, phase change, or realign.subscription.paused— Fired when a subscription is paused.subscription.resumed— Fired when a subscription resumes from a pause.subscription.trial_ended— Fired when a subscription trial ends. The payload outcome says whether billing begins (ACTIVE) or the subscription was held for a missing payment card (PAUSED).subscription.cancellation_scheduled— Fired when a future cancellation is scheduled for a subscription (still active until then).subscription.cancellation_cleared— Fired when a previously scheduled cancellation is cleared.subscription.churned— Fired when a subscription is cancelled/finalized — revoke entitlement on this event.subscription.billed— Fired once per subscription that billed onto an invoice — one per child on a parent-paid consolidated invoice, one per member on a billing-group invoice. amount is always the whole document total; deduplicate on invoiceId, attribute on billingGroupId, never sum amount across events.subscription.payment_succeeded— Fired when a card charge for the subscription clears — the success pair of the charge_failed error signal. On a billing-group card charge one event fires per member, each carrying the full charged amount and the shared billingGroupId.subscription.error— Fired when a delivery/processing problem occurs for a subscription (e.g. undeliverable recipient).billing.invoice_sent— Fired when an invoice document is sent to the customer.billing.credit_note_sent— Fired when a credit note document is sent to the customer.customer.created— Fired when a customer is created (payload flags whether it was a portal self-signup).card.added— Fired when a card is successfully saved for a customer (provider-opaque).card.removed— Fired when a saved card is removed in-app or cancelled at the provider.card.updated— Fired when a saved card’s details change (network auto-update or refresh).card.expiring— Fired when a saved card is approaching expiry.card.expired— Fired when a saved card is observed to have expired.card.default_changed— Fired when the customer’s default card changes (explicit or auto-default).card.backup_changed— Fired when the customer’s designated backup card is set, replaced, or cleared.card.add_failed— Fired when a card-save attempt fails (decline or authentication failure).quote.sent— Fired when a quote is sent to the customer.quote.converted— Fired when a quote is converted into an order confirmation or an invoice.order_confirmation.sent— Fired when an order confirmation is sent to the customer.order_confirmation.converted— Fired when an order confirmation is converted into an invoice.checkout.card_ready— Fired when the buyer's card lands on a checkout session's card window — confirm may proceed. The card-status poll remains authoritative.checkout.card_failed— Fired when a checkout card window closes without a card (the provider window expired mid-capture) — open a fresh window to retry.checkout.session_expired— Fired when a checkout session expires unconsumed — the abandoned-checkout signal.project.created— Fired when a project is created (payload carries the owned dimension id for correlation with the dimensions API).project.updated— Fired when a project's fields are updated (payload lists the changed field names). Also fires on un-archive.project.archived— Fired when a project is archived (its dimension is deactivated; postings history is preserved).
Enum values:
subscription.assigned
subscription.started
subscription.updated
subscription.transitioned
subscription.paused
subscription.resumed
subscription.trial_ended
subscription.cancellation_scheduled
Example: ["subscription.assigned"]
statusDelivery status. disabled endpoints are retained but receive no events.
Enum values:
enabled
disabled
Example: enabled
createdAtISO 8601 creation timestamp.
Example: 2026-05-29T10:00:00.000Z
updatedAtISO 8601 last-update timestamp.
Example: 2026-05-29T10:00:00.000Z
secretThe signing secret (shown only on create and roll-secret). Used to verify the webhook-signature header.
Example: whsec_...
descriptionOptional human-facing description of what this endpoint is used for.
Example: Production billing sync
Send a test event
POST
https://api.ledgerbee.com/api
/v1/webhook-endpoints/{id}/test
x-api-key (header)
or
OAuth 2.0
Synchronously POSTs a signed sample payload for the given event to the endpoint’s URL and returns the result. No delivery is recorded.
Required Scope
webhook-endpoints-read
path Parameters
idThe webhook endpoint id.
Headers
x-api-idempotency-keyOptional idempotency key for safely retrying mutating requests.
Send a test event › Request Body
eventThe event type to simulate. Must be one of the endpoint’s subscribed events.
Available events:
subscription.assigned— Fired when a subscription is assigned to a customer (may be future-dated / upcoming).subscription.started— Fired when a subscription becomes active — grant entitlement/access on this event, not on assigned.subscription.updated— Fired when a config property changes without a structural transition (e.g. name, payment method, billing direction).subscription.transitioned— Fired on a structural change: plan replace, product edit, billing cadence change, phase change, or realign.subscription.paused— Fired when a subscription is paused.subscription.resumed— Fired when a subscription resumes from a pause.subscription.trial_ended— Fired when a subscription trial ends. The payload outcome says whether billing begins (ACTIVE) or the subscription was held for a missing payment card (PAUSED).subscription.cancellation_scheduled— Fired when a future cancellation is scheduled for a subscription (still active until then).subscription.cancellation_cleared— Fired when a previously scheduled cancellation is cleared.subscription.churned— Fired when a subscription is cancelled/finalized — revoke entitlement on this event.subscription.billed— Fired once per subscription that billed onto an invoice — one per child on a parent-paid consolidated invoice, one per member on a billing-group invoice. amount is always the whole document total; deduplicate on invoiceId, attribute on billingGroupId, never sum amount across events.subscription.payment_succeeded— Fired when a card charge for the subscription clears — the success pair of the charge_failed error signal. On a billing-group card charge one event fires per member, each carrying the full charged amount and the shared billingGroupId.subscription.error— Fired when a delivery/processing problem occurs for a subscription (e.g. undeliverable recipient).billing.invoice_sent— Fired when an invoice document is sent to the customer.billing.credit_note_sent— Fired when a credit note document is sent to the customer.customer.created— Fired when a customer is created (payload flags whether it was a portal self-signup).card.added— Fired when a card is successfully saved for a customer (provider-opaque).card.removed— Fired when a saved card is removed in-app or cancelled at the provider.card.updated— Fired when a saved card’s details change (network auto-update or refresh).card.expiring— Fired when a saved card is approaching expiry.card.expired— Fired when a saved card is observed to have expired.card.default_changed— Fired when the customer’s default card changes (explicit or auto-default).card.backup_changed— Fired when the customer’s designated backup card is set, replaced, or cleared.card.add_failed— Fired when a card-save attempt fails (decline or authentication failure).quote.sent— Fired when a quote is sent to the customer.quote.converted— Fired when a quote is converted into an order confirmation or an invoice.order_confirmation.sent— Fired when an order confirmation is sent to the customer.order_confirmation.converted— Fired when an order confirmation is converted into an invoice.checkout.card_ready— Fired when the buyer's card lands on a checkout session's card window — confirm may proceed. The card-status poll remains authoritative.checkout.card_failed— Fired when a checkout card window closes without a card (the provider window expired mid-capture) — open a fresh window to retry.checkout.session_expired— Fired when a checkout session expires unconsumed — the abandoned-checkout signal.project.created— Fired when a project is created (payload carries the owned dimension id for correlation with the dimensions API).project.updated— Fired when a project's fields are updated (payload lists the changed field names). Also fires on un-archive.project.archived— Fired when a project is archived (its dimension is deactivated; postings history is preserved).
Enum values:
subscription.assigned
subscription.started
subscription.updated
subscription.transitioned
subscription.paused
subscription.resumed
subscription.trial_ended
subscription.cancellation_scheduled
Example: subscription.assigned
Send a test event › Responses
The probe result.
successWhether the endpoint responded with a 2xx status.
Example: true
durationMsRound-trip time of the probe in milliseconds.
Example: 142
statusCodeHTTP status returned by the endpoint, or null on a transport error.
Example: 200
errorTransport/error message when the probe failed, otherwise null.
Example: null