plans

Get plan by ID

get/plans/{planId}

Request

  • Base URL: https://api.agentpaid.io/api/v1
  • URL: https://api.agentpaid.io/api/v1/plans/{planId}
  • Auth: HTTP bearer

Path parameters

planIdstring uuid required

The ID of the plan

Response

Success response

idstring uuid required

The unique identifier of the plan

organizationIdstring uuid required

The organization ID that owns this plan

planGroupIdstring uuid required

The plan group ID this plan belongs to

namestring required

The name of the plan

descriptionstring nullable

The description of the plan

type'flat' | 'usage' | 'credit' required

The type of plan (flat for fixed pricing, usage for usage-based, credit for prepaid credits)

nextPlanIdstring uuid nullable

The ID of the next plan in the sequence

prevPlanIdstring uuid nullable

The ID of the previous plan in the sequence

createdAtstring date-time required

When the plan was created

updatedAtstring date-time required

When the plan was last updated

Changes

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