List all subscriptions

API Reference

GET

subscriptions

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request GET "$LAGO_URL/api/v1/subscriptions?external_customer_id=123&plan_code=starter&status[]=pending" \
  --header "Authorization: Bearer $API_KEY"

{
  "subscriptions": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "external_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
      "lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "external_customer_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
      "billing_time": "anniversary",
      "name": "Repository A",
      "plan_code": "premium",
      "status": "active",
      "created_at": "2022-08-08T00:00:00Z",
      "canceled_at": "2022-09-14T16:35:31Z",
      "started_at": "2022-08-08T00:00:00Z",
      "ending_at": "2022-10-08T00:00:00Z",
      "subscription_at": "2022-08-08T00:00:00Z",
      "terminated_at": "2022-09-14T16:35:31Z",
      "previous_plan_code": null,
      "next_plan_code": null,
      "downgrade_plan_date": "2022-04-30",
      "trial_ended_at": "2022-08-08T00:00:00Z",
      "current_billing_period_started_at": "2022-08-08T00:00:00Z",
      "current_billing_period_ending_at": "2022-09-08T00:00:00Z"
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_pages": 4,
    "total_count": 70
  }
}

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request GET "$LAGO_URL/api/v1/subscriptions?external_customer_id=123&plan_code=starter&status[]=pending" \
  --header "Authorization: Bearer $API_KEY"

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page

integer

Page number.

Example:

1

per_page

integer

Number of records per page.

Example:

20

external_customer_id

string

The customer external unique identifier (provided by your own application)

Example:

"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"

plan_code

string

The unique code representing the plan to be attached to the customer. This code must correspond to the code property of one of the active plans.

Example:

"premium"

status[]

enum<string>[]

If the field is not defined, Lago will return only active subscriptions. However, if you wish to fetch subscriptions by different status you can define them in a status[] query param. Available filter values: pending, canceled, terminated, active.

Available options:

pending,

canceled,

terminated,

active

Example:

["active", "pending"]

Response

200

application/json

List of subscriptions

subscriptions

object[]

required

subscriptions.lago_id

string

required

Unique identifier assigned to the subscription within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the subscription's record within the Lago system

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

subscriptions.external_id

string

required

The subscription external unique identifier (provided by your own application).

Example:

"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"

subscriptions.lago_customer_id

string

required

Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

subscriptions.external_customer_id

string

required

The customer external unique identifier (provided by your own application).

Example:

"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"

subscriptions.billing_time

enum<string>

required

The billing time for the subscription, which can be set as either anniversary or calendar. If not explicitly provided, it will default to calendar. The billing time determines the timing of recurring billing cycles for the subscription. By specifying anniversary, the billing cycle will be based on the specific date the subscription started (billed fully), while calendar sets the billing cycle at the first day of the week/month/year (billed with proration).

Available options:

calendar,

anniversary

Example:

"anniversary"

subscriptions.plan_code

string

required

The unique code representing the plan to be attached to the customer. This code must correspond to the code property of one of the active plans.

Example:

"premium"

subscriptions.status

enum<string>

required

The status of the subscription, which can have the following values:

pending: a previous subscription has been downgraded, and the current one is awaiting automatic activation at the end of the billing period.
active: the subscription is currently active and applied to the customer.
terminated: the subscription is no longer active.
canceled: the subscription has been stopped before its activation. This can occur when two consecutive downgrades have been applied to a customer or when a subscription with a pending status is terminated.

Available options:

active,

pending,

terminated,

canceled

Example:

"active"

subscriptions.created_at

string

required

The creation date of the subscription, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). This date provides a timestamp indicating when the subscription was initially created.

Example:

"2022-08-08T00:00:00Z"

subscriptions.subscription_at

string

required

The anniversary date and time of the initial subscription. This date serves as the basis for billing subscriptions with anniversary billing time. The anniversary_date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).

Example:

"2022-08-08T00:00:00Z"

subscriptions.name

string | null

The display name of the subscription on an invoice. This field allows for customization of the subscription's name for billing purposes, especially useful when a single customer has multiple subscriptions using the same plan.

Example:

"Repository A"

subscriptions.canceled_at

string | null

The cancellation date of the subscription. This field is not null when the subscription is canceled. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).

Example:

"2022-09-14T16:35:31Z"

subscriptions.started_at

string | null

The effective start date of the subscription. This field can be null if the subscription is pending or canceled. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).

Example:

"2022-08-08T00:00:00Z"

subscriptions.ending_at

string | null

The effective end date of the subscription. If this field is set to null, the subscription will automatically renew. This date should be provided in ISO 8601 datetime format, and use Coordinated Universal Time (UTC).

Example:

"2022-10-08T00:00:00Z"

subscriptions.terminated_at

string | null

The termination date of the subscription. This field is not null when the subscription is terminated. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC)

Example:

"2022-09-14T16:35:31Z"

subscriptions.previous_plan_code

string | null

The code identifying the previous plan associated with this subscription.

Example:

null

subscriptions.next_plan_code

string | null

The code identifying the next plan in the case of a downgrade.

Example:

null

subscriptions.downgrade_plan_date

string | null

The date when the plan will be downgraded, represented in ISO 8601 date format.

Example:

"2022-04-30"

subscriptions.trial_ended_at

string | null

The date when the free trial is ended, represented in ISO 8601 date format.

Example:

"2022-08-08T00:00:00Z"

subscriptions.current_billing_period_started_at

string | null

The date and time when the current billing period started, represented in ISO 8601 date format.

Example:

"2022-08-08T00:00:00Z"

subscriptions.current_billing_period_ending_at

string | null

The date and time when the current billing period ends, represented in ISO 8601 date format.

Example:

"2022-09-08T00:00:00Z"