Skip to main content
GET
/
companies
/
{company_id}
/
products
/
{id}
Get Product
curl --request GET \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/products/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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>"
    }
  ],
  "id": "<string>",
  "image_url": null,
  "metadata": {},
  "name": "<string>",
  "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

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

​
id
string

The ID of the product in Maple

​
image_url
string | null

The url for the image of the product

​
metadata
object

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

​
name
string

The name of the 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

⌘I