Skip to main content
POST
/
companies
/
{company_id}
/
subscriptions
/
find
Find Subscriptions
curl --request POST \
  --url https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pagination": {
    "from_key": "<string>",
    "limit": 20
  },
  "sort_key": "createdAtDesc",
  "include_meta": true,
  "query": {
    "arr": {
      "eq": 123,
      "gt": 123,
      "gte": 123,
      "lte": 123
    },
    "auto_charges": true,
    "auto_renews": true,
    "bundle_pricing_id": "<string>",
    "customer_id": "<string>",
    "end_date": {
      "eq": "2023-11-07T05:31:56Z",
      "gte": "2023-11-07T05:31:56Z",
      "lt": "2023-11-07T05:31:56Z",
      "lte": "2023-11-07T05:31:56Z"
    },
    "exclude_from_metrics": true,
    "group_id": "<string>",
    "managed_externally": true,
    "mrr": {
      "eq": 123,
      "gt": 123,
      "gte": 123,
      "lte": 123
    },
    "next_invoice_date": {
      "eq": "2023-11-07T05:31:56Z",
      "gte": "2023-11-07T05:31:56Z",
      "lt": "2023-11-07T05:31:56Z",
      "lte": "2023-11-07T05:31:56Z"
    },
    "owner_id": "<string>",
    "parent_billed": true,
    "parent_customer_id": "<string>",
    "payment_method_id": "<string>",
    "payment_status": true,
    "product_pricing_id": "<string>",
    "renewal_date": {
      "eq": "2023-11-07T05:31:56Z",
      "gte": "2023-11-07T05:31:56Z",
      "lt": "2023-11-07T05:31:56Z",
      "lte": "2023-11-07T05:31:56Z"
    },
    "sales_user_id": "<string>",
    "search": "<string>",
    "start_date": {
      "eq": "2023-11-07T05:31:56Z",
      "gte": "2023-11-07T05:31:56Z",
      "lt": "2023-11-07T05:31:56Z",
      "lte": "2023-11-07T05:31:56Z"
    },
    "trial": true
  }
}
'
import requests

url = "https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/find"

payload = {
"pagination": {
"from_key": "<string>",
"limit": 20
},
"sort_key": "createdAtDesc",
"include_meta": True,
"query": {
"arr": {
"eq": 123,
"gt": 123,
"gte": 123,
"lte": 123
},
"auto_charges": True,
"auto_renews": True,
"bundle_pricing_id": "<string>",
"customer_id": "<string>",
"end_date": {
"eq": "2023-11-07T05:31:56Z",
"gte": "2023-11-07T05:31:56Z",
"lt": "2023-11-07T05:31:56Z",
"lte": "2023-11-07T05:31:56Z"
},
"exclude_from_metrics": True,
"group_id": "<string>",
"managed_externally": True,
"mrr": {
"eq": 123,
"gt": 123,
"gte": 123,
"lte": 123
},
"next_invoice_date": {
"eq": "2023-11-07T05:31:56Z",
"gte": "2023-11-07T05:31:56Z",
"lt": "2023-11-07T05:31:56Z",
"lte": "2023-11-07T05:31:56Z"
},
"owner_id": "<string>",
"parent_billed": True,
"parent_customer_id": "<string>",
"payment_method_id": "<string>",
"payment_status": True,
"product_pricing_id": "<string>",
"renewal_date": {
"eq": "2023-11-07T05:31:56Z",
"gte": "2023-11-07T05:31:56Z",
"lt": "2023-11-07T05:31:56Z",
"lte": "2023-11-07T05:31:56Z"
},
"sales_user_id": "<string>",
"search": "<string>",
"start_date": {
"eq": "2023-11-07T05:31:56Z",
"gte": "2023-11-07T05:31:56Z",
"lt": "2023-11-07T05:31:56Z",
"lte": "2023-11-07T05:31:56Z"
},
"trial": True
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
pagination: {from_key: '<string>', limit: 20},
sort_key: 'createdAtDesc',
include_meta: true,
query: {
arr: {eq: 123, gt: 123, gte: 123, lte: 123},
auto_charges: true,
auto_renews: true,
bundle_pricing_id: '<string>',
customer_id: '<string>',
end_date: {
eq: '2023-11-07T05:31:56Z',
gte: '2023-11-07T05:31:56Z',
lt: '2023-11-07T05:31:56Z',
lte: '2023-11-07T05:31:56Z'
},
exclude_from_metrics: true,
group_id: '<string>',
managed_externally: true,
mrr: {eq: 123, gt: 123, gte: 123, lte: 123},
next_invoice_date: {
eq: '2023-11-07T05:31:56Z',
gte: '2023-11-07T05:31:56Z',
lt: '2023-11-07T05:31:56Z',
lte: '2023-11-07T05:31:56Z'
},
owner_id: '<string>',
parent_billed: true,
parent_customer_id: '<string>',
payment_method_id: '<string>',
payment_status: true,
product_pricing_id: '<string>',
renewal_date: {
eq: '2023-11-07T05:31:56Z',
gte: '2023-11-07T05:31:56Z',
lt: '2023-11-07T05:31:56Z',
lte: '2023-11-07T05:31:56Z'
},
sales_user_id: '<string>',
search: '<string>',
start_date: {
eq: '2023-11-07T05:31:56Z',
gte: '2023-11-07T05:31:56Z',
lt: '2023-11-07T05:31:56Z',
lte: '2023-11-07T05:31:56Z'
},
trial: true
}
})
};

fetch('https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/find', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/find",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pagination' => [
'from_key' => '<string>',
'limit' => 20
],
'sort_key' => 'createdAtDesc',
'include_meta' => true,
'query' => [
'arr' => [
'eq' => 123,
'gt' => 123,
'gte' => 123,
'lte' => 123
],
'auto_charges' => true,
'auto_renews' => true,
'bundle_pricing_id' => '<string>',
'customer_id' => '<string>',
'end_date' => [
'eq' => '2023-11-07T05:31:56Z',
'gte' => '2023-11-07T05:31:56Z',
'lt' => '2023-11-07T05:31:56Z',
'lte' => '2023-11-07T05:31:56Z'
],
'exclude_from_metrics' => true,
'group_id' => '<string>',
'managed_externally' => true,
'mrr' => [
'eq' => 123,
'gt' => 123,
'gte' => 123,
'lte' => 123
],
'next_invoice_date' => [
'eq' => '2023-11-07T05:31:56Z',
'gte' => '2023-11-07T05:31:56Z',
'lt' => '2023-11-07T05:31:56Z',
'lte' => '2023-11-07T05:31:56Z'
],
'owner_id' => '<string>',
'parent_billed' => true,
'parent_customer_id' => '<string>',
'payment_method_id' => '<string>',
'payment_status' => true,
'product_pricing_id' => '<string>',
'renewal_date' => [
'eq' => '2023-11-07T05:31:56Z',
'gte' => '2023-11-07T05:31:56Z',
'lt' => '2023-11-07T05:31:56Z',
'lte' => '2023-11-07T05:31:56Z'
],
'sales_user_id' => '<string>',
'search' => '<string>',
'start_date' => [
'eq' => '2023-11-07T05:31:56Z',
'gte' => '2023-11-07T05:31:56Z',
'lt' => '2023-11-07T05:31:56Z',
'lte' => '2023-11-07T05:31:56Z'
],
'trial' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/find"

payload := strings.NewReader("{\n \"pagination\": {\n \"from_key\": \"<string>\",\n \"limit\": 20\n },\n \"sort_key\": \"createdAtDesc\",\n \"include_meta\": true,\n \"query\": {\n \"arr\": {\n \"eq\": 123,\n \"gt\": 123,\n \"gte\": 123,\n \"lte\": 123\n },\n \"auto_charges\": true,\n \"auto_renews\": true,\n \"bundle_pricing_id\": \"<string>\",\n \"customer_id\": \"<string>\",\n \"end_date\": {\n \"eq\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"exclude_from_metrics\": true,\n \"group_id\": \"<string>\",\n \"managed_externally\": true,\n \"mrr\": {\n \"eq\": 123,\n \"gt\": 123,\n \"gte\": 123,\n \"lte\": 123\n },\n \"next_invoice_date\": {\n \"eq\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"owner_id\": \"<string>\",\n \"parent_billed\": true,\n \"parent_customer_id\": \"<string>\",\n \"payment_method_id\": \"<string>\",\n \"payment_status\": true,\n \"product_pricing_id\": \"<string>\",\n \"renewal_date\": {\n \"eq\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"sales_user_id\": \"<string>\",\n \"search\": \"<string>\",\n \"start_date\": {\n \"eq\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"trial\": true\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/find")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"pagination\": {\n \"from_key\": \"<string>\",\n \"limit\": 20\n },\n \"sort_key\": \"createdAtDesc\",\n \"include_meta\": true,\n \"query\": {\n \"arr\": {\n \"eq\": 123,\n \"gt\": 123,\n \"gte\": 123,\n \"lte\": 123\n },\n \"auto_charges\": true,\n \"auto_renews\": true,\n \"bundle_pricing_id\": \"<string>\",\n \"customer_id\": \"<string>\",\n \"end_date\": {\n \"eq\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"exclude_from_metrics\": true,\n \"group_id\": \"<string>\",\n \"managed_externally\": true,\n \"mrr\": {\n \"eq\": 123,\n \"gt\": 123,\n \"gte\": 123,\n \"lte\": 123\n },\n \"next_invoice_date\": {\n \"eq\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"owner_id\": \"<string>\",\n \"parent_billed\": true,\n \"parent_customer_id\": \"<string>\",\n \"payment_method_id\": \"<string>\",\n \"payment_status\": true,\n \"product_pricing_id\": \"<string>\",\n \"renewal_date\": {\n \"eq\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"sales_user_id\": \"<string>\",\n \"search\": \"<string>\",\n \"start_date\": {\n \"eq\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"trial\": true\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/find")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pagination\": {\n \"from_key\": \"<string>\",\n \"limit\": 20\n },\n \"sort_key\": \"createdAtDesc\",\n \"include_meta\": true,\n \"query\": {\n \"arr\": {\n \"eq\": 123,\n \"gt\": 123,\n \"gte\": 123,\n \"lte\": 123\n },\n \"auto_charges\": true,\n \"auto_renews\": true,\n \"bundle_pricing_id\": \"<string>\",\n \"customer_id\": \"<string>\",\n \"end_date\": {\n \"eq\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"exclude_from_metrics\": true,\n \"group_id\": \"<string>\",\n \"managed_externally\": true,\n \"mrr\": {\n \"eq\": 123,\n \"gt\": 123,\n \"gte\": 123,\n \"lte\": 123\n },\n \"next_invoice_date\": {\n \"eq\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"owner_id\": \"<string>\",\n \"parent_billed\": true,\n \"parent_customer_id\": \"<string>\",\n \"payment_method_id\": \"<string>\",\n \"payment_status\": true,\n \"product_pricing_id\": \"<string>\",\n \"renewal_date\": {\n \"eq\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"sales_user_id\": \"<string>\",\n \"search\": \"<string>\",\n \"start_date\": {\n \"eq\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"trial\": true\n }\n}"

response = http.request(request)
puts response.read_body
{
  "pagination": {
    "from_key": "<string>",
    "limit": 123
  },
  "results": [
    {
      "arr": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "auto_charges": true,
      "auto_renews": true,
      "billing_anchor_date": "2023-11-07T05:31:56Z",
      "cancel_config": {
        "campaign_id": "<string>",
        "campaign_step_id": "<string>",
        "charge_remaining_balance": true,
        "custom_end_date": "2023-11-07T05:31:56Z",
        "custom_refund_amount": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "reason": "<string>",
        "refund_type": "<string>",
        "send_customer_receipt": true,
        "timing": "<string>"
      },
      "cancel_date": "2023-11-07T05:31:56Z",
      "change_config": {
        "actual_change_time": "2023-11-07T05:31:56Z",
        "all_product_pricings": [
          {
            "company_id": "<string>",
            "computed_entitlements": [
              {
                "entitlement_id": "<string>",
                "id": "<string>",
                "inherited_from_id": "<string>",
                "inherited_from_type": "<string>",
                "key": "<string>",
                "original_value": "<unknown>",
                "overriden": true,
                "value": "<unknown>"
              }
            ],
            "created_at": "2023-11-07T05:31:56Z",
            "currency": "<string>",
            "deleted_at": {},
            "description": "<string>",
            "external_name": "<string>",
            "id": "<string>",
            "import_created_at_ref": "2023-11-07T05:31:56Z",
            "import_ref": "<string>",
            "imported_from": "<string>",
            "metadata": {},
            "minimum_spend": {
              "currency": "<string>",
              "value_in_cents": 123
            },
            "name": "<string>",
            "num_subs": 1,
            "override_entitlements": [
              {
                "entitlement_id": "<string>",
                "id": "<string>",
                "inherited_from_id": "<string>",
                "inherited_from_type": "<string>",
                "key": "<string>",
                "original_value": "<unknown>",
                "overriden": true,
                "value": "<unknown>"
              }
            ],
            "product_id": "<string>",
            "product_metric_pricings": [
              {
                "company_id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "deleted_at": {},
                "id": "<string>",
                "item_id": "<string>",
                "item_pricing_id": "<string>",
                "metric_id": "<string>",
                "product_id": "<string>",
                "product_pricing_id": "<string>",
                "updated_at": "2023-11-07T05:31:56Z"
              }
            ],
            "state": "<string>",
            "type": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "upsell_product_pricing": "<unknown>",
            "upsell_product_pricing_id": "<string>"
          }
        ],
        "auto_charges": true,
        "auto_renews": true,
        "bundle_pricing": {
          "bundle_product_pricings": [
            {
              "bundle_pricing_id": "<string>",
              "company_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "deleted_at": {},
              "id": "<string>",
              "product_id": "<string>",
              "product_pricing_id": "<string>",
              "updated_at": "2023-11-07T05:31:56Z"
            }
          ],
          "company_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "currency": "<string>",
          "default_term": {
            "count": 123
          },
          "deleted_at": {},
          "description": "<string>",
          "id": "<string>",
          "image_url": "<string>",
          "import_created_at_ref": "2023-11-07T05:31:56Z",
          "import_ref": "<string>",
          "imported_from": "<string>",
          "is_auto_generated": true,
          "key": "<string>",
          "metadata": {},
          "name": "<string>",
          "num_subs": 1,
          "state": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        },
        "bundle_pricing_id": "<string>",
        "config_items": [
          {
            "hide_at_checkout": true,
            "minimum_units": 1,
            "num_licenses": 1,
            "product_metric_pricing_id": "<string>",
            "product_pricing_id": "<string>",
            "quantity_config": {
              "allow_custom_quantity": true,
              "max_quantity": 123,
              "min_quantity": 123
            },
            "sort_order": 123,
            "upsell_product_metric_pricing_id": "<string>"
          }
        ],
        "custom_change_date": "2023-11-07T05:31:56Z",
        "discounts": [
          {
            "name": "<string>",
            "amount": {
              "currency": "<string>",
              "value_in_cents": 123
            },
            "cap": {
              "currency": "<string>",
              "value_in_cents": 123
            },
            "coupon_id": "<string>",
            "customer_id": "<string>",
            "expiration_date": "2023-11-07T05:31:56Z",
            "import_created_at_ref": "2023-11-07T05:31:56Z",
            "import_ref": "<string>",
            "imported_from": "<string>",
            "item_pricing_id": "<string>",
            "onetime_billable_id": "<string>",
            "percent": 0.5,
            "product_id": "<string>",
            "product_pricing_id": "<string>",
            "proposal_id": "<string>",
            "subscription_id": "<string>"
          }
        ],
        "metadata": {},
        "minimum_spend": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "onetime_items": [
          {
            "aggregate": 123,
            "custom_price": {
              "amount": {
                "currency": "<string>",
                "value_in_cents": 123
              },
              "product_id": "<string>",
              "description": "<string>"
            },
            "product_pricing_id": "<string>",
            "quantity_config": {
              "allow_custom_quantity": true,
              "max_quantity": 123,
              "min_quantity": 123
            },
            "sort_order": 123
          }
        ],
        "payment_method_id": "<string>",
        "product_pricing_ids": [
          "<string>"
        ],
        "relative_term": {
          "count": 123
        },
        "reset_billing_anchor": true,
        "term": {
          "count": 123
        },
        "trial": true,
        "trial_term": {
          "count": 123
        }
      },
      "change_date": "2023-11-07T05:31:56Z",
      "company_id": "<string>",
      "computed_entitlements": [
        {
          "entitlement_id": "<string>",
          "id": "<string>",
          "inherited_from_id": "<string>",
          "inherited_from_type": "<string>",
          "key": "<string>",
          "name": "<string>",
          "original_value": "<unknown>",
          "overridden": true,
          "type": "<string>",
          "value": "<unknown>"
        }
      ],
      "config_items": [
        {
          "hide_at_checkout": true,
          "minimum_units": 1,
          "num_licenses": 1,
          "product_metric_pricing_id": "<string>",
          "product_pricing_id": "<string>",
          "quantity_config": {
            "allow_custom_quantity": true,
            "max_quantity": 123,
            "min_quantity": 123
          },
          "sort_order": 123,
          "upsell_product_metric_pricing_id": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "customer": {
        "address": {
          "address_line_1": "<string>",
          "address_line_2": "<string>",
          "city": "<string>",
          "country": "<string>",
          "place_id": "<string>",
          "state": "<string>",
          "zip": "<string>"
        },
        "arr": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "billing_emails": [
          "<string>"
        ],
        "company_id": "<string>",
        "computed_entitlements": [
          {
            "entitlement_id": "<string>",
            "id": "<string>",
            "inherited_from_id": "<string>",
            "inherited_from_type": "<string>",
            "key": "<string>",
            "name": "<string>",
            "original_value": "<unknown>",
            "overridden": true,
            "type": "<string>",
            "value": "<unknown>"
          }
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "customer_integration_metadata": {},
        "display_name": "<string>",
        "email": "<string>",
        "exclude_from_metrics": true,
        "id": "<string>",
        "identifier": "<string>",
        "integration_references": [
          {
            "integration_icon": "<string>",
            "integration_id": "<string>",
            "integration_key": "<string>",
            "integration_name": "<string>",
            "reference_type": "<string>",
            "remote_id": "<string>",
            "remote_type": "<string>"
          }
        ],
        "locale": "<string>",
        "managed_externally": true,
        "metadata": {},
        "mrr": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "name": "<string>",
        "org_name": "<string>",
        "owner_id": "<string>",
        "parent_customer_id": "<string>",
        "phone": "<string>",
        "status": "<string>",
        "title": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "customer_id": "<string>",
      "end_date": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "invoice_additional_display_fields": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "invoice_due_date_from_creation": 1,
      "metadata": {},
      "minimum_spend": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "mrr": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "next_invoice_date": "2023-11-07T05:31:56Z",
      "override_entitlements": [
        {
          "entitlement_id": "<string>",
          "id": "<string>",
          "inherited_from_id": "<string>",
          "inherited_from_type": "<string>",
          "key": "<string>",
          "name": "<string>",
          "original_value": "<unknown>",
          "overridden": true,
          "type": "<string>",
          "value": "<unknown>"
        }
      ],
      "pause_config": {
        "behavior": "<string>",
        "resume_date": "2023-11-07T05:31:56Z"
      },
      "pause_date": "2023-11-07T05:31:56Z",
      "payment_method_id": "<string>",
      "product_pricing_ids": [
        "<string>"
      ],
      "product_pricings": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "currency": "<string>",
          "external_name": "<string>",
          "id": "<string>",
          "name": "<string>",
          "product": {
            "company_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "description": "<string>",
            "entitlements": [
              {
                "entitlement_id": "<string>",
                "id": "<string>",
                "inherited_from_id": "<string>",
                "inherited_from_type": "<string>",
                "key": "<string>",
                "name": "<string>",
                "original_value": "<unknown>",
                "overridden": true,
                "type": "<string>",
                "value": "<unknown>"
              }
            ],
            "external_name": "<string>",
            "gl_code": "<string>",
            "id": "<string>",
            "image_url": "<string>",
            "import_created_at_ref": "2023-11-07T05:31:56Z",
            "import_ref": "<string>",
            "imported_from": "<string>",
            "metadata": {},
            "name": "<string>",
            "num_subs": 1,
            "product_pricings": [
              {
                "company_id": "<string>",
                "computed_entitlements": [
                  {
                    "entitlement_id": "<string>",
                    "id": "<string>",
                    "inherited_from_id": "<string>",
                    "inherited_from_type": "<string>",
                    "key": "<string>",
                    "name": "<string>",
                    "original_value": "<unknown>",
                    "overridden": true,
                    "type": "<string>",
                    "value": "<unknown>"
                  }
                ],
                "created_at": "2023-11-07T05:31:56Z",
                "currency": "<string>",
                "description": "<string>",
                "external_name": "<string>",
                "id": "<string>",
                "import_created_at_ref": "2023-11-07T05:31:56Z",
                "import_ref": "<string>",
                "imported_from": "<string>",
                "metadata": {},
                "minimum_spend": {
                  "currency": "<string>",
                  "value_in_cents": 123
                },
                "name": "<string>",
                "num_subs": 1,
                "override_entitlements": [
                  {
                    "entitlement_id": "<string>",
                    "id": "<string>",
                    "inherited_from_id": "<string>",
                    "inherited_from_type": "<string>",
                    "key": "<string>",
                    "name": "<string>",
                    "original_value": "<unknown>",
                    "overridden": true,
                    "type": "<string>",
                    "value": "<unknown>"
                  }
                ],
                "product": "<unknown>",
                "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,
                      "charge_type": "<string>",
                      "company": {
                        "address": {
                          "address_line_1": "<string>",
                          "address_line_2": "<string>",
                          "city": "<string>",
                          "country": "<string>",
                          "place_id": "<string>",
                          "state": "<string>",
                          "zip": "<string>"
                        },
                        "computed_entitlements": {},
                        "created_at": "2023-11-07T05:31:56Z",
                        "customer_id": "<string>",
                        "demo": true,
                        "email": "<string>",
                        "entitlements": [
                          {
                            "entitlement_id": "<string>",
                            "id": "<string>",
                            "inherited_from_id": "<string>",
                            "inherited_from_type": "<string>",
                            "key": "<string>",
                            "name": "<string>",
                            "original_value": "<unknown>",
                            "overridden": true,
                            "type": "<string>",
                            "value": "<unknown>"
                          }
                        ],
                        "id": "<string>",
                        "is_dev": true,
                        "legal_name": "<string>",
                        "name": "<string>",
                        "override_entitlements": [
                          {
                            "entitlement_id": "<string>",
                            "id": "<string>",
                            "inherited_from_id": "<string>",
                            "inherited_from_type": "<string>",
                            "key": "<string>",
                            "name": "<string>",
                            "original_value": "<unknown>",
                            "overridden": true,
                            "type": "<string>",
                            "value": "<unknown>"
                          }
                        ],
                        "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": "<string>",
                        "scoped_product_ids": [
                          "<string>"
                        ],
                        "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": [
                          "<string>"
                        ],
                        "minimum_spend_schedule_type": "<string>"
                      },
                      "name": "<string>",
                      "num_subs": 1,
                      "proration_type": "<string>",
                      "recognition_schedule": {
                        "amount_per_period": [
                          "<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": "<string>"
                      },
                      "name": "<string>",
                      "standard": true,
                      "type": "<string>",
                      "updated_at": "2023-11-07T05:31:56Z"
                    },
                    "metric_id": "<string>",
                    "product": "<unknown>",
                    "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": "<string>"
              }
            ],
            "state": "<string>",
            "tags": [
              "<string>"
            ],
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "product_id": "<string>",
          "product_metric_pricings": [
            {
              "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,
                "charge_type": "<string>",
                "company": {
                  "address": {
                    "address_line_1": "<string>",
                    "address_line_2": "<string>",
                    "city": "<string>",
                    "country": "<string>",
                    "place_id": "<string>",
                    "state": "<string>",
                    "zip": "<string>"
                  },
                  "computed_entitlements": {},
                  "created_at": "2023-11-07T05:31:56Z",
                  "customer_id": "<string>",
                  "demo": true,
                  "email": "<string>",
                  "entitlements": [
                    {
                      "entitlement_id": "<string>",
                      "id": "<string>",
                      "inherited_from_id": "<string>",
                      "inherited_from_type": "<string>",
                      "key": "<string>",
                      "name": "<string>",
                      "original_value": "<unknown>",
                      "overridden": true,
                      "type": "<string>",
                      "value": "<unknown>"
                    }
                  ],
                  "id": "<string>",
                  "is_dev": true,
                  "legal_name": "<string>",
                  "name": "<string>",
                  "override_entitlements": [
                    {
                      "entitlement_id": "<string>",
                      "id": "<string>",
                      "inherited_from_id": "<string>",
                      "inherited_from_type": "<string>",
                      "key": "<string>",
                      "name": "<string>",
                      "original_value": "<unknown>",
                      "overridden": true,
                      "type": "<string>",
                      "value": "<unknown>"
                    }
                  ],
                  "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": "<string>",
                  "scoped_product_ids": [
                    "<string>"
                  ],
                  "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": [
                    "<string>"
                  ],
                  "minimum_spend_schedule_type": "<string>"
                },
                "name": "<string>",
                "num_subs": 1,
                "proration_type": "<string>",
                "recognition_schedule": {
                  "amount_per_period": [
                    "<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": "<string>"
                },
                "name": "<string>",
                "standard": true,
                "type": "<string>",
                "updated_at": "2023-11-07T05:31:56Z"
              },
              "metric_id": "<string>",
              "minimum_units": 123,
              "num_licenses": 123,
              "updated_at": "2023-11-07T05:31:56Z"
            }
          ],
          "tags": [
            "<string>"
          ],
          "type": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "renewal_date": "2023-11-07T05:31:56Z",
      "sales_user": {
        "company": {
          "address": {
            "address_line_1": "<string>",
            "address_line_2": "<string>",
            "city": "<string>",
            "country": "<string>",
            "place_id": "<string>",
            "state": "<string>",
            "zip": "<string>"
          },
          "computed_entitlements": {},
          "created_at": "2023-11-07T05:31:56Z",
          "customer_id": "<string>",
          "demo": true,
          "email": "<string>",
          "entitlements": [
            {
              "entitlement_id": "<string>",
              "id": "<string>",
              "inherited_from_id": "<string>",
              "inherited_from_type": "<string>",
              "key": "<string>",
              "name": "<string>",
              "original_value": "<unknown>",
              "overridden": true,
              "type": "<string>",
              "value": "<unknown>"
            }
          ],
          "id": "<string>",
          "is_dev": true,
          "legal_name": "<string>",
          "name": "<string>",
          "override_entitlements": [
            {
              "entitlement_id": "<string>",
              "id": "<string>",
              "inherited_from_id": "<string>",
              "inherited_from_type": "<string>",
              "key": "<string>",
              "name": "<string>",
              "original_value": "<unknown>",
              "overridden": true,
              "type": "<string>",
              "value": "<unknown>"
            }
          ],
          "phone": "<string>",
          "preferred_currency": "<string>",
          "preferred_timezone": "<string>",
          "slug": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        },
        "company_id": "<string>",
        "company_user": {
          "access": {
            "api_tokens": "<string>",
            "approvals": "<string>",
            "campaign": "<string>",
            "commission_plans": "<string>",
            "commission_reports": "<string>",
            "companies": "<string>",
            "credit_notes": "<string>",
            "credits": "<string>",
            "customer_portal": "<string>",
            "customers": "<string>",
            "developers": "<string>",
            "disputes": "<string>",
            "email_templates": "<string>",
            "entitlement": "<string>",
            "events": "<string>",
            "expired_card": "<string>",
            "files": "<string>",
            "import": "<string>",
            "integration_bank_accounts": "<string>",
            "integration_transactions": "<string>",
            "integrations": "<string>",
            "invoices": "<string>",
            "journal_accounts": "<string>",
            "journal_entries": "<string>",
            "logs": "<string>",
            "objects": "<string>",
            "one_time": "<string>",
            "payments": "<string>",
            "pricing": "<string>",
            "promotions": "<string>",
            "proposal": "<string>",
            "reports": "<string>",
            "sales_users": "<string>",
            "settings": "<string>",
            "subscriptions": "<string>",
            "team": "<string>",
            "webhooks": "<string>"
          },
          "company": {
            "address": {
              "address_line_1": "<string>",
              "address_line_2": "<string>",
              "city": "<string>",
              "country": "<string>",
              "place_id": "<string>",
              "state": "<string>",
              "zip": "<string>"
            },
            "computed_entitlements": {},
            "created_at": "2023-11-07T05:31:56Z",
            "customer_id": "<string>",
            "demo": true,
            "email": "<string>",
            "entitlements": [
              {
                "entitlement_id": "<string>",
                "id": "<string>",
                "inherited_from_id": "<string>",
                "inherited_from_type": "<string>",
                "key": "<string>",
                "name": "<string>",
                "original_value": "<unknown>",
                "overridden": true,
                "type": "<string>",
                "value": "<unknown>"
              }
            ],
            "id": "<string>",
            "is_dev": true,
            "legal_name": "<string>",
            "name": "<string>",
            "override_entitlements": [
              {
                "entitlement_id": "<string>",
                "id": "<string>",
                "inherited_from_id": "<string>",
                "inherited_from_type": "<string>",
                "key": "<string>",
                "name": "<string>",
                "original_value": "<unknown>",
                "overridden": true,
                "type": "<string>",
                "value": "<unknown>"
              }
            ],
            "phone": "<string>",
            "preferred_currency": "<string>",
            "preferred_timezone": "<string>",
            "slug": "<string>",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "created_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "image_url": "<string>",
          "manager_id": "<string>",
          "pending": true,
          "role": "<string>",
          "title": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "user": {
            "companies": [
              {
                "access": {
                  "api_tokens": "<string>",
                  "approvals": "<string>",
                  "campaign": "<string>",
                  "commission_plans": "<string>",
                  "commission_reports": "<string>",
                  "companies": "<string>",
                  "credit_notes": "<string>",
                  "credits": "<string>",
                  "customer_portal": "<string>",
                  "customers": "<string>",
                  "developers": "<string>",
                  "disputes": "<string>",
                  "email_templates": "<string>",
                  "entitlement": "<string>",
                  "events": "<string>",
                  "expired_card": "<string>",
                  "files": "<string>",
                  "import": "<string>",
                  "integration_bank_accounts": "<string>",
                  "integration_transactions": "<string>",
                  "integrations": "<string>",
                  "invoices": "<string>",
                  "journal_accounts": "<string>",
                  "journal_entries": "<string>",
                  "logs": "<string>",
                  "objects": "<string>",
                  "one_time": "<string>",
                  "payments": "<string>",
                  "pricing": "<string>",
                  "promotions": "<string>",
                  "proposal": "<string>",
                  "reports": "<string>",
                  "sales_users": "<string>",
                  "settings": "<string>",
                  "subscriptions": "<string>",
                  "team": "<string>",
                  "webhooks": "<string>"
                },
                "company_id": "<string>",
                "company_name": "<string>",
                "id": "<string>",
                "image_url": "<string>",
                "role": "<string>"
              }
            ],
            "created_at": "2023-11-07T05:31:56Z",
            "email": "<string>",
            "id": "<string>",
            "is_super_user": true,
            "maple_employee_role": "<string>",
            "name": "<string>",
            "otp_enabled": true,
            "updated_at": "2023-11-07T05:31:56Z",
            "verified": true
          }
        },
        "company_user_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "display_email": "<string>",
        "display_name": "<string>",
        "email": "<string>",
        "id": "<string>",
        "name": "<string>",
        "type": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "sales_user_id": "<string>",
      "start_date": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "term": {
        "count": 123
      },
      "trial": true,
      "trial_conversion_date": "2023-11-07T05:31:56Z",
      "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

sort_key
enum<string>
default:createdAtDesc
required
Available options:
createdAtDesc,
createdAtAsc,
updatedAtAsc,
updatedAtDesc,
mrrAsc,
mrrDesc,
startDateAsc,
startDateDesc,
nextInvoiceAsc,
nextInvoiceDesc,
renewalDateAsc,
renewalDateDesc
include_meta
null | boolean

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

query
object | null

The query criteria for the request

Response

200 - application/json

OK

pagination
object
results
object[] | null