POST
/
companies
/
{company_id}
/
one_times
/
find
curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/one_times/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "include_meta": true,
  "pagination": {
    "from_key": "<string>",
    "limit": 20
  },
  "query": {
    "customer_id": "<string>",
    "state": "PENDING",
    "type": "IMMEDIATE"
  },
  "sort_key": "createdAtDesc"
}'
{
  "pagination": {
    "from_key": "<string>",
    "limit": 123
  },
  "results": [
    {
      "aggregate": 123,
      "company_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "custom_price": {
        "amount": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "description": "<string>",
        "product_id": "<string>"
      },
      "customer_id": "<string>",
      "id": "<string>",
      "name": "<string>",
      "product_pricing": {
        "company_id": "<string>",
        "computed_entitlements": [
          {
            "entitlement_id": "<string>",
            "inherited_from_id": "<string>",
            "inherited_from_type": "<string>",
            "key": "<string>",
            "name": "<string>",
            "original_value": "<any>",
            "overridden": true,
            "type": "<string>",
            "value": "<any>"
          }
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "currency": "<string>",
        "description": "<string>",
        "external_name": "<string>",
        "id": "<string>",
        "import_created_at_ref": "2023-11-07T05:31:56Z",
        "import_ref": "<string>",
        "imported_from": "<string>",
        "metadata": {},
        "name": "<string>",
        "num_subs": 1,
        "override_entitlements": [
          {
            "entitlement_id": "<string>",
            "inherited_from_id": "<string>",
            "inherited_from_type": "<string>",
            "key": "<string>",
            "name": "<string>",
            "original_value": "<any>",
            "overridden": true,
            "type": "<string>",
            "value": "<any>"
          }
        ],
        "product": {
          "company_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "entitlements": [
            {
              "entitlement_id": "<string>",
              "inherited_from_id": "<string>",
              "inherited_from_type": "<string>",
              "key": "<string>",
              "name": "<string>",
              "original_value": "<any>",
              "overridden": true,
              "type": "<string>",
              "value": "<any>"
            }
          ],
          "external_name": "<string>",
          "id": "<string>",
          "image_url": "<string>",
          "import_created_at_ref": "2023-11-07T05:31:56Z",
          "import_ref": "<string>",
          "imported_from": "<string>",
          "metadata": {},
          "name": "<string>",
          "product_pricings": [
            {}
          ],
          "state": "<string>",
          "tags": [
            "<string>"
          ],
          "updated_at": "2023-11-07T05:31:56Z"
        },
        "product_id": "<string>",
        "product_metric_pricings": [
          {
            "company_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "id": "<string>",
            "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>",
            "item_pricing": {
              "base_price": {
                "currency": "<string>",
                "value_in_cents": 123
              },
              "base_units": 123,
              "carry_over": true,
              "charge_type": "<string>",
              "company": {
                "address": {
                  "address_line_1": "<string>",
                  "address_line_2": "<string>",
                  "city": "<string>",
                  "country": "<string>",
                  "place_id": "<string>",
                  "state": "<string>",
                  "zip": "<string>"
                },
                "computed_entitlements": {},
                "created_at": "2023-11-07T05:31:56Z",
                "customer_id": "<string>",
                "demo": true,
                "email": "<string>",
                "id": "<string>",
                "is_dev": true,
                "legal_name": "<string>",
                "name": "<string>",
                "phone": "<string>",
                "preferred_currency": "<string>",
                "preferred_timezone": "<string>",
                "slug": "<string>",
                "updated_at": "2023-11-07T05:31:56Z"
              },
              "company_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "credit_price": {
                "amount": {
                  "currency": "<string>",
                  "value_in_cents": 123
                },
                "item_id": "<string>",
                "type": "AMOUNT",
                "units": 2
              },
              "custom_price": {
                "max_price_per_unit": "<string>",
                "min_price_per_unit": "<string>",
                "preset_price_per_unit": "<string>",
                "price_per_unit": "<string>"
              },
              "description": "<string>",
              "display_type": "<string>",
              "editable": true,
              "external_name": "<string>",
              "fixed_price": {
                "price_per_unit": "<string>"
              },
              "frequency": "<string>",
              "gradient_price": [
                {
                  "end": 1,
                  "flat_price": "<string>",
                  "is_custom_tier": true,
                  "price_per_unit": "<string>",
                  "start": 1
                }
              ],
              "id": "<string>",
              "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>",
              "metadata": {},
              "minimum_spend": {
                "currency": "<string>",
                "value_in_cents": 123
              },
              "minimum_spend_schedule": {
                "allow_pulling_forward": true,
                "amount_per_period": [
                  "<string>"
                ],
                "minimum_spend_schedule_type": "<string>"
              },
              "name": "<string>",
              "num_subs": 1,
              "proration_type": "<string>",
              "recognition_schedule": {
                "amount_per_period": [
                  "<string>"
                ],
                "recognition_schedule_type": "<string>"
              },
              "scheduled_price": {
                "price_per_unit_per_period": [
                  "<string>"
                ]
              },
              "state": "<string>",
              "step_price": {
                "price_per_step": "<string>",
                "step_size": 1
              },
              "term_count": 123,
              "true_up_frequency": "<string>",
              "type": "<string>",
              "updated_at": "2023-11-07T05:31:56Z",
              "volume_price": [
                {
                  "flat_price": "<string>",
                  "is_custom_tier": true,
                  "price_per_unit": "<string>",
                  "total_units_end": 1,
                  "total_units_start": 1
                }
              ]
            },
            "item_pricing_id": "<string>",
            "metric": {
              "company_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "description": "<string>",
              "external_name": "<string>",
              "id": "<string>",
              "item_id": "<string>",
              "metering_rule": {
                "aggregator": "<string>",
                "group_keys": [
                  "<string>"
                ],
                "property": "<string>",
                "rule": "<string>"
              },
              "name": "<string>",
              "standard": true,
              "type": "<string>",
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "metric_id": "<string>",
            "product_id": "<string>",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        ],
        "state": "<string>",
        "tags": [
          "<string>"
        ],
        "type": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "upsell_product_pricing_id": "<string>"
      },
      "product_pricing_id": "<string>",
      "quantity_config": {
        "allow_custom_quantity": true,
        "max_quantity": 123,
        "min_quantity": 123
      },
      "state": "<string>",
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

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.