You need to add a filter parameter to your GET request. This parameter has to be a JSON array of objects. Please refer to the filters main section to see how to build correctly the filter parameter.

Allowed filter combinations for billing subscriptions

Field

Description

Value(s)

Available operators

status

The invoice status

Look at the invoice status values below

eq

customer_id

The invoice customer id

String

eq

start

The invoice issue date

String (ISO 8601)

eq, not_eq, lt, gt, lteq, gteq

finish

The invoice deadline date

String (ISO 8601)

eq, not_eq, lt, gt, lteq, gteq

List of invoice status values

Value

Description

stopped

A billing subscription that is paused

draft

A billing subscription that is still in draft mode

not_started

A billing subscription with start_date in future

finished

A billing subscription that finished all the occurences

in_progress

A billing subscription that is currently running