Skip to main content
POST
Remove billing

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

UUID of the organization.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

OK

Response for POST /billing/resolver/{organization_id}/remove-billing.

end
enum<string>
required

at_month_close: a Closient-invoiced organization's billing ends when the month closes, charged to the card still on file. at_period_end: a card-subscription organization's ends with its billing period. already_scheduled: a removal was already pending and is unchanged.

Available options:
at_month_close,
at_period_end,
already_scheduled
ends_at
string<date-time> | null

When billing ends, if known; null when it ends at a period end not yet known.