Search credits with given parameters
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": null,
"limit": 20
},
"query": {
"currency": null,
"customer_id": null,
"search": null,
"status": null,
"statuses": [
"<string>"
],
"subscription_id": null,
"type": null
},
"sort_key": "createdAtDesc"
}'
{
"pagination": {
"from_key": null,
"limit": 123
},
"results": [
{
"amount": {
"currency": "<string>",
"value_in_cents": 123
},
"coupon_id": null,
"created_at": "2023-11-07T05:31:56Z",
"customer_id": "<string>",
"expiration_date": null,
"id": "<string>",
"import_created_at_ref": null,
"import_ref": null,
"imported_from": null,
"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": null,
"metric_record_id": null,
"name": "<string>",
"one_time_billable_id": null,
"proration_date": null,
"state": "<string>",
"subscription_id": null,
"type": "<string>",
"units": 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_'.
OK
The response is of type object
.
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": null,
"limit": 20
},
"query": {
"currency": null,
"customer_id": null,
"search": null,
"status": null,
"statuses": [
"<string>"
],
"subscription_id": null,
"type": null
},
"sort_key": "createdAtDesc"
}'
{
"pagination": {
"from_key": null,
"limit": 123
},
"results": [
{
"amount": {
"currency": "<string>",
"value_in_cents": 123
},
"coupon_id": null,
"created_at": "2023-11-07T05:31:56Z",
"customer_id": "<string>",
"expiration_date": null,
"id": "<string>",
"import_created_at_ref": null,
"import_ref": null,
"imported_from": null,
"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": null,
"metric_record_id": null,
"name": "<string>",
"one_time_billable_id": null,
"proration_date": null,
"state": "<string>",
"subscription_id": null,
"type": "<string>",
"units": 123
}
]
}