Skip to main content
POST
/
subscriptions
/
addon
Add addon to subscription
curl --request POST \
  --url https://us.api.flexprice.io/v1/subscriptions/addon \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "addon_id": "<string>",
  "subscription_id": "<string>",
  "line_item_commitments": {},
  "metadata": {},
  "start_date": "<string>"
}
'
{
  "addon": {
    "created_at": "<string>",
    "created_by": "<string>",
    "description": "<string>",
    "entitlements": [
      {
        "addon": "<unknown>",
        "created_at": "<string>",
        "created_by": "<string>",
        "display_order": 123,
        "end_date": "<string>",
        "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": "<string>",
          "created_by": "<string>",
          "description": "<string>",
          "environment_id": "<string>",
          "id": "<string>",
          "lookup_key": "<string>",
          "metadata": {},
          "meter": {
            "aggregation": {
              "bucket_size": "MINUTE",
              "field": "<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>",
          "status": "published",
          "tenant_id": "<string>",
          "type": "metered",
          "unit_plural": "<string>",
          "unit_singular": "<string>",
          "updated_at": "<string>",
          "updated_by": "<string>"
        },
        "feature_id": "<string>",
        "feature_type": "metered",
        "id": "<string>",
        "is_enabled": true,
        "is_soft_limit": true,
        "parent_entitlement_id": "<string>",
        "plan": {
          "created_at": "<string>",
          "created_by": "<string>",
          "credit_grants": [
            {
              "cadence": "ONETIME",
              "conversion_rate": "<string>",
              "created_at": "<string>",
              "created_by": "<string>",
              "credit_grant_anchor": "<string>",
              "credits": "<string>",
              "end_date": "<string>",
              "environment_id": "<string>",
              "expiration_duration": 123,
              "expiration_duration_unit": "DAY",
              "expiration_type": "NEVER",
              "id": "<string>",
              "metadata": {},
              "name": "<string>",
              "period": "DAILY",
              "period_count": 123,
              "plan_id": "<string>",
              "priority": 123,
              "scope": "PLAN",
              "start_date": "<string>",
              "status": "published",
              "subscription_id": "<string>",
              "tenant_id": "<string>",
              "topup_conversion_rate": "<string>",
              "updated_at": "<string>",
              "updated_by": "<string>"
            }
          ],
          "description": "<string>",
          "display_order": 123,
          "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": "<string>",
              "created_by": "<string>",
              "currency": "<string>",
              "description": "<string>",
              "display_amount": "<string>",
              "display_name": "<string>",
              "display_price_unit_amount": "<string>",
              "end_date": "<string>",
              "entity_id": "<string>",
              "entity_type": "PLAN",
              "environment_id": "<string>",
              "group": {
                "created_at": "<string>",
                "entity_ids": [
                  "<string>"
                ],
                "entity_type": "<string>",
                "id": "<string>",
                "lookup_key": "<string>",
                "metadata": {},
                "name": "<string>",
                "status": "<string>",
                "updated_at": "<string>"
              },
              "group_id": "<string>",
              "id": "<string>",
              "invoice_cadence": "ARREAR",
              "lookup_key": "<string>",
              "metadata": {},
              "meter": {
                "aggregation": {
                  "bucket_size": "MINUTE",
                  "field": "<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": "<string>",
                "created_by": "<string>",
                "environment_id": "<string>",
                "id": "<string>",
                "metadata": {},
                "name": "<string>",
                "status": "published",
                "symbol": "<string>",
                "tenant_id": "<string>",
                "updated_at": "<string>",
                "updated_by": "<string>"
              },
              "start_date": "<string>",
              "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": 123,
              "type": "USAGE",
              "updated_at": "<string>",
              "updated_by": "<string>"
            }
          ],
          "status": "published",
          "tenant_id": "<string>",
          "updated_at": "<string>",
          "updated_by": "<string>"
        },
        "plan_id": "<string>",
        "start_date": "<string>",
        "static_value": "<string>",
        "status": "published",
        "tenant_id": "<string>",
        "updated_at": "<string>",
        "updated_by": "<string>",
        "usage_limit": 123,
        "usage_reset_period": "MONTHLY"
      }
    ],
    "environment_id": "<string>",
    "id": "<string>",
    "lookup_key": "<string>",
    "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": "<string>",
        "created_by": "<string>",
        "currency": "<string>",
        "description": "<string>",
        "display_amount": "<string>",
        "display_name": "<string>",
        "display_price_unit_amount": "<string>",
        "end_date": "<string>",
        "entity_id": "<string>",
        "entity_type": "PLAN",
        "environment_id": "<string>",
        "group": {
          "created_at": "<string>",
          "entity_ids": [
            "<string>"
          ],
          "entity_type": "<string>",
          "id": "<string>",
          "lookup_key": "<string>",
          "metadata": {},
          "name": "<string>",
          "status": "<string>",
          "updated_at": "<string>"
        },
        "group_id": "<string>",
        "id": "<string>",
        "invoice_cadence": "ARREAR",
        "lookup_key": "<string>",
        "metadata": {},
        "meter": {
          "aggregation": {
            "bucket_size": "MINUTE",
            "field": "<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": "<string>",
          "created_by": "<string>",
          "environment_id": "<string>",
          "id": "<string>",
          "metadata": {},
          "name": "<string>",
          "status": "published",
          "symbol": "<string>",
          "tenant_id": "<string>",
          "updated_at": "<string>",
          "updated_by": "<string>"
        },
        "start_date": "<string>",
        "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": 123,
        "type": "USAGE",
        "updated_at": "<string>",
        "updated_by": "<string>"
      }
    ],
    "status": "published",
    "tenant_id": "<string>",
    "type": "onetime",
    "updated_at": "<string>",
    "updated_by": "<string>"
  },
  "addon_id": "<string>",
  "addon_status": "active",
  "cancellation_reason": "<string>",
  "cancelled_at": "<string>",
  "created_at": "<string>",
  "created_by": "<string>",
  "end_date": "<string>",
  "entity_id": "<string>",
  "entity_type": "subscription",
  "environment_id": "<string>",
  "id": "<string>",
  "metadata": {},
  "start_date": "<string>",
  "status": "published",
  "subscription": {
    "active_pause_id": "<string>",
    "billing_anchor": "<string>",
    "billing_cadence": "RECURRING",
    "billing_cycle": "anniversary",
    "billing_period": "MONTHLY",
    "billing_period_count": 123,
    "cancel_at": "<string>",
    "cancel_at_period_end": true,
    "cancelled_at": "<string>",
    "collection_method": "<string>",
    "commitment_amount": "<string>",
    "coupon_associations": [
      {
        "coupon": {
          "amount_off": "<string>",
          "cadence": "once",
          "created_at": "<string>",
          "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": "<string>",
          "updated_by": "<string>"
        },
        "coupon_id": "<string>",
        "created_at": "<string>",
        "created_by": "<string>",
        "end_date": "<string>",
        "environment_id": "<string>",
        "id": "<string>",
        "metadata": {},
        "start_date": "<string>",
        "status": "published",
        "subscription_id": "<string>",
        "subscription_line_item_id": "<string>",
        "subscription_phase_id": "<string>",
        "tenant_id": "<string>",
        "updated_at": "<string>",
        "updated_by": "<string>"
      }
    ],
    "created_at": "<string>",
    "created_by": "<string>",
    "credit_grants": [
      {
        "cadence": "ONETIME",
        "conversion_rate": "<string>",
        "created_at": "<string>",
        "created_by": "<string>",
        "credit_grant_anchor": "<string>",
        "credits": "<string>",
        "end_date": "<string>",
        "environment_id": "<string>",
        "expiration_duration": 123,
        "expiration_duration_unit": "DAY",
        "expiration_type": "NEVER",
        "id": "<string>",
        "metadata": {},
        "name": "<string>",
        "period": "DAILY",
        "period_count": 123,
        "plan_id": "<string>",
        "priority": 123,
        "scope": "PLAN",
        "start_date": "<string>",
        "status": "published",
        "subscription_id": "<string>",
        "tenant_id": "<string>",
        "topup_conversion_rate": "<string>",
        "updated_at": "<string>",
        "updated_by": "<string>"
      }
    ],
    "currency": "<string>",
    "current_period_end": "<string>",
    "current_period_start": "<string>",
    "customer": {
      "address_city": "<string>",
      "address_country": "<string>",
      "address_line1": "<string>",
      "address_line2": "<string>",
      "address_postal_code": "<string>",
      "address_state": "<string>",
      "created_at": "<string>",
      "created_by": "<string>",
      "email": "<string>",
      "environment_id": "<string>",
      "external_id": "<string>",
      "id": "<string>",
      "metadata": {},
      "name": "<string>",
      "parent_customer": "<unknown>",
      "parent_customer_id": "<string>",
      "status": "published",
      "tenant_id": "<string>",
      "updated_at": "<string>",
      "updated_by": "<string>"
    },
    "customer_id": "<string>",
    "customer_timezone": "<string>",
    "enable_true_up": true,
    "end_date": "<string>",
    "environment_id": "<string>",
    "gateway_payment_method_id": "<string>",
    "id": "<string>",
    "invoicing_customer_id": "<string>",
    "latest_invoice": {
      "amount_due": "<string>",
      "amount_paid": "<string>",
      "amount_remaining": "<string>",
      "billing_period": "<string>",
      "billing_reason": "<string>",
      "billing_sequence": 123,
      "coupon_applications": [
        {
          "applied_at": "<string>",
          "coupon_association_id": "<string>",
          "coupon_id": "<string>",
          "coupon_snapshot": {},
          "created_at": "<string>",
          "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": "<string>",
          "updated_by": "<string>"
        }
      ],
      "created_at": "<string>",
      "created_by": "<string>",
      "currency": "<string>",
      "customer": {
        "address_city": "<string>",
        "address_country": "<string>",
        "address_line1": "<string>",
        "address_line2": "<string>",
        "address_postal_code": "<string>",
        "address_state": "<string>",
        "created_at": "<string>",
        "created_by": "<string>",
        "email": "<string>",
        "environment_id": "<string>",
        "external_id": "<string>",
        "id": "<string>",
        "metadata": {},
        "name": "<string>",
        "parent_customer": "<unknown>",
        "parent_customer_id": "<string>",
        "status": "published",
        "tenant_id": "<string>",
        "updated_at": "<string>",
        "updated_by": "<string>"
      },
      "customer_id": "<string>",
      "description": "<string>",
      "due_date": "<string>",
      "finalized_at": "<string>",
      "id": "<string>",
      "idempotency_key": "<string>",
      "invoice_number": "<string>",
      "invoice_pdf_url": "<string>",
      "invoice_status": "DRAFT",
      "invoice_type": "SUBSCRIPTION",
      "line_items": [
        {
          "amount": "<string>",
          "commitment_info": {
            "amount": "<string>",
            "computed_commitment_utilized_amount": "<string>",
            "computed_overage_amount": "<string>",
            "computed_true_up_amount": "<string>",
            "is_windowed": true,
            "overage_factor": "<string>",
            "quantity": "<string>",
            "true_up_enabled": true,
            "type": "amount"
          },
          "created_at": "<string>",
          "created_by": "<string>",
          "currency": "<string>",
          "customer_id": "<string>",
          "display_name": "<string>",
          "entity_id": "<string>",
          "entity_type": "<string>",
          "id": "<string>",
          "invoice_id": "<string>",
          "metadata": {},
          "meter_display_name": "<string>",
          "meter_id": "<string>",
          "period_end": "<string>",
          "period_start": "<string>",
          "plan_display_name": "<string>",
          "plan_id": "<string>",
          "price_id": "<string>",
          "price_type": "<string>",
          "price_unit": "<string>",
          "price_unit_amount": "<string>",
          "price_unit_id": "<string>",
          "quantity": "<string>",
          "status": "<string>",
          "subscription_id": "<string>",
          "tenant_id": "<string>",
          "updated_at": "<string>",
          "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": "<string>",
      "payment_status": "INITIATED",
      "period_end": "<string>",
      "period_start": "<string>",
      "status": "<string>",
      "subscription": "<unknown>",
      "subscription_id": "<string>",
      "subtotal": "<string>",
      "taxes": [
        {
          "applied_at": "<string>",
          "created_at": "<string>",
          "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": "<string>",
            "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": "<string>",
            "updated_by": "<string>"
          },
          "tax_rate_id": "<string>",
          "taxable_amount": "<string>",
          "tenant_id": "<string>",
          "updated_at": "<string>",
          "updated_by": "<string>"
        }
      ],
      "tenant_id": "<string>",
      "total": "<string>",
      "total_discount": "<string>",
      "total_tax": "<string>",
      "updated_at": "<string>",
      "updated_by": "<string>",
      "version": 123,
      "voided_at": "<string>"
    },
    "line_items": [
      {
        "billing_period": "MONTHLY",
        "commitment_amount": 123,
        "commitment_overage_factor": 123,
        "commitment_quantity": 123,
        "commitment_true_up_enabled": true,
        "commitment_type": "amount",
        "commitment_windowed": true,
        "created_at": "<string>",
        "created_by": "<string>",
        "currency": "<string>",
        "customer_id": "<string>",
        "display_name": "<string>",
        "end_date": "<string>",
        "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": "<string>",
          "created_by": "<string>",
          "currency": "<string>",
          "description": "<string>",
          "display_amount": "<string>",
          "display_name": "<string>",
          "display_price_unit_amount": "<string>",
          "end_date": "<string>",
          "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": "<string>",
          "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": 123,
          "type": "USAGE",
          "updated_at": "<string>",
          "updated_by": "<string>"
        },
        "price_id": "<string>",
        "price_type": "USAGE",
        "price_unit": "<string>",
        "price_unit_id": "<string>",
        "quantity": "<string>",
        "start_date": "<string>",
        "status": "published",
        "subscription_id": "<string>",
        "subscription_phase_id": "<string>",
        "tenant_id": "<string>",
        "trial_period": 123,
        "updated_at": "<string>",
        "updated_by": "<string>"
      }
    ],
    "lookup_key": "<string>",
    "metadata": {},
    "overage_factor": "<string>",
    "pause_status": "none",
    "pauses": [
      {
        "created_at": "<string>",
        "created_by": "<string>",
        "environment_id": "<string>",
        "id": "<string>",
        "metadata": {},
        "original_period_end": "<string>",
        "original_period_start": "<string>",
        "pause_end": "<string>",
        "pause_mode": "immediate",
        "pause_start": "<string>",
        "pause_status": "none",
        "reason": "<string>",
        "resume_mode": "immediate",
        "resumed_at": "<string>",
        "status": "published",
        "subscription_id": "<string>",
        "tenant_id": "<string>",
        "updated_at": "<string>",
        "updated_by": "<string>"
      }
    ],
    "payment_behavior": "<string>",
    "phases": [
      {
        "created_at": "<string>",
        "created_by": "<string>",
        "end_date": "<string>",
        "environment_id": "<string>",
        "id": "<string>",
        "metadata": {},
        "start_date": "<string>",
        "status": "published",
        "subscription_id": "<string>",
        "tenant_id": "<string>",
        "updated_at": "<string>",
        "updated_by": "<string>"
      }
    ],
    "plan": {
      "created_at": "<string>",
      "created_by": "<string>",
      "credit_grants": [
        {
          "cadence": "ONETIME",
          "conversion_rate": "<string>",
          "created_at": "<string>",
          "created_by": "<string>",
          "credit_grant_anchor": "<string>",
          "credits": "<string>",
          "end_date": "<string>",
          "environment_id": "<string>",
          "expiration_duration": 123,
          "expiration_duration_unit": "DAY",
          "expiration_type": "NEVER",
          "id": "<string>",
          "metadata": {},
          "name": "<string>",
          "period": "DAILY",
          "period_count": 123,
          "plan_id": "<string>",
          "priority": 123,
          "scope": "PLAN",
          "start_date": "<string>",
          "status": "published",
          "subscription_id": "<string>",
          "tenant_id": "<string>",
          "topup_conversion_rate": "<string>",
          "updated_at": "<string>",
          "updated_by": "<string>"
        }
      ],
      "description": "<string>",
      "display_order": 123,
      "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": "<string>",
          "created_by": "<string>",
          "currency": "<string>",
          "description": "<string>",
          "display_amount": "<string>",
          "display_name": "<string>",
          "display_price_unit_amount": "<string>",
          "end_date": "<string>",
          "entity_id": "<string>",
          "entity_type": "PLAN",
          "environment_id": "<string>",
          "group": {
            "created_at": "<string>",
            "entity_ids": [
              "<string>"
            ],
            "entity_type": "<string>",
            "id": "<string>",
            "lookup_key": "<string>",
            "metadata": {},
            "name": "<string>",
            "status": "<string>",
            "updated_at": "<string>"
          },
          "group_id": "<string>",
          "id": "<string>",
          "invoice_cadence": "ARREAR",
          "lookup_key": "<string>",
          "metadata": {},
          "meter": {
            "aggregation": {
              "bucket_size": "MINUTE",
              "field": "<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": "<string>",
            "created_by": "<string>",
            "environment_id": "<string>",
            "id": "<string>",
            "metadata": {},
            "name": "<string>",
            "status": "published",
            "symbol": "<string>",
            "tenant_id": "<string>",
            "updated_at": "<string>",
            "updated_by": "<string>"
          },
          "start_date": "<string>",
          "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": 123,
          "type": "USAGE",
          "updated_at": "<string>",
          "updated_by": "<string>"
        }
      ],
      "status": "published",
      "tenant_id": "<string>",
      "updated_at": "<string>",
      "updated_by": "<string>"
    },
    "plan_id": "<string>",
    "proration_behavior": "create_prorations",
    "start_date": "<string>",
    "status": "published",
    "subscription_status": "active",
    "tenant_id": "<string>",
    "trial_end": "<string>",
    "trial_start": "<string>",
    "updated_at": "<string>",
    "updated_by": "<string>",
    "version": 123
  },
  "tenant_id": "<string>",
  "updated_at": "<string>",
  "updated_by": "<string>"
}

Authorizations

x-api-key
string
header
required

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

Body

application/json

Add Addon Request

addon_id
string
required
subscription_id
string
required
line_item_commitments
object

LineItemCommitments allows setting commitment configuration per addon line item (keyed by price_id)

metadata
object
start_date
string

Response

OK

addon
object
addon_id
string
addon_status
enum<string>
Available options:
active,
cancelled,
paused
cancellation_reason
string
cancelled_at
string
created_at
string
created_by
string
end_date
string
entity_id
string
entity_type
enum<string>
Available options:
subscription,
plan,
addon
environment_id
string
id
string
metadata
object
start_date
string
status
enum<string>
Available options:
published,
deleted,
archived
subscription
object
tenant_id
string
updated_at
string
updated_by
string