POST
/
companies
/
{company_id}
/
credits
/
find
curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/credits/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "include_meta": true,
  "pagination": {
    "from_key": "<string>",
    "limit": 20
  },
  "query": {
    "customer_id": "<string>",
    "search": "<string>",
    "status": "ACTIVE",
    "statuses": [
      "<string>"
    ],
    "subscription_id": "<string>",
    "type": "<string>"
  },
  "sort_key": "createdAtDesc"
}'
{
  "pagination": {
    "from_key": "<string>",
    "limit": 123
  },
  "results": [
    {
      "amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "coupon_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "customer_id": "<string>",
      "expiration_date": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "import_created_at_ref": "2023-11-07T05:31:56Z",
      "import_ref": "<string>",
      "imported_from": "<string>",
      "issued_amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "issued_units": 123,
      "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>",
      "metric_record_id": "<string>",
      "name": "<string>",
      "one_time_billable_id": "<string>",
      "proration_date": "2023-11-07T05:31:56Z",
      "state": "<string>",
      "subscription_id": "<string>",
      "type": "<string>",
      "units": 123
    }
  ]
}

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_'.

Body

application/json

Response

200 - application/json

OK

The response is of type object.