Invoice terms

List, create, read, update, enable, disable and delete invoice terms, each a period and a duration.

An invoice term is a settings record made of a period, such as MONTHLY, and a duration. You can list, create, read, update, enable or disable and delete invoice terms. This area has 5 endpoints, and all seven SDKs call every one.

At a glance

Endpoint	Method	Path	What it does
List invoice terms	GET	/settings/invoice_terms	Returns a page of invoice terms under data, with paging details under pagination.
Create an invoice term	POST	/settings/invoice_terms	Creates an invoice term and returns it under invoice_term.
Retrieve an invoice term	GET	/settings/invoice_terms/{invoice_term_id}	Returns one invoice term by its id, under invoice_term.
Delete an invoice term	DELETE	/settings/invoice_terms/{invoice_term_id}	Deletes an invoice term. The response has no body.
Update an invoice term	PATCH	/settings/invoice_terms/{invoice_term_id}	Changes the fields of an invoice term, or enables or disables it, and returns it under invoice_term.

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

• Writes and reads return different shapes. A create or an update returns a flat period and an integer duration, where a read nests them as duration.period and duration.count.
• A create sends period and duration. For example "period": "MONTHLY" and "duration": 1, with name and display_name, under invoice_term.
• Listings page by cursor. Records sit under data; pass pagination.next_cursor as cursor to read the next page, and stop when pagination.has_more is false.
• A delete returns 204 with no body. Reading the invoice term afterwards returns 404.