organization.billing.payment_method
Subscribe an endpoint to every event on this page with organization.billing.payment_method.*. Each is the envelope every webhook event shares, with the PaymentMethodEventObject object as its data.object.
A payment method as a webhook event carries it: its identifier and whether it is the one the organization is charged on. getOrganizationBillingPaymentMethods reads its details.
objectstring
One of: organization.billing.payment_method
The kind of object this is, always organization.billing.payment_method: the family of the event types that carry it, and what tells the members of WebhookEventObject apart.
idstring
Identifier of the payment method, the payment provider's pm_ identifier. It is not a UUID.
organization_idstring (uuid)
Identifier of the organization the payment method belongs to.
is_defaultboolean
Whether the organization is charged on it once this change was made.
A payment method was saved to the organization. It is recorded once for the payment method, whatever became of the request that saved it: one saved and not made the default, because the organization's Data API subscription could not be opened on it, is recorded too.
Triggered by
organization.billing.payment_method.attach: Once for each payment method saved, whether or not it becomes the one the organization is charged on:is_defaultsays whether it was when the event was recorded.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
typestring
One of: organization.billing.payment_method.attached
Always organization.billing.payment_method.attached.
data.objectPaymentMethodEventObject
The payment method.
Every other field is the envelope every webhook event shares.
Which payment method the organization is charged on changed: one records it for the new default and one for the former.
Triggered by
organization.billing.payment_method.attach: When the payment method saved becomes the one the organization is charged on: once for it and once for the former default.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.
organization.billing.payment_method.set_default: When the default changes: once for the new default and once for the former one.POST /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/set-default:postOrganizationBillingPaymentMethodSetDefault,mountaya.admin.billing.postOrganizationBillingPaymentMethodSetDefault()in TypeScript. Every request.
Payload
typestring
One of: organization.billing.payment_method.updated
Always organization.billing.payment_method.updated.
data.objectPaymentMethodEventObject
The payment method.
data.previous_attributesobject
The former value of each field of data.object the change moved, and of no other.
Every other field is the envelope every webhook event shares.
A payment method was removed from the organization.
Triggered by
organization.billing.payment_method.detach: Always.DELETE /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}:deleteOrganizationBillingPaymentMethod,mountaya.admin.billing.deleteOrganizationBillingPaymentMethod()in TypeScript. Every payment method removed.
Payload
typestring
One of: organization.billing.payment_method.detached
Always organization.billing.payment_method.detached.
data.objectPaymentMethodEventObject
The payment method.
Every other field is the envelope every webhook event shares.