curl --request POST \
  --url https://us.api.flexprice.io/v1/subscriptions/{id}/pause \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "metadata": {},
  "reason": "<string>"
}
'

from flexprice import Flexprice


with Flexprice(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as f_client:

    res = f_client.subscriptions.pause_subscription(id="<id>")

    # Handle response
    print(res)

import { Flexprice } from "@flexprice/sdk";

const flexprice = new Flexprice({
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await flexprice.subscriptions.pauseSubscription("<id>", {});

  console.log(result);
}

run();

package main

import(
	"context"
	flexprice "github.com/flexprice/go-sdk/v2"
	"github.com/flexprice/go-sdk/v2/models/types"
	"log"
)

func main() {
    ctx := context.Background()

    s := flexprice.New(
        flexprice.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.Subscriptions.PauseSubscription(ctx, "<id>", types.PauseSubscriptionRequest{})
    if err != nil {
        log.Fatal(err)
    }
    if res.PauseSubscriptionResponse != nil {
        // handle response
    }
}

{
  "pause": {
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "environment_id": "<string>",
    "id": "<string>",
    "metadata": {},
    "original_period_end": "2023-11-07T05:31:56Z",
    "original_period_start": "2023-11-07T05:31:56Z",
    "pause_end": "2023-11-07T05:31:56Z",
    "pause_mode": "immediate",
    "pause_start": "2023-11-07T05:31:56Z",
    "pause_status": "none",
    "reason": "<string>",
    "resume_mode": "immediate",
    "resumed_at": "2023-11-07T05:31:56Z",
    "status": "published",
    "subscription_id": "<string>",
    "tenant_id": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": "<string>"
  },
  "subscription": {
    "active_pause_id": "<string>",
    "auto_invoice_threshold": "<string>",
    "billing_anchor": "2023-11-07T05:31:56Z",
    "billing_cadence": "RECURRING",
    "billing_cycle": "anniversary",
    "billing_period": "MONTHLY",
    "billing_period_count": 123,
    "cancel_at": "2023-11-07T05:31:56Z",
    "cancel_at_period_end": true,
    "cancelled_at": "2023-11-07T05:31:56Z",
    "checkout_session": {
      "action": "create_subscription",
      "cancel_url": "<string>",
      "cancelled_at": "2023-11-07T05:31:56Z",
      "checkout_invoice_id": "<string>",
      "checkout_payment_id": "<string>",
      "checkout_status": "initiated",
      "completed_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "customer_id": "<string>",
      "entity_creation_result": {
        "entity_id": "<string>",
        "status": "created"
      },
      "expires_at": "2023-11-07T05:31:56Z",
      "failure_reason": "<string>",
      "failure_url": "<string>",
      "id": "<string>",
      "idempotency_key": "<string>",
      "metadata": {},
      "next_poll_after_ms": 123,
      "payment": {
        "gateway": "<string>",
        "id": "<string>",
        "status": "INITIATED"
      },
      "payment_action": {
        "type": "checkout_url",
        "url": "<string>"
      },
      "payment_provider": "razorpay",
      "stale": true,
      "success_url": "<string>",
      "terminal": true,
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "collection_method": "<string>",
    "commitment_amount": "<string>",
    "commitment_duration": "MONTHLY",
    "coupon_associations": [
      {
        "coupon": {
          "amount_off": "<string>",
          "cadence": "once",
          "coupon_code": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "currency": "<string>",
          "duration_in_periods": 123,
          "environment_id": "<string>",
          "id": "<string>",
          "max_redemptions": 123,
          "metadata": {},
          "name": "<string>",
          "percentage_off": "<string>",
          "redeem_after": "<string>",
          "redeem_before": "<string>",
          "rules": {},
          "status": "published",
          "tenant_id": "<string>",
          "total_redemptions": 123,
          "type": "fixed",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>"
        },
        "coupon_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "end_date": "2023-11-07T05:31:56Z",
        "environment_id": "<string>",
        "id": "<string>",
        "metadata": {},
        "start_date": "2023-11-07T05:31:56Z",
        "status": "published",
        "subscription_id": "<string>",
        "subscription_line_item": {
          "addon_association_id": "<string>",
          "billing_period": "MONTHLY",
          "billing_period_count": 123,
          "commitment_amount": "<string>",
          "commitment_duration": "MONTHLY",
          "commitment_overage_factor": "<string>",
          "commitment_quantity": "<string>",
          "commitment_time_buckets": [
            {
              "commitment_type": "amount",
              "commitment_value": "<string>",
              "end": {
                "hour": 12,
                "minute": 29
              },
              "id": "<string>",
              "overage_factor": 123,
              "price_id": "<string>",
              "start": {
                "hour": 12,
                "minute": 29
              },
              "true_up_enabled": true
            }
          ],
          "commitment_true_up_enabled": true,
          "commitment_type": "amount",
          "commitment_windowed": true,
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "currency": "<string>",
          "customer_id": "<string>",
          "display_name": "<string>",
          "end_date": "2023-11-07T05:31:56Z",
          "entity_id": "<string>",
          "entity_type": "plan",
          "environment_id": "<string>",
          "id": "<string>",
          "invoice_cadence": "ARREAR",
          "metadata": {},
          "meter": {
            "aggregation": {
              "bucket_size": "MINUTE",
              "expression": "<string>",
              "field": "<string>",
              "group_by": "<string>",
              "multiplier": "<string>",
              "type": "COUNT"
            },
            "created_at": "2023-11-07T05:31:56Z",
            "created_by": "<string>",
            "environment_id": "<string>",
            "event_name": "<string>",
            "filters": [
              {
                "key": "<string>",
                "values": [
                  "<string>"
                ]
              }
            ],
            "id": "<string>",
            "name": "<string>",
            "reset_usage": "BILLING_PERIOD",
            "status": "published",
            "tenant_id": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>"
          },
          "meter_display_name": "<string>",
          "meter_id": "<string>",
          "plan_display_name": "<string>",
          "price": {
            "addon": {
              "created_at": "2023-11-07T05:31:56Z",
              "created_by": "<string>",
              "credit_grants": [
                {
                  "addon_id": "<string>",
                  "cadence": "ONETIME",
                  "conversion_rate": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "created_by": "<string>",
                  "credit_grant_anchor": "2023-11-07T05:31:56Z",
                  "credits": "<string>",
                  "end_date": "2023-11-07T05:31:56Z",
                  "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",
                  "start_date": "2023-11-07T05:31:56Z",
                  "status": "published",
                  "subscription_id": "<string>",
                  "tenant_id": "<string>",
                  "topup_conversion_rate": "<string>",
                  "updated_at": "2023-11-07T05:31:56Z",
                  "updated_by": "<string>"
                }
              ],
              "description": "<string>",
              "entitlements": [
                {
                  "addon": "<unknown>",
                  "aggregation_mode": "additive",
                  "config_value": {},
                  "created_at": "2023-11-07T05:31:56Z",
                  "created_by": "<string>",
                  "display_order": 123,
                  "end_date": "2023-11-07T05:31:56Z",
                  "entity_id": "<string>",
                  "entity_type": "PLAN",
                  "environment_id": "<string>",
                  "feature": {
                    "alert_settings": {
                      "alert_enabled": true,
                      "alert_threshold_type": "absolute",
                      "critical": {
                        "condition": "above",
                        "threshold": "<string>"
                      },
                      "info": {
                        "condition": "above",
                        "threshold": "<string>"
                      },
                      "warning": {
                        "condition": "above",
                        "threshold": "<string>"
                      }
                    },
                    "created_at": "2023-11-07T05:31:56Z",
                    "created_by": "<string>",
                    "description": "<string>",
                    "environment_id": "<string>",
                    "group": {
                      "created_at": "2023-11-07T05:31:56Z",
                      "entity_ids": [
                        "<string>"
                      ],
                      "entity_type": "<string>",
                      "id": "<string>",
                      "lookup_key": "<string>",
                      "metadata": {},
                      "name": "<string>",
                      "status": "<string>",
                      "updated_at": "2023-11-07T05:31:56Z"
                    },
                    "group_id": "<string>",
                    "id": "<string>",
                    "lookup_key": "<string>",
                    "metadata": {},
                    "meter": {
                      "aggregation": {
                        "bucket_size": "MINUTE",
                        "expression": "<string>",
                        "field": "<string>",
                        "group_by": "<string>",
                        "multiplier": "<string>",
                        "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>",
                    "reporting_unit": {
                      "conversion_rate": 123,
                      "unit_plural": "<string>",
                      "unit_singular": "<string>"
                    },
                    "status": "published",
                    "tenant_id": "<string>",
                    "type": "metered",
                    "unit_plural": "<string>",
                    "unit_singular": "<string>",
                    "updated_at": "2023-11-07T05:31:56Z",
                    "updated_by": "<string>"
                  },
                  "feature_id": "<string>",
                  "feature_type": "metered",
                  "grant_allocation_behavior": "first_usage",
                  "grant_duration_unit": "hour",
                  "grant_duration_value": 123,
                  "grant_measure": "quantity",
                  "grant_quota": "<string>",
                  "id": "<string>",
                  "is_enabled": true,
                  "is_soft_limit": true,
                  "parent_entitlement_id": "<string>",
                  "plan": {
                    "created_at": "2023-11-07T05:31:56Z",
                    "created_by": "<string>",
                    "credit_grants": [
                      {
                        "addon_id": "<string>",
                        "cadence": "ONETIME",
                        "conversion_rate": "<string>",
                        "created_at": "2023-11-07T05:31:56Z",
                        "created_by": "<string>",
                        "credit_grant_anchor": "2023-11-07T05:31:56Z",
                        "credits": "<string>",
                        "end_date": "2023-11-07T05:31:56Z",
                        "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",
                        "start_date": "2023-11-07T05:31:56Z",
                        "status": "published",
                        "subscription_id": "<string>",
                        "tenant_id": "<string>",
                        "topup_conversion_rate": "<string>",
                        "updated_at": "2023-11-07T05:31:56Z",
                        "updated_by": "<string>"
                      }
                    ],
                    "description": "<string>",
                    "display_order": 123,
                    "entitlements": "<array>",
                    "environment_id": "<string>",
                    "id": "<string>",
                    "lookup_key": "<string>",
                    "metadata": {},
                    "name": "<string>",
                    "price_sync_status": {
                      "current_sequence": 123,
                      "synced": true,
                      "unsynced_subscription_count": 123
                    },
                    "prices": "<array>",
                    "status": "published",
                    "tenant_id": "<string>",
                    "updated_at": "2023-11-07T05:31:56Z",
                    "updated_by": "<string>"
                  },
                  "plan_id": "<string>",
                  "start_date": "2023-11-07T05:31:56Z",
                  "static_value": "<string>",
                  "status": "published",
                  "tenant_id": "<string>",
                  "updated_at": "2023-11-07T05:31:56Z",
                  "updated_by": "<string>",
                  "usage_limit": 123,
                  "usage_reset_period": "MONTHLY"
                }
              ],
              "environment_id": "<string>",
              "id": "<string>",
              "lookup_key": "<string>",
              "metadata": {},
              "name": "<string>",
              "price_sync_status": {
                "current_sequence": 123,
                "synced": true,
                "unsynced_association_count": 123
              },
              "prices": "<array>",
              "status": "published",
              "tenant_id": "<string>",
              "updated_at": "2023-11-07T05:31:56Z",
              "updated_by": "<string>"
            },
            "amount": "<string>",
            "billing_cadence": "RECURRING",
            "billing_model": "FLAT_FEE",
            "billing_period": "MONTHLY",
            "billing_period_count": 123,
            "bucket_size": "MINUTE",
            "conversion_rate": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "created_by": "<string>",
            "currency": "<string>",
            "description": "<string>",
            "display_amount": "<string>",
            "display_name": "<string>",
            "display_price_unit_amount": "<string>",
            "end_date": "2023-11-07T05:31:56Z",
            "entity_id": "<string>",
            "entity_type": "PLAN",
            "environment_id": "<string>",
            "feature": {
              "reporting_unit": {
                "conversion_rate": 123,
                "unit_plural": "<string>",
                "unit_singular": "<string>"
              }
            },
            "group": {
              "created_at": "2023-11-07T05:31:56Z",
              "entity_ids": [
                "<string>"
              ],
              "entity_type": "<string>",
              "id": "<string>",
              "lookup_key": "<string>",
              "metadata": {},
              "name": "<string>",
              "status": "<string>",
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "group_id": "<string>",
            "id": "<string>",
            "invoice_cadence": "ARREAR",
            "lookup_key": "<string>",
            "metadata": {},
            "meter": {
              "aggregation": {
                "bucket_size": "MINUTE",
                "expression": "<string>",
                "field": "<string>",
                "group_by": "<string>",
                "multiplier": "<string>",
                "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>",
            "min_quantity": "<string>",
            "parent_price_id": "<string>",
            "plan": {
              "created_at": "2023-11-07T05:31:56Z",
              "created_by": "<string>",
              "credit_grants": [
                {
                  "addon_id": "<string>",
                  "cadence": "ONETIME",
                  "conversion_rate": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "created_by": "<string>",
                  "credit_grant_anchor": "2023-11-07T05:31:56Z",
                  "credits": "<string>",
                  "end_date": "2023-11-07T05:31:56Z",
                  "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",
                  "start_date": "2023-11-07T05:31:56Z",
                  "status": "published",
                  "subscription_id": "<string>",
                  "tenant_id": "<string>",
                  "topup_conversion_rate": "<string>",
                  "updated_at": "2023-11-07T05:31:56Z",
                  "updated_by": "<string>"
                }
              ],
              "description": "<string>",
              "display_order": 123,
              "entitlements": "<array>",
              "environment_id": "<string>",
              "id": "<string>",
              "lookup_key": "<string>",
              "metadata": {},
              "name": "<string>",
              "price_sync_status": {
                "current_sequence": 123,
                "synced": true,
                "unsynced_subscription_count": 123
              },
              "prices": "<array>",
              "status": "published",
              "tenant_id": "<string>",
              "updated_at": "2023-11-07T05:31:56Z",
              "updated_by": "<string>"
            },
            "price_unit": "<string>",
            "price_unit_amount": "<string>",
            "price_unit_id": "<string>",
            "price_unit_tiers": [
              {
                "flat_amount": "<string>",
                "unit_amount": "<string>",
                "up_to": 123
              }
            ],
            "price_unit_type": "FIAT",
            "pricing_unit": {
              "base_currency": "<string>",
              "code": "<string>",
              "conversion_rate": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "created_by": "<string>",
              "environment_id": "<string>",
              "id": "<string>",
              "metadata": {},
              "name": "<string>",
              "status": "published",
              "symbol": "<string>",
              "tenant_id": "<string>",
              "updated_at": "2023-11-07T05:31:56Z",
              "updated_by": "<string>"
            },
            "sequence": 123,
            "start_date": "2023-11-07T05:31:56Z",
            "status": "published",
            "tenant_id": "<string>",
            "tier_mode": "VOLUME",
            "tiers": [
              {
                "flat_amount": "<string>",
                "unit_amount": "<string>",
                "up_to": 123
              }
            ],
            "transform_quantity": {
              "divide_by": 123,
              "round": "up"
            },
            "trial_period_days": 123,
            "type": "USAGE",
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>"
          },
          "price_id": "<string>",
          "price_type": "USAGE",
          "price_unit": "<string>",
          "price_unit_id": "<string>",
          "quantity": "<string>",
          "start_date": "2023-11-07T05:31:56Z",
          "status": "published",
          "subscription_id": "<string>",
          "subscription_phase_id": "<string>",
          "tenant_id": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>"
        },
        "subscription_line_item_id": "<string>",
        "subscription_phase_id": "<string>",
        "tenant_id": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "updated_by": "<string>"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "credit_grants": [
      {
        "addon_id": "<string>",
        "cadence": "ONETIME",
        "conversion_rate": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "credit_grant_anchor": "2023-11-07T05:31:56Z",
        "credits": "<string>",
        "end_date": "2023-11-07T05:31:56Z",
        "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",
        "start_date": "2023-11-07T05:31:56Z",
        "status": "published",
        "subscription_id": "<string>",
        "tenant_id": "<string>",
        "topup_conversion_rate": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "updated_by": "<string>"
      }
    ],
    "currency": "<string>",
    "current_period_end": "2023-11-07T05:31:56Z",
    "current_period_start": "2023-11-07T05:31:56Z",
    "customer": {
      "address_city": "<string>",
      "address_country": "<string>",
      "address_line1": "<string>",
      "address_line2": "<string>",
      "address_postal_code": "<string>",
      "address_state": "<string>",
      "billing_currency": "<string>",
      "contact": "<string>",
      "contact_persons": [
        {
          "first_name": "<string>",
          "department": "<string>",
          "designation": "<string>",
          "email": "<string>",
          "id": "<string>",
          "is_primary": true,
          "last_name": "<string>",
          "mobile": "<string>",
          "salutation": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "email": "<string>",
      "environment_id": "<string>",
      "external_id": "<string>",
      "id": "<string>",
      "integrations": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "entity_id": "<string>",
          "entity_type": "customer",
          "environment_id": "<string>",
          "id": "<string>",
          "metadata": {},
          "provider_entity_id": "<string>",
          "provider_type": "<string>",
          "status": "published",
          "tenant_id": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>"
        }
      ],
      "metadata": {},
      "name": "<string>",
      "status": "published",
      "tax_treatment": "taxable",
      "tenant_id": "<string>",
      "timezone": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": "<string>"
    },
    "customer_id": "<string>",
    "enable_true_up": true,
    "end_date": "2023-11-07T05:31:56Z",
    "entitlements": [
      {
        "entitlement": {
          "aggregation_mode": "additive",
          "buckets": [
            {
              "entitlement_id": "<string>",
              "grant_duration_unit": "hour",
              "grant_duration_value": 123,
              "grant_measure": "quantity",
              "grant_quota": "<string>",
              "grant_unlimited": true,
              "source_entity_id": "<string>",
              "usage_limit": 123
            }
          ],
          "config_values": [
            {}
          ],
          "grant_duration_unit": "hour",
          "grant_duration_value": 123,
          "grant_measure": "quantity",
          "grant_quota": "<string>",
          "grant_state": {
            "allowances": [
              {
                "entitlement_id": "<string>",
                "grant_id": "<string>",
                "is_active": true,
                "last_computed_at": "2023-11-07T05:31:56Z",
                "measure": "quantity",
                "quota": "<string>",
                "quota_crossed_at": "2023-11-07T05:31:56Z",
                "remaining": "<string>",
                "status": "active",
                "unlimited": true,
                "usage": "<string>",
                "valid_from": "<string>",
                "valid_to": "<string>"
              }
            ]
          },
          "grant_unlimited": true,
          "is_enabled": true,
          "is_soft_limit": true,
          "static_values": [
            "<string>"
          ],
          "usage_limit": 123,
          "usage_reset_period": "MONTHLY"
        },
        "feature": {
          "alert_settings": {
            "alert_enabled": true,
            "alert_threshold_type": "absolute",
            "critical": {
              "condition": "above",
              "threshold": "<string>"
            },
            "info": {
              "condition": "above",
              "threshold": "<string>"
            },
            "warning": {
              "condition": "above",
              "threshold": "<string>"
            }
          },
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "description": "<string>",
          "environment_id": "<string>",
          "group": {
            "created_at": "2023-11-07T05:31:56Z",
            "entity_ids": [
              "<string>"
            ],
            "entity_type": "<string>",
            "id": "<string>",
            "lookup_key": "<string>",
            "metadata": {},
            "name": "<string>",
            "status": "<string>",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "group_id": "<string>",
          "id": "<string>",
          "lookup_key": "<string>",
          "metadata": {},
          "meter": {
            "aggregation": {
              "bucket_size": "MINUTE",
              "expression": "<string>",
              "field": "<string>",
              "group_by": "<string>",
              "multiplier": "<string>",
              "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>",
          "reporting_unit": {
            "conversion_rate": 123,
            "unit_plural": "<string>",
            "unit_singular": "<string>"
          },
          "status": "published",
          "tenant_id": "<string>",
          "type": "metered",
          "unit_plural": "<string>",
          "unit_singular": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>"
        },
        "sources": [
          {
            "config_value": {},
            "entitlement_id": "<string>",
            "entity_id": "<string>",
            "entity_name": "<string>",
            "entity_type": "plan",
            "is_enabled": true,
            "quantity": 123,
            "static_value": "<string>",
            "subscription_id": "<string>",
            "usage_limit": 123,
            "usage_reset_period": "MONTHLY"
          }
        ]
      }
    ],
    "environment_id": "<string>",
    "gateway_payment_method_id": "<string>",
    "id": "<string>",
    "invoicing_customer_id": "<string>",
    "latest_invoice": {
      "adjustment_amount": "<string>",
      "amount_due": "<string>",
      "amount_paid": "<string>",
      "amount_remaining": "<string>",
      "billing_period": "<string>",
      "billing_reason": "<string>",
      "billing_sequence": 123,
      "checkout_session": {
        "action": "create_subscription",
        "cancel_url": "<string>",
        "cancelled_at": "2023-11-07T05:31:56Z",
        "checkout_invoice_id": "<string>",
        "checkout_payment_id": "<string>",
        "checkout_status": "initiated",
        "completed_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "customer_id": "<string>",
        "entity_creation_result": {
          "entity_id": "<string>",
          "status": "created"
        },
        "expires_at": "2023-11-07T05:31:56Z",
        "failure_reason": "<string>",
        "failure_url": "<string>",
        "id": "<string>",
        "idempotency_key": "<string>",
        "metadata": {},
        "next_poll_after_ms": 123,
        "payment": {
          "gateway": "<string>",
          "id": "<string>",
          "status": "INITIATED"
        },
        "payment_action": {
          "type": "checkout_url",
          "url": "<string>"
        },
        "payment_provider": "razorpay",
        "stale": true,
        "success_url": "<string>",
        "terminal": true,
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "coupon_applications": [
        {
          "applied_at": "2023-11-07T05:31:56Z",
          "coupon_association_id": "<string>",
          "coupon_id": "<string>",
          "coupon_snapshot": {},
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "currency": "<string>",
          "discount_percentage": "<string>",
          "discount_type": "fixed",
          "discounted_amount": "<string>",
          "environment_id": "<string>",
          "final_price": "<string>",
          "id": "<string>",
          "invoice_id": "<string>",
          "invoice_line_item_id": "<string>",
          "metadata": {},
          "original_price": "<string>",
          "status": "published",
          "subscription_id": "<string>",
          "tenant_id": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "currency": "<string>",
      "custom_currency": {
        "amount_due": "<string>",
        "code": "<string>",
        "rate": "<string>",
        "subtotal": "<string>",
        "total": "<string>",
        "total_discount": "<string>",
        "total_prepaid_credits_applied": "<string>",
        "total_tax": "<string>"
      },
      "customer": {
        "address_city": "<string>",
        "address_country": "<string>",
        "address_line1": "<string>",
        "address_line2": "<string>",
        "address_postal_code": "<string>",
        "address_state": "<string>",
        "billing_currency": "<string>",
        "contact": "<string>",
        "contact_persons": [
          {
            "first_name": "<string>",
            "department": "<string>",
            "designation": "<string>",
            "email": "<string>",
            "id": "<string>",
            "is_primary": true,
            "last_name": "<string>",
            "mobile": "<string>",
            "salutation": "<string>"
          }
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "email": "<string>",
        "environment_id": "<string>",
        "external_id": "<string>",
        "id": "<string>",
        "integrations": [
          {
            "created_at": "2023-11-07T05:31:56Z",
            "created_by": "<string>",
            "entity_id": "<string>",
            "entity_type": "customer",
            "environment_id": "<string>",
            "id": "<string>",
            "metadata": {},
            "provider_entity_id": "<string>",
            "provider_type": "<string>",
            "status": "published",
            "tenant_id": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>"
          }
        ],
        "metadata": {},
        "name": "<string>",
        "status": "published",
        "tax_treatment": "taxable",
        "tenant_id": "<string>",
        "timezone": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "updated_by": "<string>"
      },
      "customer_id": "<string>",
      "description": "<string>",
      "due_date": "2023-11-07T05:31:56Z",
      "environment_id": "<string>",
      "finalized_at": "2023-11-07T05:31:56Z",
      "fx_conversion": {
        "billing_currency": "<string>",
        "charge_currency": "<string>",
        "converted_at": "2023-11-07T05:31:56Z",
        "rate": "<string>",
        "rate_id": "<string>",
        "scope": "tenant",
        "source": {
          "net": "<string>",
          "subtotal": "<string>",
          "total_discount": "<string>",
          "total_prepaid_credits_applied": "<string>"
        }
      },
      "id": "<string>",
      "idempotency_key": "<string>",
      "invoice_number": "<string>",
      "invoice_pdf_url": "<string>",
      "invoice_status": "DRAFT",
      "invoice_type": "SUBSCRIPTION",
      "is_manually_edited": true,
      "issue_date": "2023-11-07T05:31:56Z",
      "last_computed_at": "2023-11-07T05:31:56Z",
      "line_items": [
        {
          "adjusted_entitlement_quantity": "<string>",
          "amount": "<string>",
          "commitment_info": {
            "amount": "<string>",
            "computed_commitment_utilized_amount": "<string>",
            "computed_overage_amount": "<string>",
            "computed_true_up_amount": "<string>",
            "duration": "MONTHLY",
            "is_windowed": true,
            "overage_factor": "<string>",
            "quantity": "<string>",
            "true_up_enabled": true,
            "type": "amount"
          },
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "currency": "<string>",
          "custom_currency": {
            "amount": "<string>",
            "invoice_level_discount": "<string>",
            "line_item_discount": "<string>",
            "prepaid_credits_applied": "<string>"
          },
          "customer_id": "<string>",
          "display_name": "<string>",
          "entity_id": "<string>",
          "entity_type": "<string>",
          "environment_id": "<string>",
          "fx_conversion": {
            "billing_currency": "<string>",
            "charge_currency": "<string>",
            "converted_at": "2023-11-07T05:31:56Z",
            "rate": "<string>",
            "rate_id": "<string>",
            "scope": "tenant",
            "source": {
              "net": "<string>",
              "subtotal": "<string>",
              "total_discount": "<string>",
              "total_prepaid_credits_applied": "<string>"
            }
          },
          "id": "<string>",
          "invoice_id": "<string>",
          "invoice_level_discount": "<string>",
          "line_item_discount": "<string>",
          "metadata": {},
          "meter_display_name": "<string>",
          "meter_id": "<string>",
          "parent_line_item_id": "<string>",
          "period_end": "2023-11-07T05:31:56Z",
          "period_start": "2023-11-07T05:31:56Z",
          "plan_display_name": "<string>",
          "prepaid_credits_applied": "<string>",
          "price_id": "<string>",
          "price_type": "<string>",
          "price_unit": "<string>",
          "price_unit_amount": "<string>",
          "price_unit_id": "<string>",
          "quantity": "<string>",
          "status": "published",
          "subscription_id": "<string>",
          "subscription_line_item_id": "<string>",
          "tenant_id": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>",
          "usage_analytics": [
            {
              "cost": "<string>",
              "event_count": 123,
              "percentage": "<string>",
              "source": "<string>",
              "usage": "<string>"
            }
          ],
          "usage_breakdown": [
            {
              "cost": "<string>",
              "event_count": 123,
              "grouped_by": {},
              "percentage": "<string>",
              "usage": "<string>"
            }
          ]
        }
      ],
      "metadata": {},
      "overpaid_amount": "<string>",
      "paid_at": "2023-11-07T05:31:56Z",
      "payment_status": "INITIATED",
      "period_end": "2023-11-07T05:31:56Z",
      "period_start": "2023-11-07T05:31:56Z",
      "recalculated_invoice_id": "<string>",
      "refunded_amount": "<string>",
      "source_type": "checkout",
      "status": "published",
      "subscription": "<unknown>",
      "subscription_customer_id": "<string>",
      "subscription_id": "<string>",
      "subtotal": "<string>",
      "tax_exemption_reason_code": "customer_exempt",
      "tax_summary": {
        "exclusive_tax": "<string>",
        "exemption": {
          "reason": "<string>",
          "reason_code": "customer_exempt"
        },
        "inclusive_tax": "<string>",
        "total_tax": "<string>"
      },
      "taxes": [
        {
          "applied_at": "2023-11-07T05:31:56Z",
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "currency": "<string>",
          "entity_id": "<string>",
          "entity_type": "customer",
          "environment_id": "<string>",
          "external_tax_details": {
            "calculation_expires_at": "2023-11-07T05:31:56Z",
            "calculation_id": "<string>",
            "display_name": "<string>",
            "jurisdiction": {
              "country": "<string>",
              "display_name": "<string>",
              "level": "<string>",
              "state": "<string>"
            },
            "percentage": "<string>",
            "reference": "<string>",
            "reversal": {
              "mode": "full",
              "original_transaction": "<string>"
            },
            "sourcing": "<string>",
            "tax_code": "<string>",
            "tax_type": "<string>",
            "taxability_reason": "<string>"
          },
          "id": "<string>",
          "idempotency_key": "<string>",
          "metadata": {},
          "provider": "flexprice",
          "status": "published",
          "tax_amount": "<string>",
          "tax_association_id": "<string>",
          "tax_behavior": "inclusive",
          "tax_rate": {
            "code": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "created_by": "<string>",
            "description": "<string>",
            "environment_id": "<string>",
            "id": "<string>",
            "metadata": {},
            "name": "<string>",
            "percentage_value": "<string>",
            "scope": "INTERNAL",
            "status": "published",
            "tax_rate_status": "ACTIVE",
            "tax_rate_type": "percentage",
            "tenant_id": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>"
          },
          "tax_rate_id": "<string>",
          "tax_transaction_id": "<string>",
          "tax_transaction_type": "filing",
          "taxable_amount": "<string>",
          "tenant_id": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>"
        }
      ],
      "tenant_id": "<string>",
      "total": "<string>",
      "total_discount": "<string>",
      "total_prepaid_credits_applied": "<string>",
      "total_tax": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": "<string>",
      "version": 123,
      "voided_at": "2023-11-07T05:31:56Z"
    },
    "line_item_grouping": "per_charge_period",
    "line_items": [
      {
        "addon_association_id": "<string>",
        "billing_period": "MONTHLY",
        "billing_period_count": 123,
        "commitment_amount": "<string>",
        "commitment_duration": "MONTHLY",
        "commitment_overage_factor": "<string>",
        "commitment_quantity": "<string>",
        "commitment_time_buckets": [
          {
            "commitment_type": "amount",
            "commitment_value": "<string>",
            "end": {
              "hour": 12,
              "minute": 29
            },
            "id": "<string>",
            "overage_factor": 123,
            "price_id": "<string>",
            "start": {
              "hour": 12,
              "minute": 29
            },
            "true_up_enabled": true
          }
        ],
        "commitment_true_up_enabled": true,
        "commitment_type": "amount",
        "commitment_windowed": true,
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "currency": "<string>",
        "customer_id": "<string>",
        "display_name": "<string>",
        "end_date": "2023-11-07T05:31:56Z",
        "entity_id": "<string>",
        "entity_type": "plan",
        "environment_id": "<string>",
        "id": "<string>",
        "invoice_cadence": "ARREAR",
        "metadata": {},
        "meter": {
          "aggregation": {
            "bucket_size": "MINUTE",
            "expression": "<string>",
            "field": "<string>",
            "group_by": "<string>",
            "multiplier": "<string>",
            "type": "COUNT"
          },
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "environment_id": "<string>",
          "event_name": "<string>",
          "filters": [
            {
              "key": "<string>",
              "values": [
                "<string>"
              ]
            }
          ],
          "id": "<string>",
          "name": "<string>",
          "reset_usage": "BILLING_PERIOD",
          "status": "published",
          "tenant_id": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>"
        },
        "meter_display_name": "<string>",
        "meter_id": "<string>",
        "plan_display_name": "<string>",
        "price": {
          "amount": "<string>",
          "billing_cadence": "RECURRING",
          "billing_model": "FLAT_FEE",
          "billing_period": "MONTHLY",
          "billing_period_count": 123,
          "bucket_size": "MINUTE",
          "conversion_rate": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "currency": "<string>",
          "description": "<string>",
          "display_amount": "<string>",
          "display_name": "<string>",
          "display_price_unit_amount": "<string>",
          "end_date": "2023-11-07T05:31:56Z",
          "entity_id": "<string>",
          "entity_type": "PLAN",
          "environment_id": "<string>",
          "group_id": "<string>",
          "id": "<string>",
          "invoice_cadence": "ARREAR",
          "lookup_key": "<string>",
          "metadata": {},
          "meter_id": "<string>",
          "min_quantity": "<string>",
          "parent_price_id": "<string>",
          "price_unit": "<string>",
          "price_unit_amount": "<string>",
          "price_unit_id": "<string>",
          "price_unit_tiers": [
            {
              "flat_amount": "<string>",
              "unit_amount": "<string>",
              "up_to": 123
            }
          ],
          "price_unit_type": "FIAT",
          "sequence": 123,
          "start_date": "2023-11-07T05:31:56Z",
          "status": "published",
          "tenant_id": "<string>",
          "tier_mode": "VOLUME",
          "tiers": [
            {
              "flat_amount": "<string>",
              "unit_amount": "<string>",
              "up_to": 123
            }
          ],
          "transform_quantity": {
            "divide_by": 123,
            "round": "up"
          },
          "trial_period_days": 123,
          "type": "USAGE",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>"
        },
        "price_id": "<string>",
        "price_type": "USAGE",
        "price_unit": "<string>",
        "price_unit_id": "<string>",
        "quantity": "<string>",
        "start_date": "2023-11-07T05:31:56Z",
        "status": "published",
        "subscription_id": "<string>",
        "subscription_phase_id": "<string>",
        "tenant_id": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "updated_by": "<string>"
      }
    ],
    "lookup_key": "<string>",
    "metadata": {},
    "overage_factor": "<string>",
    "parent_subscription_id": "<string>",
    "pause_status": "none",
    "pauses": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "environment_id": "<string>",
        "id": "<string>",
        "metadata": {},
        "original_period_end": "2023-11-07T05:31:56Z",
        "original_period_start": "2023-11-07T05:31:56Z",
        "pause_end": "2023-11-07T05:31:56Z",
        "pause_mode": "immediate",
        "pause_start": "2023-11-07T05:31:56Z",
        "pause_status": "none",
        "reason": "<string>",
        "resume_mode": "immediate",
        "resumed_at": "2023-11-07T05:31:56Z",
        "status": "published",
        "subscription_id": "<string>",
        "tenant_id": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "updated_by": "<string>"
      }
    ],
    "payment_behavior": "<string>",
    "payment_terms": "15 NET",
    "phases": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "end_date": "2023-11-07T05:31:56Z",
        "environment_id": "<string>",
        "id": "<string>",
        "metadata": {},
        "start_date": "2023-11-07T05:31:56Z",
        "status": "published",
        "subscription_id": "<string>",
        "tenant_id": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "updated_by": "<string>"
      }
    ],
    "plan": {
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "credit_grants": [
        {
          "addon_id": "<string>",
          "cadence": "ONETIME",
          "conversion_rate": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "credit_grant_anchor": "2023-11-07T05:31:56Z",
          "credits": "<string>",
          "end_date": "2023-11-07T05:31:56Z",
          "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",
          "start_date": "2023-11-07T05:31:56Z",
          "status": "published",
          "subscription_id": "<string>",
          "tenant_id": "<string>",
          "topup_conversion_rate": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>"
        }
      ],
      "description": "<string>",
      "display_order": 123,
      "entitlements": "<array>",
      "environment_id": "<string>",
      "id": "<string>",
      "lookup_key": "<string>",
      "metadata": {},
      "name": "<string>",
      "price_sync_status": {
        "current_sequence": 123,
        "synced": true,
        "unsynced_subscription_count": 123
      },
      "prices": "<array>",
      "status": "published",
      "tenant_id": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": "<string>"
    },
    "plan_id": "<string>",
    "proration_behavior": "create_prorations",
    "start_date": "2023-11-07T05:31:56Z",
    "status": "published",
    "subscription_status": "active",
    "subscription_type": "standalone",
    "synced_price_sequence": 123,
    "tenant_id": "<string>",
    "timezone": "<string>",
    "trial_end": "2023-11-07T05:31:56Z",
    "trial_start": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": "<string>",
    "version": 123
  }
}

{
  "code": "http_client_error",
  "http_status_code": 123,
  "message": "<string>"
}

{
  "code": "http_client_error",
  "http_status_code": 123,
  "message": "<string>"
}

{
  "code": "http_client_error",
  "http_status_code": 123,
  "message": "<string>"
}