Skip to main content
PUT
Update recurring invoice

Authorizations

Authorization
string
header
required

Access token obtained from the /v1/auth/login endpoint

Path Parameters

recurringInvoiceId
string<uuid>
required

The ID of the recurring invoice to update

Body

application/json
client_id
string<uuid>
Example:

"01jtbf0c9zaraqx3swthf88n5y"

name
string | null
Example:

"Monthly Hosting"

frequency
string
Example:

"MONTHLY"

start_date
string<date>
Example:

"2023-06-01"

end_date
string<date> | null
max_occurrences
integer | null
currency
string
Example:

"USD"

tax_id
string<uuid> | null
Example:

"01jtbf0c9zaraqx3swthf88n5y"

tax_distribution
string
Example:

"PER_DOCUMENT"

discount_type
string
Example:

"PERCENTAGE"

discount_value
number<float>
Example:

0

discount_distribution
string
Example:

"NO_DISCOUNT"

net_terms
string
Example:

"NET30"

has_late_fee
boolean
Example:

true

late_fee_kind
string
Example:

"PERCENTAGE"

late_fee_interval
string
Example:

"ONE_TIME"

late_fee
number<float>
Example:

5

shipping
number<float> | null
Example:

0

notes
string | null
Example:

"Monthly hosting services"

options
object | null
template_items
object[]

Response

Recurring invoice updated successfully

success
boolean
Example:

true

message
string
Example:

"Recurring invoice updated successfully"

data
object