List all packages

Lists all packages with details including name, aliases, duration, and terms. To view contracts on a specific package, use the listContractsOnPackage endpoint.

POST /v1/packages/list

List all packages

cURL

curl --request POST \
  --url https://api.metronome.com/v1/packages/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "data": [
    {
      "id": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
      "name": "Test Package",
      "usage_statement_schedule": {
        "frequency": "MONTHLY"
      },
      "created_at": "2019-12-31T14:23:55.234Z",
      "created_by": "Alice",
      "commits": [
        {
          "id": "62c0cb84-bf3f-48b9-9bcf-a8ddf8c1cf35",
          "type": "PREPAID",
          "name": "My test commit",
          "description": "My test commit description",
          "product": {
            "id": "2e30f074-d04c-412e-a134-851ebfa5ceb2",
            "name": "My product A"
          },
          "applicable_product_ids": [
            "13a2179b-f0cb-460b-85a1-cd42964ca533"
          ],
          "access_schedule": {
            "credit_type": {
              "id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
              "name": "USD (cents)"
            },
            "schedule_items": [
              {
                "id": "2d45952c-5a6e-43a9-8aab-f61ee21be81a",
                "amount": 10000000,
                "starting_at_offset": {
                  "unit": "MONTHS",
                  "value": 1
                },
                "duration": {
                  "unit": "MONTHS",
                  "value": 3
                }
              }
            ]
          },
          "invoice_schedule": {
            "credit_type": {
              "id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
              "name": "USD (cents)"
            },
            "schedule_items": [
              {
                "id": "f15e4e23-f74e-4de4-9b3a-8b07434116c4",
                "unit_price": 10000000,
                "quantity": 1,
                "date_offset": {
                  "unit": "MONTHS",
                  "value": 4
                }
              }
            ],
            "do_not_invoice": false
          }
        }
      ],
      "overrides": [
        {
          "id": "6cf3292a-e85c-4be6-822c-e25ba9d19757",
          "starting_at_offset": {
            "unit": "MONTHS",
            "value": 1
          },
          "type": "MULTIPLIER",
          "multiplier": 0.1,
          "override_specifiers": [
            {
              "product_id": "eae8903b-693b-41a7-8c0b-f23748c9a9c8"
            }
          ]
        }
      ],
      "scheduled_charges": [
        {
          "id": "04dbca69-0bc2-45c6-ba22-a53934353b10",
          "name": "Test Scheduled Charge",
          "description": "Test Scheduled Charge Description",
          "product": {
            "id": "eae8903b-693b-41a7-8c0b-f23748c9a9c8",
            "name": "My product B"
          },
          "schedule": {
            "credit_type": {
              "id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
              "name": "USD (cents)"
            },
            "schedule_items": [
              {
                "id": "f15e4e23-f74e-4de4-9b3a-8b07434116c4",
                "unit_price": 10000000,
                "quantity": 1,
                "date_offset": {
                  "unit": "MONTHS",
                  "value": 4
                }
              }
            ]
          }
        }
      ]
    },
    {
      "id": "67ee9504-ae43-4317-b70e-1c449910e14f",
      "name": "Test Package 2",
      "commits": [],
      "overrides": [],
      "scheduled_charges": [],
      "usage_statement_schedule": {
        "frequency": "MONTHLY"
      },
      "created_at": "2021-07-10T00:00:00.000Z",
      "created_by": "Bob"
    }
  ],
  "next_page": "eyJvZmZzZXQiOjF9"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit · integer

The maximum number of packages to return. Defaults to 10.

Required range: 1 <= x <= 100

next_page · string

Cursor that indicates where the next page of results should start.

Body

application/json

The body is of type object.

Response

200 - application/json

Success

data · object[] · required

Show child attributes

next_page · string | null · required