Skip to main content
GET
/
planDetails
/
{plan_id}
Get plan details
curl --request GET \
  --url https://api.metronome.com/v1/planDetails/{plan_id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "custom_fields": {},
    "description": "<string>",
    "minimums": [
      {
        "name": "<string>",
        "value": 123,
        "start_period": 123,
        "credit_type": {
          "name": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    ],
    "overage_rates": [
      {
        "to_fiat_conversion_factor": 123,
        "start_period": 123,
        "fiat_credit_type": {
          "name": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "credit_type": {
          "name": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    ],
    "credit_grants": [
      {
        "name": "<string>",
        "amount_granted": 123,
        "amount_paid": 123,
        "effective_duration": 123,
        "priority": "<string>",
        "send_invoice": true,
        "amount_paid_credit_type": {
          "name": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "amount_granted_credit_type": {
          "name": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "reason": "<string>",
        "recurrence_duration": 123,
        "recurrence_interval": 123
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

plan_id
string<uuid>
required

Response

200 - application/json

Success

data
object
required