Search credit logs with given parameters
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": {
"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
},
"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
}
]
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The idempotency key that will be used to ensure the request is only performed once
The company ID with the prefix 'cmp_'.
The pagination parameters for the request
Show child attributes
Whether to include additional metadata in the pagination response such the number of total results
The query criteria for the request
Show child attributes
createdAtDesc, createdAtAsc, updatedAtAsc, updatedAtDesc 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": {
"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
},
"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
}
]
}