Skip to main content

Cancel Recurring Plan​

Cancel all recycling cycles of this recycling plan

Path Parameters
    id string required
Request Body
    activate_type string required

    Possible values: [immediate, next_billing_date]

    Immediate: The cycle to be added will start immediately and all previously-active recurring_cycles.state from the recurring plan will be updated to cancelled.

    Next Billing Date: The cycle to be added will start on the next billing date of the current recurring cycle. The recurring_cycles.state will be updated to completed, and all the succession recurring_cycles.state of it will be updated to cancelled.

    refund_credit boolean required

    Only applicable for activate_type = immediate. By default, we will refund the current recurring billing's remaining credit back to the customer

Responses
Response Headers
    Schema
      code integer required
      message string required
      data object required
    Loading...