Find Credits

POST

companies

{company_id}

credits

find

Find Credits

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 '
{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 20
  },
  "include_meta": true,
  "query": {
    "currency": "<unknown>",
    "customer_id": "<unknown>",
    "search": "<unknown>",
    "status": "ACTIVE",
    "statuses": "ACTIVE",
    "subscription_id": "<unknown>",
    "type": "<unknown>"
  },
  "sort_key": "createdAtDesc"
}
'

{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 123
  },
  "results": [
    {
      "amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "coupon_id": "<unknown>",
      "created_at": "2023-11-07T05:31:56Z",
      "customer_id": "<string>",
      "expiration_date": "<unknown>",
      "id": "<string>",
      "import_created_at_ref": "<unknown>",
      "import_ref": "<unknown>",
      "imported_from": "<unknown>",
      "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": "<unknown>",
      "metric_record_id": "<unknown>",
      "name": "<string>",
      "one_time_billable_id": "<unknown>",
      "proration_date": "<unknown>",
      "state": "<string>",
      "subscription_id": "<unknown>",
      "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

The company ID with the prefix 'cmp_'.

Body

application/json

pagination

object

required

The pagination parameters for the request

Show child attributes

pagination.from_key

null | string

pagination.limit

integer<int64>

default:20

Required range: 0 <= x <= 200

include_meta

boolean | null

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

query

object

The query criteria for the request

Show child attributes

query.currency

null | string

Credit if amount is assigned to currency

query.customer_id

null | string

The customer ID to which the credits belong

query.search

null | string

Any search string to match customers

query.status

null | enum<string>

The specific status of the customer that can be one of ACTIVE CONSUMED REVOKED or EXPIRED

Available options:

ACTIVE,

CONSUMED,

REVOKED,

EXPIRED

query.statuses

string[] | null

The status of the customers that can include ACTIVE CONSUMED REVOKED or EXPIRED

query.subscription_id

null | string

The subscription ID to which the credits belong

query.type

null | string

The credit type that can be one of AMOUNT or UNITS

sort_key

enum<string>

default:createdAtDesc

Available options:

createdAtDesc,

createdAtAsc,

updatedAtAsc,

updatedAtDesc,

expirationDateAsc,

expirationDateDesc

Response

200 - application/json

pagination

object

Show child attributes

pagination.from_key

null | string

pagination.limit

integer<int64>

results

object[] | null

Show child attributes

results.amount

object

The amount which has value in cents and a currency

Show child attributes

results.amount.currency

string

results.amount.value_in_cents

integer<int64>

results.coupon_id

null | string

results.created_at

string<date-time>

results.customer_id

string

results.expiration_date

null | string<date-time>

results.id

string

results.import_created_at_ref

null | string<date-time>

results.import_ref

null | string

results.imported_from

null | string

results.issued_amount

object

The amount which has value in cents and a currency

Show child attributes

results.issued_amount.currency

string

results.issued_amount.value_in_cents

integer<int64>

results.issued_units

number<double>

results.item

object

Show child attributes

results.item.company_id

string

The company ID for the billable item

results.item.created_at

string<date-time>

The date the billable item was created

results.item.description

string

Any description attached to the billable item

results.item.display_type

string

The display type of the billable item which can be one of UNITS, AMOUNT, THOUSAND_UNITS, MILLION_UNITS

results.item.editable

boolean

Whether the billable item can be further edited

results.item.external_name

string

The public name of the billable item

results.item.id

string

The ID of the billable item in Maple

results.item.name

string

The name of the billable item

results.item.standard

boolean

Whether this is a standard billable item in Maple or a custom billable item

results.item.type

string

The type of the billable item which can be one of CUSTOM_USAGE or CUSTOM_OBJ, based on usage-based item or object-based item

results.item.updated_at

string<date-time>

The date the billable item was last updated

results.item_id

null | string

results.metric_record_id

null | string

results.name

string

results.one_time_billable_id

null | string

results.proration_date

null | string<date-time>

results.state

string

results.subscription_id

null | string

results.type

string

results.units

number<double>

Find Credit LogsSearch credit logs with given parameters

⌘I

Find Credits

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 '
{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 20
  },
  "include_meta": true,
  "query": {
    "currency": "<unknown>",
    "customer_id": "<unknown>",
    "search": "<unknown>",
    "status": "ACTIVE",
    "statuses": "ACTIVE",
    "subscription_id": "<unknown>",
    "type": "<unknown>"
  },
  "sort_key": "createdAtDesc"
}
'

{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 123
  },
  "results": [
    {
      "amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "coupon_id": "<unknown>",
      "created_at": "2023-11-07T05:31:56Z",
      "customer_id": "<string>",
      "expiration_date": "<unknown>",
      "id": "<string>",
      "import_created_at_ref": "<unknown>",
      "import_ref": "<unknown>",
      "imported_from": "<unknown>",
      "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": "<unknown>",
      "metric_record_id": "<unknown>",
      "name": "<string>",
      "one_time_billable_id": "<unknown>",
      "proration_date": "<unknown>",
      "state": "<string>",
      "subscription_id": "<unknown>",
      "type": "<string>",
      "units": 123
    }
  ]
}

API Features

API Reference

Webhook Reference

Authorizations

Headers

Path Parameters

Body

Response