SubscriptionCancelRequest

Optional request body for canceling a subscription. If not provided, the subscription is canceled immediately.

  • cancel_at_period_end
    Type: boolean

    If true, the subscription remains active until the end of the current billing period, then cancels automatically.

  • cancel_at
    Type: string | nullFormat: date-time

    Schedule cancellation for a specific date (ISO 8601). The subscription remains active until this date. Cannot be used with cancel_at_period_end=true.

  • cancellation_details
    Type: CancellationDetails

    Details about why this subscription was cancelled.

    Properties: 2