GEgetlago
add_ons

List all add-ons

Changed on

This endpoint is used to list all existing add-ons.

get/add_ons

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

Add-ons

Example response

{
  "add_ons": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "name": "Setup Fee",
      "invoice_display_name": "Setup Fee (SF1)",
      "code": "setup_fee",
      "amount_cents": 50000,
      "amount_currency": "USD",
      "description": "Implementation fee for new customers.",
      "created_at": "2022-04-29T08:59:51Z",
      "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
    • warning

      added the new SYP enum value to the // response property for the response status

    • warning

      added the new TND enum value to the // response property for the response status

    • info

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

    • info

      the response property // became required for the status

    • info

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