POST
/
companies
/
{company_id}
/
contracts
/
find
Find Contracts
curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/contracts/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "include_meta": null,
  "pagination": {
    "from_key": null,
    "limit": 20
  },
  "query": {
    "auto_charges": null,
    "auto_renews": null,
    "customer_id": null,
    "owner_id": null,
    "search": null,
    "statuses": [
      "<string>"
    ],
    "type": null
  },
  "sort_key": "createdAtDesc"
}'
{
  "pagination": {
    "from_key": null,
    "limit": 123
  },
  "results": [
    {
      "acv": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "auto_charges": true,
      "auto_renews": true,
      "bundle_pricing": {
        "bundle_product_pricings": [
          {
            "bundle_pricing_id": "<string>",
            "company_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "id": "<string>",
            "product": {
              "company_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "description": "<string>",
              "entitlements": [
                {
                  "entitlement_id": "<any>",
                  "inherited_from_id": "<any>",
                  "inherited_from_type": "<any>",
                  "key": "<any>",
                  "name": "<any>",
                  "original_value": "<any>",
                  "overridden": "<any>",
                  "type": "<any>",
                  "value": "<any>"
                }
              ],
              "external_name": "<string>",
              "id": "<string>",
              "image_url": null,
              "import_created_at_ref": null,
              "import_ref": null,
              "imported_from": null,
              "metadata": {},
              "name": "<string>",
              "product_pricings": [
                {
                  "company_id": "<string>",
                  "computed_entitlements": [
                    {
                      "entitlement_id": "<any>",
                      "inherited_from_id": "<any>",
                      "inherited_from_type": "<any>",
                      "key": "<any>",
                      "name": "<any>",
                      "original_value": "<any>",
                      "overridden": "<any>",
                      "type": "<any>",
                      "value": "<any>"
                    }
                  ],
                  "created_at": "2023-11-07T05:31:56Z",
                  "currency": "<string>",
                  "description": "<string>",
                  "external_name": "<string>",
                  "id": "<string>",
                  "import_created_at_ref": null,
                  "import_ref": null,
                  "imported_from": null,
                  "metadata": {},
                  "name": "<string>",
                  "num_subs": 1,
                  "override_entitlements": [
                    {
                      "entitlement_id": "<any>",
                      "inherited_from_id": "<any>",
                      "inherited_from_type": "<any>",
                      "key": "<any>",
                      "name": "<any>",
                      "original_value": "<any>",
                      "overridden": "<any>",
                      "type": "<any>",
                      "value": "<any>"
                    }
                  ],
                  "product": {},
                  "product_id": "<string>",
                  "product_metric_pricings": [
                    {
                      "company_id": "<any>",
                      "created_at": "<any>",
                      "id": "<any>",
                      "item": "<any>",
                      "item_id": "<any>",
                      "item_pricing": "<any>",
                      "item_pricing_id": "<any>",
                      "metric": "<any>",
                      "metric_id": "<any>",
                      "product_id": "<any>",
                      "updated_at": "<any>"
                    }
                  ],
                  "state": "<string>",
                  "tags": [
                    "<string>"
                  ],
                  "type": "<string>",
                  "updated_at": "2023-11-07T05:31:56Z",
                  "upsell_product_pricing_id": null
                }
              ],
              "state": "<string>",
              "tags": [
                "<string>"
              ],
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "product_id": "<string>",
            "product_pricing": {
              "company_id": "<string>",
              "computed_entitlements": [
                {
                  "entitlement_id": "<any>",
                  "inherited_from_id": "<any>",
                  "inherited_from_type": "<any>",
                  "key": "<any>",
                  "name": "<any>",
                  "original_value": "<any>",
                  "overridden": "<any>",
                  "type": "<any>",
                  "value": "<any>"
                }
              ],
              "created_at": "2023-11-07T05:31:56Z",
              "currency": "<string>",
              "description": "<string>",
              "external_name": "<string>",
              "id": "<string>",
              "import_created_at_ref": null,
              "import_ref": null,
              "imported_from": null,
              "metadata": {},
              "name": "<string>",
              "num_subs": 1,
              "override_entitlements": [
                {
                  "entitlement_id": "<any>",
                  "inherited_from_id": "<any>",
                  "inherited_from_type": "<any>",
                  "key": "<any>",
                  "name": "<any>",
                  "original_value": "<any>",
                  "overridden": "<any>",
                  "type": "<any>",
                  "value": "<any>"
                }
              ],
              "product": {},
              "product_id": "<string>",
              "product_metric_pricings": [
                {
                  "company_id": "<any>",
                  "created_at": "<any>",
                  "id": "<any>",
                  "item": "<any>",
                  "item_id": "<any>",
                  "item_pricing": "<any>",
                  "item_pricing_id": "<any>",
                  "metric": "<any>",
                  "metric_id": "<any>",
                  "product_id": "<any>",
                  "updated_at": "<any>"
                }
              ],
              "state": "<string>",
              "tags": [
                "<string>"
              ],
              "type": "<string>",
              "updated_at": "2023-11-07T05:31:56Z",
              "upsell_product_pricing_id": null
            },
            "product_pricing_id": "<string>",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        ],
        "company_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "currency": "<string>",
        "description": "<string>",
        "id": "<string>",
        "is_auto_generated": true,
        "metadata": {},
        "name": "<string>",
        "num_subs": 1,
        "state": "<string>",
        "term": {
          "count": 2,
          "frequency": "HOUR"
        },
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "bundle_pricing_id": "<string>",
      "campaigns": [
        {
          "amount": {
            "currency": "<string>",
            "value_in_cents": 123
          },
          "created_at": "2023-11-07T05:31:56Z",
          "current_step": 1,
          "customer": {
            "email": "<string>",
            "id": "<string>",
            "name": "<string>",
            "org_name": "<string>"
          },
          "id": "<string>",
          "invoice": {
            "auto_charges": true,
            "billed_customer_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "currency": "<string>",
            "customer_id": "<string>",
            "due": {
              "currency": "<string>",
              "value_in_cents": 123
            },
            "due_date": "2023-11-07T05:31:56Z",
            "hosted_link": null,
            "invoice_date": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "number": "<string>",
            "paid": {
              "currency": "<string>",
              "value_in_cents": 123
            },
            "paid_date": null,
            "pdf_link": null,
            "prorated_amount": {
              "currency": "<string>",
              "value_in_cents": 123
            },
            "status": "<string>",
            "sub_total": {
              "currency": "<string>",
              "value_in_cents": 123
            },
            "subscription_id": null,
            "total": {
              "currency": "<string>",
              "value_in_cents": 123
            },
            "updated_at": "2023-11-07T05:31:56Z",
            "uuid": "<string>"
          },
          "next_action_in": null,
          "next_action_type": null,
          "proposal": {},
          "status": "<string>",
          "steps": [
            {
              "action_type": "<string>",
              "completed_at": "2023-11-07T05:31:56Z",
              "enqueued_at": "2023-11-07T05:31:56Z",
              "id": "<string>",
              "notification_log": {
                "cc": [
                  "<string>"
                ],
                "id": "<string>",
                "notification_type": "<string>",
                "status": "<string>",
                "subject": "<string>",
                "to": "<string>"
              },
              "payment_transaction": {
                "created_at": "2023-11-07T05:31:56Z",
                "id": "<string>",
                "provider_type": "<string>",
                "status": "<string>",
                "total_amount": {
                  "currency": "<string>",
                  "value_in_cents": 123
                },
                "total_amount_default_currency": {
                  "currency": "<string>",
                  "value_in_cents": 123
                },
                "transaction_type": "<string>",
                "updated_at": "2023-11-07T05:31:56Z"
              },
              "status": "<string>",
              "step_number": 1
            }
          ],
          "time_from_reference_data": null,
          "total_steps": 1,
          "type": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "change_custom_date": null,
      "change_proration_type": "<string>",
      "change_reset_billing_anchor": null,
      "change_timing": "<string>",
      "company": {
        "address": {
          "address_line_1": "<string>",
          "address_line_2": "<string>",
          "city": "<string>",
          "country": "<string>",
          "place_id": null,
          "state": "<string>",
          "zip": "<string>"
        },
        "computed_entitlements": {},
        "created_at": "2023-11-07T05:31:56Z",
        "customer_id": null,
        "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>",
      "completed_date": null,
      "config_items": [
        {
          "minimum_units": 1,
          "num_licenses": 1,
          "product_metric_pricing_id": null,
          "product_pricing_id": null,
          "quantity_config": {
            "allow_custom_quantity": true,
            "max_quantity": 123,
            "min_quantity": 123
          },
          "sort_order": null,
          "upsell_product_metric_pricing_id": null
        }
      ],
      "content": null,
      "content_template": null,
      "contract_attachments": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "file_id": "<string>",
          "id": "<string>",
          "original_filename": "<string>",
          "uploaded_at": "2023-11-07T05:31:56Z"
        }
      ],
      "counter_signatories": [
        {
          "company_user": {
            "created_at": "2023-11-07T05:31:56Z",
            "id": "<string>",
            "image_url": "<string>",
            "title": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "user": {
              "email": "<string>",
              "id": "<string>",
              "name": "<string>",
              "verified": true
            }
          },
          "declined": true,
          "email": "<string>",
          "id": "<string>",
          "position": null,
          "signature_id": null,
          "signed": true,
          "signed_date": null
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "custom_variables": {},
      "customer": {
        "address": {
          "address_line_1": "<string>",
          "address_line_2": "<string>",
          "city": "<string>",
          "country": "<string>",
          "place_id": null,
          "state": "<string>",
          "zip": "<string>"
        },
        "billing_emails": [
          "<string>"
        ],
        "email": "<string>",
        "id": "<string>",
        "identifier": "<string>",
        "name": "<string>",
        "org_name": "<string>",
        "parent_customer": {},
        "parent_customer_id": null,
        "phone": "<string>"
      },
      "customer_id": null,
      "discounts": [
        {
          "amount": {
            "currency": "<string>",
            "value_in_cents": 123
          },
          "cap": {
            "currency": "<string>",
            "value_in_cents": 123
          },
          "company_id": "<string>",
          "coupon_id": null,
          "created_at": "2023-11-07T05:31:56Z",
          "customer_id": null,
          "deleted_at": {},
          "expiration_date": null,
          "id": "<string>",
          "import_created_at_ref": null,
          "import_ref": null,
          "imported_from": null,
          "item_pricing_id": null,
          "name": "<string>",
          "onetime_billable": {
            "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": null,
            "deleted_at": {},
            "id": "<string>",
            "import_ref": null,
            "imported_from": null,
            "name": "<string>",
            "product_pricing_id": null,
            "proposal_id": null,
            "quantity_config": {
              "allow_custom_quantity": true,
              "max_quantity": 123,
              "min_quantity": 123
            },
            "sort_order": null,
            "state": "<string>",
            "type": "<string>",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "onetime_billable_id": null,
          "percent": 123,
          "product_id": null,
          "product_pricing_id": null,
          "proposal_id": null,
          "state": "<string>",
          "subscription_id": null,
          "type": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "expiration_date": null,
      "finalized_date": null,
      "id": "<string>",
      "invoice_due_date_from_creation": null,
      "invoice_event_grace_period": null,
      "invoice_payment_instructions": null,
      "metadata": {},
      "minimum_spend": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "one_time_billables": [
        {
          "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": null,
          "id": "<string>",
          "name": "<string>",
          "product_pricing": {
            "company_id": "<string>",
            "computed_entitlements": [
              {
                "entitlement_id": "<any>",
                "inherited_from_id": "<any>",
                "inherited_from_type": "<any>",
                "key": "<any>",
                "name": "<any>",
                "original_value": "<any>",
                "overridden": "<any>",
                "type": "<any>",
                "value": "<any>"
              }
            ],
            "created_at": "2023-11-07T05:31:56Z",
            "currency": "<string>",
            "description": "<string>",
            "external_name": "<string>",
            "id": "<string>",
            "import_created_at_ref": null,
            "import_ref": null,
            "imported_from": null,
            "metadata": {},
            "name": "<string>",
            "num_subs": 1,
            "override_entitlements": [
              {
                "entitlement_id": "<any>",
                "inherited_from_id": "<any>",
                "inherited_from_type": "<any>",
                "key": "<any>",
                "name": "<any>",
                "original_value": "<any>",
                "overridden": "<any>",
                "type": "<any>",
                "value": "<any>"
              }
            ],
            "product": {},
            "product_id": "<string>",
            "product_metric_pricings": [
              {
                "company_id": "<any>",
                "created_at": "<any>",
                "id": "<any>",
                "item": "<any>",
                "item_id": "<any>",
                "item_pricing": "<any>",
                "item_pricing_id": "<any>",
                "metric": "<any>",
                "metric_id": "<any>",
                "product_id": "<any>",
                "updated_at": "<any>"
              }
            ],
            "state": "<string>",
            "tags": [
              "<string>"
            ],
            "type": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "upsell_product_pricing_id": null
          },
          "product_pricing_id": null,
          "quantity_config": {
            "allow_custom_quantity": true,
            "max_quantity": 123,
            "min_quantity": 123
          },
          "sort_order": null,
          "state": "<string>",
          "type": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "options": {
        "allow_promo_code": true,
        "collect_taxes": true,
        "completion_action": "<string>",
        "confirmation_message": "<string>",
        "redirect_url": "<string>",
        "requires_customer_address": true,
        "requires_customer_confirmation": true,
        "requires_customer_phone": true,
        "requires_email_verification": true,
        "save_card_on_checkout": true
      },
      "owner": {
        "created_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "image_url": "<string>",
        "title": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "user": {
          "email": "<string>",
          "id": "<string>",
          "name": "<string>",
          "verified": true
        }
      },
      "owner_id": null,
      "parent_billed": true,
      "payment_config": {
        "account_id": "<string>",
        "client_secret": "<string>",
        "integration_id": null,
        "live_mode": true,
        "provider": "<string>",
        "razorpay": {
          "account_id": "<string>"
        },
        "stripe": {
          "account_id": "<string>"
        }
      },
      "payment_data": {
        "authorize_net": {
          "payment_method_id": "<string>"
        },
        "helcim": {
          "payment_method_id": null
        },
        "payment_provider_key": "stripe",
        "razor_pay": {
          "token_id": "<string>"
        },
        "stripe": {
          "payment_method_id": "<string>"
        }
      },
      "payment_provided_date": null,
      "po_number": null,
      "previous_arr": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "previous_subscription": {
        "id": "<string>"
      },
      "previous_subscription_id": null,
      "require_payment_method": true,
      "requires_customer_confirmation": true,
      "scheduled_changes": [
        {
          "actual_change_time": null,
          "auto_charges": null,
          "bundle_pricing": {
            "bundle_product_pricings": [
              {
                "bundle_pricing_id": "<string>",
                "company_id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "deleted_at": {},
                "id": "<string>",
                "product_id": "<string>",
                "product_pricing_id": "<string>",
                "updated_at": "2023-11-07T05:31:56Z"
              }
            ],
            "company_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "currency": "<string>",
            "default_term": {
              "count": 2,
              "frequency": "HOUR"
            },
            "deleted_at": {},
            "description": "<string>",
            "id": "<string>",
            "image_url": "<string>",
            "import_created_at_ref": null,
            "import_ref": null,
            "imported_from": null,
            "is_auto_generated": true,
            "key": "<string>",
            "metadata": {},
            "name": "<string>",
            "num_subs": 1,
            "state": "<string>",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "bundle_pricing_id": null,
          "config_items": [
            {
              "minimum_units": 1,
              "num_licenses": 1,
              "product_metric_pricing_id": null,
              "product_pricing_id": null,
              "quantity_config": {
                "allow_custom_quantity": true,
                "max_quantity": 123,
                "min_quantity": 123
              },
              "sort_order": null,
              "upsell_product_metric_pricing_id": null
            }
          ],
          "custom_change_date": null,
          "discounts": null,
          "metadata": {},
          "minimum_spend": {
            "currency": "<string>",
            "value_in_cents": 123
          },
          "onetime_items": [
            {
              "aggregate": 2,
              "custom_price": {
                "amount": {
                  "currency": "<string>",
                  "value_in_cents": 123
                },
                "description": "<string>",
                "product_id": "<string>"
              },
              "product_pricing_id": null,
              "quantity_config": {
                "allow_custom_quantity": true,
                "max_quantity": 123,
                "min_quantity": 123
              },
              "sort_order": null
            }
          ],
          "payment_method_id": null,
          "product_pricing_ids": [
            "<string>"
          ],
          "proration_type": "NEXT",
          "relative_term": {
            "count": 2,
            "frequency": "HOUR"
          },
          "reset_billing_anchor": null,
          "term": {
            "count": 2,
            "frequency": "HOUR"
          },
          "timing": "IMMEDIATE",
          "trial": null,
          "trial_term": {
            "count": 2,
            "frequency": "HOUR"
          }
        }
      ],
      "signatories": [
        {
          "declined": true,
          "email": "<string>",
          "name": "<string>",
          "position": null,
          "signature_id": "<string>",
          "signature_link": "<string>",
          "signed": true,
          "signed_date": null,
          "title": "<string>",
          "view_timestamps": [
            "2023-11-07T05:31:56Z"
          ]
        }
      ],
      "signed_date": null,
      "signed_file_id": null,
      "signed_offline": true,
      "start_date": null,
      "start_type": "<string>",
      "status": "<string>",
      "subscription": {
        "id": "<string>"
      },
      "subscription_id": null,
      "tcv": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "template_id": null,
      "template_variables": [
        "<string>"
      ],
      "term": {
        "count": 2,
        "frequency": "HOUR"
      },
      "title": "<string>",
      "trial": true,
      "trial_term": {
        "count": 2,
        "frequency": "HOUR"
      },
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "variable_configs": [
        {
          "default": "<string>",
          "is_custom": true,
          "is_editable": true,
          "key": "<string>",
          "name": "<string>",
          "tag": "<string>",
          "type": "<string>",
          "validation": "<string>",
          "value": "<string>"
        }
      ]
    }
  ]
}

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

Response

200 - application/json

OK

The response is of type object.