Create Ad Hoc Charge

Required permission: write_adhoc_charges

Create an ad hoc charge for one of your clients. The charge is added to the client's bill when a bill covering the charge date is generated or regenerated, unless the bill's billing profile excludes ad hoc charges. Bills that already exist are not changed until they are regenerated.

The billed amount is amount multiplied by quantity. Each successful request creates a new charge. Only organization API keys can access this endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
≥ 1

The ID of the client to charge.

string
required
length between 1 and 255

The name of the ad hoc charge.

float
required

The amount per unit. Must not be 0. Use a negative amount for a credit.

float
> 0

The number of units charged. Defaults to 1.

date-time
required

The date of the charge. The charge is billed on the bill whose period contains this date, so send midnight in your organization's timezone to place it on that calendar day.

string

Additional details shown on the bill line item.

string
enum

The billing category to bill the charge under. Defaults to adhoc.

string
length between 1 and 255

The billing code copied onto the bill line item.

integer
≥ 1

The ID of an order of the client to link the charge to.

integer
≥ 1

The ID of a shipment of the client to link the charge to.

integer
≥ 1

The ID of a return of the client to link the charge to.

integer
≥ 1

The ID of an inbound shipment of the client to link the charge to.

integer
≥ 1

The ID of a kit assembly task of the client to link the charge to.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json