Find Credit Logs

POST

companies

{company_id}

credits

logs

find

Find Credit Logs

curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/credits/logs/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 20
  },
  "include_meta": true,
  "query": {
    "action_type": "<unknown>",
    "credit_id": "<unknown>",
    "customer_id": "<unknown>",
    "invoice_id": "<unknown>",
    "note": "<unknown>",
    "search": "<unknown>",
    "type": "<unknown>"
  },
  "sort_key": "createdAtDesc"
}
'

{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 123
  },
  "results": [
    {
      "action_type": "<string>",
      "amount_applied": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "created_at": "2023-11-07T05:31:56Z",
      "credit_id": "<string>",
      "customer": {
        "email": "<string>",
        "id": "<string>",
        "identifier": "<string>",
        "name": "<string>",
        "org_name": "<string>",
        "parent_customer": "<unknown>",
        "parent_customer_id": "<unknown>"
      },
      "customer_id": "<string>",
      "id": "<string>",
      "invoice": {
        "auto_charges": true,
        "billed_customer_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "currency": "<string>",
        "customer": {
          "address": {
            "address_line_1": "<string>",
            "address_line_2": "<string>",
            "city": "<string>",
            "country": "<string>",
            "place_id": "<unknown>",
            "state": "<string>",
            "zip": "<string>"
          },
          "arr": {
            "currency": "<string>",
            "value_in_cents": 123
          },
          "billing_emails": [
            "<string>"
          ],
          "company_id": "<string>",
          "computed_entitlements": [
            {
              "entitlement_id": "<string>",
              "id": "<string>",
              "inherited_from_id": "<unknown>",
              "inherited_from_type": "<unknown>",
              "key": "<string>",
              "name": "<string>",
              "original_value": "<unknown>",
              "overridden": "<unknown>",
              "type": "<string>",
              "value": "<unknown>"
            }
          ],
          "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": "<unknown>",
          "parent_customer_id": "<unknown>",
          "phone": "<string>",
          "status": "<string>",
          "title": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        },
        "customer_id": "<string>",
        "due": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "due_date": "2023-11-07T05:31:56Z",
        "hosted_link": "<unknown>",
        "invoice_date": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "number": "<string>",
        "paid": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "paid_date": "<unknown>",
        "pdf_link": "<unknown>",
        "prorated_amount": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "status": "<string>",
        "sub_total": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "subscription_id": "<unknown>",
        "total": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "updated_at": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
      },
      "invoice_id": "<unknown>",
      "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>",
      "note": "<unknown>",
      "type": "<string>",
      "units_applied": 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.action_type

null | string

The credit log action type that can be one of ISSUED, CONSUMED, EXPIRED or REVOKED

query.credit_id

null | string

The credit ID to which the credit logs belong

query.customer_id

null | string

The customer ID to which the credits logs belong

query.invoice_id

null | string

The invoice ID to which the credits logs belong

query.note

null | string

Search any notes attached to the credit log

query.search

null | string

Any search string to match customers

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

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.action_type

string

results.amount_applied

object

The amount which has value in cents and a currency

Show child attributes

results.amount_applied.currency

string

results.amount_applied.value_in_cents

integer<int64>

results.created_at

string<date-time>

results.credit_id

string

results.customer

object

Show child attributes

results.customer.email

string

results.customer.id

string

results.customer.identifier

string

results.customer.name

string

results.customer.org_name

string

results.customer.parent_customer

any

results.customer.parent_customer_id

null | string

results.customer_id

string

results.id

string

results.invoice

object

Show child attributes

results.invoice.auto_charges

boolean

Whether the invoice is automatically charged to the payment method on file for the customer

results.invoice.billed_customer_id

string

The billed customer ID for the invoice. This matches the customer_id by default, but can be set to another parent customer ID

results.invoice.created_at

string<date-time>

The date the invoice was created

results.invoice.currency

string

The currency of the invoice

results.invoice.customer

object

The expanded customer details for the invoice

Show child attributes

results.invoice.customer.address

object

The address of the customer

Show child attributes

results.invoice.customer.address.address_line_1

string

results.invoice.customer.address.address_line_2

string

results.invoice.customer.address.city

string

results.invoice.customer.address.country

string

2-character country code (ISO 3166-1 alpha-2)

results.invoice.customer.address.place_id

null | string

results.invoice.customer.address.state

string

results.invoice.customer.address.zip

string

results.invoice.customer.arr

object

The ARR of the customer

Show child attributes

results.invoice.customer.arr.currency

string

results.invoice.customer.arr.value_in_cents

integer<int64>

results.invoice.customer.billing_emails

string[] | null

The additional emails to cc on customer's invoices

results.invoice.customer.company_id

string

The company ID of the customer

results.invoice.customer.computed_entitlements

object[] | null

The computed entitlements for the customer

Show child attributes

results.invoice.customer.computed_entitlements.entitlement_id

string

results.invoice.customer.computed_entitlements.id

string

results.invoice.customer.computed_entitlements.inherited_from_id

null | string

results.invoice.customer.computed_entitlements.inherited_from_type

null | string

results.invoice.customer.computed_entitlements.key

string

results.invoice.customer.computed_entitlements.name

string

results.invoice.customer.computed_entitlements.original_value

any

results.invoice.customer.computed_entitlements.overridden

null | boolean

results.invoice.customer.computed_entitlements.type

string

results.invoice.customer.computed_entitlements.value

any

results.invoice.customer.created_at

string<date-time>

The date the customer was created

results.invoice.customer.customer_integration_metadata

object

Show child attributes

results.invoice.customer.customer_integration_metadata.{key}

object

Show child attributes

results.invoice.customer.customer_integration_metadata.{key}.avalara

object

Show child attributes

results.invoice.customer.customer_integration_metadata.{key}.avalara.entity_code

string

results.invoice.customer.email

string

The email of the customer

results.invoice.customer.exclude_from_metrics

boolean

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

results.invoice.customer.id

string

The ID of the customer in Maple

results.invoice.customer.identifier

string

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

results.invoice.customer.integration_references

object[]

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

Show child attributes

results.invoice.customer.integration_references.integration_icon

string

results.invoice.customer.integration_references.integration_id

string

results.invoice.customer.integration_references.integration_key

string

results.invoice.customer.integration_references.integration_name

string

results.invoice.customer.integration_references.reference_type

string

results.invoice.customer.integration_references.remote_id

string

results.invoice.customer.integration_references.remote_type

string

results.invoice.customer.locale

string

The locale of the customer

results.invoice.customer.managed_externally

boolean

Whether this customer is managed outside of Maple

results.invoice.customer.metadata

object

The metadata as key-value pairs attached to this customer

results.invoice.customer.mrr

object

The MRR of the customer

Show child attributes

results.invoice.customer.mrr.currency

string

results.invoice.customer.mrr.value_in_cents

integer<int64>

results.invoice.customer.name

string

The name of the customer

results.invoice.customer.org_name

string

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

results.invoice.customer.owner_id

null | string

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

results.invoice.customer.parent_customer_id

null | string

The customer ID of the parent customer assigned in Maple

results.invoice.customer.phone

string

The phone number of the customer

results.invoice.customer.status

string

The status of the customer such as ACTIVE or ARCHIVED

results.invoice.customer.title

string

The title of the customer, such as CEO, VP

results.invoice.customer.updated_at

string<date-time>

The date the customer was last updated

results.invoice.customer_id

string

The customer ID for the invoice

results.invoice.due

object

The total amount due on the invoice after any payments

Show child attributes

results.invoice.due.currency

string

results.invoice.due.value_in_cents

integer<int64>

results.invoice.due_date

string<date-time>

The date the invoice total is due

results.invoice.hosted_link

null | string

The hosted link for the invoice

results.invoice.invoice_date

string<date-time>

The date for the invoice

results.invoice.name

string

The name of the invoice

results.invoice.number

string

The invoice number for the invoice

results.invoice.paid

object

The total amount paid against the invoice

Show child attributes

results.invoice.paid.currency

string

results.invoice.paid.value_in_cents

integer<int64>

results.invoice.paid_date

null | string<date-time>

The date the invoice was paid

results.invoice.pdf_link

null | string

The PDF link for the invoice

results.invoice.prorated_amount

object

Any prorated amounts for the invoice

Show child attributes

results.invoice.prorated_amount.currency

string

results.invoice.prorated_amount.value_in_cents

integer<int64>

results.invoice.status

string

The status of the invoice such as PAID, DRAFT, VOID or PENDING

results.invoice.sub_total

object

The subtotal of the invoice which is prior to applying credits

Show child attributes

results.invoice.sub_total.currency

string

results.invoice.sub_total.value_in_cents

integer<int64>

results.invoice.subscription_id

null | string

The subscription ID for the invoice, if is not a one-time invoice

results.invoice.total

object

The final total of the invoice after applying all credits, discounts and taxes

Show child attributes

results.invoice.total.currency

string

results.invoice.total.value_in_cents

integer<int64>

results.invoice.updated_at

string<date-time>

The last date the invoice was updated

results.invoice.uuid

string

The unique identifier for the invoice

results.invoice_id

null | string

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.note

null | string

results.type

string

results.units_applied

number<double>

Get CreditRetrieve a credit by ID

⌘I

Find Credit Logs

curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/credits/logs/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 20
  },
  "include_meta": true,
  "query": {
    "action_type": "<unknown>",
    "credit_id": "<unknown>",
    "customer_id": "<unknown>",
    "invoice_id": "<unknown>",
    "note": "<unknown>",
    "search": "<unknown>",
    "type": "<unknown>"
  },
  "sort_key": "createdAtDesc"
}
'

{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 123
  },
  "results": [
    {
      "action_type": "<string>",
      "amount_applied": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "created_at": "2023-11-07T05:31:56Z",
      "credit_id": "<string>",
      "customer": {
        "email": "<string>",
        "id": "<string>",
        "identifier": "<string>",
        "name": "<string>",
        "org_name": "<string>",
        "parent_customer": "<unknown>",
        "parent_customer_id": "<unknown>"
      },
      "customer_id": "<string>",
      "id": "<string>",
      "invoice": {
        "auto_charges": true,
        "billed_customer_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "currency": "<string>",
        "customer": {
          "address": {
            "address_line_1": "<string>",
            "address_line_2": "<string>",
            "city": "<string>",
            "country": "<string>",
            "place_id": "<unknown>",
            "state": "<string>",
            "zip": "<string>"
          },
          "arr": {
            "currency": "<string>",
            "value_in_cents": 123
          },
          "billing_emails": [
            "<string>"
          ],
          "company_id": "<string>",
          "computed_entitlements": [
            {
              "entitlement_id": "<string>",
              "id": "<string>",
              "inherited_from_id": "<unknown>",
              "inherited_from_type": "<unknown>",
              "key": "<string>",
              "name": "<string>",
              "original_value": "<unknown>",
              "overridden": "<unknown>",
              "type": "<string>",
              "value": "<unknown>"
            }
          ],
          "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": "<unknown>",
          "parent_customer_id": "<unknown>",
          "phone": "<string>",
          "status": "<string>",
          "title": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        },
        "customer_id": "<string>",
        "due": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "due_date": "2023-11-07T05:31:56Z",
        "hosted_link": "<unknown>",
        "invoice_date": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "number": "<string>",
        "paid": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "paid_date": "<unknown>",
        "pdf_link": "<unknown>",
        "prorated_amount": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "status": "<string>",
        "sub_total": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "subscription_id": "<unknown>",
        "total": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "updated_at": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
      },
      "invoice_id": "<unknown>",
      "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>",
      "note": "<unknown>",
      "type": "<string>",
      "units_applied": 123
    }
  ]
}

API Features

API Reference

Webhook Reference

Authorizations

Headers

Path Parameters

Body

Response