Skip to main content
GET
/
companies
/
{company_id}
/
bundles
/
{id}
Get Bundle
curl --request GET \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/bundles/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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>",
            "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>",
                "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>",
                "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": {
                  "company_id": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "description": "<string>",
                  "display_type": "<string>",
                  "editable": true,
                  "external_name": "<string>",
                  "id": "<string>",
                  "name": "<string>",
                  "standard": true,
                  "type": "<string>",
                  "updated_at": "2023-11-07T05:31:56Z"
                },
                "item_id": "<string>",
                "item_pricing": {
                  "base_price": {},
                  "base_units": 123,
                  "carry_over": true,
                  "charge_type": "<string>",
                  "company": {},
                  "company_id": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "credit_price": {},
                  "custom_price": {},
                  "description": "<string>",
                  "display_type": "<string>",
                  "editable": true,
                  "external_name": "<string>",
                  "fixed_price": {},
                  "frequency": "<string>",
                  "gradient_price": [
                    "<any>"
                  ],
                  "id": "<string>",
                  "item": {},
                  "item_id": "<string>",
                  "metadata": {},
                  "minimum_spend": {},
                  "minimum_spend_schedule": {},
                  "name": "<string>",
                  "num_subs": 1,
                  "proration_type": "<string>",
                  "recognition_schedule": {},
                  "scheduled_price": {},
                  "state": "<string>",
                  "step_price": {},
                  "term_count": 123,
                  "true_up_frequency": "<string>",
                  "type": "<string>",
                  "updated_at": "2023-11-07T05:31:56Z",
                  "volume_price": [
                    "<any>"
                  ]
                },
                "item_pricing_id": "<string>",
                "metric": {
                  "company_id": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "description": "<string>",
                  "external_name": "<string>",
                  "id": "<string>",
                  "item_id": "<string>",
                  "metering_rule": {},
                  "name": "<string>",
                  "standard": true,
                  "type": "<string>",
                  "updated_at": "2023-11-07T05:31:56Z"
                },
                "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>",
            "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>",
            "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": {
              "company_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "description": "<string>",
              "display_type": "<string>",
              "editable": true,
              "external_name": "<string>",
              "id": "<string>",
              "name": "<string>",
              "standard": true,
              "type": "<string>",
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "item_id": "<string>",
            "item_pricing": {
              "base_price": {},
              "base_units": 123,
              "carry_over": true,
              "charge_type": "<string>",
              "company": {},
              "company_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "credit_price": {},
              "custom_price": {},
              "description": "<string>",
              "display_type": "<string>",
              "editable": true,
              "external_name": "<string>",
              "fixed_price": {},
              "frequency": "<string>",
              "gradient_price": [
                "<any>"
              ],
              "id": "<string>",
              "item": {},
              "item_id": "<string>",
              "metadata": {},
              "minimum_spend": {},
              "minimum_spend_schedule": {},
              "name": "<string>",
              "num_subs": 1,
              "proration_type": "<string>",
              "recognition_schedule": {},
              "scheduled_price": {},
              "state": "<string>",
              "step_price": {},
              "term_count": 123,
              "true_up_frequency": "<string>",
              "type": "<string>",
              "updated_at": "2023-11-07T05:31:56Z",
              "volume_price": [
                "<any>"
              ]
            },
            "item_pricing_id": "<string>",
            "metric": {
              "company_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "description": "<string>",
              "external_name": "<string>",
              "id": "<string>",
              "item_id": "<string>",
              "metering_rule": {},
              "name": "<string>",
              "standard": true,
              "type": "<string>",
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "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": 123,
    "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_'.

​
id
string
required

The resource ID

Response

200 - application/json

OK

​
bundle_product_pricings
object[] | null
​
company_id
string
​
created_at
string<date-time>
​
currency
string
​
description
string
​
id
string
​
is_auto_generated
boolean
​
metadata
object
​
name
string
​
num_subs
integer
Required range: x >= 0
​
state
string
​
term
object

The term which includes a frequency interval and a count for number of intervals

​
updated_at
string<date-time>
⌘I