Get Details

API Reference

V1

Plans

Get plan details

get/v1/planDetails/{plan_id}

Fetch high level details of a specific plan.

Path Parameters

plan_idstring

formatuuid

Returns

dataidstringcustom_fieldsmapnamestringcredit_grantsarray of objectdescriptionstringminimumsarray of objectoverage_ratesarray of objectPlanDetail

HTTPTypeScriptPythonGoRubyTerraform

curl https://api.metronome.com/v1/planDetails/$PLAN_ID \
    -H "Authorization: Bearer $METRONOME_BEARER_TOKEN"

200 Example

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "custom_fields": {
      "foo": "string"
    },
    "name": "name",
    "credit_grants": [
      {
        "amount_granted": 0,
        "amount_granted_credit_type": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "name": "name"
        },
        "amount_paid": 0,
        "amount_paid_credit_type": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "name": "name"
        },
        "effective_duration": 0,
        "name": "name",
        "priority": "priority",
        "send_invoice": true,
        "reason": "reason",
        "recurrence_duration": 0,
        "recurrence_interval": 0
      }
    ],
    "description": "description",
    "minimums": [
      {
        "credit_type": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "name": "name"
        },
        "name": "name",
        "start_period": 0,
        "value": 0
      }
    ],
    "overage_rates": [
      {
        "credit_type": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "name": "name"
        },
        "fiat_credit_type": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "name": "name"
        },
        "start_period": 0,
        "to_fiat_conversion_factor": 0
      }
    ]
  }
}