Create a recurrence
Recurrences
Create a recurrence
POST
Create a recurrence
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The ID of the entity that owns the requested resource.
Example:
"9d2b4c8f-2087-4738-ba91-7359683c49a4"
Body
application/json
ID of the base invoice that will be used as a template for creating recurring invoices.
Controls how invoices are processed when generated:
- "draft": Creates invoices in draft status, requiring manual review, issuing, and sending
- "issue": Automatically issues invoices but requires manual sending
- "issue_and_send": Fully automates the process (creates, issues, and sends invoices)
Default: "issue" (or "issue_and_send" if subject_text and body_text are provided)
Note: When using "issue_and_send", both subject_text and body_text must be provided.
Available options:
draft, issue, issue_and_send The body text for the email that will be sent with the recurring invoice.
Minimum string length:
1Deprecated, use start_date instead
Available options:
first_day, last_day The end date of the recurring invoice, in the yyyy-mm-dd format. The end date is inclusive, that is, the last invoice will be created on this date if the last occurrence falls on this date. end_date is mutually exclusive with max_occurrences. Either end_date or max_occurrences must be specified.
Deprecated, use end_date instead
Required range:
1 <= x <= 12Deprecated, use end_date instead
Required range:
x <= 2077How often the invoice will be created.
Available options:
day, week, month, quarter, year The interval between each occurrence of the invoice. For example, when using monthly frequency, an interval of 1 means invoices will be created every month, an interval of 2 means invoices will be created every 2 months.
Required range:
1 <= x <= 100How many times the recurring invoice will be created. The recurrence will stop after this number is reached. max_occurrences is mutually exclusive with end_date. Either max_occurrences or end_date must be specified.
Required range:
1 <= x <= 1000An object containing the recipients (To, CC, BCC) of the recurring invoices. Can be omitted if the base invoice has the counterpart contact email specified in the counterpart_contact.email field.
The date when the first invoice will be created, in the yyyy-mm-dd format. Cannot be a past date. Subsequent invoice dates will be calculated based on start_date, frequency, and interval.
Deprecated, use start_date instead
Required range:
1 <= x <= 12Deprecated, use start_date instead
Required range:
x <= 2077The subject for the email that will be sent with the recurring invoice.
Minimum string length:
1Response
Successful Response
Time at which the recurrence was created. Timestamps follow the ISO 8601 standard.
Time at which the recurrence was last updated. Timestamps follow the ISO 8601 standard.
Controls how invoices are processed when generated:
- "draft": Creates invoices in draft status, requiring manual review, issuing, and sending
- "issue": Automatically issues invoices but requires manual sending
- "issue_and_send": Fully automates the process (creates, issues, and sends invoices)
Default: "issue" (or "issue_and_send" if subject_text and body_text are provided)
Note: When using "issue_and_send", both subject_text and body_text must be provided.
Available options:
draft, issue, issue_and_send Current iteration number
Required range:
x >= 1Deprecated, use start_date instead
Available options:
first_day, last_day How often the invoice will be created.
Available options:
day, week, month, quarter, year The interval between each occurrence of the invoice. For example, when using monthly frequency, an interval of 1 means invoices will be created every month, an interval of 2 means invoices will be created every 2 months.
Required range:
1 <= x <= 100ID of the base invoice that will be used as a template for creating recurring invoices.
List of iterations for the recurrence
Minimum array length:
1The date when the first invoice will be created, in the yyyy-mm-dd format. Cannot be a past date. Subsequent invoice dates will be calculated based on start_date, frequency, and interval.
Deprecated, use start_date instead
Required range:
1 <= x <= 12Deprecated, use start_date instead
Required range:
x <= 2077Status of the recurrence
Available options:
active, paused, canceled, completed Example:
"active"
The body text for the email that will be sent with the recurring invoice.
The end date of the recurring invoice, in the yyyy-mm-dd format. The end date is inclusive, that is, the last invoice will be created on this date if the last occurrence falls on this date. end_date is mutually exclusive with max_occurrences. Either end_date or max_occurrences must be specified.
Deprecated, use end_date instead
Required range:
1 <= x <= 12Deprecated, use end_date instead
Required range:
x <= 2077How many times the recurring invoice will be created. The recurrence will stop after this number is reached. max_occurrences is mutually exclusive with end_date. Either max_occurrences or end_date must be specified.
Required range:
1 <= x <= 1000An object containing the recipients (To, CC, BCC) of the recurring invoices. Can be omitted if the base invoice has the counterpart contact email specified in the counterpart_contact.email field.
The subject for the email that will be sent with the recurring invoice.