List credit notes with filtering

curl --request GET \
  --url https://api.cloud.flexprice.com/v1/creditnotes \
  --header 'x-api-key: <api-key>'

{
  "items": [
    {
      "created_at": "<string>",
      "created_by": "<string>",
      "credit_note_number": "<string>",
      "credit_note_status": "DRAFT",
      "credit_note_type": "ADJUSTMENT",
      "currency": "<string>",
      "customer": {
        "address_city": "<string>",
        "address_country": "<string>",
        "address_line1": "<string>",
        "address_line2": "<string>",
        "address_postal_code": "<string>",
        "address_state": "<string>",
        "created_at": "<string>",
        "created_by": "<string>",
        "email": "<string>",
        "environment_id": "<string>",
        "external_id": "<string>",
        "id": "<string>",
        "metadata": {},
        "name": "<string>",
        "status": "published",
        "tenant_id": "<string>",
        "updated_at": "<string>",
        "updated_by": "<string>"
      },
      "customer_id": "<string>",
      "environment_id": "<string>",
      "finalized_at": "<string>",
      "id": "<string>",
      "idempotency_key": "<string>",
      "invoice": {
        "amount_due": 123,
        "amount_paid": 123,
        "amount_remaining": 123,
        "billing_period": "<string>",
        "billing_reason": "<string>",
        "billing_sequence": 123,
        "created_at": "<string>",
        "created_by": "<string>",
        "currency": "<string>",
        "customer": {
          "address_city": "<string>",
          "address_country": "<string>",
          "address_line1": "<string>",
          "address_line2": "<string>",
          "address_postal_code": "<string>",
          "address_state": "<string>",
          "created_at": "<string>",
          "created_by": "<string>",
          "email": "<string>",
          "environment_id": "<string>",
          "external_id": "<string>",
          "id": "<string>",
          "metadata": {},
          "name": "<string>",
          "status": "published",
          "tenant_id": "<string>",
          "updated_at": "<string>",
          "updated_by": "<string>"
        },
        "customer_id": "<string>",
        "description": "<string>",
        "due_date": "<string>",
        "finalized_at": "<string>",
        "id": "<string>",
        "idempotency_key": "<string>",
        "invoice_number": "<string>",
        "invoice_pdf_url": "<string>",
        "invoice_status": "DRAFT",
        "invoice_type": "SUBSCRIPTION",
        "line_items": [
          {
            "amount": 123,
            "created_at": "<string>",
            "created_by": "<string>",
            "currency": "<string>",
            "customer_id": "<string>",
            "display_name": "<string>",
            "id": "<string>",
            "invoice_id": "<string>",
            "metadata": {},
            "meter_display_name": "<string>",
            "meter_id": "<string>",
            "period_end": "<string>",
            "period_start": "<string>",
            "plan_display_name": "<string>",
            "plan_id": "<string>",
            "price_id": "<string>",
            "price_type": "<string>",
            "quantity": 123,
            "status": "<string>",
            "subscription_id": "<string>",
            "tenant_id": "<string>",
            "updated_at": "<string>",
            "updated_by": "<string>"
          }
        ],
        "metadata": {},
        "paid_at": "<string>",
        "payment_status": "PENDING",
        "period_end": "<string>",
        "period_start": "<string>",
        "status": "<string>",
        "subscription": {
          "active_pause_id": "<string>",
          "billing_anchor": "<string>",
          "billing_cadence": "RECURRING",
          "billing_cycle": "anniversary",
          "billing_period": "MONTHLY",
          "billing_period_count": 123,
          "cancel_at": "<string>",
          "cancel_at_period_end": true,
          "cancelled_at": "<string>",
          "commitment_amount": 123,
          "created_at": "<string>",
          "created_by": "<string>",
          "currency": "<string>",
          "current_period_end": "<string>",
          "current_period_start": "<string>",
          "customer": {
            "address_city": "<string>",
            "address_country": "<string>",
            "address_line1": "<string>",
            "address_line2": "<string>",
            "address_postal_code": "<string>",
            "address_state": "<string>",
            "created_at": "<string>",
            "created_by": "<string>",
            "email": "<string>",
            "environment_id": "<string>",
            "external_id": "<string>",
            "id": "<string>",
            "metadata": {},
            "name": "<string>",
            "status": "published",
            "tenant_id": "<string>",
            "updated_at": "<string>",
            "updated_by": "<string>"
          },
          "customer_id": "<string>",
          "end_date": "<string>",
          "environment_id": "<string>",
          "id": "<string>",
          "line_items": [
            {
              "billing_period": "MONTHLY",
              "created_at": "<string>",
              "created_by": "<string>",
              "currency": "<string>",
              "customer_id": "<string>",
              "display_name": "<string>",
              "end_date": "<string>",
              "environment_id": "<string>",
              "id": "<string>",
              "invoice_cadence": "ARREAR",
              "metadata": {},
              "meter_display_name": "<string>",
              "meter_id": "<string>",
              "plan_display_name": "<string>",
              "plan_id": "<string>",
              "price_id": "<string>",
              "price_type": "USAGE",
              "quantity": 123,
              "start_date": "<string>",
              "status": "published",
              "subscription_id": "<string>",
              "tenant_id": "<string>",
              "trial_period": 123,
              "updated_at": "<string>",
              "updated_by": "<string>"
            }
          ],
          "lookup_key": "<string>",
          "metadata": {},
          "overage_factor": 123,
          "pause_status": "none",
          "pauses": [
            {
              "created_at": "<string>",
              "created_by": "<string>",
              "environment_id": "<string>",
              "id": "<string>",
              "metadata": {},
              "original_period_end": "<string>",
              "original_period_start": "<string>",
              "pause_end": "<string>",
              "pause_mode": "immediate",
              "pause_start": "<string>",
              "pause_status": "none",
              "reason": "<string>",
              "resume_mode": "immediate",
              "resumed_at": "<string>",
              "status": "published",
              "subscription_id": "<string>",
              "tenant_id": "<string>",
              "updated_at": "<string>",
              "updated_by": "<string>"
            }
          ],
          "plan": {
            "created_at": "<string>",
            "created_by": "<string>",
            "credit_grants": [
              {
                "cadence": "ONETIME",
                "created_at": "<string>",
                "created_by": "<string>",
                "credits": 123,
                "currency": "<string>",
                "environment_id": "<string>",
                "expiration_duration": 123,
                "expiration_duration_unit": "DAY",
                "expiration_type": "NEVER",
                "id": "<string>",
                "metadata": {},
                "name": "<string>",
                "period": "DAILY",
                "period_count": 123,
                "plan_id": "<string>",
                "priority": 123,
                "scope": "PLAN",
                "status": "published",
                "subscription_id": "<string>",
                "tenant_id": "<string>",
                "updated_at": "<string>",
                "updated_by": "<string>"
              }
            ],
            "description": "<string>",
            "entitlements": [
              {
                "created_at": "<string>",
                "created_by": "<string>",
                "environment_id": "<string>",
                "feature": {
                  "created_at": "<string>",
                  "created_by": "<string>",
                  "description": "<string>",
                  "environment_id": "<string>",
                  "id": "<string>",
                  "lookup_key": "<string>",
                  "metadata": {},
                  "meter": {
                    "aggregation": {
                      "field": "<string>",
                      "multiplier": 123,
                      "type": "COUNT"
                    },
                    "created_at": "2024-03-20T15:04:05Z",
                    "event_name": "api_request",
                    "filters": [
                      {
                        "key": "<string>",
                        "values": [
                          "<string>"
                        ]
                      }
                    ],
                    "id": "550e8400-e29b-41d4-a716-446655440000",
                    "name": "API Usage Meter",
                    "reset_usage": "BILLING_PERIOD",
                    "status": "published",
                    "tenant_id": "tenant123",
                    "updated_at": "2024-03-20T15:04:05Z"
                  },
                  "meter_id": "<string>",
                  "name": "<string>",
                  "status": "published",
                  "tenant_id": "<string>",
                  "type": "metered",
                  "unit_plural": "<string>",
                  "unit_singular": "<string>",
                  "updated_at": "<string>",
                  "updated_by": "<string>"
                },
                "feature_id": "<string>",
                "feature_type": "metered",
                "id": "<string>",
                "is_enabled": true,
                "is_soft_limit": true,
                "plan": {},
                "plan_id": "<string>",
                "static_value": "<string>",
                "status": "published",
                "tenant_id": "<string>",
                "updated_at": "<string>",
                "updated_by": "<string>",
                "usage_limit": 123,
                "usage_reset_period": "MONTHLY"
              }
            ],
            "environment_id": "<string>",
            "id": "<string>",
            "lookup_key": "<string>",
            "name": "<string>",
            "prices": [
              {
                "amount": 123,
                "billing_cadence": "RECURRING",
                "billing_model": "FLAT_FEE",
                "billing_period": "MONTHLY",
                "billing_period_count": 123,
                "created_at": "<string>",
                "created_by": "<string>",
                "currency": "<string>",
                "description": "<string>",
                "display_amount": "<string>",
                "environment_id": "<string>",
                "id": "<string>",
                "invoice_cadence": "ARREAR",
                "lookup_key": "<string>",
                "metadata": {},
                "meter": {
                  "aggregation": {
                    "field": "<string>",
                    "multiplier": 123,
                    "type": "COUNT"
                  },
                  "created_at": "2024-03-20T15:04:05Z",
                  "event_name": "api_request",
                  "filters": [
                    {
                      "key": "<string>",
                      "values": [
                        "<string>"
                      ]
                    }
                  ],
                  "id": "550e8400-e29b-41d4-a716-446655440000",
                  "name": "API Usage Meter",
                  "reset_usage": "BILLING_PERIOD",
                  "status": "published",
                  "tenant_id": "tenant123",
                  "updated_at": "2024-03-20T15:04:05Z"
                },
                "meter_id": "<string>",
                "plan_id": "<string>",
                "status": "published",
                "tenant_id": "<string>",
                "tier_mode": "VOLUME",
                "tiers": [
                  {
                    "flat_amount": 123,
                    "unit_amount": 123,
                    "up_to": 123
                  }
                ],
                "transform_quantity": {
                  "divide_by": 123,
                  "round": "<string>"
                },
                "trial_period": 123,
                "type": "USAGE",
                "updated_at": "<string>",
                "updated_by": "<string>"
              }
            ],
            "status": "published",
            "tenant_id": "<string>",
            "updated_at": "<string>",
            "updated_by": "<string>"
          },
          "plan_id": "<string>",
          "schedule": {
            "created_at": "<string>",
            "current_phase_index": 123,
            "end_behavior": "RELEASE",
            "id": "<string>",
            "phases": [
              {
                "commitment_amount": 123,
                "created_at": "<string>",
                "credit_grants": [
                  {
                    "cadence": "ONETIME",
                    "created_at": "<string>",
                    "created_by": "<string>",
                    "credits": 123,
                    "currency": "<string>",
                    "environment_id": "<string>",
                    "expiration_duration": 123,
                    "expiration_duration_unit": "DAY",
                    "expiration_type": "NEVER",
                    "id": "<string>",
                    "metadata": {},
                    "name": "<string>",
                    "period": "DAILY",
                    "period_count": 123,
                    "plan_id": "<string>",
                    "priority": 123,
                    "scope": "PLAN",
                    "status": "published",
                    "subscription_id": "<string>",
                    "tenant_id": "<string>",
                    "updated_at": "<string>",
                    "updated_by": "<string>"
                  }
                ],
                "end_date": "<string>",
                "id": "<string>",
                "line_items": [
                  {
                    "billing_period": "MONTHLY",
                    "created_at": "<string>",
                    "created_by": "<string>",
                    "currency": "<string>",
                    "customer_id": "<string>",
                    "display_name": "<string>",
                    "end_date": "<string>",
                    "environment_id": "<string>",
                    "id": "<string>",
                    "invoice_cadence": "ARREAR",
                    "metadata": {},
                    "meter_display_name": "<string>",
                    "meter_id": "<string>",
                    "plan_display_name": "<string>",
                    "plan_id": "<string>",
                    "price_id": "<string>",
                    "price_type": "USAGE",
                    "quantity": 123,
                    "start_date": "<string>",
                    "status": "published",
                    "subscription_id": "<string>",
                    "tenant_id": "<string>",
                    "trial_period": 123,
                    "updated_at": "<string>",
                    "updated_by": "<string>"
                  }
                ],
                "overage_factor": 123,
                "phase_index": 123,
                "schedule_id": "<string>",
                "start_date": "<string>",
                "updated_at": "<string>"
              }
            ],
            "start_date": "<string>",
            "status": "ACTIVE",
            "subscription_id": "<string>",
            "updated_at": "<string>"
          },
          "start_date": "<string>",
          "status": "published",
          "subscription_status": "active",
          "tenant_id": "<string>",
          "trial_end": "<string>",
          "trial_start": "<string>",
          "updated_at": "<string>",
          "updated_by": "<string>",
          "version": 123
        },
        "subscription_id": "<string>",
        "subtotal": 123,
        "tenant_id": "<string>",
        "total": 123,
        "updated_at": "<string>",
        "updated_by": "<string>",
        "version": 123,
        "voided_at": "<string>"
      },
      "invoice_id": "<string>",
      "line_items": [
        {
          "amount": 123,
          "created_at": "<string>",
          "created_by": "<string>",
          "credit_note_id": "<string>",
          "currency": "<string>",
          "display_name": "<string>",
          "environment_id": "<string>",
          "id": "<string>",
          "invoice_line_item_id": "<string>",
          "metadata": {},
          "status": "published",
          "tenant_id": "<string>",
          "updated_at": "<string>",
          "updated_by": "<string>"
        }
      ],
      "memo": "<string>",
      "metadata": {},
      "reason": "DUPLICATE",
      "refund_status": "PENDING",
      "status": "published",
      "subscription": {
        "active_pause_id": "<string>",
        "billing_anchor": "<string>",
        "billing_cadence": "RECURRING",
        "billing_cycle": "anniversary",
        "billing_period": "MONTHLY",
        "billing_period_count": 123,
        "cancel_at": "<string>",
        "cancel_at_period_end": true,
        "cancelled_at": "<string>",
        "commitment_amount": 123,
        "created_at": "<string>",
        "created_by": "<string>",
        "currency": "<string>",
        "current_period_end": "<string>",
        "current_period_start": "<string>",
        "customer": {
          "address_city": "<string>",
          "address_country": "<string>",
          "address_line1": "<string>",
          "address_line2": "<string>",
          "address_postal_code": "<string>",
          "address_state": "<string>",
          "created_at": "<string>",
          "created_by": "<string>",
          "email": "<string>",
          "environment_id": "<string>",
          "external_id": "<string>",
          "id": "<string>",
          "metadata": {},
          "name": "<string>",
          "status": "published",
          "tenant_id": "<string>",
          "updated_at": "<string>",
          "updated_by": "<string>"
        },
        "customer_id": "<string>",
        "end_date": "<string>",
        "environment_id": "<string>",
        "id": "<string>",
        "line_items": [
          {
            "billing_period": "MONTHLY",
            "created_at": "<string>",
            "created_by": "<string>",
            "currency": "<string>",
            "customer_id": "<string>",
            "display_name": "<string>",
            "end_date": "<string>",
            "environment_id": "<string>",
            "id": "<string>",
            "invoice_cadence": "ARREAR",
            "metadata": {},
            "meter_display_name": "<string>",
            "meter_id": "<string>",
            "plan_display_name": "<string>",
            "plan_id": "<string>",
            "price_id": "<string>",
            "price_type": "USAGE",
            "quantity": 123,
            "start_date": "<string>",
            "status": "published",
            "subscription_id": "<string>",
            "tenant_id": "<string>",
            "trial_period": 123,
            "updated_at": "<string>",
            "updated_by": "<string>"
          }
        ],
        "lookup_key": "<string>",
        "metadata": {},
        "overage_factor": 123,
        "pause_status": "none",
        "pauses": [
          {
            "created_at": "<string>",
            "created_by": "<string>",
            "environment_id": "<string>",
            "id": "<string>",
            "metadata": {},
            "original_period_end": "<string>",
            "original_period_start": "<string>",
            "pause_end": "<string>",
            "pause_mode": "immediate",
            "pause_start": "<string>",
            "pause_status": "none",
            "reason": "<string>",
            "resume_mode": "immediate",
            "resumed_at": "<string>",
            "status": "published",
            "subscription_id": "<string>",
            "tenant_id": "<string>",
            "updated_at": "<string>",
            "updated_by": "<string>"
          }
        ],
        "plan": {
          "created_at": "<string>",
          "created_by": "<string>",
          "credit_grants": [
            {
              "cadence": "ONETIME",
              "created_at": "<string>",
              "created_by": "<string>",
              "credits": 123,
              "currency": "<string>",
              "environment_id": "<string>",
              "expiration_duration": 123,
              "expiration_duration_unit": "DAY",
              "expiration_type": "NEVER",
              "id": "<string>",
              "metadata": {},
              "name": "<string>",
              "period": "DAILY",
              "period_count": 123,
              "plan_id": "<string>",
              "priority": 123,
              "scope": "PLAN",
              "status": "published",
              "subscription_id": "<string>",
              "tenant_id": "<string>",
              "updated_at": "<string>",
              "updated_by": "<string>"
            }
          ],
          "description": "<string>",
          "entitlements": [
            {
              "created_at": "<string>",
              "created_by": "<string>",
              "environment_id": "<string>",
              "feature": {
                "created_at": "<string>",
                "created_by": "<string>",
                "description": "<string>",
                "environment_id": "<string>",
                "id": "<string>",
                "lookup_key": "<string>",
                "metadata": {},
                "meter": {
                  "aggregation": {
                    "field": "<string>",
                    "multiplier": 123,
                    "type": "COUNT"
                  },
                  "created_at": "2024-03-20T15:04:05Z",
                  "event_name": "api_request",
                  "filters": [
                    {
                      "key": "<string>",
                      "values": [
                        "<string>"
                      ]
                    }
                  ],
                  "id": "550e8400-e29b-41d4-a716-446655440000",
                  "name": "API Usage Meter",
                  "reset_usage": "BILLING_PERIOD",
                  "status": "published",
                  "tenant_id": "tenant123",
                  "updated_at": "2024-03-20T15:04:05Z"
                },
                "meter_id": "<string>",
                "name": "<string>",
                "status": "published",
                "tenant_id": "<string>",
                "type": "metered",
                "unit_plural": "<string>",
                "unit_singular": "<string>",
                "updated_at": "<string>",
                "updated_by": "<string>"
              },
              "feature_id": "<string>",
              "feature_type": "metered",
              "id": "<string>",
              "is_enabled": true,
              "is_soft_limit": true,
              "plan": {},
              "plan_id": "<string>",
              "static_value": "<string>",
              "status": "published",
              "tenant_id": "<string>",
              "updated_at": "<string>",
              "updated_by": "<string>",
              "usage_limit": 123,
              "usage_reset_period": "MONTHLY"
            }
          ],
          "environment_id": "<string>",
          "id": "<string>",
          "lookup_key": "<string>",
          "name": "<string>",
          "prices": [
            {
              "amount": 123,
              "billing_cadence": "RECURRING",
              "billing_model": "FLAT_FEE",
              "billing_period": "MONTHLY",
              "billing_period_count": 123,
              "created_at": "<string>",
              "created_by": "<string>",
              "currency": "<string>",
              "description": "<string>",
              "display_amount": "<string>",
              "environment_id": "<string>",
              "id": "<string>",
              "invoice_cadence": "ARREAR",
              "lookup_key": "<string>",
              "metadata": {},
              "meter": {
                "aggregation": {
                  "field": "<string>",
                  "multiplier": 123,
                  "type": "COUNT"
                },
                "created_at": "2024-03-20T15:04:05Z",
                "event_name": "api_request",
                "filters": [
                  {
                    "key": "<string>",
                    "values": [
                      "<string>"
                    ]
                  }
                ],
                "id": "550e8400-e29b-41d4-a716-446655440000",
                "name": "API Usage Meter",
                "reset_usage": "BILLING_PERIOD",
                "status": "published",
                "tenant_id": "tenant123",
                "updated_at": "2024-03-20T15:04:05Z"
              },
              "meter_id": "<string>",
              "plan_id": "<string>",
              "status": "published",
              "tenant_id": "<string>",
              "tier_mode": "VOLUME",
              "tiers": [
                {
                  "flat_amount": 123,
                  "unit_amount": 123,
                  "up_to": 123
                }
              ],
              "transform_quantity": {
                "divide_by": 123,
                "round": "<string>"
              },
              "trial_period": 123,
              "type": "USAGE",
              "updated_at": "<string>",
              "updated_by": "<string>"
            }
          ],
          "status": "published",
          "tenant_id": "<string>",
          "updated_at": "<string>",
          "updated_by": "<string>"
        },
        "plan_id": "<string>",
        "schedule": {
          "created_at": "<string>",
          "current_phase_index": 123,
          "end_behavior": "RELEASE",
          "id": "<string>",
          "phases": [
            {
              "commitment_amount": 123,
              "created_at": "<string>",
              "credit_grants": [
                {
                  "cadence": "ONETIME",
                  "created_at": "<string>",
                  "created_by": "<string>",
                  "credits": 123,
                  "currency": "<string>",
                  "environment_id": "<string>",
                  "expiration_duration": 123,
                  "expiration_duration_unit": "DAY",
                  "expiration_type": "NEVER",
                  "id": "<string>",
                  "metadata": {},
                  "name": "<string>",
                  "period": "DAILY",
                  "period_count": 123,
                  "plan_id": "<string>",
                  "priority": 123,
                  "scope": "PLAN",
                  "status": "published",
                  "subscription_id": "<string>",
                  "tenant_id": "<string>",
                  "updated_at": "<string>",
                  "updated_by": "<string>"
                }
              ],
              "end_date": "<string>",
              "id": "<string>",
              "line_items": [
                {
                  "billing_period": "MONTHLY",
                  "created_at": "<string>",
                  "created_by": "<string>",
                  "currency": "<string>",
                  "customer_id": "<string>",
                  "display_name": "<string>",
                  "end_date": "<string>",
                  "environment_id": "<string>",
                  "id": "<string>",
                  "invoice_cadence": "ARREAR",
                  "metadata": {},
                  "meter_display_name": "<string>",
                  "meter_id": "<string>",
                  "plan_display_name": "<string>",
                  "plan_id": "<string>",
                  "price_id": "<string>",
                  "price_type": "USAGE",
                  "quantity": 123,
                  "start_date": "<string>",
                  "status": "published",
                  "subscription_id": "<string>",
                  "tenant_id": "<string>",
                  "trial_period": 123,
                  "updated_at": "<string>",
                  "updated_by": "<string>"
                }
              ],
              "overage_factor": 123,
              "phase_index": 123,
              "schedule_id": "<string>",
              "start_date": "<string>",
              "updated_at": "<string>"
            }
          ],
          "start_date": "<string>",
          "status": "ACTIVE",
          "subscription_id": "<string>",
          "updated_at": "<string>"
        },
        "start_date": "<string>",
        "status": "published",
        "subscription_status": "active",
        "tenant_id": "<string>",
        "trial_end": "<string>",
        "trial_start": "<string>",
        "updated_at": "<string>",
        "updated_by": "<string>",
        "version": 123
      },
      "subscription_id": "<string>",
      "tenant_id": "<string>",
      "total_amount": 123,
      "updated_at": "<string>",
      "updated_by": "<string>",
      "voided_at": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}