The subscription object

{
  "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",
  "plan_amount_cents": 10000,
  "plan_amount_currency": "USD",
  "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",
  "on_termination_credit_note": "credit",
  "on_termination_invoice": "generate",
  "payment_method": {
    "payment_method_type": "provider",
    "payment_method_id": "1a901a90-1a90-1a90-1a90-1a901a901a90"
  },
  "consolidate_invoice": true,
  "progressive_billing_disabled": false,
  "cancellation_reason": "payment_failed",
  "activated_at": "2022-08-08T00:00:00Z",
  "activation_rules": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "type": "payment",
      "timeout_hours": 48,
      "status": "pending",
      "expires_at": "2022-08-10T00:00:00Z",
      "created_at": "2022-08-08T00:00:00Z",
      "updated_at": "2022-08-08T00:00:00Z"
    }
  ],
  "purchase_order_number": "PO-123",
  "billing_entity_code": "default",
  "applied_invoice_custom_sections": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "created_at": "2023-07-06T14:35:58Z",
      "invoice_custom_section": {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "name": "EU Bank Details",
        "code": "eu_bank_details",
        "description": "This section contains the bank details for EU customers.",
        "details": "Bank Name: Lago Bank, IBAN: FR7630004000031234567890143",
        "display_name": "Bank Details:",
        "applied_to_organization": true,
        "organization_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "created_at": "2023-07-06T14:35:58Z"
      },
      "invoice_custom_section_id": "1a901a90-1a90-1a90-1a90-1a901a901a90"
    }
  ],
  "applicable_usage_thresholds": [
    {
      "threshold_display_name": "Threshold 1",
      "amount_cents": 10000,
      "recurring": true
    }
  ],
  "entitlements": [
    {
      "code": "seats",
      "name": "Number of seats",
      "description": "Number of users of the account",
      "privileges": [
        {
          "code": "max",
          "name": "Maximum",
          "value_type": "integer",
          "config": {},
          "value": 15,
          "plan_value": 10,
          "override_value": 15
        },
        {
          "code": "max_admins",
          "name": "Max Admins",
          "value_type": "integer",
          "config": {},
          "value": 5,
          "plan_value": 5,
          "override_value": null
        },
        {
          "code": "root",
          "name": "Allow root user",
          "value_type": "boolean",
          "config": {},
          "value": true,
          "plan_value": true,
          "override_value": null
        },
        {
          "code": "provider",
          "name": "SSO Provider",
          "value_type": "select",
          "value": "okta",
          "plan_value": "google",
          "override_value": "okta",
          "config": {
            "select_options": [
              "google",
              "okta"
            ]
          }
        }
      ],
      "overrides": {
        "max": 15,
        "provider": "okta"
      }
    }
  ]
}

lago_id

string<uuid>

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"

external_id

string

required

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

Example:

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

lago_customer_id

string<uuid>

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"

external_customer_id

string

required

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

Example:

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

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"

name

string | null

required

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"

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"

plan_amount_cents

integer

required

The base cost of the related plan, excluding any applicable taxes, that is billed on a recurring basis.

Example:

10000

plan_amount_currency

enum<string>

required

The currency of the related plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLF,

CLP,

CNY,

COP,

CRC,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

ISK,

JMD,

JPY,

KES,

KGS,

KHR,

KMF,

KRW,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRO,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

STD,

SYP,

SZL,

THB,

TJS,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

Example:

"USD"

status

enum<string>

required

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

active: the subscription is currently active and applied to the customer.
canceled: the subscription has been stopped before its activation. This can occur when two consecutive downgrades have been applied to a customer, when a subscription with a pending status is terminated, or when a payment-gated subscription fails to be paid (or its activation rule expires) before activation. When caused by payment gating, the cancellation_reason field is set.
incomplete: the subscription was created with a payment activation rule and is waiting for the gating payment to succeed before it becomes active. It is automatically canceled if the payment fails or the activation rule expires.
pending: a previous subscription has been downgraded, and the current one is awaiting automatic activation at the end of the billing period.
terminated: the subscription is no longer active.

Available options:

active,

canceled,

incomplete,

pending,

terminated

Example:

"active"

created_at

string<date-time>

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"

canceled_at

string<date-time> | null

required

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"

started_at

string<date-time> | null

required

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"

ending_at

string<date-time> | null

required

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"

subscription_at

string<date-time>

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"

terminated_at

string<date-time> | null

required

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"

previous_plan_code

string | null

required

The code identifying the previous plan associated with this subscription.

Example:

null

next_plan_code

string | null

required

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

Example:

null

downgrade_plan_date

string<date> | null

required

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

Example:

"2022-04-30"

trial_ended_at

string<date-time> | null

required

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

Example:

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

current_billing_period_started_at

string<date-time> | null

required

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

Example:

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

current_billing_period_ending_at

string<date-time> | null

required

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

Example:

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

on_termination_credit_note

enum<string> | null

required

When a pay-in-advance subscription is terminated before the end of its billing period, we generate a credit note for the unused subscription time by default. This field allows you to control the behavior of the credit note generation:

credit: A credit note is generated for the unused subscription time. The unused amount is credited back to the customer.
refund: A credit note is generated for the unused subscription time. If the invoice is paid or partially paid, the unused paid amount is refunded; any unpaid unused amount is credited back to the customer.
offset: A credit note is generated for the unused subscription time. If the invoice is paid or partially paid, the unused paid amount is refunded; any unpaid unused amount is applied to the invoice reducing its amount due.
skip: No credit note is generated for the unused subscription time.

Note: This field is only applicable to pay-in-advance plans and will be null for pay-in-arrears plans.

Available options:

credit,

refund,

offset,

skip

Example:

"credit"

on_termination_invoice

enum<string>

default:generate

required

When a subscription is terminated before the end of its billing period, we generate an invoice for the unbilled usage. This field allows you to control the behavior of the invoice generation:

generate: An invoice is generated for the unbilled usage.
skip: No invoice is generated for the unbilled usage.

Available options:

generate,

skip

Example:

"generate"

payment_method

object

required

The payment method assigned to this subscription for processing payments.

Show child attributes

consolidate_invoice

boolean

default:true

required

Controls whether this subscription is eligible to be grouped with other subscriptions of the same customer on a consolidated recurring invoice.

true (default): the subscription is included in the customer's standard invoice grouping (by billing entity, currency and payment method).
false: the subscription is excluded from consolidation and always billed on its own dedicated invoice, regardless of other grouping criteria.

Example:

true

progressive_billing_disabled

boolean

default:false

required

Indicates whether progressive billing is switched off for this subscription, regardless of any usage thresholds defined on the plan (including thresholds inherited from a parent plan when the subscription runs on a plan override).

When true, no progressive billing invoice is issued for this subscription.

Example:

false

cancellation_reason

enum<string> | null

required

The reason a payment-gated subscription was canceled while still incomplete. Null unless the subscription was canceled before activation.

payment_failed: the gating payment failed.
timeout: the activation rule expired before the payment succeeded.
manual: the incomplete subscription was canceled on demand, via a terminate request with status=incomplete.

Available options:

payment_failed,

timeout,

manual

Example:

"payment_failed"

activated_at

string<date-time> | null

required

The date and time when a payment-gated subscription was activated (i.e. moved from incomplete to active once the gating payment succeeded), represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). Null while the subscription is still incomplete.

Example:

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

activation_rules

object[]

required

The activation rules attached to the subscription. A payment activation rule gates activation on a successful first payment, keeping the subscription in the incomplete state until the payment succeeds or the rule expires.

Show child attributes

purchase_order_number

string | null

required

The purchase order number associated with the subscription. It will be added to invoices generated for this subscription.

Example:

"PO-123"

billing_entity_code

string

The code of the billing entity associated with the subscription.

Example:

"default"

applied_invoice_custom_sections

object[]

The invoice custom sections applied to invoices generated by this subscription. Only returned when creating, retrieving, updating or terminating a subscription, not when listing subscriptions and not in subscription webhooks.

Show child attributes

plan

object

Show child attributes

applicable_usage_thresholds

object[]

List of usage thresholds applicable to this subscription. Not returned when terminating a subscription.

Show child attributes

entitlements

object[]

The feature entitlements of the subscription. Only returned when creating or retrieving a subscription.

Show child attributes