Plans

Get Plan by ID

The Get Plan by ID endpoint lets you retrieve detailed information about a specific subscription plan using its unique identifier. Use this endpoint to manage and review individual plans effectively.

get/v1/plan/{planId}

Request

Base URL
//mapi.boomfi.xyz (relative, and the document’s source URL is not known)
Auth
API key in header X-API-KEY
TypeScript
https://skmtc.dev/boomfi/apis/boomfi-merchants-api/docs/v1/plan/:planId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

planIdstring required

The unique identifier of the plan.

Response

errorboolean

Example response

{
  "data": {
    "id": "2eJh1L1rDrCZxTyE6vwGhck7LWI",
    "org_id": "2Tpmnmh6GHJXumKN1oBy2u56Ima",
    "metadata": {
      "key": "value"
    },
    "properties": {
      "key": "value"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.