List coupon associations

List coupon associations with optional filters. Coupon associations are created and removed via the subscription modify API.

GET /coupons/associations

List coupon associations

cURL

curl --request GET \
  --url https://us.api.flexprice.io/v1/coupons/associations \
  --header 'x-api-key: <api-key>'

200

{
  "items": [
    {
      "coupon": {
        "amount_off": "<string>",
        "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": {},
        "tenant_id": "<string>",
        "total_redemptions": 123,
        "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",
      "subscription_id": "<string>",
      "subscription_line_item": {
        "addon_association_id": "<string>",
        "billing_period_count": 123,
        "commitment_amount": "<string>",
        "commitment_overage_factor": "<string>",
        "commitment_quantity": "<string>",
        "commitment_time_buckets": [
          {
            "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_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>",
        "environment_id": "<string>",
        "id": "<string>",
        "metadata": {},
        "meter_display_name": "<string>",
        "meter_id": "<string>",
        "plan_display_name": "<string>",
        "price": {
          "addon": {
            "created_at": "2023-11-07T05:31:56Z",
            "created_by": "<string>",
            "description": "<string>",
            "entitlements": [
              {
                "addon": "<unknown>",
                "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>",
                "environment_id": "<string>",
                "feature": {
                  "alert_settings": {
                    "alert_enabled": true,
                    "critical": {
                      "threshold": 123
                    },
                    "info": {
                      "threshold": 123
                    },
                    "warning": {
                      "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": {
                      "expression": "<string>",
                      "field": "<string>",
                      "group_by": "<string>",
                      "multiplier": "<string>"
                    },
                    "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",
                    "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>"
                  },
                  "tenant_id": "<string>",
                  "unit_plural": "<string>",
                  "unit_singular": "<string>",
                  "updated_at": "2023-11-07T05:31:56Z",
                  "updated_by": "<string>"
                },
                "feature_id": "<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": [
                    {
                      "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,
                      "id": "<string>",
                      "metadata": {},
                      "name": "<string>",
                      "period_count": 123,
                      "plan_id": "<string>",
                      "priority": 123,
                      "start_date": "2023-11-07T05:31:56Z",
                      "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>",
                  "prices": "<array>",
                  "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>",
                "tenant_id": "<string>",
                "updated_at": "2023-11-07T05:31:56Z",
                "updated_by": "<string>",
                "usage_limit": 123
              }
            ],
            "environment_id": "<string>",
            "id": "<string>",
            "lookup_key": "<string>",
            "metadata": {},
            "name": "<string>",
            "prices": "<array>",
            "tenant_id": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>"
          },
          "amount": "<string>",
          "billing_cadence": "RECURRING",
          "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>",
          "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": {
              "expression": "<string>",
              "field": "<string>",
              "group_by": "<string>",
              "multiplier": "<string>"
            },
            "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",
            "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": [
              {
                "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,
                "id": "<string>",
                "metadata": {},
                "name": "<string>",
                "period_count": 123,
                "plan_id": "<string>",
                "priority": 123,
                "start_date": "2023-11-07T05:31:56Z",
                "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>",
            "prices": "<array>",
            "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
            }
          ],
          "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>",
            "symbol": "<string>",
            "tenant_id": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>"
          },
          "sequence": 123,
          "start_date": "2023-11-07T05:31:56Z",
          "tenant_id": "<string>",
          "tiers": [
            {
              "flat_amount": "<string>",
              "unit_amount": "<string>",
              "up_to": 123
            }
          ],
          "transform_quantity": {
            "divide_by": 123
          },
          "trial_period_days": 123,
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>"
        },
        "price_id": "<string>",
        "price_unit": "<string>",
        "price_unit_id": "<string>",
        "quantity": "<string>",
        "start_date": "2023-11-07T05:31:56Z",
        "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>"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

x-api-key · string · header · required

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

Query Parameters

subscription_ids · string[]

Filter by subscription IDs (max 100)

coupon_ids · string[]

Filter by coupon IDs (max 100)

active_only · boolean

Return only currently active associations

expand · string

Comma-separated fields: coupon, subscription_line_items, subscription_line_items.prices

limit · integer

Page size

offset · integer

Page offset

Response

200

application/json

OK

items · object[]

Show child attributes

pagination · object

Show child attributes