GEgetlago
plans

List all fixed charges for a plan

Changed on

This endpoint retrieves all fixed charges for a specific plan.

get/plans/{code}/fixed_charges

Request

Query parameters

pageinteger
Example:1

Page number. Defaults to 1. A value that is not a positive integer, such as 0, returns the first page.

per_pageinteger
Example:20

Number of records per page. Defaults to 100. The maximum is 200, unless another maximum is configured for your organization. A value above the maximum returns a 422 error with value_is_out_of_range on per_page. A value that is not a positive integer, such as 0, returns the default number of records.

Response

List of fixed charges

Example response

{
  "fixed_charges": [
    {
      "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"
        }
      ]
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_pages": 4,
    "total_count": 70
  }
}

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 optional property //// to the response with the status

    • info

      the response property //// became required for the status