plans

Unsubscribe customer from plan

Cancels the renewal of an active order for a customer's plan subscription. The order will remain active until the cancellation date.

post/plans/{planId}/unsubscribe

Request

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

Path parameters

planIdstring uuid required

The ID of the plan

Query parameters

customerExternalIdstring required

The external ID of the customer

Response

Customer unsubscribed from plan 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

endDatestring date-time required

The new end date of the order

effectiveDatestring date-time required

The effective date of the cancellation

Changes

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