Cancel a payment plan
Stops collecting installments and returns the recovery case to open.
Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Path Parameters
The id identifier.
Response
Returns a canceled payment plan object if successful.
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
payment_plan The date and time the customer accepted the plan.
The total amount the plan collects across all installments.
The date and time the plan was canceled.
The date and time the final installment was collected.
Three-letter ISO currency code, in lowercase. Must be a supported currency.
gbp, usd, eur, sek "gbp"
The customer the plan is for.
The date and time the plan defaulted.
The frequency installments are collected at.
week, month The payment method installments are charged to.
The recovery case the plan settles.
The status of the plan.
proposed, active, completed, defaulted, canceled The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
The amount collected by the plan so far.
The installments that make up the plan, in collection order.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.