PATCH
/
companies
/
{company_id}
/
products
/
{id}
Update Product
curl --request PATCH \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/products/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": null,
  "entitlements": null,
  "external_name": null,
  "image_url": {},
  "metadata": {},
  "name": null,
  "state": null,
  "tags": null
}'
{
  "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": {
            "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": {
              "currency": "<string>",
              "value_in_cents": 123
            },
            "base_units": 123,
            "carry_over": true,
            "charge_type": "<string>",
            "company": {
              "address": {
                "address_line_1": "<string>",
                "address_line_2": "<string>",
                "city": "<string>",
                "country": "<string>",
                "place_id": null,
                "state": "<string>",
                "zip": "<string>"
              },
              "computed_entitlements": {},
              "created_at": "2023-11-07T05:31:56Z",
              "customer_id": null,
              "demo": true,
              "email": "<string>",
              "id": "<string>",
              "is_dev": true,
              "legal_name": "<string>",
              "name": "<string>",
              "phone": "<string>",
              "preferred_currency": "<string>",
              "preferred_timezone": "<string>",
              "slug": "<string>",
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "company_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "credit_price": {
              "amount": {
                "currency": "<string>",
                "value_in_cents": 123
              },
              "item_id": null,
              "type": "AMOUNT",
              "units": 123
            },
            "custom_price": {
              "max_price_per_unit": 123,
              "min_price_per_unit": 123,
              "preset_price_per_unit": 123,
              "price_per_unit": 123
            },
            "description": "<string>",
            "display_type": "<string>",
            "editable": true,
            "external_name": "<string>",
            "fixed_price": {
              "price_per_unit": 123
            },
            "frequency": "<string>",
            "gradient_price": [
              {
                "end": 1,
                "flat_price": 123,
                "is_custom_tier": true,
                "price_per_unit": 123,
                "start": 1
              }
            ],
            "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>",
            "metadata": {},
            "minimum_spend": {
              "currency": "<string>",
              "value_in_cents": 123
            },
            "minimum_spend_schedule": {
              "allow_pulling_forward": true,
              "amount_per_period": null,
              "minimum_spend_schedule_type": "<string>"
            },
            "name": "<string>",
            "num_subs": 1,
            "proration_type": "<string>",
            "recognition_schedule": {
              "amount_per_period": null,
              "recognition_schedule_type": "<string>"
            },
            "scheduled_price": {
              "price_per_unit_per_period": [
                "<string>"
              ]
            },
            "state": "<string>",
            "step_price": {
              "price_per_step": 123,
              "step_size": 1
            },
            "term_count": 123,
            "true_up_frequency": "<string>",
            "type": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "volume_price": [
              {
                "flat_price": 123,
                "is_custom_tier": true,
                "price_per_unit": 123,
                "total_units_end": 1,
                "total_units_start": 1
              }
            ]
          },
          "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": {
              "aggregator": "<string>",
              "group_keys": [
                "<string>"
              ],
              "property": "<string>",
              "rule": null
            },
            "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"
}

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

Body

application/json
​
description
string | null

The description of the product

​
entitlements
object[] | null

The entitlements that enable features for the product

​
external_name
string | null

The external name of the product

​
image_url
object

The url for the image of the product

​
metadata
object

Any additional data as key-value pairs that need to be attached to the product

​
name
string | null

The name of the product

​
state
string | null

The state of the product such as ACTIVE or ARCHIVED

​
tags
string[] | null

Any string tags associated with this product

Response

200 - application/json

OK

​
company_id
string

The company ID of the product

​
created_at
string<date-time>

The date the product was created

​
description
string

The description of the product

​
entitlements
object[] | null

The entitlements that enable features for the product

​
external_name
string

The external name of the product

​
id
string

The ID of the product in Maple

​
image_url
string | null

The url for the image of the product

​
import_created_at_ref
string<date-time> | null

The date the product was created in the import source

​
import_ref
string | null

The import reference ID for the product

​
imported_from
string | null

Where the product is imported from

​
metadata
object

Any additional data as key-value pairs attached to the product

​
name
string

The name of the product

​
product_pricings
object[] | null

The product prices attached to this product

​
state
string

The state of the product such as ACTIVE or ARCHIVED

​
tags
string[] | null

Any tags on the product

​
updated_at
string<date-time>

The date the product was last updated