POST
/
companies
/
{company_id}
/
subscriptions
/
{id}
/
usage
curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/subscriptions/{id}/usage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "period": {
    "end_date": "2023-11-07T05:31:56Z",
    "start_date": "2023-11-07T05:31:56Z"
  },
  "product_metric_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"
  },
  "usage": [
    {
      "breakdown": [
        {
          "breakout": {},
          "grouping": {},
          "period": {
            "end_date": "2023-11-07T05:31:56Z",
            "start_date": "2023-11-07T05:31:56Z"
          },
          "value": "<any>"
        }
      ],
      "period": {
        "end_date": "2023-11-07T05:31:56Z",
        "start_date": "2023-11-07T05:31:56Z"
      },
      "subscription_metric_record_id": "<string>",
      "value": "<any>"
    }
  ]
}

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

Body

application/json

Response

200 - application/json

OK

The response is of type object.