Get billing capabilities Close due billing periods List the handoff queue Claim invoices from the handoff queue Acknowledge a handed-off invoice Get the billing health Get billing settings Update billing settings Sync with the payment providers now Get a customer's billing Detach a customer's payment method Open a page saving a customer's payment method Complete a payment-method session Open a customer's billing portal Get an instance's subscription Subscribe an instance Change a subscription's terms or provider Cancel a subscription Reactivate a subscription Cancel a scheduled plan change Schedule a plan change Preview an instance's upcoming invoice List an instance's invoices List invoices Export invoices Get an invoice List the usage reports behind an invoice line Mark an invoice paid Recompose an invoice Release a held invoice Retry pushing an invoice to its provider Sync an invoice with its provider Void an invoice Write off an invoice Billing Provider Connected Webhook Billing Provider Disconnected Webhook Billing Provider Sync Failed Webhook Customer Payment Method Attached Webhook Customer Payment Method Detached Webhook Customer Payment Method Expiring Webhook Instance Billing Canceled Webhook Instance Billing Cancellation Reverted Webhook Instance Billing Cancellation Scheduled Webhook Instance Billing Plan Change Canceled Webhook Instance Billing Plan Change Scheduled Webhook Instance Billing Plan Changed Webhook Instance Billing Provider Changed Webhook Instance Billing Started Webhook Instance Billing Status Changed Webhook Instance Billing Trial Will End Webhook Instance Invoice Handoff Acknowledged Webhook Instance Invoice Held Webhook Instance Invoice Issued Webhook Instance Invoice Marked Uncollectible Webhook Instance Invoice Paid Webhook Instance Invoice Payment Failed Webhook Instance Invoice Push Failed Webhook Instance Invoice Pushed Webhook Instance Invoice Reconciliation Mismatch Webhook Instance Invoice Released Webhook Instance Invoice Voided Webhook

Instance Billing Trial Will End Webhook

Triggered once per trial, at reminderAt: its family's trialReminderDays before trialEndsAt (3 by default), or at once when the trial is shorter. Carries what a reminder e-mail needs, read when it is emitted: the customer and its billing e-mail, the instance, the plan, daysLeft, the charge the conversion would make and the card it would be made to.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

Example Requests

POST/com.kaiten.instance.billing.v1.trial_will_end

Instance Billing Status Changed Webhook

Triggered when a trial converts, or a subscription becomes PAST_DUE or leaves it.

Instance Invoice Handoff Acknowledged Webhook

Triggered when the organization's accounting system acknowledges an invoice from the handoff queue, or the invoice is marked paid while still waiting there.

data*

headers?

name*string

Event name

Value in"INSTANCE_BILLING_TRIAL_WILL_END"

type*string

Event type

Value in"com.kaiten.instance.billing.v1.trial_will_end"