plans

Upgrade customer to a new plan

Upgrades a customer from one plan to another with automatic proration. Credits are applied for the unused portion of the current billing period, and the order is updated with the new plan's pricing.

post/plans/upgrade

Request

  • Base URL: https://api.agentpaid.io/api/v1
  • URL: https://api.agentpaid.io/api/v1/plans/upgrade
  • Auth: HTTP bearer

Query parameters

customerExternalIdstring required

The external ID of the customer

oldPlanIdstring uuid required

The ID of the current plan

newPlanIdstring uuid required

The ID of the plan to upgrade to

Response

Plan upgrade completed successfully

orderIdstring uuid required

The ID of the order

amendmentIdstring uuid required

The ID of the amendment record

versioninteger required

The new version of the order after the amendment

effectiveDatestring date-time required

The effective date of the plan change

endedLineIdsstring[] required

IDs of order lines that were ended

createdLineIdsstring[] required

IDs of new order lines that were created

creditLineIdsstring[] required

IDs of credit lines that were created

Changes

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