Sign in
bills

Store a new subscription

Creates a new subscription. The data required can be submitted as a JSON body or as a list of parameters. Subscriptions are also known as bills.

post/v1/subscriptions

Headers

X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Request body

currency_idstring string

Use either currency_id or currency_code

currency_codestring string

Use either currency_id or currency_code

namestring string required
amount_minstring amount required
amount_maxstring amount required
datestring date-time required
end_datestring date-time

The date after which this bill is no longer valid or applicable

extension_datestring date-time

The date before which the bill must be renewed (or cancelled)

repeat_freq'weekly' | 'monthly' | 'quarterly' | 'half-year' | 'yearly' string required

How often the bill must be paid.

skipinteger

How often the bill must be skipped. 1 means a bi-monthly bill.

activeboolean

If the bill is active.

notesstring string nullable
object_group_idstring string nullable

The group ID of the group this object is part of. NULL if no group.

object_group_titlestring string nullable

The name of the group. NULL if no group.

Example request

{
  "currency_id": "5",
  "currency_code": "EUR",
  "name": "Rent",
  "amount_min": "123.45",
  "amount_max": "123.45",
  "date": "2026-08-01T00:00:00+00:00",
  "end_date": "2026-08-31T23:59:59+00:00",
  "extension_date": "2026-08-31T23:59:59+00:00",
  "repeat_freq": "monthly",
  "active": true,
  "notes": "Some example notes",
  "object_group_id": "5",
  "object_group_title": "Example Group"
}

Response

New subscription stored, result in response.

Changes