Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Response
200 - application/json
Success
curl --request GET \
--url https://api.metronome.com/v1/planDetails/{plan_id} \
--header 'Authorization: Bearer <token>'
{
"data": {
"id": "d46c3bce-40a6-4fbf-9b45-fcb00d45ad5f",
"name": "Plan with Minimums",
"description": "A plan with minimums",
"credit_grants": [
{
"name": "Acme Corp Promotional Credit Grant",
"amount_granted": 2400,
"amount_paid": 1500,
"effective_duration": 3,
"priority": "1",
"send_invoice": true,
"reason": "Prepaid grant",
"recurrence_interval": 1,
"amount_granted_credit_type": {
"id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
"name": "USD (cents)"
},
"amount_paid_credit_type": {
"id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
"name": "USD (cents)"
}
}
],
"minimums": [
{
"name": "Invoice minimum",
"value": 10000,
"start_period": 0,
"credit_type": {
"id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
"name": "USD (cents)"
}
}
],
"overage_rates": [
{
"start_period": 0,
"to_fiat_conversion_factor": 1600,
"fiat_credit_type": {
"id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
"name": "USD (cents)"
},
"credit_type": {
"id": "d46c3bce-40a6-4fbf-9b45-fcb00d45ad5f",
"name": "MetroBux"
}
}
],
"custom_fields": {
"x_account_id": "KyVnHhSBWl7eY2bl"
}
}
}
Fetch high level details of a specific plan. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.
curl --request GET \
--url https://api.metronome.com/v1/planDetails/{plan_id} \
--header 'Authorization: Bearer <token>'
{
"data": {
"id": "d46c3bce-40a6-4fbf-9b45-fcb00d45ad5f",
"name": "Plan with Minimums",
"description": "A plan with minimums",
"credit_grants": [
{
"name": "Acme Corp Promotional Credit Grant",
"amount_granted": 2400,
"amount_paid": 1500,
"effective_duration": 3,
"priority": "1",
"send_invoice": true,
"reason": "Prepaid grant",
"recurrence_interval": 1,
"amount_granted_credit_type": {
"id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
"name": "USD (cents)"
},
"amount_paid_credit_type": {
"id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
"name": "USD (cents)"
}
}
],
"minimums": [
{
"name": "Invoice minimum",
"value": 10000,
"start_period": 0,
"credit_type": {
"id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
"name": "USD (cents)"
}
}
],
"overage_rates": [
{
"start_period": 0,
"to_fiat_conversion_factor": 1600,
"fiat_credit_type": {
"id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
"name": "USD (cents)"
},
"credit_type": {
"id": "d46c3bce-40a6-4fbf-9b45-fcb00d45ad5f",
"name": "MetroBux"
}
}
],
"custom_fields": {
"x_account_id": "KyVnHhSBWl7eY2bl"
}
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Success
Show child attributes