--- title: "Retrieve a subscription" method: GET path: "/subscriptions/{external_id}" tags: ["subscriptions"] --- # Retrieve a subscription `GET /subscriptions/{external_id}` This endpoint retrieves a specific subscription. ## Query parameters - `status` 'active' | 'terminated' | 'pending' | 'canceled' ## Response `200` Subscription - SubscriptionExtended - `subscription` SubscriptionObjectExtended, required - `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 - `external_id` string, required — The subscription external unique identifier (provided by your own application). - `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 - `external_customer_id` string, required — The customer external unique identifier (provided by your own application). - `billing_entity_code` string — The code of the billing entity associated with the subscription. - `billing_time` 'calendar' | 'anniversary', 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). - `name` string, nullable, 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. - `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. - `plan_amount_cents` integer — The base cost of the related plan, excluding any applicable taxes, that is billed on a recurring basis. - `plan_amount_currency` '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' | 'SZL' | 'THB' | 'TJS' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' - `status` 'active' | 'canceled' | 'incomplete' | 'pending' | 'terminated', 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. - `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. - `canceled_at` string, date-time, nullable, 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). - `started_at` string, date-time, nullable, 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). - `ending_at` string, date-time, nullable, 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). - `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). - `terminated_at` string, date-time, nullable, 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) - `previous_plan_code` string, nullable, required — The code identifying the previous plan associated with this subscription. - `next_plan_code` string, nullable, required — The code identifying the next plan in the case of a downgrade. - `downgrade_plan_date` string, date, nullable, required — The date when the plan will be downgraded, represented in ISO 8601 date format. - `trial_ended_at` string, date-time, nullable, required — The date when the free trial is ended, represented in ISO 8601 date format. - `current_billing_period_started_at` string, date-time, nullable, required — The date and time when the current billing period started, represented in ISO 8601 date format. - `current_billing_period_ending_at` string, date-time, nullable, required — The date and time when the current billing period ends, represented in ISO 8601 date format. - `on_termination_credit_note` 'credit' | 'refund' | 'offset' | 'skip', nullable, 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._ - `on_termination_invoice` 'generate' | 'skip', 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. - `applied_invoice_custom_sections` AppliedInvoiceCustomSectionObject[] — The invoice custom sections applied to invoices generated by this subscription. - `lago_id` string, uuid, required — Unique identifier of the applied invoice custom section in the Lago application. - `created_at` string, date-time, required — The date of the applied invoice custom section creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). - `invoice_custom_section_id` string, uuid — **Deprecated.** Unique identifier of the invoice custom section that was applied. - `invoice_custom_section` InvoiceCustomSectionObject, required - `lago_id` string, uuid, required — Unique identifier for the invoice custom section in the Lago application, generated by Lago to ensure record uniqueness within the system. - `name` string, required — Name of the invoice custom section. - `code` string, required — Unique code identifying the invoice custom section for the API request. - `description` string — Internal description of the invoice custom section. - `details` string — The value shown on the invoice PDF. - `display_name` string — The name of the invoice custom section displayed on the invoice. - `applied_to_organization` boolean — **Deprecated.** This field will be removed in a future version. When set to true, it applies the invoice custom section to the organization's default billing entity. To apply or remove an invoice custom section from any billing entity (including the default one), please use the `PUT /billing_entities/:code` endpoint instead. - `organization_id` string, uuid — Unique identifier for the organization associated with the invoice custom section. - `created_at` string, date-time — Creation date of the tax. - `payment_method` PaymentMethodReference — Reference to a specific payment method for processing the payment. - `payment_method_type` 'provider' | 'manual' — The type of payment method to use. - `payment_method_id` string, uuid — The unique identifier of the payment method (required when using a specific provider payment method). - `consolidate_invoice` boolean — 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. - `cancellation_reason` 'payment_failed' | 'timeout', nullable — The reason a payment-gated subscription was canceled before activation. Null unless the subscription was canceled by payment gating. - `payment_failed`: the gating payment failed. - `timeout`: the activation rule expired before the payment succeeded. - `activated_at` string, date-time, nullable — 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`. - `activation_rules` SubscriptionActivationRuleObject[] — 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. - `lago_id` string, uuid, required — Unique identifier assigned to the activation rule within the Lago application. This ID is exclusively created by Lago. - `type` 'payment', required — The type of the activation rule. Only `payment` is currently supported. A `payment` rule gates the subscription activation on a successful payment of the first invoice. - `timeout_hours` integer, required — The number of hours the subscription stays in the `incomplete` state waiting for the payment to succeed before it is automatically canceled. - `status` 'inactive' | 'pending' | 'satisfied' | 'declined' | 'failed' | 'expired' | 'not_applicable', required — The evaluation status of the activation rule: - `inactive`: the rule has not been evaluated yet. - `pending`: the rule is applicable and is waiting to be satisfied (e.g. waiting for the payment). - `satisfied`: the rule has been satisfied and no longer blocks activation. - `declined`: the rule was applicable but was declined. - `failed`: the rule could not be satisfied (e.g. the payment failed). - `expired`: the rule was not satisfied before its timeout elapsed. - `not_applicable`: the rule did not apply to this subscription. - `expires_at` string, date-time, nullable — The date and time when the rule expires, after which an unsatisfied rule causes the subscription to be canceled. Represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). Null until the rule starts being evaluated. - `created_at` string, date-time, required — The creation date of the activation rule, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). - `updated_at` string, date-time, required — The last update date of the activation rule, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). - `plan` PlanObject - `lago_id` string, uuid, required — Unique identifier of the plan created by Lago. - `name` string, required — The name of the plan. - `invoice_display_name` string — Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the plan will be used as the default display name. - `created_at` string, date-time, required — The date and time when the plan was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the plan was initially created. - `code` string, required — The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance. - `interval` 'weekly' | 'monthly' | 'quarterly' | 'semiannual' | 'yearly', required — The interval used for recurring billing. It represents the frequency at which subscription billing occurs. The interval can be one of the following values: `yearly`, `semiannual`, `quarterly`, `monthly` or `weekly`. - `description` string — The description on the plan. - `amount_cents` integer, required — The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan. - `amount_currency` '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' | 'SZL' | 'THB' | 'TJS' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW', required - `trial_period` number — The duration in days during which the base cost of the plan is offered for free. - `pay_in_advance` boolean — This field determines the billing timing for the plan. When set to `true`, the base cost of the plan is due at the beginning of each billing period. Conversely, when set to `false`, the base cost of the plan is due at the end of each billing period. - `bill_charges_monthly` boolean, nullable — This field, when set to `true`, enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is yearly or semiannual. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan's interval is `yearly` or `semiannual`. - `bill_fixed_charges_monthly` boolean, nullable — This field, when set to `true`, enables to invoice fixed charges on monthly basis, even if the cadence of the plan is yearly or semiannual. This allows customers to pay fixed charges on a monthly basis. This can be set to true only if the plan's interval is `yearly` or `semiannual`. - `minimum_commitment` MinimumCommitmentObject, nullable - `lago_id` string, uuid, required — Unique identifier of the minimum commitment, created by Lago. - `plan_code` string — The unique code representing the plan to be attached to the customer. - `amount_cents` integer, required — The amount of the minimum commitment in cents. - `invoice_display_name` string — Specifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name. - `interval` 'weekly' | 'monthly' | 'quarterly' | 'semiannual' | 'yearly' — The interval used for recurring billing. It represents the frequency at which subscription billing occurs. The interval can be one of the following values: `yearly`, `semiannual`, `quarterly`, `monthly` or `weekly`. - `created_at` string, date-time, required — The date and time when the minimum commitment was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the minimum commitment was initially created. - `updated_at` string, date-time — The date and time when the minimum commitment was updated. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the minimum commitment was initially created. - `taxes` TaxObject[] — All taxes applied to the minimum commitment. - `lago_id` string, uuid, required — Unique identifier of the tax, created by Lago. - `name` string, required — Name of the tax. - `code` string, required — Unique code used to identify the tax associated with the API request. - `description` string, nullable — Internal description of the tax - `rate` number, required — The percentage rate of the tax - `applied_to_organization` boolean, required — **Deprecated.** This field will be removed in a future version. When set to true, it applies the tax to the organization's default billing entity. To apply or remove a tax from any billing entity (including the default one), please use the `PUT /billing_entities/:code` endpoint instead. - `created_at` string, date-time, required — Creation date of the tax. - `charges` ChargeObject[] — Additional usage-based charges for this plan. - `lago_id` string, uuid, required — Unique identifier of charge, created by Lago. - `lago_billable_metric_id` string, uuid, required — Unique identifier of the billable metric created by Lago. - `code` string, nullable — Unique code identifying the charge within the plan. - `billable_metric_code` string, required — Unique code identifying a billable metric. - `invoice_display_name` string, nullable — Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name. - `created_at` string, date-time, required — The date and time when the charge was created. It is expressed in UTC format according to the ISO 8601 datetime standard. - `charge_model` 'dynamic' | 'graduated' | 'graduated_percentage' | 'package' | 'percentage' | 'standard' | 'volume', required — Specifies the pricing model used for the calculation of the final fee. It can be any of the following values: - [`dynamic`](https://docs.getlago.com/guide/plans/charges/charge-models/dynamic) - [`graduated_percentage`](https://docs.getlago.com/guide/plans/charges/charge-models/graduated-percentage) - [`graduated`](https://docs.getlago.com/guide/plans/charges/charge-models/graduated) - [`package`](https://docs.getlago.com/guide/plans/charges/charge-models/package) - [`percentage`](https://docs.getlago.com/guide/plans/charges/charge-models/percentage) - [`standard`](https://docs.getlago.com/guide/plans/charges/charge-models/standard) - [`volume`](https://docs.getlago.com/guide/plans/charges/charge-models/volume) - `pay_in_advance` boolean, required — This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to `false`, the charge is due and invoiced at the end of each billing period. - `invoiceable` boolean, required — This field specifies whether the charge should be included in a proper invoice. If set to `false`, no invoice will be issued for this charge. You can only set it to `false` when `pay_in_advance` is `true`. - `regroup_paid_fees` 'null' | 'invoice', nullable, required — This setting can only be configured if `pay_in_advance` is `true` and `invoiceable` is `false`. This field determines whether and when the charge fee should be included in the invoice. If `null`, no invoice will be issued for this charge fee. If `invoice`, an invoice will be generated at the end of the period, consolidating all charge fees with a succeeded payment status. - `prorated` boolean, required — Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully. - If set to `true`, the charge is prorated based on the remaining days in the current billing period. - If set to `false`, the charge is billed in full. - If not defined in the request, default value is `false`. - `min_amount_cents` integer, required — The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period. - `properties` ChargeObjectProperties, required - `grouped_by` string[] — **Deprecated.** Replaced by `pricing_group_keys`. The list of event properties that are used to group the events on the invoice for a `standard` charge model. - `pricing_group_keys` string[] — The list of event properties that are used to group the events on the invoice. - `graduated_ranges` object[] — Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model. - `from_value` integer, required — Specifies the lower value of a tier for a `graduated` charge model. It must be either 0 or the previous range's `to_value + 1` to maintain the proper sequence of values. - `to_value` integer, nullable, required — Specifies the highest value of a tier for a `graduated` charge model. - This value must be higher than the from_value of the same tier. - This value must be null for the last tier. - `flat_amount` string, required — The flat amount for a whole tier, excluding tax, for a `graduated` charge model. It is expressed as a decimal value. - `per_unit_amount` string, required — The unit price, excluding tax, for a specific tier of a `graduated` charge model. It is expressed as a decimal value. - `graduated_percentage_ranges` object[] — Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model. - `from_value` integer, required — Specifies the lower value of a tier for a `graduated_percentage` charge model. It must be either 0 or the previous range's `to_value + 1` to maintain the proper sequence of values. - `to_value` integer, nullable, required — Specifies the highest value of a tier for a `graduated_percentage` charge model. - This value must be higher than the from_value of the same tier. - This value must be null for the last tier. - `rate` string, ^[0-9]+.?[0-9]*$, required — The percentage rate that is applied to the amount of each transaction in the tier for a `graduated_percentage` charge model. It is expressed as a decimal value. - `flat_amount` string, ^[0-9]+.?[0-9]*$, required — The flat amount for a whole tier, excluding tax, for a `graduated_percentage` charge model. It is expressed as a decimal value. - `amount` string — - The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value. - The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value. - `free_units` integer — The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle. - `package_size` integer — The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure. - `rate` string — The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value. - `fixed_amount` string — The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value. - `free_units_per_events` integer, nullable — The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee. - `free_units_per_total_aggregation` string, nullable — The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee. - `per_transaction_max_amount` string, ^[0-9]+.?[0-9]*$, nullable — Specifies the maximum allowable spending for a single transaction. Working as a transaction cap. - `per_transaction_min_amount` string, ^[0-9]+.?[0-9]*$, nullable — Specifies the minimum allowable spending for a single transaction. Working as a transaction floor. - `volume_ranges` object[] — Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model. - `from_value` integer, required — Specifies the lower value of a tier for a `volume` charge model. It must be either 0 or the previous range's `to_value + 1` to maintain the proper sequence of values. - `to_value` integer, nullable, required — Specifies the highest value of a tier for a `volume` charge model. - This value must be higher than the `from_value` of the same tier. - This value must be `null` for the last tier. - `flat_amount` string, required — The flat amount for a whole tier, excluding tax, for a `volume` charge model. It is expressed as a decimal value. - `per_unit_amount` string, required — The unit price, excluding tax, for a specific tier of a `volume` charge model. It is expressed as a decimal value. - `presentation_group_keys` object[] — Groups usage into sub-items on invoices for display only, without affecting pricing or aggregation. - `value` string — The event property to group by. - `options` object - … - `filters` ChargeFilterObject[], required — List of filters used to apply differentiated pricing based on additional event properties. - `invoice_display_name` string, nullable, required — Specifies the name that will be displayed on an invoice. If no value is set for this field, the values of the filter will be used as the default display name. - `properties` ChargeProperties, required - `grouped_by` string[] — **Deprecated.** Replaced by `pricing_group_keys`. The list of event properties that are used to group the events on the invoice for a `standard` charge model. - `pricing_group_keys` string[] — The list of event properties that are used to group the events on the invoice. - `graduated_ranges` object[] — Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model. - … - `graduated_percentage_ranges` object[] — Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model. - … - `amount` string — - The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value. - The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value. - `free_units` integer — The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle. - `package_size` integer — The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure. - `rate` string — The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value. - `fixed_amount` string — The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value. - `free_units_per_events` integer, nullable — The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee. - `free_units_per_total_aggregation` string, nullable — The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee. - `per_transaction_max_amount` string, ^[0-9]+.?[0-9]*$, nullable — Specifies the maximum allowable spending for a single transaction. Working as a transaction cap. - `per_transaction_min_amount` string, ^[0-9]+.?[0-9]*$, nullable — Specifies the minimum allowable spending for a single transaction. Working as a transaction floor. - `volume_ranges` object[] — Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model. - … - `values` object, required — List of possible filter values. The key and values must match one of the billable metric filters. - `taxes` TaxObject[] — All taxes applied to the charge. - `lago_id` string, uuid, required — Unique identifier of the tax, created by Lago. - `name` string, required — Name of the tax. - `code` string, required — Unique code used to identify the tax associated with the API request. - `description` string, nullable — Internal description of the tax - `rate` number, required — The percentage rate of the tax - `applied_to_organization` boolean, required — **Deprecated.** This field will be removed in a future version. When set to true, it applies the tax to the organization's default billing entity. To apply or remove a tax from any billing entity (including the default one), please use the `PUT /billing_entities/:code` endpoint instead. - `created_at` string, date-time, required — Creation date of the tax. - `applied_pricing_unit` object, nullable — The pricing unit applied to the charge. - `code` string, required — The code of the pricing unit. - `conversion_rate` string, required — The conversion rate from pricing units to the plan's currency. - `accepts_target_wallet` boolean, nullable — Specifies whether the charge accepts a target wallet for prepaid credits deduction. - `lago_parent_id` string, uuid, nullable — Unique identifier of the parent charge (if this is an override). - `fixed_charges` FixedChargeObject[] — List of fixed charges for this plan. - `lago_id` string, uuid, required — Unique identifier of the fixed charge, created by Lago. - `lago_add_on_id` string, uuid, required — Unique identifier of the add-on associated with this fixed charge. - `invoice_display_name` string, required — Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name. - `add_on_code` string, required — Unique code used to identify the add-on. - `created_at` string, date-time, required — The date and time when the fixed charge was created. It is expressed in UTC format according to the ISO 8601 datetime standard. - `code` string, required — Unique code for the fixed charge. - `charge_model` 'standard' | 'graduated' | 'volume', required — The charge model for the fixed charge. Only `standard`, `graduated`, and `volume` models are supported for fixed charges. - `pay_in_advance` boolean, required — This field determines the billing timing for this fixed charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period. - `prorated` boolean, required — Specifies whether a fixed charge is prorated based on the remaining number of days in the billing period or billed fully. - If set to `true`, the charge is prorated based on the remaining days in the current billing period. - If set to `false`, the charge is billed in full. - If not defined in the request, default value is `false`. - `properties` FixedChargeProperties, required - `amount` string — - The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value. - The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value. - `graduated_ranges` object[] — Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model. - `from_value` integer, required — Specifies the lower value of a tier for a `graduated` charge model. It must be either 0 or the previous range's `to_value + 1` to maintain the proper sequence of values. - `to_value` integer, nullable, required — Specifies the highest value of a tier for a `graduated` charge model. - This value must be higher than the from_value of the same tier. - This value must be null for the last tier. - `flat_amount` string, required — The flat amount for a whole tier, excluding tax, for a `graduated` charge model. It is expressed as a decimal value. - `per_unit_amount` string, required — The unit price, excluding tax, for a specific tier of a `graduated` charge model. It is expressed as a decimal value. - `volume_ranges` object[] — Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model. - `from_value` integer, required — Specifies the lower value of a tier for a `volume` charge model. It must be either 0 or the previous range's `to_value + 1` to maintain the proper sequence of values. - `to_value` integer, nullable, required — Specifies the highest value of a tier for a `volume` charge model. - This value must be higher than the `from_value` of the same tier. - This value must be `null` for the last tier. - `flat_amount` string, required — The flat amount for a whole tier, excluding tax, for a `volume` charge model. It is expressed as a decimal value. - `per_unit_amount` string, required — The unit price, excluding tax, for a specific tier of a `volume` charge model. It is expressed as a decimal value. - `units` number, required — The number of units for the fixed charge. When retrieved through a subscription-scoped endpoint (e.g. `GET /subscriptions/{external_id}/fixed_charges`), this reflects the per-subscription unit override when one exists, and falls back to the plan-level units otherwise. Plan-scoped endpoints always return the plan-level units. - `lago_parent_id` string, uuid, nullable — Unique identifier of the parent fixed charge (for plan versions). - `taxes` TaxObject[] — List of taxes applied to the fixed charge. - `lago_id` string, uuid, required — Unique identifier of the tax, created by Lago. - `name` string, required — Name of the tax. - `code` string, required — Unique code used to identify the tax associated with the API request. - `description` string, nullable — Internal description of the tax - `rate` number, required — The percentage rate of the tax - `applied_to_organization` boolean, required — **Deprecated.** This field will be removed in a future version. When set to true, it applies the tax to the organization's default billing entity. To apply or remove a tax from any billing entity (including the default one), please use the `PUT /billing_entities/:code` endpoint instead. - `created_at` string, date-time, required — Creation date of the tax. - `taxes` TaxObject[] — All taxes applied to the plan. - `lago_id` string, uuid, required — Unique identifier of the tax, created by Lago. - `name` string, required — Name of the tax. - `code` string, required — Unique code used to identify the tax associated with the API request. - `description` string, nullable — Internal description of the tax - `rate` number, required — The percentage rate of the tax - `applied_to_organization` boolean, required — **Deprecated.** This field will be removed in a future version. When set to true, it applies the tax to the organization's default billing entity. To apply or remove a tax from any billing entity (including the default one), please use the `PUT /billing_entities/:code` endpoint instead. - `created_at` string, date-time, required — Creation date of the tax. - `usage_thresholds` UsageThresholdObject[] — List of usage thresholds applied to the plan. - `lago_id` string, uuid, required — Unique identifier of the usage threshold created by Lago. - `threshold_display_name` string, nullable, required — The display name of the usage threshold. - `amount_cents` integer, required — The amount to reach to trigger a `progressive_billing` invoice. - `recurring` boolean, required — This field when set to `true` indicates that a `progressive_billing` invoice will be created every time the lifetime usage increases by the specified amount. - `created_at` string, date-time, required — The date and time when the usage threshold was created. It is expressed in UTC format according to the ISO 8601 datetime standard. - `updated_at` string, date-time, required — The date and time when the usage threshold was last updated. It is expressed in UTC format according to the ISO 8601 datetime standard. - `entitlements` PlanEntitlement[] — List of all feature entitlements and their privileges available for this plan. - `entitlement` PlanEntitlementObject, required - `code` string, required — Unique code used to identify the feature. Max 255 characters. - `name` string, nullable, required — Name of the feature. Max 255 characters. - `description` string, nullable, required — Description of the feature. Max 600 characters. - `privileges` PlanEntitlementPrivilegeObject[], required — Privileges associated with this feature. Each privilege must have a value assigned. - `code` string, required — Unique code for the privilege. - `name` string, nullable, required — Display name for the privilege. - `value_type` 'integer' | 'boolean' | 'string' | 'select', required — Data type of the privilege value. Default: string - `config` object, required - … - `value` union, required — Value assigned to this privilege in the entitlement. Type depends on the privilege's value_type. - … - `metadata` MetadataObject, nullable — Custom metadata stored as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null. - `applicable_usage_thresholds` ApplicableUsageThreshold[] — List of usage thresholds applicable to this subscription. - `threshold_display_name` string, nullable, required — The display name of the usage threshold. - `amount_cents` integer, required — The amount to reach to trigger a `progressive_billing` invoice. - `recurring` boolean, required — This field when set to `true` indicates that a `progressive_billing` invoice will be created every time the lifetime usage increases by the specified amount. ## Other responses - `401` — Unauthorized error - `404` — Not Found error --- [API](https://skmtc.dev/getlago/apis/lago-api-documentation.md) · [All operations](https://skmtc.dev/getlago/apis/lago-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getlago/lago-api-documentation/revisions/6e969ef3bb45/schema)