Sign in

v1

latestOpenAPI 3.1.02026-07-24170121.2 MB

Create and Send Invoice

post/v1/orders/customer

Headers

Acceptstring required

Indicates which content types, expressed as MIME types, the client is able to understand.

Content-Typestring required

Indicates the media type of the resource sent in the HTTP message body. <br /><br /><b>Possible Values:</b><br /> application/json<br />application/x-www-form-urlencoded

Request body

namestring required

Invoice name.

emailstring

Email address associated with the invoice.

descriptionstring

Invoice description.

amountinteger

Amount of the invoice in cents.

send_viastring[]

Method of invoice distribution.

payment_option'card' | 'ach'

Invoice payment method.

surcharge_percentagestring

Invoice surcharge percentage.

multi_useboolean
dynamic_amountboolean
can_be_recurringboolean

is the invoice recurring? true/false

Response

200

statusstring
codeinteger
messagestring
status_codeinteger

Example response

{
  "status": "success",
  "message": "Invoice has been sent successfully",
  "status_code": 200
}