Get started
Webhooks

organization.billing.info

organization.billing.info

Subscribe an endpoint to every event on this page with organization.billing.info.*. Each is the envelope every webhook event shares, with the BillingInfoEventObject object as its data.object.

Event typeWhat happened
organization.billing.info.updatedAn organization's billing information changed.

The BillingInfoEventObject object

An organization's billing information as a webhook event carries it: whose it is, and which of its parts the change wrote. What invoices are addressed to is never carried: getOrganizationBillingInfo reads it.

object

string

required

One of: organization.billing.info

The kind of object this is, always organization.billing.info: the family of the event types that carry it, and what tells the members of WebhookEventObject apart.

organization_id

string (uuid)

required

Identifier of the organization the billing information belongs to.

fields

array of string

required

The parts of the billing information the change wrote, each once. A part written with the value it already held is listed too.

organization.billing.info.updated

What the organization's invoices are addressed to was written.

Triggered by

  • organization.billing.info.update: When the request names at least one part of the billing information, each named in fields. A request naming none writes nothing and records nothing.
    • PATCH /v1/organizations/{organization_id}/billing/info: patchOrganizationBillingInfo, mountaya.admin.billing.patchOrganizationBillingInfo() in TypeScript. Every change accepted.
  • organization.billing.payment_method.attach: When the organization's billing information held no address and the payment method's is copied to it, with fields naming address.
    • POST /v1/organizations/{organization_id}/billing/payment-methods: postOrganizationBillingPaymentMethod, mountaya.admin.billing.postOrganizationBillingPaymentMethod() in TypeScript. Every payment method saved.
    • The payment provider: The payment provider reports a payment method confirmed, as a method that confirms after the request does.
    • A schedule: Every day, a check finds that the payment method the organization is charged on was saved without being recorded, and records it.

Payload

type

string

required

One of: organization.billing.info.updated

Always organization.billing.info.updated.

data.object

BillingInfoEventObject

required

The billing information.

See the BillingInfoEventObject object.

Every other field is the envelope every webhook event shares.