Create a recurring invoice
Create a recurring invoice.
Parameters
charge_automatically
boolean
When payment gateway is credit_card, Kitchen will try to charge the client automatically.
client
string
The unique identifier of a client user.
currency
string
Three-letter ISO currency code.
discounts
associative array
Discounts which are going to be applied to the invoice.
due_date_in_days
integer
Days in which the invoice created from the recurring invoice will be due.
due_reminder_message
string
Message which will be when the due reminder is sent.
due_reminder_send_days
integer
Number of days indicating how many days before or after the invoice due is the reminder sent.
footer_notes
string
Footer notes for the invoice.
items
associative array
Invoice line items.
language
string
Display language of the invoice. Java Locale format is used, for example - en_US.
memo
string
Memo of the invoice.
payment_gateways
enum
Payment gateways which will be available as payment options on checkout screen. Will be displayed only if configured. One of
credit_card, stripe_ach, paypal, bank.recurring_end_date
string
Time at which the recurring invoice will end.
recurring_frequency
integer
Positive integer describing the recurring frequency..
recurring_period_unit
enum
The unit in which the recurring frequency is measured. One of
day, week, month, year.recurring_send_email_cc_addresses
array
Emails to which the invoice will be sent when issued.
recurring_send_email_message
string
Message for the email sent when the invoice is issued.
recurring_send_to_conversation
string
Unique identifier for the conversation to which the invoices will be sent when issued.
recurring_start_date
string
Time at which the recurring invoice will start.
shipping_amount
number
Shipping amount of the invoice.
target_folder
string
Unique identifier for the folder in which the issued invoices will be added.
tax_items
associative array
Invoice tax items.
Returns
Returns the created recurring invoice object. Throws an error if some parameters are not valid.
post
/api/recurring-invoices
curl -X POST https://{workspace}.kitchen.co/api/recurring-invoices \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Requested-With: XMLHttpRequest' \
-H 'Authorization: Bearer {API_KEY}'
Response
{
"amount": 675.65,
"billing_profile": "bp_0123bc88a70c86ed9d1feb73",
"charge_automatically": false,
"client": "u_62988d0392da49247a831d35",
"created_at": "2024-03-13T09:16:53+00:00",
"creator": "u_c13cc0aee4b5af7a42951898",
"currency": "USD",
"discount_amount": 341.47,
"discounts": [
{
"amount": 50.54,
"currency": "USD",
"id": "invti_81c4288ef04117d38e29b22c",
"title": "The discount item title",
"type": "percentage"
}
],
"due_date_in_days": 8,
"due_reminder_message": "The reminder message",
"due_reminder_send_days": 2,
"footer_notes": null,
"id": "in_700e2b6deea32f7022cc3cc9",
"items": [
{
"amount": 675.65,
"currency": "USD",
"description": "The invoice item description",
"id": "invi_ac3074df0d1c309d12624399",
"quantity": "1.00",
"title": "The invoice item title"
}
],
"language": "en_US",
"memo": null,
"next_invoice_issue_date": null,
"payment_gateways": [],
"recurring_activated_at": null,
"recurring_end_date": null,
"recurring_frequency": 1,
"recurring_name": "Recurring #1",
"recurring_period_unit": "month",
"recurring_send_email_cc_addresses": null,
"recurring_send_email_message": null,
"recurring_send_email_to_client": null,
"recurring_send_to_conversation": null,
"recurring_start_date": null,
"recurring_status": "draft",
"recurring_stopped_at": null,
"target_folder": null,
"tax_items": [
{
"amount": 46.3,
"currency": "USD",
"id": "invti_e5d2b8e5d9a4017b84c95b47",
"title": "The tax item title"
}
],
"tax_amount": 154.73,
"shipping_amount": 19.99,
"total_amount": 508.9,
"type": "recurring",
"updated_at": "2024-03-13T09:16:53+00:00"
}