Skip to main content
PATCH
Update recurring invoice status

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 status

Body

application/json
status
enum<string>
required

The new status to set for the recurring invoice

Available options:
ACTIVE,
PAUSED,
CANCELED
Example:

"PAUSED"

Response

Recurring invoice status updated successfully

success
boolean
Example:

true

message
string
Example:

"Recurring invoice status updated successfully"

data
object