Skip to main content
PATCH
/
companies
/
{company_id}
/
objects
/
{id}
Update Object
curl --request PATCH \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/objects/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "properties": {}
}'
{
  "company_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "customer_id": "<string>",
  "customer_identifier": "<string>",
  "id": "<string>",
  "item_id": "<string>",
  "object_identifier": "<string>",
  "properties": {},
  "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

Body

application/json
​
properties
object
required

Response

200 - application/json

OK

​
company_id
string

The company ID of the object

​
created_at
string<date-time>

The date the object was created

​
customer_id
string

The customer ID in Maple for the object

​
customer_identifier
string

The unique identifier for the customer that ties back to your system

​
id
string

The ID of the object in Maple

​
item_id
string

The billable item ID from Maple that this object is being tracked for

​
object_identifier
string

The unique identifier for the object that ties back to your system

​
properties
object | null

The set of properties relevant to billing metrics that are set up in Maple

​
updated_at
string<date-time>

The date the object was last updated

⌘I