Find Product Pricing

POST

companies

{company_id}

pricing

find

Find Product Pricing

curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/pricing/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 20
  },
  "include_meta": true,
  "query": {
    "currency": "<unknown>",
    "external_name": "<unknown>",
    "name": "<unknown>",
    "product_id": "<unknown>",
    "search": "<unknown>",
    "state": "<unknown>",
    "tags": "<unknown>",
    "type": "<unknown>"
  },
  "sort_key": "createdAtDesc"
}
'

{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 123
  },
  "results": [
    {
      "company_id": "<string>",
      "computed_entitlements": [
        {
          "entitlement_id": "<string>",
          "id": "<string>",
          "inherited_from_id": "<unknown>",
          "inherited_from_type": "<unknown>",
          "key": "<string>",
          "name": "<string>",
          "original_value": "<unknown>",
          "overridden": "<unknown>",
          "type": "<string>",
          "value": "<unknown>"
        }
      ],
      "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>",
          "id": "<string>",
          "inherited_from_id": "<unknown>",
          "inherited_from_type": "<unknown>",
          "key": "<string>",
          "name": "<string>",
          "original_value": "<unknown>",
          "overridden": "<unknown>",
          "type": "<string>",
          "value": "<unknown>"
        }
      ],
      "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

The company ID with the prefix 'cmp_'.

Body

application/json

pagination

object

required

The pagination parameters for the request

Show child attributes

pagination.from_key

null | string

pagination.limit

integer<int64>

default:20

Required range: 0 <= x <= 200

include_meta

boolean | null

Whether to include additional metadata in the pagination response such the number of total results

query

object

The query criteria for the request

Show child attributes

query.currency

null | string

The currency of the product pricing

query.external_name

null | string

The externally visible name for the product pricing

query.name

null | string

The name of the product pricing

query.product_id

null | string

The product to which the product pricing belongs

query.search

null | string

Any search string to match product pricing

query.state

null | string

The state of the product pricing whether ACTIVE or ARCHIVED

query.tags

null | string[]

Any of the tags to match against the product pricing

query.type

null | string

The type of the product pricing whether one-time or recurring

sort_key

enum<string>

default:createdAtDesc

Available options:

createdAtDesc,

createdAtAsc,

updatedAtAsc,

updatedAtDesc,

aToZ,

zToA

Response

200 - application/json

pagination

object

Show child attributes

pagination.from_key

null | string

pagination.limit

integer<int64>

results

object[] | null

Show child attributes

results.company_id

string

The company ID for the product pricing

results.computed_entitlements

object[] | null

The final computed features for the product pricing

Show child attributes

results.computed_entitlements.entitlement_id

string

results.computed_entitlements.id

string

results.computed_entitlements.inherited_from_id

null | string

results.computed_entitlements.inherited_from_type

null | string

results.computed_entitlements.key

string

results.computed_entitlements.name

string

results.computed_entitlements.original_value

any

results.computed_entitlements.overridden

null | boolean

results.computed_entitlements.type

string

results.computed_entitlements.value

any

results.created_at

string<date-time>

The date the product pricing was created

results.currency

string

The currency for the product pricing

results.description

string

The description for the product pricing

results.external_name

string

The externally exposed name for the product pricing used on invoices

results.id

string

The ID of the product pricing in Maple

results.metadata

object

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

results.name

string

The name of the product pricing

results.num_subs

integer

The number of subscriptions in the company with the product pricing

Required range: x >= 0

results.override_entitlements

object[] | null

The overridden features for the product pricing

Show child attributes

results.override_entitlements.entitlement_id

string

results.override_entitlements.id

string

results.override_entitlements.inherited_from_id

null | string

results.override_entitlements.inherited_from_type

null | string

results.override_entitlements.key

string

results.override_entitlements.name

string

results.override_entitlements.original_value

any

results.override_entitlements.overridden

null | boolean

results.override_entitlements.type

string

results.override_entitlements.value

any

results.product_id

string

The product ID that the product pricing is attached to

results.state

string

The state of the product pricing such as ACTIVE or ARCHIVED

results.tags

string[] | null

Any tags on the product pricing

results.type

string

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

results.updated_at

string<date-time>

The date the product pricing was last updated

Get Product PricingRetrieve a product pricing by ID or external identifier

⌘I

Find Product Pricing

curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/pricing/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 20
  },
  "include_meta": true,
  "query": {
    "currency": "<unknown>",
    "external_name": "<unknown>",
    "name": "<unknown>",
    "product_id": "<unknown>",
    "search": "<unknown>",
    "state": "<unknown>",
    "tags": "<unknown>",
    "type": "<unknown>"
  },
  "sort_key": "createdAtDesc"
}
'

{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 123
  },
  "results": [
    {
      "company_id": "<string>",
      "computed_entitlements": [
        {
          "entitlement_id": "<string>",
          "id": "<string>",
          "inherited_from_id": "<unknown>",
          "inherited_from_type": "<unknown>",
          "key": "<string>",
          "name": "<string>",
          "original_value": "<unknown>",
          "overridden": "<unknown>",
          "type": "<string>",
          "value": "<unknown>"
        }
      ],
      "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>",
          "id": "<string>",
          "inherited_from_id": "<unknown>",
          "inherited_from_type": "<unknown>",
          "key": "<string>",
          "name": "<string>",
          "original_value": "<unknown>",
          "overridden": "<unknown>",
          "type": "<string>",
          "value": "<unknown>"
        }
      ],
      "product_id": "<string>",
      "state": "<string>",
      "tags": [
        "<string>"
      ],
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

API Features

API Reference

Webhook Reference

Authorizations

Headers

Path Parameters

Body

Response