The Recurring Invoice object
Attributes
amount
nullable integer
The amount in cents to be charged, represented as a whole integer if possible.
billing_profile
nullable string
ID of the invoice billing profile.
charge_automatically
boolean
Whether the invoice will charge the customer automatically when it is due.
client
nullable string
ID of the invoice client user.
created_at
string
Time at which the invoice was created.
creator
string
ID of the invoice creator user.
currency
string
Three-letter ISO currency code.
discount_amount
integer
Total discount amount of the invoice in cents.
discounts
associative array
Discounts applied to the invoice.
due_date_in_days
nullable integer
Days in which invoices will be due after issuing.
due_reminder_message
nullable string
Message that will be sent with the due reminder.
due_reminder_send_days
nullable string
Number of days indicating how many days before or after the invoice due is the reminder sent.
footer_notes
nullable string
Footer notes of the invoice.
id
string
Unique identifier for the invoice.
items
associative array
Line items of the invoice
language
string
Language of the invoice.
memo
nullable string
Memo of the invoice.
next_invoice_issue_date
nullable string
Time at which the next invoice will be issued.
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_activated_at
nullable string
Time at which the invoice was activated.
recurring_end_date
nullable string
Time at which the next invoice will end.
recurring_frequency
nullable integer
Positive integer describing the recurring frequency.
recurring_name
string
The name for the invoice.
recurring_period_unit
nullable enum
The unit in which the recurring frequency is measured. One of
day, week, month, year.recurring_send_email_cc_addresses
nullable array
Emails to which the invoice will be sent when issued.
recurring_send_email_message
nullable array
Message for the email sent when the invoice is issued.
recurring_send_email_to_client
nullable boolean
Whether to send an email to the client when invoice is issued.
recurring_send_to_conversation
nullable string
Unique identifier for the conversation to which the invoices will be sent when issued.
recurring_start_date
nullable string
Unique identifier for the conversation to which the invoices will be sent when issued.
recurring_status
enum
Status of the recurring invoice. One of
active, stopped, draft, expired.recurring_stopped_at
nullable string
Time at which the invoice was stopped.
target_folder
nullable string
Unique identifier for the folder in which the issued invoices will be added.
tax_items
associative array
Tax items of the invoice
tax_amount
integer
Total tax amount of the invoice in cents.
total_amount
integer
Total amount of the invoice in cents.
type
enum
The type of the invoice. One of
invoice, recurring.updated_at
string
Time at which the invoice was last updated.
The Recurring Invoice object
{
"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,
"total_amount": 488.91,
"type": "recurring",
"updated_at": "2024-03-13T09:16:53+00:00"
}