Skip to main content
GET
/
v1
/
subscriptions
List subscriptions
curl --request GET \
  --url https://api.quentli.com/v1/subscriptions \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "sub_1234567890abcdefghij",
    "createdAt": "2025-01-01T06:00:00.000Z",
    "updatedAt": "2025-01-01T06:00:00.000Z",
    "customerId": "cus_1234567890abcdefghij",
    "collectionMethod": "AUTOMATIC",
    "firstCollectionDate": "2025-01-01T06:00:00.000Z",
    "generationMode": "AUTO",
    "onlyAutomaticCollection": false,
    "isActive": true,
    "isCompleted": false,
    "description": "Colegiatura mensual",
    "status": "ACTIVE",
    "paymentMethodId": "pm_1234567890abcdefghij",
    "taxProfileId": null,
    "nextCollectionDate": "2025-02-01T06:00:00.000Z",
    "lastCollectionDate": "2025-12-01T06:00:00.000Z",
    "metadata": {
      "Nivel": "Preparatoria"
    },
    "customCancelReason": null,
    "canceledAt": null,
    "canceledById": null
  }
]

Authorizations

​
Authorization
string
header
required

Organization API key using Authorization: Bearer sk_....

Query Parameters

​
filter
string

A qs-encoded subscriptionFilter object.

Example:

"isActive[equals]=true"

​
skip
number
default:0

Pagination offset.

Required range: x >= 0
Example:

0

​
take
number
default:20

Pagination limit.

Required range: 1 <= x <= 100
Example:

20

​
orderBy
string

A qs-encoded subscriptionOrderBy object.

Example:

"createdAt=desc"

Response

Subscriptions list

​
id
string
required

Unique identifier of the subscription.

Example:

"sub_1234567890abcdefghij"

​
createdAt
required

Date and time when the subscription was created.

Example:

"2025-01-01T06:00:00.000Z"

​
updatedAt
required

Date and time when the subscription was last updated.

Example:

"2025-01-01T06:00:00.000Z"

​
customerId
string
required

Identifier of the customer this subscription belongs to.

Example:

"cus_1234567890abcdefghij"

​
collectionMethod
enum<string>
required

How payment is collected: AUTOMATIC, SEND_REMINDER, or NONE.

Available options:
AUTOMATIC,
SEND_REMINDER,
NONE
Example:

"AUTOMATIC"

​
firstCollectionDate
required

Date and time of the first collection.

Example:

"2025-01-01T06:00:00.000Z"

​
generationMode
enum<string>
required

Whether invoices are generated manually or automatically.

Available options:
MANUAL,
AUTO
Example:

"AUTO"

​
onlyAutomaticCollection
boolean
required

Whether only automatic collection is allowed.

Example:

false

​
isActive
boolean
required

Whether the subscription is currently active.

Example:

true

​
isCompleted
boolean
required

Whether the subscription has completed all scheduled collections.

Example:

false

​
description
string | null

Human-readable description of the subscription.

Example:

"Colegiatura mensual"

​
status
enum<string> | null

Current status: INACTIVE, ACTIVE, CANCELED, or COMPLETED.

Available options:
INACTIVE,
ACTIVE,
CANCELED,
COMPLETED,
null
Example:

"ACTIVE"

​
paymentMethodId
string | null

Identifier of the payment method used for automatic collection.

Example:

"pm_1234567890abcdefghij"

​
taxProfileId
string | null

Identifier of the tax profile used for invoice generation.

Example:

null

​
nextCollectionDate

Date and time of the next scheduled collection.

Example:

"2025-02-01T06:00:00.000Z"

​
lastCollectionDate

Date and time of the last collection, if set.

Example:

"2025-12-01T06:00:00.000Z"

​
metadata
object

Flattened metadata map where each key maps to a string value.

Example:
{ "Nivel": "Preparatoria" }
​
customCancelReason
string | null

Custom cancellation reason provided by the user.

Example:

null

​
canceledAt

Date and time when the subscription was canceled.

Example:

null

​
canceledById
string | null

Identifier of the user who canceled the subscription.

Example:

null