GEgetlago
subscriptions

Retrieve a fixed charge for a subscription

Changed on

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}

Request

Query parameters

subscription_status'pending' | 'active' | 'terminated' | 'canceled' | 'incomplete'
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, canceled, or incomplete.

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.0",
    "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,
        "applied_to_billing_entities_codes": [
          "acme_corp",
          "foo_bar"
        ],
        "created_at": "2023-07-06T14:35:58Z"
      }
    ]
  }
}

Changes

  • 5d26657495a3Revision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the / response's property type changed from number to string for status

    • info

      added the new enum value incomplete to the query request parameter subscription_status

    • info

      added the optional property /// to the response with the status

    • info

      the response property /// became required for the status