Find Subscriptions

curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/subscriptions/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,
    "bundle_pricing_id": null,
    "customer_id": null,
    "end_date": {
      "eq": null,
      "gte": null,
      "lte": null
    },
    "exclude_from_metrics": null,
    "group_id": null,
    "mrr": {
      "eq": null,
      "gte": null,
      "lte": null
    },
    "next_invoice_date": {
      "eq": null,
      "gte": null,
      "lte": null
    },
    "owner_id": "<string>",
    "parent_billed": null,
    "parent_customer_id": "<string>",
    "payment_method_id": null,
    "product_ids": {
      "condition": "AND",
      "values": [
        "<string>"
      ]
    },
    "product_pricing_id": null,
    "product_pricing_ids": {
      "condition": "AND",
      "values": [
        "<string>"
      ]
    },
    "product_pricing_tags": {
      "condition": "AND",
      "values": [
        "<string>"
      ]
    },
    "product_tags": {
      "condition": "AND",
      "values": [
        "<string>"
      ]
    },
    "renewal_date": {
      "eq": null,
      "gte": null,
      "lte": null
    },
    "search": null,
    "start_date": {
      "eq": null,
      "gte": null,
      "lte": null
    },
    "status": null,
    "statuses": [
      "<string>"
    ],
    "trial": null
  },
  "sort_key": "createdAtDesc"
}'

{
  "pagination": {
    "from_key": null,
    "limit": 123
  },
  "results": [
    {
      "arr": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "auto_charges": true,
      "auto_renews": true,
      "billing_anchor_date": "2023-11-07T05:31:56Z",
      "cancel_config": {
        "campaign_id": "<string>",
        "campaign_step_id": "<string>",
        "charge_remaining_balance": null,
        "custom_end_date": null,
        "custom_refund_amount": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "reason": null,
        "refund_type": "<string>",
        "send_customer_receipt": null,
        "timing": "<string>"
      },
      "cancel_date": null,
      "change_config": {
        "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"
        }
      },
      "change_date": null,
      "company_id": "<string>",
      "computed_entitlements": [
        {
          "entitlement_id": "<string>",
          "inherited_from_id": null,
          "inherited_from_type": null,
          "key": "<string>",
          "name": "<string>",
          "original_value": "<any>",
          "overridden": null,
          "type": "<string>",
          "value": "<any>"
        }
      ],
      "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
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "customer": {
        "address": {
          "address_line_1": "<string>",
          "address_line_2": "<string>",
          "city": "<string>",
          "country": "<string>",
          "place_id": null,
          "state": "<string>",
          "zip": "<string>"
        },
        "arr": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "billing_emails": [
          "<string>"
        ],
        "company_id": "<string>",
        "computed_entitlements": [
          {
            "entitlement_id": "<string>",
            "inherited_from_id": null,
            "inherited_from_type": null,
            "key": "<string>",
            "name": "<string>",
            "original_value": "<any>",
            "overridden": null,
            "type": "<string>",
            "value": "<any>"
          }
        ],
        "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": null,
        "parent_customer_id": null,
        "phone": "<string>",
        "status": "<string>",
        "title": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "customer_id": "<string>",
      "end_date": null,
      "id": "<string>",
      "invoice_additional_display_fields": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "invoice_due_date_from_creation": 1,
      "metadata": {},
      "minimum_spend": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "mrr": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "next_invoice_date": null,
      "override_entitlements": [
        {
          "entitlement_id": "<string>",
          "inherited_from_id": null,
          "inherited_from_type": null,
          "key": "<string>",
          "name": "<string>",
          "original_value": "<any>",
          "overridden": null,
          "type": "<string>",
          "value": "<any>"
        }
      ],
      "pause_config": {
        "behavior": "<string>",
        "resume_date": null
      },
      "pause_date": null,
      "payment_method_id": null,
      "product_pricing_ids": [
        "<string>"
      ],
      "product_pricings": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "currency": "<string>",
          "external_name": "<string>",
          "id": "<string>",
          "name": "<string>",
          "product": {
            "company_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "description": "<string>",
            "entitlements": [
              {
                "entitlement_id": "<string>",
                "inherited_from_id": null,
                "inherited_from_type": null,
                "key": "<string>",
                "name": "<string>",
                "original_value": "<any>",
                "overridden": null,
                "type": "<string>",
                "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": "<string>",
                    "inherited_from_id": null,
                    "inherited_from_type": null,
                    "key": "<string>",
                    "name": "<string>",
                    "original_value": "<any>",
                    "overridden": null,
                    "type": "<string>",
                    "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": "<string>",
                    "inherited_from_id": null,
                    "inherited_from_type": null,
                    "key": "<string>",
                    "name": "<string>",
                    "original_value": "<any>",
                    "overridden": null,
                    "type": "<string>",
                    "value": "<any>"
                  }
                ],
                "product": {},
                "product_id": "<string>",
                "product_metric_pricings": [
                  {
                    "company_id": "<string>",
                    "created_at": "2023-11-07T05:31:56Z",
                    "id": "<string>",
                    "item": {
                      "company_id": "<any>",
                      "created_at": "<any>",
                      "description": "<any>",
                      "display_type": "<any>",
                      "editable": "<any>",
                      "external_name": "<any>",
                      "id": "<any>",
                      "name": "<any>",
                      "standard": "<any>",
                      "type": "<any>",
                      "updated_at": "<any>"
                    },
                    "item_id": "<string>",
                    "item_pricing": {
                      "base_price": "<any>",
                      "base_units": "<any>",
                      "carry_over": "<any>",
                      "charge_type": "<any>",
                      "company": "<any>",
                      "company_id": "<any>",
                      "created_at": "<any>",
                      "credit_price": "<any>",
                      "custom_price": "<any>",
                      "description": "<any>",
                      "display_type": "<any>",
                      "editable": "<any>",
                      "external_name": "<any>",
                      "fixed_price": "<any>",
                      "frequency": "<any>",
                      "gradient_price": "<any>",
                      "id": "<any>",
                      "item": "<any>",
                      "item_id": "<any>",
                      "metadata": "<any>",
                      "minimum_spend": "<any>",
                      "minimum_spend_schedule": "<any>",
                      "name": "<any>",
                      "num_subs": "<any>",
                      "proration_type": "<any>",
                      "recognition_schedule": "<any>",
                      "scheduled_price": "<any>",
                      "state": "<any>",
                      "step_price": "<any>",
                      "term_count": "<any>",
                      "true_up_frequency": "<any>",
                      "type": "<any>",
                      "updated_at": "<any>",
                      "volume_price": "<any>"
                    },
                    "item_pricing_id": "<string>",
                    "metric": {
                      "company_id": "<any>",
                      "created_at": "<any>",
                      "description": "<any>",
                      "external_name": "<any>",
                      "id": "<any>",
                      "item_id": "<any>",
                      "metering_rule": "<any>",
                      "name": "<any>",
                      "standard": "<any>",
                      "type": "<any>",
                      "updated_at": "<any>"
                    },
                    "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": null
              }
            ],
            "state": "<string>",
            "tags": [
              "<string>"
            ],
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "product_id": "<string>",
          "product_metric_pricings": [
            {
              "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": {},
                "base_units": 123,
                "carry_over": true,
                "charge_type": "<string>",
                "company": {},
                "company_id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "credit_price": {},
                "custom_price": {},
                "description": "<string>",
                "display_type": "<string>",
                "editable": true,
                "external_name": "<string>",
                "fixed_price": {},
                "frequency": "<string>",
                "gradient_price": [
                  "<any>"
                ],
                "id": "<string>",
                "item": {},
                "item_id": "<string>",
                "metadata": {},
                "minimum_spend": {},
                "minimum_spend_schedule": {},
                "name": "<string>",
                "num_subs": 1,
                "proration_type": "<string>",
                "recognition_schedule": {},
                "scheduled_price": {},
                "state": "<string>",
                "step_price": {},
                "term_count": 123,
                "true_up_frequency": "<string>",
                "type": "<string>",
                "updated_at": "2023-11-07T05:31:56Z",
                "volume_price": [
                  "<any>"
                ]
              },
              "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": {},
                "name": "<string>",
                "standard": true,
                "type": "<string>",
                "updated_at": "2023-11-07T05:31:56Z"
              },
              "metric_id": "<string>",
              "minimum_units": 123,
              "num_licenses": 123,
              "updated_at": "2023-11-07T05:31:56Z"
            }
          ],
          "tags": [
            "<string>"
          ],
          "type": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "renewal_date": null,
      "start_date": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "term": {
        "count": 2,
        "frequency": "HOUR"
      },
      "trial": true,
      "trial_conversion_date": null,
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}