Skip to main content
PATCH
/
v1
/
recurring-invoices
/
{recurringInvoiceId}
/
status
Update recurring invoice status
curl --request PATCH \
  --url https://app.blinksale.test/api/v1/recurring-invoices/{recurringInvoiceId}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "PAUSED"
}
'
{
  "success": true,
  "message": "Recurring invoice status updated successfully",
  "data": {
    "id": "01jtbf0c9zaraqx3swthf88n5y",
    "organization_id": "01jtbf0c9zaraqx3swthf88n5y",
    "client_id": "01jtbf0c9zaraqx3swthf88n5y",
    "name": "Monthly Hosting",
    "frequency": "MONTHLY",
    "frequency_name": "Monthly",
    "status": "ACTIVE",
    "status_name": "Active",
    "start_date": "2023-06-01",
    "end_date": null,
    "max_occurrences": null,
    "occurrences": 3,
    "last_generated_date": "2023-08-01",
    "next_date": "2023-09-01",
    "client": {
      "id": "01jtbf0c9zaraqx3swthf88n5y",
      "name": "Acme Inc",
      "email": "[email protected]",
      "kind": "BUSINESS",
      "kind_name": "Business",
      "profile": {
        "company_name": "Acme Inc",
        "website": "https://acme.com"
      },
      "address": {
        "line1": "123 Main St",
        "line2": "Suite 101",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94107",
        "country": "US"
      },
      "document_defaults": {
        "currency": "USD"
      },
      "contact_count": 3,
      "note_count": 2,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "template": {
      "id": "01jtbf0c9zaraqx3swthf88n5y",
      "currency": "USD",
      "tax_id": "01jtbf0c9zaraqx3swthf88n5y",
      "tax_name": "Sales Tax",
      "tax_percent": 8.5,
      "tax_distribution": "PER_DOCUMENT",
      "discount_type": "PERCENTAGE",
      "discount_value": 10,
      "discount_distribution": "PER_DOCUMENT",
      "net_terms": "NET30",
      "has_late_fee": true,
      "late_fee_kind": "PERCENTAGE",
      "late_fee_interval": "ONE_TIME",
      "late_fee": 5,
      "shipping": 15,
      "notes": "Monthly hosting services.",
      "options": {},
      "items": [
        {
          "id": "01jtbf0c9zaraqx3swthf88n5y",
          "organization_id": "01jtbf0c9zaraqx3swthf88n5y",
          "name": "Consulting Services",
          "description": "Professional consulting services",
          "quantity": 10,
          "price": 150,
          "unit_of_measurement_id": "01jtbf0c9zaraqx3swthf88n5y",
          "unit_name": "Hour",
          "tax_id": "01jtbf0c9zaraqx3swthf88n5y",
          "tax_name": "Sales Tax",
          "tax_percent": 8.5,
          "discount_type": "PERCENTAGE",
          "discount_value": 10,
          "subtotal": 1500,
          "tax_amount": 127.5,
          "total": 1627.5
        }
      ]
    },
    "is_due_for_generation": false,
    "can_generate_invoices": true,
    "is_editable": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

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