Skip to main content
POST
/
subscriptions
/
{id}
/
modify
/
preview
Preview subscription modification
curl --request POST \
  --url https://us.api.flexprice.io/v1/subscriptions/{id}/modify/preview \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "type": "inheritance",
  "inheritance_params": {
    "external_customer_ids_to_inherit_subscription": [
      "<string>"
    ]
  }
}
'
{
  "changed_resources": {
    "invoices": [
      {
        "action": "created",
        "id": "<string>",
        "invoice": {
          "adjustment_amount": "<string>",
          "amount_due": "<string>",
          "amount_paid": "<string>",
          "amount_remaining": "<string>",
          "billing_period": "<string>",
          "billing_reason": "<string>",
          "billing_sequence": 123,
          "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>",
          "customer": {
            "address_city": "<string>",
            "address_country": "<string>",
            "address_line1": "<string>",
            "address_line2": "<string>",
            "address_postal_code": "<string>",
            "address_state": "<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>",
                "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",
            "tenant_id": "<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",
          "id": "<string>",
          "idempotency_key": "<string>",
          "invoice_number": "<string>",
          "invoice_pdf_url": "<string>",
          "invoice_status": "DRAFT",
          "invoice_type": "SUBSCRIPTION",
          "last_computed_at": "2023-11-07T05:31:56Z",
          "line_items": [
            {
              "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>",
              "customer_id": "<string>",
              "display_name": "<string>",
              "entity_id": "<string>",
              "entity_type": "<string>",
              "environment_id": "<string>",
              "id": "<string>",
              "invoice_id": "<string>",
              "invoice_level_discount": "<string>",
              "line_item_discount": "<string>",
              "metadata": {},
              "meter_display_name": "<string>",
              "meter_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>",
              "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>",
          "status": "published",
          "subscription": {
            "active_pause_id": "<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",
            "collection_method": "<string>",
            "commitment_amount": "<string>",
            "commitment_duration": "MONTHLY",
            "coupon_associations": [
              {
                "coupon": {
                  "amount_off": "<string>",
                  "cadence": "once",
                  "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_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": [
              {
                "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>",
              "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>",
                  "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",
              "tenant_id": "<string>",
              "updated_at": "2023-11-07T05:31:56Z",
              "updated_by": "<string>"
            },
            "customer_id": "<string>",
            "customer_timezone": "<string>",
            "enable_true_up": true,
            "end_date": "2023-11-07T05:31:56Z",
            "environment_id": "<string>",
            "gateway_payment_method_id": "<string>",
            "id": "<string>",
            "invoicing_customer_id": "<string>",
            "latest_invoice": "<unknown>",
            "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_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_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,
                  "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",
                  "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": [
                {
                  "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": [
                {
                  "addon": {
                    "created_at": "2023-11-07T05:31:56Z",
                    "created_by": "<string>",
                    "description": "<string>",
                    "entitlements": "<array>",
                    "environment_id": "<string>",
                    "id": "<string>",
                    "lookup_key": "<string>",
                    "metadata": {},
                    "name": "<string>",
                    "prices": [
                      {
                        "addon": "<unknown>",
                        "amount": "<string>",
                        "billing_cadence": "RECURRING",
                        "billing_model": "FLAT_FEE",
                        "billing_period": "MONTHLY",
                        "billing_period_count": 123,
                        "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": {
                          "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": "<unknown>",
                        "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>"
                        },
                        "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>"
                      }
                    ],
                    "status": "published",
                    "tenant_id": "<string>",
                    "updated_at": "2023-11-07T05:31:56Z",
                    "updated_by": "<string>"
                  },
                  "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,
                      "critical": {
                        "condition": "above",
                        "threshold": 123
                      },
                      "info": {
                        "condition": "above",
                        "threshold": 123
                      },
                      "warning": {
                        "condition": "above",
                        "threshold": 123
                      }
                    },
                    "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",
                  "id": "<string>",
                  "is_enabled": true,
                  "is_soft_limit": true,
                  "parent_entitlement_id": "<string>",
                  "plan": "<unknown>",
                  "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>",
              "prices": [
                {
                  "addon": "<unknown>",
                  "amount": "<string>",
                  "billing_cadence": "RECURRING",
                  "billing_model": "FLAT_FEE",
                  "billing_period": "MONTHLY",
                  "billing_period_count": 123,
                  "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": {
                    "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": "<unknown>",
                  "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>"
                  },
                  "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>"
                }
              ],
              "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",
            "tenant_id": "<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
          },
          "subscription_customer_id": "<string>",
          "subscription_id": "<string>",
          "subtotal": "<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>",
              "id": "<string>",
              "idempotency_key": "<string>",
              "metadata": {},
              "status": "published",
              "tax_amount": "<string>",
              "tax_association_id": "<string>",
              "tax_rate": {
                "code": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "created_by": "<string>",
                "description": "<string>",
                "environment_id": "<string>",
                "fixed_value": "<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>",
              "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"
        },
        "status": "preview",
        "wallet_transaction": {
          "amount": "<string>",
          "conversion_rate": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "created_by_user": {
            "email": "<string>",
            "id": "<string>",
            "roles": [
              "<string>"
            ],
            "tenant": {
              "billing_details": {
                "address": {
                  "address_city": "<string>",
                  "address_country": "<string>",
                  "address_line1": "<string>",
                  "address_line2": "<string>",
                  "address_postal_code": "<string>",
                  "address_state": "<string>"
                },
                "email": "<string>",
                "help_email": "<string>",
                "phone": "<string>"
              },
              "created_at": "2023-11-07T05:31:56Z",
              "id": "<string>",
              "metadata": {},
              "name": "<string>",
              "status": "<string>",
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "type": "user"
          },
          "credit_amount": "<string>",
          "credit_balance_after": "<string>",
          "credit_balance_before": "<string>",
          "credits_available": "<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": "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>",
                "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",
            "tenant_id": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>"
          },
          "customer_id": "<string>",
          "description": "<string>",
          "environment_id": "<string>",
          "expiry_date": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "idempotency_key": "<string>",
          "metadata": {},
          "priority": 123,
          "reference_id": "<string>",
          "reference_type": "PAYMENT",
          "status": "published",
          "tenant_id": "<string>",
          "topup_conversion_rate": "<string>",
          "transaction_reason": "INVOICE_PAYMENT",
          "transaction_status": "pending",
          "type": "credit",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>",
          "wallet": {
            "alert_settings": {
              "alert_enabled": true,
              "critical": {
                "condition": "above",
                "threshold": 123
              },
              "info": {
                "condition": "above",
                "threshold": 123
              },
              "warning": {
                "condition": "above",
                "threshold": 123
              }
            },
            "alert_state": "ok",
            "auto_topup": {
              "amount": 123,
              "enabled": true,
              "invoicing": true,
              "threshold": 123
            },
            "balance": "<string>",
            "config": {
              "allowed_price_types": [
                "ALL"
              ]
            },
            "conversion_rate": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "created_by": "<string>",
            "credit_balance": "<string>",
            "credits_available_breakdown": {
              "free": "<string>",
              "purchased": "<string>"
            },
            "currency": "<string>",
            "customer_id": "<string>",
            "description": "<string>",
            "environment_id": "<string>",
            "id": "<string>",
            "metadata": {},
            "name": "<string>",
            "status": "published",
            "tenant_id": "<string>",
            "topup_conversion_rate": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>",
            "wallet_status": "active",
            "wallet_type": "PRE_PAID"
          },
          "wallet_id": "<string>"
        }
      }
    ],
    "line_items": [
      {
        "change_action": "created",
        "end_date": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "price_id": "<string>",
        "quantity": "<string>",
        "start_date": "2023-11-07T05:31:56Z"
      }
    ],
    "subscriptions": [
      {
        "action": "created",
        "id": "<string>",
        "status": "active"
      }
    ]
  },
  "subscription": {
    "active_pause_id": "<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",
    "collection_method": "<string>",
    "commitment_amount": "<string>",
    "commitment_duration": "MONTHLY",
    "coupon_associations": [
      {
        "coupon": {
          "amount_off": "<string>",
          "cadence": "once",
          "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_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": [
      {
        "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>",
      "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>",
          "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",
      "tenant_id": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": "<string>"
    },
    "customer_id": "<string>",
    "customer_timezone": "<string>",
    "enable_true_up": true,
    "end_date": "2023-11-07T05:31:56Z",
    "environment_id": "<string>",
    "gateway_payment_method_id": "<string>",
    "id": "<string>",
    "invoicing_customer_id": "<string>",
    "latest_invoice": "<unknown>",
    "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_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_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,
          "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",
          "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": [
        {
          "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": [
        {
          "addon": {
            "created_at": "2023-11-07T05:31:56Z",
            "created_by": "<string>",
            "description": "<string>",
            "entitlements": "<array>",
            "environment_id": "<string>",
            "id": "<string>",
            "lookup_key": "<string>",
            "metadata": {},
            "name": "<string>",
            "prices": [
              {
                "addon": "<unknown>",
                "amount": "<string>",
                "billing_cadence": "RECURRING",
                "billing_model": "FLAT_FEE",
                "billing_period": "MONTHLY",
                "billing_period_count": 123,
                "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": {
                  "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": "<unknown>",
                "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>"
                },
                "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>"
              }
            ],
            "status": "published",
            "tenant_id": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>"
          },
          "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,
              "critical": {
                "condition": "above",
                "threshold": 123
              },
              "info": {
                "condition": "above",
                "threshold": 123
              },
              "warning": {
                "condition": "above",
                "threshold": 123
              }
            },
            "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",
          "id": "<string>",
          "is_enabled": true,
          "is_soft_limit": true,
          "parent_entitlement_id": "<string>",
          "plan": "<unknown>",
          "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>",
      "prices": [
        {
          "addon": "<unknown>",
          "amount": "<string>",
          "billing_cadence": "RECURRING",
          "billing_model": "FLAT_FEE",
          "billing_period": "MONTHLY",
          "billing_period_count": 123,
          "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": {
            "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": "<unknown>",
          "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>"
          },
          "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>"
        }
      ],
      "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",
    "tenant_id": "<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
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.flexprice.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

id
string
required

Subscription ID

Body

application/json

Modification preview request

type
enum<string>
required
Available options:
inheritance,
quantity_change
inheritance_params
object
quantity_change_params
object

Response

OK

changed_resources
object
subscription
object