GET
/
companies
/
{company_id}
/
pricing
/
{id}
curl --request GET \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/pricing/{id} \
  --header 'Authorization: Bearer <token>'
{
  "company_id": "<string>",
  "computed_entitlements": [
    {
      "entitlement_id": "<string>",
      "inherited_from_id": "<string>",
      "inherited_from_type": "<string>",
      "key": "<string>",
      "name": "<string>",
      "original_value": "<any>",
      "overridden": true,
      "type": "<string>",
      "value": "<any>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "description": "<string>",
  "external_name": "<string>",
  "id": "<string>",
  "metadata": {},
  "name": "<string>",
  "num_subs": 1,
  "override_entitlements": [
    {
      "entitlement_id": "<string>",
      "inherited_from_id": "<string>",
      "inherited_from_type": "<string>",
      "key": "<string>",
      "name": "<string>",
      "original_value": "<any>",
      "overridden": true,
      "type": "<string>",
      "value": "<any>"
    }
  ],
  "product_id": "<string>",
  "state": "<string>",
  "tags": [
    "<string>"
  ],
  "type": "<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

Company ID. It should have a prefix 'cmp_'.

​
id
string
required

resource id

Response

200 - application/json

OK

​
company_id
string

The company ID for the product pricing

​
computed_entitlements
object[] | null

The final computed features for the product pricing

​
created_at
string

The date the product pricing was created

​
currency
string

The currency for the product pricing

​
description
string

The description for the product pricing

​
external_name
string

The externally exposed name for the product pricing used on invoices

​
id
string

The ID of the product pricing in Maple

​
metadata
object

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

​
name
string

The name of the product pricing

​
num_subs
integer

The number of subscriptions in the company with the product pricing

Required range: x >= 0
​
override_entitlements
object[] | null

The overridden features for the product pricing

​
product_id
string

The product ID that the product pricing is attached to

​
state
string

The state of the product pricing such as ACTIVE or ARCHIVED

​
tags
string[] | null

Any tags on the product pricing

​
type
string

The type of product pricing such as recurring or one-time

​
updated_at
string

The date the product pricing was last updated