PATCH
/
companies
/
{company_id}
/
customers
/
{customer_id}
/
start_managing
Start Managing Customer
curl --request PATCH \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/customers/{customer_id}/start_managing \
  --header 'Authorization: Bearer <token>'
{
  "address": {
    "address_line_1": "<string>",
    "address_line_2": "<string>",
    "city": "<string>",
    "country": "<string>",
    "place_id": null,
    "state": "<string>",
    "zip": "<string>"
  },
  "arr": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "billing_emails": [
    "<string>"
  ],
  "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",
  "customer_integration_metadata": {},
  "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": null,
  "parent_customer_id": null,
  "phone": "<string>",
  "status": "<string>",
  "title": "<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_'.

​
customer_id
string
required

customer_id or identifier

Response

200 - application/json

OK

​
address
object

The address of the customer

​
arr
object

The ARR of the customer

​
billing_emails
string[] | null

The additional emails to cc on customer's invoices

​
company_id
string

The company ID of the customer

​
computed_entitlements
object[] | null

The computed entitlements for the customer

​
created_at
string<date-time>

The date the customer was created

​
customer_integration_metadata
object
​
email
string

The email of the customer

​
exclude_from_metrics
boolean

Whether to exclude this customer and related fields from any metrics in Maple

​
id
string

The ID of the customer in Maple

​
identifier
string

The unique identifier for the customer that ties back to your system. You can query for a customer using this identifier

​
integration_references
object[]

The integration references of this customer in third-party applications connected to Maple

​
locale
string

The locale of the customer

​
managed_externally
boolean

Whether this customer is managed outside of Maple

​
metadata
object

The metadata as key-value pairs attached to this customer

​
mrr
object

The MRR of the customer

​
name
string

The name of the customer

​
org_name
string

The name of the company or the organization this customer is a part of

​
owner_id
string | null

The company user ID of person in Maple assigned to manage this customer

​
parent_customer_id
string | null

The customer ID of the parent customer assigned in Maple

​
phone
string

The phone number of the customer

​
status
string

The status of the customer such as ACTIVE or ARCHIVED

​
title
string

The title of the customer, such as CEO, VP

​
updated_at
string<date-time>

The date the customer was last updated