plans

Update plan by external ID

Update a plan by your external plan ID. If attributes are provided, they replace the plan's existing attributes. Set status to archive or restore the plan.

put/plans/external/{externalId}

Request

  • Base URL: https://api.agentpaid.io/api/v2
  • URL: https://api.agentpaid.io/api/v2/plans/external/{externalId}
  • Auth: HTTP bearer

Path parameters

externalIdstring required

Request body

namestring nullable
externalIdstring nullable
supportedCurrenciesstring[]
isDefaultboolean
status'active' | 'archived'

Set to archived to archive this plan, or active to restore it.

Response

200

idstring required
productIdstring required
namestring nullable required
externalIdstring nullable required
supportedCurrenciesstring[] required
isDefaultboolean required
status'active' | 'archived' required
upgradePathOrdernumber double nullable required
archivedAtstring date-time nullable required
createdAtstring date-time required
updatedAtstring date-time required

Changes

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