Skip to main content
POST
Charge a company a custom fee
Read the guides before using this pageTo use this endpoint properly, make sure you are up to date on our managing users guides.
This endpoint applies one-time custom charges to companies (like program setup fees, administrative charges, or other ad-hoc fees).

Rain-managed vs Partner-managed programs

Rain-managed programs: Custom charges are automatically processed and applied directly to the company’s balance. No additional ledgering required on your side. Partner-managed programs: You typically handle fees through your own ledgering system. This API provides an alternative for one-off charges when needed.
Charges apply after authorizationCustom charges are applied after the authorization process, which means companies may go negative if their balance is insufficient to cover the charge.
FX/XB fees are handled differentlyForeign exchange (FX) and cross-border (XB) fees are configured at the tenant level and included during authorization. See Pricing and fees for more information.

Example

Best practicesAlways use idempotency keys to prevent duplicate charges. Provide clear descriptions for charges to help with user support. Monitor company balances to avoid excessive negative balances, and consider notifying companies before applying charges when possible.

Authorizations

Api-Key
string
header
required

Path Parameters

companyId
string<uuid>
required

Id of the company to charge a custom fee for

Body

application/json

Details of the custom fee charge

amount
integer
required

The amount of the charge, in cents

Required range: x >= 1
description
string
required

The description of the charge

Response

Successful operation

id
string<uuid>
required

The id of the charge

createdAt
string<date-time>
required

The time at which the charge was created

amount
integer

The amount of the charge, in cents

Required range: x >= 1
description
string

The description of the charge