POST
/
companies
/
{company_id}
/
bundles
/
find
Find Bundles
curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/bundles/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "include_meta": true,
  "pagination": {
    "from_key": null,
    "limit": 20
  },
  "query": {
    "is_auto_generated": null,
    "search": null,
    "state": null
  },
  "sort_key": "createdAtDesc"
}'
{
  "pagination": {
    "from_key": null,
    "limit": 123
  },
  "results": [
    {
      "bundle_product_pricings": [
        {
          "bundle_pricing_id": "<string>",
          "company_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "product": {
            "company_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "description": "<string>",
            "entitlements": [
              {
                "entitlement_id": "<string>",
                "inherited_from_id": null,
                "inherited_from_type": null,
                "key": "<string>",
                "name": "<string>",
                "original_value": "<any>",
                "overridden": null,
                "type": "<string>",
                "value": "<any>"
              }
            ],
            "external_name": "<string>",
            "id": "<string>",
            "image_url": null,
            "import_created_at_ref": null,
            "import_ref": null,
            "imported_from": null,
            "metadata": {},
            "name": "<string>",
            "product_pricings": [
              {
                "company_id": "<string>",
                "computed_entitlements": [
                  {
                    "entitlement_id": "<string>",
                    "inherited_from_id": null,
                    "inherited_from_type": null,
                    "key": "<string>",
                    "name": "<string>",
                    "original_value": "<any>",
                    "overridden": null,
                    "type": "<string>",
                    "value": "<any>"
                  }
                ],
                "created_at": "2023-11-07T05:31:56Z",
                "currency": "<string>",
                "description": "<string>",
                "external_name": "<string>",
                "id": "<string>",
                "import_created_at_ref": null,
                "import_ref": null,
                "imported_from": null,
                "metadata": {},
                "name": "<string>",
                "num_subs": 1,
                "override_entitlements": [
                  {
                    "entitlement_id": "<string>",
                    "inherited_from_id": null,
                    "inherited_from_type": null,
                    "key": "<string>",
                    "name": "<string>",
                    "original_value": "<any>",
                    "overridden": null,
                    "type": "<string>",
                    "value": "<any>"
                  }
                ],
                "product": {},
                "product_id": "<string>",
                "product_metric_pricings": [
                  {
                    "company_id": "<string>",
                    "created_at": "2023-11-07T05:31:56Z",
                    "id": "<string>",
                    "item": {},
                    "item_id": "<string>",
                    "item_pricing": {},
                    "item_pricing_id": "<string>",
                    "metric": {},
                    "metric_id": "<string>",
                    "product_id": "<string>",
                    "updated_at": "2023-11-07T05:31:56Z"
                  }
                ],
                "state": "<string>",
                "tags": [
                  "<string>"
                ],
                "type": "<string>",
                "updated_at": "2023-11-07T05:31:56Z",
                "upsell_product_pricing_id": null
              }
            ],
            "state": "<string>",
            "tags": [
              "<string>"
            ],
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "product_id": "<string>",
          "product_pricing": {
            "company_id": "<string>",
            "computed_entitlements": [
              {
                "entitlement_id": "<string>",
                "inherited_from_id": null,
                "inherited_from_type": null,
                "key": "<string>",
                "name": "<string>",
                "original_value": "<any>",
                "overridden": null,
                "type": "<string>",
                "value": "<any>"
              }
            ],
            "created_at": "2023-11-07T05:31:56Z",
            "currency": "<string>",
            "description": "<string>",
            "external_name": "<string>",
            "id": "<string>",
            "import_created_at_ref": null,
            "import_ref": null,
            "imported_from": null,
            "metadata": {},
            "name": "<string>",
            "num_subs": 1,
            "override_entitlements": [
              {
                "entitlement_id": "<string>",
                "inherited_from_id": null,
                "inherited_from_type": null,
                "key": "<string>",
                "name": "<string>",
                "original_value": "<any>",
                "overridden": null,
                "type": "<string>",
                "value": "<any>"
              }
            ],
            "product": {},
            "product_id": "<string>",
            "product_metric_pricings": [
              {
                "company_id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "id": "<string>",
                "item": {},
                "item_id": "<string>",
                "item_pricing": {},
                "item_pricing_id": "<string>",
                "metric": {},
                "metric_id": "<string>",
                "product_id": "<string>",
                "updated_at": "2023-11-07T05:31:56Z"
              }
            ],
            "state": "<string>",
            "tags": [
              "<string>"
            ],
            "type": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "upsell_product_pricing_id": null
          },
          "product_pricing_id": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "company_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "description": "<string>",
      "id": "<string>",
      "is_auto_generated": true,
      "metadata": {},
      "name": "<string>",
      "num_subs": 1,
      "state": "<string>",
      "term": {
        "count": 2,
        "frequency": "HOUR"
      },
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

​
company_id
string
required

The company ID with the prefix 'cmp_'.

Body

application/json

Response

200 - application/json

OK

The response is of type object.