Update an Invoice

put

https://api.tap.company/v2/invoices/{invoice_id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

invoice_id

string

required

[Required]

Body Params

draft

boolean

Merchant can save the invoice without creating the actual invoice. The default value will be false.

due

int32

required

Invoice Due Date; measured in seconds since the Unix epoch.

expiry

int32

required

Invoice Expiry Date; measured in seconds since the Unix epoch.

description

string

Invoice description

mode

string

Invoice mode- how the invoice page is showed to customers (INVOICE - Open invoice page, PAY - Open payment page, INVOICEPAY - Open invoice page and payment page.

note

string

It will be added in the invoice footer.

notifications

object

Notification object. By default, the invoice will be dispatched automatically.

channels

array of strings

Notifications channels.

channels

dispatch

boolean

Merchant can specify the field, dispatch the invoice or not.

currencies

array of strings

Charge currency object. If you pass null or empty, all currencies will show.

currencies

metadata

object

Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

charge

object

Charge Object

customer

object

required

Customer object; Either customer ID or customer information is required.

order

object

required

Order Object; Either order id or order information is required.

payment_methods

array of strings

Charge payment method object, if you pass null or empty, then all payment methods will show.

payment_methods

post

object

Post url object.

redirect

object

Redirect url object.

reference

object

Merchant reference object.

invoicer

object

Email notification to merchant.

payment_provider

object

Information about the payment provider associated with this invoice

Headers

lang_code

string

optional

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400