Skip to main content
GET
/
v1
/
plans
/
{planId}
Get Plan
curl --request GET \
  --url https://api.monk.com/v1/plans/{planId} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "status": "draft",
    "currency": "<string>",
    "netTerms": "<string>",
    "externalId": "<string>",
    "metadata": {
      "defaultAutoPayEnabled": true,
      "invoiceSendMethod": "<string>",
      "defaultCreditSettings": {
        "onDepletion": "<string>"
      },
      "defaultCreditGrantCents": 123
    },
    "items": [
      {
        "id": "<string>",
        "pricingId": "<string>",
        "productId": "<string>",
        "productName": "<string>",
        "pricingName": "<string>",
        "pricingModel": "<string>",
        "billingMode": "<string>",
        "defaultQuantity": "<string>",
        "isMetered": true
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
Scope: plans:read

Authorizations

Authorization
string
header
required

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

Path Parameters

planId
string
required

Response

Plan found

data
object