v1

latestOpenAPI 3.1.0AGPLv32026-07-26168262527.5 KB
subscriptions

Retrieve a fixed charge for a subscription

This endpoint retrieves a specific effective fixed charge for a subscription. The units reflect any per-subscription unit override applied to the subscription; when no override exists, the plan-level units are returned.

get/subscriptions/{external_id}/fixed_charges/{fixed_charge_code}

Query parameters

subscription_status'pending' | 'active' | 'terminated' | 'canceled'
Example:active

Filter by subscription status. When provided, the subscription is looked up with this status instead of the default active status. Possible values are pending, active, terminated, or canceled.

Response

Fixed Charge

Example response

{
  "fixed_charge": {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "lago_add_on_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "invoice_display_name": "Setup fee",
    "add_on_code": "setup_fee",
    "created_at": "2023-06-27T19:43:42Z",
    "code": "setup_fee",
    "charge_model": "standard",
    "properties": {
      "amount": "30",
      "graduated_ranges": [
        {
          "to_value": 10,
          "flat_amount": "10",
          "per_unit_amount": "0.5"
        }
      ],
      "volume_ranges": [
        {
          "to_value": 10,
          "flat_amount": "10",
          "per_unit_amount": "0.5"
        }
      ]
    },
    "units": 1,
    "lago_parent_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "taxes": [
      {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "name": "TVA",
        "code": "french_standard_vat",
        "description": "French standard VAT",
        "rate": 20,
        "applied_to_organization": true,
        "created_at": "2023-07-06T14:35:58Z"
      }
    ]
  }
}