/

Docs
History
Schema
Generate

Filter operations

activity_logs2

add_ons5

analytics6

api_logs2

billable_metrics6

billing_entities4

coupons8

credit_notes11

customers15

entitlements10

events7

get/eventsList all events
post/eventsSend a usage event
post/events/batchBatch multiple events
post/events/estimate_feesEstimate fees for a pay in advance charge
post/events/estimate_instant_feesEstimate instant fees for a pay in advance charge
post/events/batch_estimate_instant_feesBatch estimate instant fees for a pay in advance charge
get/events/{transaction_id}Retrieve a specific event

features6

fees4

invoices14

order_forms4

orders3

organizations2

payment_methods3

payment_receipts2

payment_requests3

payments3

plans24

quotes7

subscriptions24

taxes5

wallets30

webhook_endpoints5

webhooks2

Webhooks

postadd_on_createdA new add-on has been created
postadd_on_updatedAn add-on has been updated
postadd_on_deletedAn add-on has been deleted
postalert_resolvedAn alert was resolved
postalert_triggeredA new alert was triggered
postbillable_metric_createdA new billable metric has been created
postbillable_metric_updatedA billable metric has been updated
postbillable_metric_deletedA billable metric has been deleted
postcustomer_createdA new customer has been created
postcustomer_updatedA customer has been updated
postcustomer_accounting_provider_createdA customer was created on an accounting integration
postcustomer_accounting_provider_errorAn error was encountered while syncing a customer to an accounting provider
postcustomer_crm_provider_createdA customer has been created in the CRM provider
postcustomer_crm_provider_errorAn error was encountered while syncing a customer to a CRM provider
postcustomer_payment_provider_createdA customer has been created on a payment provider
postcustomer_payment_provider_errorAn error was encountered while syncing a customer to a payment provider
postcustomer_checkout_url_generatedA checkout URL was generated for a customer
postcustomer_tax_provider_errorAn error was encountered while fetching taxes for a customer on a tax provider
postcustomer_vies_checkVIES VAT number has been checked for a customer
postcredit_note_createdA new credit note has been created
postcredit_note_generatedA new credit note PDF has been generated
postcredit_note_provider_refund_failureThe refund of a credit note has failed on a payment provider
postcoupon_createdA new coupon has been created
postcoupon_updatedA coupon has been updated
postcoupon_deletedA coupon has been deleted
postcoupon_terminatedA coupon has been terminated
postdunning_campaign_finishedThe dunning campaign has been completed for a customer
postevent_errorAn error has been detected on an event
postevents_errorsErrors were encountered while post-processing some events
postfeature_createdA new feature has been created
postfeature_updatedA feature has been updated
postfeature_deletedA feature has been deleted
postfee_createdA pay in advance fee has been created
postfee_tax_provider_errorAn error was encountered while fetching taxes for a fee on a tax provider
postinvoice_createdA new invoice has been emitted
postinvoice_one_off_createdA new one off invoice has been emitted
postinvoice_add_on_addedA new add on invoice has been emitted
postinvoice_paid_credit_addedA new prepaid credit invoice has been emitted
postinvoice_generatedA new invoice PDF has been generated
postinvoice_draftedA new draft invoice has been emitted
postinvoice_ready_to_finalizeA draft invoice is ready to be finalized
postinvoice_voidedAn invoice has been voided
postinvoice_deletedA draft invoice has been deleted
postinvoice_payment_dispute_lostA payment dispute has been lost for an invoice payment
postinvoice_payment_status_updatedThe payment status of an invoice has been updated
postinvoice_payment_overdueAn invoice payment is overdue
postinvoice_payment_failureA payment attempt for an invoice has failed on a payment provider
postinvoice_resyncedAn invoice has been resynced with Salesforce
postintegration_provider_errorAn error was encountered while processing data on an integration
postorder_createdAn order has been created from a signed order form
postorder_executedAn order has been executed
postorder_form_createdAn order form has been generated from an approved quote
postorder_form_signedAn order form has been marked as signed
postorder_form_expiredAn order form has expired
postorder_form_voidedAn order form has been voided
postpayment_requires_actionAn action is required to process a payment
postpayment_succeededA payment has been successfully processed
postpayment_provider_errorAn error was raised by a payment provider
postpayment_receipt_createdA new payment receipt has been created
postpayment_receipt_generatedThe PDF of a payment receipt has been generated
postpayment_request_createdA new payment request has been created
postpayment_request_payment_failureA payment attempt for a payment request has failed on a payment provider
postpayment_request_payment_status_updatedThe payment status of a payment request has been updated
postplan_createdA new plan has been created
postplan_updatedA plan has been updated
postplan_deletedA plan has been deleted
postquote_createdA new quote has been created
postquote_approvedA quote has been approved
postquote_voidedA quote has been voided
postsubscription_terminatedA subscription has been terminated
postsubscription_incompleteA subscription is incomplete and waiting for payment
postsubscription_canceledA subscription has been canceled
postsubscription_startedA subscription has started
postsubscription_updatedA subscription has been updated
postsubscription_termination_alertA subscription will be terminated in the future
postsubscription_trial_endedA subscription trial period has ended
postsubscription_usage_threshold_reachedA usage threshold has been reached by a subscription
postwallet_createdA new wallet has been created
postwallet_updatedA wallet has been updated
postwallet_terminatedA wallet has been terminated
postwallet_depleted_ongoing_balanceThe balance of a wallet has been depleted
postwallet_transaction_createdA new wallet transaction has been created
postwallet_transaction_updatedA wallet transaction has been updated
postwallet_transaction_payment_failureA payment attempt for a wallet transaction has failed on a payment provider

events

Changes to Send a usage event

post/events

Nov 3, 20265d26657495a3 Revision changes
- info
  added the new optional request property //